blocks 2.4.0 → 2.5.0

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+2.5.0 (October 14, 2013)
+* Added skip method as a shorthand for defining or replacing a block's definition so that nothing is output when the block is rendered
+* Added ability to wrap each block in a collection with an element or render a block with an element, using syntax like:
+  <%= blocks.render :brand,
+                    :collection => @brands,
+                    :wrap_each => {:tag => "div", :style => "border: 1px solid black", :class => Proc.new {cycle("even", "odd")}},
+                    :wrap_with => {:tag => "div", :style => "color: red"}  %>
+  <%= blocks.render :brand, :wrap_with => {:tag => "div", :class => Proc.new {cycle("even", "odd")}} %>
+* Changed blocks.surrounding_tag_surrounds_before_and_after_blocks to Blocks.wrap_with_surrounds_before_and_after_blocks
+
 2.4.0 (September 4, 2013)
 * Moved queue and render_templates methods into the new with_template gem.
 

data/VERSION

@@ -1 +1 @@
-2.4.0
+2.5.0

data/blocks.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "blocks"
-  s.version = "2.4.0"
+  s.version = "2.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Hunter"]
-  s.date = "2013-09-05"
+  s.date = "2013-10-15"
   s.description = "Blocks goes beyond blocks and partials"
   s.email = "hunterae@gmail.com"
   s.extra_rdoc_files = [

data/lib/blocks.rb

@@ -14,8 +14,8 @@ module Blocks
   mattr_accessor :use_partials
   @@use_partials = false
 
-  mattr_accessor :surrounding_tag_surrounds_before_and_after_blocks
-  @@surrounding_tag_surrounds_before_and_after_blocks = false
+  mattr_accessor :wrap_with_surrounds_before_and_after_blocks
+  @@wrap_with_surrounds_before_and_after_blocks = false
 
   # Shortcut for using the templating feature / rendering templates
   def self.render_template(view, partial, options={}, &block)

data/lib/blocks/base.rb

@@ -23,8 +23,8 @@ module Blocks
     # Boolean variable for whether Blocks should attempt to render blocks as partials if a defined block cannot be found
     attr_accessor :use_partials
 
-    # Boolean variable for whether Blocks should render before and after blocks inside or outside of a collections' elements' surrounding tags
-    attr_accessor :surrounding_tag_surrounds_before_and_after_blocks
+    # Boolean variable for whether Blocks should render before and after blocks inside or outside of a collections' elements' wrap_with tags
+    attr_accessor :wrap_with_surrounds_before_and_after_blocks
 
     # Checks if a particular block has been defined within the current block scope.
     #   <%= blocks.defined? :some_block_name %>
@@ -84,6 +84,25 @@ module Blocks
       nil
     end
 
+    # Skip the rendering of a particular block when blocks.render is called for the a particular block name
+    #   <%= blocks.define :some_block_name do %>
+    #     My output
+    #   <% end %>
+    #
+    #   <%= blocks.skip :some_block_name %>
+    #
+    #   <%= blocks.render :some_block_name %>
+    #   <%# will not render anything %>
+    # Options:
+    # [+name+]
+    #   The name of the block to skip rendering for
+    def skip(name)
+      blocks[name.to_sym] = nil
+      self.define_block_container(name) do
+      end
+      nil
+    end
+
     # Render a block, first rendering any "before" blocks, then rendering the block itself, then rendering
     # any "after" blocks. Additionally, a collection may also be passed in, and Blocks will render
     # an the block, along with corresponding before and after blocks for each element of the collection.
@@ -123,10 +142,10 @@ module Blocks
     #       The collection of elements to render blocks for
     #     [:as]
     #       The variable name to assign the current element in the collection being rendered over
-    #     [:surrounding_tag]
+    #     [:wrap_with]
     #       The content tag to render around a block, which might be particularly useful when rendering a collection of blocks,
     #       such as for a list or table
-    #     [:surrounding_tag_html]
+    #     [:wrap_each]
     #       The attributes to be applied to the HTML content tag, such as styling or special properties. Please note, any Procs passed
     #       in will automatically be evaluated (For example: :class => lambda { cycle("even", "odd") })
     #     [:use_partials]
@@ -141,30 +160,34 @@ module Blocks
 
       buffer = ActiveSupport::SafeBuffer.new
 
+      wrap_with = options.delete(:wrap_with) || {}
+
       if collection
         as = options.delete(:as)
-
-        collection.each do |object|
-          cloned_args = args.clone
-          cloned_args.unshift(object)
-          cloned_options = options.clone
-          cloned_options = cloned_options.merge(object.options) if object.is_a?(Blocks::Container)
-          cloned_args.push(cloned_options)
-
-          block_name = call_with_params(name_or_container, *cloned_args)
-          as_name = (as.presence || block_name).to_sym
-          cloned_options[as_name] = object
-
-          buffer << render(block_name, *cloned_args, &block)
+        wrap_each = options.delete(:wrap_each) || {}
+
+        buffer = content_tag_with_block(wrap_with[:tag], wrap_with.except(:tag), *args) do
+          collection.each do |object|
+            cloned_args = args.clone
+            cloned_args.unshift(object)
+            cloned_options = options.clone
+            cloned_options = cloned_options.merge(object.options) if object.is_a?(Blocks::Container)
+            cloned_args.push(cloned_options)
+
+            block_name = call_with_params(name_or_container, *cloned_args)
+            as_name = (as.presence || block_name).to_sym
+            cloned_options[as_name] = object
+            cloned_options[:wrap_with] = wrap_each
+
+            buffer << render(block_name, *cloned_args, &block)
+          end
+          buffer
         end
       else
-        surrounding_tag = options.delete(:surrounding_tag)
-        surrounding_tag_html = options.delete(:surrounding_tag_html)
-
         args.push(options)
 
-        if surrounding_tag_surrounds_before_and_after_blocks
-          buffer << content_tag_with_block(surrounding_tag, surrounding_tag_html, *args) do
+        if wrap_with_surrounds_before_and_after_blocks
+          buffer << content_tag_with_block(wrap_with[:tag], wrap_with.except(:tag), *args) do
             temp_buffer = ActiveSupport::SafeBuffer.new
             temp_buffer << render_before_blocks(name_or_container, *args)
             temp_buffer << render_block_with_around_blocks(name_or_container, *args, &block)
@@ -172,7 +195,7 @@ module Blocks
           end
         else
           buffer << render_before_blocks(name_or_container, *args)
-          buffer << content_tag_with_block(surrounding_tag, surrounding_tag_html, *args) do
+          buffer << content_tag_with_block(wrap_with[:tag], wrap_with.except(:tag), *args) do
             render_block_with_around_blocks(name_or_container, *args, &block)
           end
           buffer << render_after_blocks(name_or_container, *args)
@@ -405,7 +428,7 @@ module Blocks
       self.blocks = {}
       self.anonymous_block_number = 0
       self.use_partials = options[:use_partials].nil? ? Blocks.use_partials : options.delete(:use_partials)
-      self.surrounding_tag_surrounds_before_and_after_blocks = options[:surrounding_tag_surrounds_before_and_after_blocks].nil? ? Blocks.surrounding_tag_surrounds_before_and_after_blocks : options.delete(:surrounding_tag_surrounds_before_and_after_blocks)
+      self.wrap_with_surrounds_before_and_after_blocks = options[:wrap_with_surrounds_before_and_after_blocks].nil? ? Blocks.wrap_with_surrounds_before_and_after_blocks : options.delete(:wrap_with_surrounds_before_and_after_blocks)
     end
 
     # Return a unique name for an anonymously defined block (i.e. a block that has not been given a name)

data/spec/blocks/base_spec.rb

@@ -331,6 +331,14 @@ describe Blocks::Base do
       buffer.should eql "rendered content"
     end
 
+    it "should be able to render an element surrounding the block" do
+      block = Proc.new {}
+      @view.expects(:capture).with(nil).returns("rendered content")
+      @builder.define :some_block, &block
+      buffer = @builder.render :some_block, :wrap_with => {:tag => "span", :id => "my-id"}
+      buffer.should eql "<span id=\"my-id\">rendered content</span>"
+    end
+
     describe "with a collection passed in" do
       it "should render a block for each element of the collection with the name of the block used as the name of the element passed into the block" do
         block = Proc.new {|item, options| "output#{options[:some_block]} "}
@@ -347,13 +355,13 @@ describe Blocks::Base do
       it "should render a block for each element of the collection with a surrounding element if that option is specified" do
         block = Proc.new {|item, options| "output#{options[:my_block_name]} "}
         @builder.define :some_block, &block
-        @builder.render(:some_block, :collection => [1,2,3], :surrounding_tag => "div").should eql "<div>output </div><div>output </div><div>output </div>"
+        @builder.render(:some_block, :collection => [1,2,3], :wrap_each => {:tag => "div"}).should eql "<div>output </div><div>output </div><div>output </div>"
       end
 
       it "should render a block for each element of the collection with a surrounding element and specified html options if those options are specified" do
         block = Proc.new {|item, options| "output#{options[:my_block_name]} "}
         @builder.define :some_block, &block
-        @builder.render(:some_block, :collection => [1,2,3], :surrounding_tag => "div", :surrounding_tag_html => {:class => lambda { @view.cycle("even", "odd")}, :style => "color:red"}).should eql "<div class=\"even\" style=\"color:red\">output </div><div class=\"odd\" style=\"color:red\">output </div><div class=\"even\" style=\"color:red\">output </div>"
+        @builder.render(:some_block, :collection => [1,2,3], :wrap_each => {:tag => "div", :class => lambda { @view.cycle("even", "odd")}, :style => "color:red"}).should eql "<div class=\"even\" style=\"color:red\">output </div><div class=\"odd\" style=\"color:red\">output </div><div class=\"even\" style=\"color:red\">output </div>"
       end
 
       it "should be able to render before blocks before each element of a collection" do
@@ -395,11 +403,11 @@ describe Blocks::Base do
 
         block = Proc.new {|item, options| "output#{options[:some_block]} "}
         @builder.define :some_block, &block
-        @builder.render(:some_block, :collection => [1,2,3], :surrounding_tag => "div").should eql "<div>before1 output1 after1 </div><div>before2 output2 after2 </div><div>before3 output3 after3 </div>"
+        @builder.render(:some_block, :collection => [1,2,3], :wrap_each => {:tag => "div"}).should eql "<div>before1 output1 after1 </div><div>before2 output2 after2 </div><div>before3 output3 after3 </div>"
       end
 
       it "should allow the global option to be set to render before and after blocks outside of surrounding elements" do
-        Blocks.surrounding_tag_surrounds_before_and_after_blocks = false
+        Blocks.wrap_with_surrounds_before_and_after_blocks = false
         @builder = Blocks::Base.new(@view)
         before_block = Proc.new {|item, options| "before#{options[:some_block]} "}
         @builder.before :some_block, &before_block
@@ -409,11 +417,23 @@ describe Blocks::Base do
 
         block = Proc.new {|item, options| "output#{options[:some_block]} "}
         @builder.define :some_block, &block
-        @builder.render(:some_block, :collection => [1,2,3], :surrounding_tag => "div").should eql "before1 <div>output1 </div>after1 before2 <div>output2 </div>after2 before3 <div>output3 </div>after3 "
+        @builder.render(:some_block, :collection => [1,2,3], :wrap_each => {:tag => "div"}).should eql "before1 <div>output1 </div>after1 before2 <div>output2 </div>after2 before3 <div>output3 </div>after3 "
       end
 
       it "should allow the option to be set to render before and after blocks outside of surrounding elements to be specified when Blocks is initialized" do
-        @builder = Blocks::Base.new(@view, :surrounding_tag_surrounds_before_and_after_blocks => false)
+        @builder = Blocks::Base.new(@view, :wrap_with_surrounds_before_and_after_blocks => false)
+        before_block = Proc.new {|item, options| "before#{options[:some_block]} "}
+        @builder.before :some_block, &before_block
+
+        after_block = Proc.new {|item, options| "after#{options[:some_block]} "}
+        @builder.after :some_block, &after_block
+
+        block = Proc.new {|item, options| "output#{options[:some_block]} "}
+        @builder.define :some_block, &block
+        @builder.render(:some_block, :collection => [1,2,3], :wrap_each => {:tag => "div"}).should eql "before1 <div>output1 </div>after1 before2 <div>output2 </div>after2 before3 <div>output3 </div>after3 "
+      end
+
+      it "should be able to render an element around everything" do
         before_block = Proc.new {|item, options| "before#{options[:some_block]} "}
         @builder.before :some_block, &before_block
 
@@ -422,7 +442,7 @@ describe Blocks::Base do
 
         block = Proc.new {|item, options| "output#{options[:some_block]} "}
         @builder.define :some_block, &block
-        @builder.render(:some_block, :collection => [1,2,3], :surrounding_tag => "div").should eql "before1 <div>output1 </div>after1 before2 <div>output2 </div>after2 before3 <div>output3 </div>after3 "
+        @builder.render(:some_block, :collection => [1,2,3], :wrap_each => {:tag => "div"}, :wrap_with => {:tag => "div", :style => "color:red"}).should eql "<div style=\"color:red\"><div>before1 output1 after1 </div><div>before2 output2 after2 </div><div>before3 output3 after3 </div></div>"
       end
     end
   end

data/spec/spec_helper.rb

@@ -13,7 +13,7 @@ RSpec.configure do |config|
   
   config.before :each do
     Blocks.template_folder = "blocks"
-    Blocks.surrounding_tag_surrounds_before_and_after_blocks = true
+    Blocks.wrap_with_surrounds_before_and_after_blocks = true
     Blocks.use_partials = false
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blocks
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -134,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1012298278410896826
+      hash: -2216410614422126676
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: