From 1f5b360466c3494267cc9aad08a19d1ace4763d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joel=20Junstr=C3=B6m?= Date: Sun, 16 Sep 2012 22:45:08 +0200 Subject: Added PartialIteration class used when rendering collections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The iteration object is available as the local variable "template_name_iteration" when rendering partials with collections. It gives access to the +size+ of the collection beeing iterated over, the current +index+ and two convinicence methods +first?+ and +last?+ "template_name_counter" variable is kept but is deprecated. [Joel Junström + Lucas Uyezu] --- .../lib/action_view/renderer/partial_renderer.rb | 41 +++++++++++++++------- 1 file changed, 28 insertions(+), 13 deletions(-) (limited to 'actionview/lib/action_view') diff --git a/actionview/lib/action_view/renderer/partial_renderer.rb b/actionview/lib/action_view/renderer/partial_renderer.rb index 36f17f01fd..3963a73204 100644 --- a/actionview/lib/action_view/renderer/partial_renderer.rb +++ b/actionview/lib/action_view/renderer/partial_renderer.rb @@ -1,4 +1,5 @@ require 'thread_safe' +require "action_view/partial_iteration" module ActionView # = Action View Partials @@ -56,8 +57,12 @@ module ActionView # <%= render partial: "ad", collection: @advertisements %> # # This will render "advertiser/_ad.html.erb" and pass the local variable +ad+ to the template for display. An - # iteration counter will automatically be made available to the template with a name of the form - # +partial_name_counter+. In the case of the example above, the template would be fed +ad_counter+. + # iteration object will automatically be made available to the template with a name of the form + # +partial_name_iteration+. The iteration object has knowledge about which index the current object has in + # the collection and the total size of the collection. The iteration object also has two convenience methods, + # +first?+ and +last?+. In the case of the example above, the template would be fed +ad_iteration+. + # For backwards compatibility the +partial_name_counter+ is still present and is mapped to the iteration's + # +index+ method. # # The :as option may be used when rendering partials. # @@ -352,7 +357,7 @@ module ActionView end if @path - @variable, @variable_counter = retrieve_variable(@path, as) + @variable, @variable_counter, @variable_iteration = retrieve_variable(@path, as) @template_keys = retrieve_template_keys else paths.map! { |path| retrieve_variable(path, as).unshift(path) } @@ -385,7 +390,7 @@ module ActionView def collection_with_template view, locals, template = @view, @locals, @template - as, counter = @variable, @variable_counter + as, counter, iteration = @variable, @variable_counter, @variable_iteration if layout = @options[:layout] layout = find_template(layout, @template_keys) @@ -393,8 +398,11 @@ module ActionView index = -1 @collection.map do |object| - locals[as] = object - locals[counter] = (index += 1) + index += 1 + + locals[as] = object + locals[counter] = index + locals[iteration] = PartialIteration.new(@collection.size, index) content = template.render(view, locals) content = layout.render(view, locals) { content } if layout @@ -410,10 +418,11 @@ module ActionView index = -1 @collection.map do |object| index += 1 - path, as, counter = collection_data[index] + path, as, counter, iteration = collection_data[index] - locals[as] = object - locals[counter] = index + locals[as] = object + locals[counter] = index + locals[iteration] = PartialIteration.new(@collection.size, index) template = (cache[path] ||= find_template(path, keys + [as, counter])) template.render(view, locals) @@ -466,8 +475,11 @@ module ActionView def retrieve_template_keys keys = @locals.keys - keys << @variable if @object || @collection - keys << @variable_counter if @collection + keys << @variable if @object || @collection + if @collection + keys << @variable_counter + keys << @variable_iteration + end keys end @@ -477,8 +489,11 @@ module ActionView raise_invalid_identifier(path) unless base =~ /\A_?([a-z]\w*)(\.\w+)*\z/ $1.to_sym end - variable_counter = :"#{variable}_counter" if @collection - [variable, variable_counter] + if @collection + variable_counter = :"#{variable}_counter" + variable_iteration = :"#{variable}_iteration" + end + [variable, variable_counter, variable_iteration] end IDENTIFIER_ERROR_MESSAGE = "The partial name (%s) is not a valid Ruby identifier; " + -- cgit v1.2.3 From 9830ebbeaf6f7faead9b4503ed9c9ab0a327df9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Mendon=C3=A7a=20Fran=C3=A7a?= Date: Wed, 16 Jul 2014 14:13:42 -0300 Subject: No need to have a file to PartialIteration class This class is only used on the PartialRenderer. --- .../lib/action_view/renderer/partial_renderer.rb | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'actionview/lib/action_view') diff --git a/actionview/lib/action_view/renderer/partial_renderer.rb b/actionview/lib/action_view/renderer/partial_renderer.rb index 3963a73204..6b3c49aa79 100644 --- a/actionview/lib/action_view/renderer/partial_renderer.rb +++ b/actionview/lib/action_view/renderer/partial_renderer.rb @@ -1,7 +1,23 @@ require 'thread_safe' -require "action_view/partial_iteration" module ActionView + class PartialIteration # :nodoc: + attr_reader :size, :index + + def initialize(size, index) + @size = size + @index = index + end + + def first? + index == 0 + end + + def last? + index == size - 1 + end + end + # = Action View Partials # # There's also a convenience method for rendering sub templates within the current controller that depends on a -- cgit v1.2.3 From 9290fc5ce213836f666a97e0e458d98e69a920ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Mendon=C3=A7a=20Fran=C3=A7a?= Date: Wed, 16 Jul 2014 14:28:39 -0300 Subject: Build only one PartialIteration object for loop --- .../lib/action_view/renderer/partial_renderer.rb | 29 ++++++++++++++-------- 1 file changed, 18 insertions(+), 11 deletions(-) (limited to 'actionview/lib/action_view') diff --git a/actionview/lib/action_view/renderer/partial_renderer.rb b/actionview/lib/action_view/renderer/partial_renderer.rb index 6b3c49aa79..bc0215b6c6 100644 --- a/actionview/lib/action_view/renderer/partial_renderer.rb +++ b/actionview/lib/action_view/renderer/partial_renderer.rb @@ -4,9 +4,9 @@ module ActionView class PartialIteration # :nodoc: attr_reader :size, :index - def initialize(size, index) + def initialize(size) @size = size - @index = index + @index = 0 end def first? @@ -16,6 +16,10 @@ module ActionView def last? index == size - 1 end + + def iterate! + @index += 1 + end end # = Action View Partials @@ -412,16 +416,16 @@ module ActionView layout = find_template(layout, @template_keys) end - index = -1 - @collection.map do |object| - index += 1 + partial_interation = PartialIteration.new(@collection.size) + locals[iteration] = partial_interation + @collection.map do |object| locals[as] = object - locals[counter] = index - locals[iteration] = PartialIteration.new(@collection.size, index) + locals[counter] = partial_interation.index content = template.render(view, locals) content = layout.render(view, locals) { content } if layout + partial_interation.iterate! content end end @@ -431,17 +435,20 @@ module ActionView cache = {} keys = @locals.keys - index = -1 + partial_interation = PartialIteration.new(@collection.size) + @collection.map do |object| - index += 1 + index = partial_interation.index path, as, counter, iteration = collection_data[index] locals[as] = object locals[counter] = index - locals[iteration] = PartialIteration.new(@collection.size, index) + locals[iteration] = partial_interation template = (cache[path] ||= find_template(path, keys + [as, counter])) - template.render(view, locals) + content = template.render(view, locals) + partial_interation.iterate! + content end end -- cgit v1.2.3 From 7dc0f3fc8d3160db3408ef5a20c43a7268c0cd8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Mendon=C3=A7a=20Fran=C3=A7a?= Date: Wed, 16 Jul 2014 14:38:07 -0300 Subject: Document the PartialIteration object --- actionview/lib/action_view/renderer/partial_renderer.rb | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'actionview/lib/action_view') diff --git a/actionview/lib/action_view/renderer/partial_renderer.rb b/actionview/lib/action_view/renderer/partial_renderer.rb index bc0215b6c6..eb8db16796 100644 --- a/actionview/lib/action_view/renderer/partial_renderer.rb +++ b/actionview/lib/action_view/renderer/partial_renderer.rb @@ -1,23 +1,29 @@ require 'thread_safe' module ActionView - class PartialIteration # :nodoc: - attr_reader :size, :index + class PartialIteration + # The number of iterations that will be done by the partial. + attr_reader :size + + # The current iteration of the partial. + attr_reader :index def initialize(size) @size = size @index = 0 end + # Check if this is the first iteration of the partial. def first? index == 0 end + # Check if this is the last iteration of the partial. def last? index == size - 1 end - def iterate! + def iterate! # :nodoc: @index += 1 end end -- cgit v1.2.3