blocks 2.6.4 → 2.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjAzYTVjNjBiN2UxM2JmNWFlYmFiYjMzMGMwM2UxZDc1MDNjYjViNg==
+    MWI0ZTBkM2RiYWJjMzkxM2NiNTQ0NDEyYjY5MzIyNjI0YWNlMTZmNQ==
   data.tar.gz: !binary |-
-    MzAzOWU1NWM1Yzg0M2RlMTAyNDM3NWQwZTYyODdlZDg4NmQ1ZmEwYw==
+    NmFiNDE4Yjg5OTBiYTg5YmQwZTQxZWU1ZmEzOGQ2ZjIzNDNhYWQzYg==
 SHA512:
   metadata.gz: !binary |-
-    MDQzZWZkY2YwNDY1M2VlMGY3OWQ5MDdiMWE1Mjg0MzgwZjljNmQzYzFhNTM5
-    NjhhODhiZWY5ZTg0YWU1YjBmYWJhOWU2NzRjZGM1Y2U5Mzc3NWI3MmUzZTVj
-    M2JhYjc3NDg2NTU5N2NkMDVlZGU2YjM0YjY1YTRmY2Q2YWVmNjE=
+    ZjAyM2ZjYWZmMzc1MDM1ZjkyY2FmMTdhYTYyOTk0OTgwMzBhMmRmNDJhMjdi
+    ZWE0NDFkZDM2NjVjYTgxZWRjNjVlYTUyNjZkMTlhMTk1YWUzMWIzMDkwN2M1
+    N2IyYjQ3NDU2MWIyMGVkYWZkMDA4YTEzOGNlMjgzNzAzNDY5YzA=
   data.tar.gz: !binary |-
-    MWE0MTRjZGM3MDY4NjdkYWQwYjZjYWY1OTY2MWYxMjEwYTNmOGQ1NTJmMzVh
-    NjVmMzA0OTI3MDFiODQwMjE0NWRjMzUxYTFlZjFhZTA0NjU1OTBmNGY1NjE2
-    MGZmYzMwYjk1YjhiZGQyOWY4NDNlZWE1YWJhZTM2YmQwYzM4Mzc=
+    M2MyNmEwMTMwNzllYjZlZWVkNjQ2MGE2MWIyMDNmYzI5NGNkMDQ1ODU3NTFj
+    YTJhZjk0YjgwYThiM2I5MjA5M2E2ZTdiZTIwOWFjODYzMzRhZjQ1MTk1Nzgw
+    Y2QxNzYyN2EzOWFiNzU0NGRkZGYzN2YyYzMzOTIwYTc2ZWMzYjk=

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+2.7.0 (December 9, 2015)
+* Added configuration option skip_applies_to_surrounding_blocks. When set to true, if blocks.skip :SOME_BLOCK is called,
+  any before, after, and around hooks applied to that block will also be skipped when the block attempts to render.
+  This may be configured in an initializer as follows:
+    Blocks.setup { |config| config.skip_applies_to_surrounding_blocks = true }
+* Cleanup to Blocks::Base to reduce code duplication
+
 2.6.4 (July 21, 2014)
 * Removed dependence on jeweler for managing gem
 * Small cleanups of the code
@@ -83,4 +90,4 @@
 * Ability to disable use of partials when rendering a block
 * Ability to disable use of partials for before and after hooks
 * Complete test coverage
-* :template_folder and :variable options are no longer being passed in as part of the options hash to defined blocks and partials
+* :template_folder and :variable options are no longer being passed in as part of the options hash to defined blocks and partials

data/Rakefile

@@ -4,7 +4,7 @@ require 'bundler/gem_tasks'
 # Default directory to look in is `/specs`
 # Run with `rake spec`
 RSpec::Core::RakeTask.new(:spec) do |task|
-  task.rspec_opts = ['--color', '--format', 'nested']
+  task.rspec_opts = ['--color', '--format', 'documentation']
 end
 
-task :default => :spec
+task :default => :spec

data/lib/blocks.rb

@@ -14,6 +14,7 @@ module Blocks
   @@config.wrap_before_and_after_blocks = false
   @@config.use_partials = false
   @@config.partials_folder = "blocks"
+  @@config.skip_applies_to_surrounding_blocks = false
 
   # Default way to setup Blocks
   def self.setup
@@ -21,5 +22,5 @@ module Blocks
   end
 end
 
-ActionView::Base.send :include, Blocks::ViewAdditions::ClassMethods
-ActionController::Base.send :include, Blocks::ControllerAdditions::ClassMethods
+ActionView::Base.send :include, Blocks::ViewAdditions
+ActionController::Base.send :include, Blocks::ControllerAdditions

data/lib/blocks/base.rb

@@ -16,6 +16,9 @@ module Blocks
     # These are the options that are passed into the initalize method
     attr_accessor :global_options
 
+    # Hash of block names that have been explicitely skipped
+    attr_accessor :skipped_blocks
+
     # Checks if a particular block has been defined within the current block scope.
     #   <%= blocks.defined? :some_block_name %>
     # Options:
@@ -90,6 +93,7 @@ module Blocks
     #   The name of the block to skip rendering for
     def skip(name)
       blocks[name] = nil
+      skipped_blocks[name] = true
       self.define_block_container(name) do
       end
       nil
@@ -147,6 +151,10 @@ module Blocks
     def render(name_or_container, *args, &block)
       options = args.extract_options!
       collection = options.delete(:collection)
+      name = extract_block_name name_or_container
+      if skipped_blocks[name] && global_options.skip_applies_to_surrounding_blocks
+        return
+      end
 
       buffer = ActiveSupport::SafeBuffer.new
 
@@ -415,6 +423,7 @@ module Blocks
     def initialize(view, options={})
       self.view = view
       self.global_options = Blocks.config.merge(options)
+      self.skipped_blocks = HashWithIndifferentAccess.new
       self.blocks = HashWithIndifferentAccess.new
       self.anonymous_block_number = 0
     end
@@ -428,7 +437,7 @@ module Blocks
     end
 
     def render_block_with_around_blocks(name_or_container, *args, &block)
-      name = name_or_container.is_a?(Blocks::Container) ? name_or_container.name : name_or_container
+      name = extract_block_name name_or_container
       around_name = "around_#{name}"
 
       around_blocks = blocks[around_name].present? ? blocks[around_name].clone : []
@@ -448,13 +457,7 @@ module Blocks
     def render_block(name_or_container, *args, &block)
       buffer = ActiveSupport::SafeBuffer.new
 
-      if (name_or_container.is_a?(Blocks::Container))
-        name = name_or_container.name.to_sym
-        block_render_options = name_or_container.options
-      else
-        name = name_or_container.to_sym
-        block_render_options = {}
-      end
+      name, block_render_options = extract_block_name_and_options(name_or_container)
 
       block_definition_options = {}
       if blocks[name]
@@ -472,10 +475,10 @@ module Blocks
         begin
           begin
             buffer << view.render("#{name.to_s}", options)
-          rescue ActionView::MissingTemplate
+          rescue ActionView::MissingTemplate, ArgumentError
             buffer << view.render("#{options[:partials_folder]}/#{name.to_s}", options)
           end
-        rescue ActionView::MissingTemplate
+        rescue ActionView::MissingTemplate, ArgumentError
           args.push(global_options.merge(options))
           buffer << view.capture(*(args[0, block.arity]), &block) if block_given?
         end
@@ -560,5 +563,17 @@ module Blocks
       blocks[block_container.name] = block_container if blocks[block_container.name].nil? && block_given?
       block_container
     end
+
+    def extract_block_name(name_or_container)
+      extract_block_name_and_options(name_or_container).first
+    end
+
+    def extract_block_name_and_options(name_or_container)
+      if name_or_container.is_a?(Blocks::Container)
+        [name_or_container.name, name_or_container.options]
+      else
+        [name_or_container, {}]
+      end
+    end
   end
 end

data/lib/blocks/version.rb

@@ -1,3 +1,3 @@
 module Blocks
-  VERSION = "2.6.4"
-end
+  VERSION = "2.7.0"
+end

data/lib/blocks/view_additions.rb

@@ -1,12 +1,10 @@
 module Blocks
   module ViewAdditions
-    module ClassMethods
-      def blocks
-        return @blocks if @blocks
-        @blocks = Blocks::Base.new(self)
-        @blocks.blocks.merge! @controller_blocks.blocks if @controller_blocks
-        @blocks
-      end
+    def blocks
+      return @blocks if @blocks
+      @blocks = Blocks::Base.new(self)
+      @blocks.blocks.merge! @controller_blocks.blocks if @controller_blocks
+      @blocks
     end
   end
-end
+end

data/spec/blocks/base_spec.rb

@@ -15,32 +15,32 @@ describe Blocks::Base do
     @builder.expects(:render_before_blocks).at_least_once
     @builder.expects(:render_after_blocks).at_least_once
     # @view.expects(:capture).with(:value1 => 1, :value2 => 2).never
-    @view.expects(:render).with("some_block", 'partials_folder' => 'shared', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'value1' => 1, 'value2' => 2).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
-    @view.expects(:render).with("shared/some_block", 'partials_folder' => 'shared', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'value1' => 1, 'value2' => 2).once
+    @view.expects(:render).with("some_block", 'partials_folder' => 'shared', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
+    @view.expects(:render).with("shared/some_block", 'partials_folder' => 'shared', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).once
     @builder.render :some_block, :value1 => 1, :value2 => 2
   end
 
   describe "#defined?" do
     it "should be able to determine if a block by a specific name is already defined" do
-      @builder.defined?(:test_block).should be_false
+      @builder.defined?(:test_block).should be false
       @builder.define :test_block do end
-      @builder.defined?(:test_block).should be_true
+      @builder.defined?(:test_block).should be true
     end
 
     it "should not care whether the block name was defined with a string or a symbol" do
-      @builder.defined?(:test_block).should be_false
+      @builder.defined?(:test_block).should be false
       @builder.define "test_block" do end
-      @builder.defined?(:test_block).should be_true
+      @builder.defined?(:test_block).should be true
 
-      @builder.defined?(:test_block2).should be_false
+      @builder.defined?(:test_block2).should be false
       @builder.define :test_block2 do end
-      @builder.defined?(:test_block2).should be_true
+      @builder.defined?(:test_block2).should be true
     end
 
     it "should not care whether the defined? method is passed a string or a symbol" do
-      @builder.defined?("test_block").should be_false
+      @builder.defined?("test_block").should be false
       @builder.define :test_block do end
-      @builder.defined?("test_block").should be_true
+      @builder.defined?("test_block").should be true
     end
   end
 
@@ -299,7 +299,7 @@ describe Blocks::Base do
     it "should automatically pass in an options hash to a defined block that takes one paramter when that block is rendered" do
       block = Proc.new {|options| print_hash(options) }
       @builder.define :some_block, &block
-      @builder.render(:some_block).should eql print_hash(:wrap_before_and_after_blocks => false, :use_partials => false, :partials_folder => "blocks", )
+      @builder.render(:some_block).should eql print_hash(:wrap_before_and_after_blocks => false, :use_partials => false, :partials_folder => "blocks", :skip_applies_to_surrounding_blocks => true)
     end
 
     it "should be able to render a defined block by its name and pass in runtime arguments as a hash" do
@@ -307,7 +307,7 @@ describe Blocks::Base do
         print_hash(options)
       end
       @builder.define :some_block, &block
-      @builder.render(:some_block, :param1 => 1, :param2 => "value2").should eql print_hash(:wrap_before_and_after_blocks => false, :use_partials => false, :partials_folder => "blocks", :param1 => 1, :param2 => "value2")
+      @builder.render(:some_block, :param1 => 1, :param2 => "value2").should eql print_hash(:wrap_before_and_after_blocks => false, :use_partials => false, :partials_folder => "blocks", :skip_applies_to_surrounding_blocks => true, :param1 => 1, :param2 => "value2")
     end
 
     it "should be able to render a defined block by its name and pass in runtime arguments one by one" do
@@ -315,7 +315,7 @@ describe Blocks::Base do
         "first_param: #{first_param}, second_param: #{second_param}, #{print_hash options}"
       end
       @builder.define :some_block, &block
-      @builder.render(:some_block, 3, 4, :param1 => 1, :param2 => "value2").should eql("first_param: 3, second_param: 4, #{print_hash(:wrap_before_and_after_blocks => false, :use_partials => false, :partials_folder => "blocks", :param1 => 1, :param2 => "value2")}")
+      @builder.render(:some_block, 3, 4, :param1 => 1, :param2 => "value2").should eql("first_param: 3, second_param: 4, #{print_hash(:wrap_before_and_after_blocks => false, :use_partials => false, :partials_folder => "blocks", :skip_applies_to_surrounding_blocks => true, :param1 => 1, :param2 => "value2")}")
     end
 
     it "should match up the number of arguments to a defined block with the parameters passed when a block is rendered" do
@@ -331,7 +331,7 @@ describe Blocks::Base do
         "first_param: #{first_param}, second_param: #{second_param}, #{print_hash options}"
       end
       @builder.replace :some_block, &block
-      @builder.render(:some_block, 3, 4, :param1 => 1, :param2 => "value2").should eql("first_param: 3, second_param: 4, #{print_hash(:wrap_before_and_after_blocks => false, :use_partials => false, :partials_folder => "blocks", :param1 => 1, :param2 => "value2")}")
+      @builder.render(:some_block, 3, 4, :param1 => 1, :param2 => "value2").should eql("first_param: 3, second_param: 4, #{print_hash(:wrap_before_and_after_blocks => false, :use_partials => false, :partials_folder => "blocks", :skip_applies_to_surrounding_blocks => true, :param1 => 1, :param2 => "value2")}")
     end
 
     it "should not render anything if using a block that has been defined" do
@@ -339,8 +339,8 @@ describe Blocks::Base do
         config.use_partials = true
       end
       @builder = Blocks::Base.new(@view)
-      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
-      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
+      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
+      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
       @builder.render :some_block
     end
 
@@ -357,8 +357,8 @@ describe Blocks::Base do
         config.use_partials = true
       end
       @builder = Blocks::Base.new(@view)
-      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'value1' => 1, 'value2' => 2).once
-      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'value1' => 1, 'value2' => 2).never
+      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).once
+      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).never
       @builder.render :some_block, :value1 => 1, :value2 => 2
     end
 
@@ -367,8 +367,8 @@ describe Blocks::Base do
         config.use_partials = true
       end
       @builder = Blocks::Base.new(@view)
-      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'value1' => 1, 'value2' => 2).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
-      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'value1' => 1, 'value2' => 2).once
+      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
+      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).once
       @builder.render :some_block, :value1 => 1, :value2 => 2
     end
 
@@ -381,8 +381,8 @@ describe Blocks::Base do
         config.use_partials = true
       end
       @builder = Blocks::Base.new(@view)
-      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'value1' => 1, 'value2' => 2).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
-      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'value1' => 1, 'value2' => 2).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
+      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
+      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => true, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).raises(ActionView::MissingTemplate.new([],[],[],[],[]))
       @builder.render :some_block, :value1 => 1, :value2 => 2, &block
     end
 
@@ -391,8 +391,8 @@ describe Blocks::Base do
         options[:value1].should eql 1
         options[:value2].should eql 2
       end
-      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => false, 'value1' => 1, 'value2' => 2).never
-      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => false, 'value1' => 1, 'value2' => 2).never
+      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => false, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).never
+      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => false, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).never
       @builder.render :some_block, :value1 => 1, :value2 => 2, &block
     end
 
@@ -405,8 +405,8 @@ describe Blocks::Base do
         options[:value1].should eql 1
         options[:value2].should eql 2
       end
-      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => false, 'value1' => 1, 'value2' => 2).never
-      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => false, 'value1' => 1, 'value2' => 2).never
+      @view.expects(:render).with("some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => false, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).never
+      @view.expects(:render).with("blocks/some_block", 'partials_folder' => 'blocks', 'wrap_before_and_after_blocks' => false, 'use_partials' => false, 'skip_applies_to_surrounding_blocks' => true, 'value1' => 1, 'value2' => 2).never
       @builder.render :some_block, :value1 => 1, :value2 => 2, &block
     end
 
@@ -591,14 +591,14 @@ describe Blocks::Base do
 
     it "should be able to nest multiple around blocks with the last defined around block on the outside" do
       my_block = Proc.new { "test" }
-      around_block1 = Proc.new { |content_block| "<h1>#{content_block.call}</h1>" }
-      around_block2 = Proc.new { |content_block| "<span style='font-size: 100px'>#{content_block.call}</span>" }
-      around_block3 = Proc.new { |content_block| "<span style='color:red'>#{content_block.call}</span>" }
+      around_block1 = Proc.new { |content_block| @view.content_tag :h1, content_block.call }
+      around_block2 = Proc.new { |content_block| @view.content_tag :span, content_block.call, :style => "font-size: 100px" }
+      around_block3 = Proc.new { |content_block| @view.content_tag :span, content_block.call, :style => "style='color:red" }
       @builder.define(:my_block, &my_block)
       @builder.around(:my_block, &around_block1)
       @builder.around(:my_block, &around_block2)
       @builder.around(:my_block, &around_block3)
-      @builder.render(:my_block).should eql("&lt;h1&gt;&amp;lt;span style='font-size: 100px'&amp;gt;&amp;amp;lt;span style='color:red'&amp;amp;gt;test&amp;amp;lt;/span&amp;amp;gt;&amp;lt;/span&amp;gt;&lt;/h1&gt;")
+      @builder.render(:my_block).should eql(%%<h1><span style="font-size: 100px"><span style="style=&#39;color:red">test</span></span></h1>%)
     end
   end
 
@@ -632,4 +632,4 @@ describe Blocks::Base do
       @builder.render :my_after_block, :param1 => "top level"
     end
   end
-end
+end

data/spec/blocks/view_additions_spec.rb

@@ -4,7 +4,7 @@ describe Blocks::ViewAdditions do
   before(:each) do
     @view_class = Class.new
     @view = @view_class.new
-    @view_class.send(:include, Blocks::ViewAdditions::ClassMethods)
+    @view_class.send(:include, Blocks::ViewAdditions)
   end
 
   describe "#blocks" do
@@ -19,4 +19,4 @@ describe Blocks::ViewAdditions do
       @view.blocks.should eql "something"
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blocks
 version: !ruby/object:Gem::Version
-  version: 2.6.4
+  version: 2.7.0
 platform: ruby
 authors:
 - Andrew Hunter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Blocks goes beyond blocks and partials
@@ -166,3 +166,4 @@ test_files:
 - spec/blocks/blocks_spec.rb
 - spec/blocks/view_additions_spec.rb
 - spec/spec_helper.rb
+has_rdoc: