Skip to content

Update docs (2023/11/16) #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 16, 2023
Merged

Update docs (2023/11/16) #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a36d67b
chore: Use constant to make it easy to switch the branch
toshimaru Nov 16, 2023
399ae5a
docs: update doc
toshimaru Nov 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 2 additions & 1 deletion Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ require 'bundler'
SOURCE_DIR = 'src'
INDEX_HTML = 'files/railties/RDOC_MAIN_rdoc.html'
NEW_INDEX_HTML = 'files/railties/RDOC_MAIN_md.html'
MY_SDOC_BRANCH = 'main'

desc 'Generate documentation for default Rails version and build Jekyll site'
task build: :switch_default_rails do
Expand Down Expand Up @@ -64,7 +65,7 @@ def generate_rails_rdoc

# Replace sdoc gem with my forked one
gemfile = File.read('Gemfile')
gemfile.gsub!(/"sdoc".*$/, '"sdoc", github: "toshimaru/sdoc", branch: "main"')
gemfile.gsub!(/"sdoc".*$/, %("sdoc", github: "toshimaru/sdoc", branch: "#{MY_SDOC_BRANCH}"))
File.write('Gemfile', gemfile)

sh 'bundle install && bundle update sdoc'
Expand Down
66 changes: 33 additions & 33 deletions src/classes/AbstractController/Base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,15 +183,15 @@ <h3 id="method-c-abstract-21">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 57
def abstract!
@abstract = true
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L57" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L57" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -223,7 +223,7 @@ <h4 id="method-c-action_methods-label-Returns">Returns</h4>

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 96
Expand All @@ -234,12 +234,12 @@ <h4 id="method-c-action_methods-label-Returns">Returns</h4>
methods = public_instance_methods(true) - internal_methods
# Be sure to include shadowed public instance methods of this class.
methods.concat(public_instance_methods(false))
methods.map!(&:to_s)
methods.map!(&amp;:to_s)
methods.to_set
end
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L96" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L96" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -266,15 +266,15 @@ <h3 id="method-c-clear_action_methods-21">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 111
def clear_action_methods!
@action_methods = nil
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L111" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L111" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -313,15 +313,15 @@ <h4 id="method-c-controller_path-label-Returns">Returns</h4>

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 125
def controller_path
@controller_path ||= name.delete_suffix("Controller").underscore unless anonymous?
@controller_path ||= name.delete_suffix(&quot;Controller&quot;).underscore unless anonymous?
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L125" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L125" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -348,7 +348,7 @@ <h3 id="method-c-internal_methods">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 76
Expand All @@ -364,7 +364,7 @@ <h3 id="method-c-internal_methods">
controller.public_instance_methods(true) - methods
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L76" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L76" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -391,7 +391,7 @@ <h3 id="method-c-method_added">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 130
Expand All @@ -400,7 +400,7 @@ <h3 id="method-c-method_added">
clear_action_methods!
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L130" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L130" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -427,15 +427,15 @@ <h3 id="method-c-supports_path-3F">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 199
def self.supports_path?
true
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L199" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L199" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -466,15 +466,15 @@ <h3 id="method-i-action_methods">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 170
def action_methods
self.class.action_methods
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L170" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L170" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -501,14 +501,14 @@ <h3 id="method-i-action_name">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 42
attr_internal :action_name
</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L42" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L42" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -542,15 +542,15 @@ <h4 id="method-i-available_action-3F-label-Parameters">Parameters</h4>

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 184
def available_action?(action_name)
_find_action_name(action_name)
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L184" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L184" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -577,15 +577,15 @@ <h3 id="method-i-controller_path">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 165
def controller_path
self.class.controller_path
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L165" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L165" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -612,14 +612,14 @@ <h3 id="method-i-formats">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 46
attr_internal :formats
</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L46" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L46" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -646,15 +646,15 @@ <h3 id="method-i-performed-3F">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 191
def performed?
response_body
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L191" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L191" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -688,23 +688,23 @@ <h4 id="method-i-process-label-Returns">Returns</h4>

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 151
def process(action, *args)
@_action_name = action.to_s

unless action_name = _find_action_name(@_action_name)
raise ActionNotFound.new("The action '#{action}' could not be found for #{self.class.name}", self, action)
raise ActionNotFound.new(&quot;The action &#39;#{action}&#39; could not be found for #{self.class.name}&quot;, self, action)
end

@_response_body = nil

process_action(action_name, *args)
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L151" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L151" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -731,14 +731,14 @@ <h3 id="method-i-response_body">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 38
attr_internal :response_body
</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L38" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L38" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down
14 changes: 7 additions & 7 deletions src/classes/AbstractController/Caching.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,15 +123,15 @@ <h3 id="method-i-view_cache_dependencies">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/caching.rb, line 52
def view_cache_dependencies
self.class._view_cache_dependencies.filter_map { |dep| instance_exec(&dep) }
self.class._view_cache_dependencies.filter_map { |dep| instance_exec(&amp;dep) }
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L52" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L52" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -161,19 +161,19 @@ <h3 id="method-i-cache">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/caching.rb, line 58
def cache(key, options = {}, &block) # :doc:
def cache(key, options = {}, &amp;block) # :doc:
if cache_configured?
cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &block)
cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &amp;block)
else
yield
end
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L58" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L58" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down
6 changes: 3 additions & 3 deletions src/classes/AbstractController/Caching/ClassMethods.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,15 @@ <h3 id="method-i-view_cache_dependency">

<details class="method__source">
<summary>
<span class="label">Source code</span>
<span class="label">📝 Source code</span>
</summary>

<pre><code class="ruby"># File actionpack/lib/abstract_controller/caching.rb, line 47
def view_cache_dependency(&dependency)
def view_cache_dependency(&amp;dependency)
self._view_cache_dependencies += [dependency]
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L47" target="_blank" class="github_url">See on GitHub</a>
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L47" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down
Loading