blocks 2.3.1 → 2.4.0

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+2.4.0 (September 4, 2013)
+* Moved queue and render_templates methods into the new with_template gem.
+
 2.3.1 (September 3, 2013)
 * Removed call to autoload class that was moved into a separate gem, broke .rvmrc into .ruby-gemset and .ruby-version
 

data/Gemfile

@@ -12,4 +12,5 @@ end
 group :test do
   gem "rspec-rails"
   gem "mocha"
+  gem "debugger"
 end

data/Rakefile

@@ -27,11 +27,4 @@ Jeweler::Tasks.new do |gem|
   gem.authors = ["Andrew Hunter"]
   # dependencies defined in Gemfile
 end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-2.3.1
+2.4.0

data/blocks.gemspec

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

data/lib/blocks/base.rb

@@ -8,15 +8,9 @@ module Blocks
     # Hash of block names to Blocks::Container objects
     attr_accessor :blocks
 
-    # Array of Blocks::Container objects, storing the order of blocks as they were queued
-    attr_accessor :queued_blocks
-
     # counter, used to give unnamed blocks a unique name
     attr_accessor :anonymous_block_number
 
-    # A Hash of queued_blocks arrays; a new array is started when method_missing is invoked
-    attr_accessor :block_groups
-
     # These are the options that are passed into the initalize method
     attr_accessor :global_options
 
@@ -170,7 +164,7 @@ module Blocks
         args.push(options)
 
         if surrounding_tag_surrounds_before_and_after_blocks
-          buffer << content_tag(surrounding_tag, surrounding_tag_html, *args) do
+          buffer << content_tag_with_block(surrounding_tag, surrounding_tag_html, *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)
@@ -178,7 +172,7 @@ module Blocks
           end
         else
           buffer << render_before_blocks(name_or_container, *args)
-          buffer << content_tag(surrounding_tag, surrounding_tag_html, *args) do
+          buffer << content_tag_with_block(surrounding_tag, surrounding_tag_html, *args) do
             render_block_with_around_blocks(name_or_container, *args, &block)
           end
           buffer << render_after_blocks(name_or_container, *args)
@@ -277,91 +271,6 @@ module Blocks
       render(name_or_container, *args, &block)
     end
 
-    # Queue a block for later rendering, such as within a template.
-    #   <%= Blocks::Base.new(self).render_template("shared/wizard") do |blocks| %>
-    #     <% blocks.queue :step1 %>
-    #     <% blocks.queue :step2 do %>
-    #       My overridden Step 2 |
-    #     <% end %>
-    #     <% blocks.queue :step3 %>
-    #     <% blocks.queue do %>
-    #       | Anonymous Step 4
-    #     <% end %>
-    #   <% end %>
-    #
-    #   <!-- In /app/views/shared/wizard -->
-    #   <% blocks.define :step1 do %>
-    #     Step 1 |
-    #   <% end %>
-    #
-    #   <% blocks.define :step2 do %>
-    #     Step 2 |
-    #   <% end %>
-    #
-    #   <% blocks.define :step3 do %>
-    #     Step 3
-    #   <% end %>
-    #
-    #   <% blocks.queued_blocks.each do |block| %>
-    #     <%= blocks.render block %>
-    #   <% end %>
-    #
-    #   <!-- Will render: Step 1 | My overridden Step 2 | Step 3 | Anonymous Step 4-->
-    # Options:
-    # [+*args+]
-    #   The options to pass in when this block is rendered. These will override any options provided to the actual block
-    #   definition. Any or all of these options may be overriden by whoever calls "blocks.render" on this block.
-    #   Usually the first of these args will be the name of the block being queued (either a string or a symbol)
-    # [+block+]
-    #   The optional block definition to render when the queued block is rendered
-    def queue(*args, &block)
-      self.queued_blocks << self.define_block_container(*args, &block)
-      nil
-    end
-
-    # Render a partial, treating it as a template, and any code in the block argument will impact how the template renders
-    #   <%= Blocks::Base.new(self).render_template("shared/wizard") do |blocks| %>
-    #     <% blocks.queue :step1 %>
-    #     <% blocks.queue :step2 do %>
-    #       My overridden Step 2 |
-    #     <% end %>
-    #     <% blocks.queue :step3 %>
-    #     <% blocks.queue do %>
-    #       | Anonymous Step 4
-    #     <% end %>
-    #   <% end %>
-    #
-    #   <!-- In /app/views/shared/wizard -->
-    #   <% blocks.define :step1 do %>
-    #     Step 1 |
-    #   <% end %>
-    #
-    #   <% blocks.define :step2 do %>
-    #     Step 2 |
-    #   <% end %>
-    #
-    #   <% blocks.define :step3 do %>
-    #     Step 3
-    #   <% end %>
-    #
-    #   <% blocks.queued_blocks.each do |block| %>
-    #     <%= blocks.render block %>
-    #   <% end %>
-    #
-    #   <!-- Will render: Step 1 | My overridden Step 2 | Step 3 | Anonymous Step 4-->
-    # Options:
-    # [+partial+]
-    #   The partial to render as a template
-    # [+block+]
-    #   An optional block with code that affects how the template renders
-    def render_template(partial, &block)
-      render_options = global_options.clone
-      render_options[self.variable] = self
-      render_options[:captured_block] = view.capture(self, &block) if block_given?
-
-      view.render partial, render_options
-    end
-
     # Add a block to render before another block. This before block will be put into an array so that multiple
     #  before blocks may be queued. They will render in the order in which they are declared when the
     #  "blocks#render" method is called. Any options specified to the before block will override any options
@@ -396,7 +305,7 @@ module Blocks
     # [+block+]
     #   The block of code to render before another block
     def before(name, options={}, &block)
-      self.queue_block_container("before_#{name.to_s}", options, &block)
+      self.add_block_container_to_list("before_#{name.to_s}", options, &block)
       nil
     end
     alias prepend before
@@ -435,7 +344,7 @@ module Blocks
     # [+block+]
     #   The block of code to render after another block
     def after(name, options={}, &block)
-      self.queue_block_container("after_#{name.to_s}", options, &block)
+      self.add_block_container_to_list("after_#{name.to_s}", options, &block)
       nil
     end
     alias append after
@@ -482,43 +391,19 @@ module Blocks
     # [+block+]
     #   The block of code to render after another block
     def around(name, options={}, &block)
-      self.queue_block_container("around_#{name.to_s}", options, &block)
+      self.add_block_container_to_list("around_#{name.to_s}", options, &block)
       nil
     end
 
     protected
 
-    # If a method is missing, we'll assume the user is starting a new block group by that missing method name
-    def method_missing(m, *args, &block)
-      options = args.extract_options!
-
-      # If the specified block group has already been defined, it is simply returned here for iteration.
-      #  It will consist of all the blocks used in this block group that have yet to be rendered,
-      #   as the call for their use occurred before the template was rendered (where their definitions likely occurred)
-      return self.block_groups[m] unless self.block_groups[m].nil?
-
-      # Allows for nested block groups, store the current block positions array and start a new one
-      original_queued_blocks = self.queued_blocks
-      self.queued_blocks = []
-      self.block_groups[m] = self.queued_blocks
-
-      # Capture the contents of the block group (this will only capture block definitions and block renders; it will ignore anything else)
-      view.capture(global_options.merge(options), &block) if block_given?
-
-      # restore the original block positions array
-      self.queued_blocks = original_queued_blocks
-      nil
-    end
-
     def initialize(view, options={})
       self.template_folder = options[:template_folder] ? options.delete(:template_folder) : Blocks.template_folder
       self.variable = (options[:variable] ? options.delete(:variable) : :blocks).to_sym
       self.view = view
       self.global_options = options
-      self.queued_blocks = []
       self.blocks = {}
       self.anonymous_block_number = 0
-      self.block_groups = {}
       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)
     end
@@ -639,8 +524,8 @@ module Blocks
     end
 
     # Build a Blocks::Container object and add it to an array of containers matching it's block name
-    #  (used only for queuing a collection of before and after blocks for a particular block name)
-    def queue_block_container(*args, &block)
+    #  (used only for queuing a collection of before, after, and around blocks for a particular block name)
+    def add_block_container_to_list(*args, &block)
       block_container = self.build_block_container(*args, &block)
       if blocks[block_container.name].nil?
         blocks[block_container.name] = [block_container]
@@ -657,7 +542,7 @@ module Blocks
       block_container
     end
 
-    def content_tag(tag, tag_html, *args, &block)
+    def content_tag_with_block(tag, tag_html, *args, &block)
       if tag
         view.content_tag(tag, block.call, call_each_hash_value_with_params(tag_html, *args))
       else

data/spec/blocks/base_spec.rb

@@ -90,98 +90,6 @@ describe Blocks::Base do
     end
   end
 
-  describe "queue method" do
-    it "should store all queued blocks in the queued_blocks array" do
-      @builder.queued_blocks.should be_empty
-      @builder.queue :test_block
-      @builder.queued_blocks.length.should eql 1
-      @builder.queued_blocks.map(&:name).first.should eql(:test_block)
-    end
-
-    it "should convert a string block name to a symbol" do
-      @builder.queue "test_block"
-      @builder.queued_blocks.map(&:name).first.should eql(:test_block)
-    end
-
-    it "should queue blocks as Blocks::Container objects" do
-      @builder.queue :test_block, :a => 1, :b => 2, :c => 3
-      container = @builder.queued_blocks.first
-      container.should be_a(Blocks::Container)
-      container.name.should eql(:test_block)
-      container.options.should eql(:a => 1, :b => 2, :c => 3)
-    end
-
-    it "should not require a name for the block being queued" do
-      @builder.queue
-      @builder.queue
-      @builder.queued_blocks.length.should eql 2
-      @builder.queued_blocks.map(&:name).first.should eql(:block_1)
-      @builder.queued_blocks.map(&:name).second.should eql(:block_2)
-    end
-
-    it "should anonymously define the name of a block if not specified" do
-      @builder.queue
-      @builder.queue :my_block
-      @builder.queue
-      @builder.queued_blocks.map(&:name).first.should eql(:block_1)
-      @builder.queued_blocks.map(&:name).second.should eql(:my_block)
-      @builder.queued_blocks.map(&:name).third.should eql(:block_2)
-    end
-
-    it "should store queued blocks in the order in which they are queued" do
-      @builder.queue :block1
-      @builder.queue :block3
-      @builder.queue :block2
-      @builder.queued_blocks.map(&:name).first.should eql(:block1)
-      @builder.queued_blocks.map(&:name).second.should eql(:block3)
-      @builder.queued_blocks.map(&:name).third.should eql(:block2)
-    end
-
-    it "should allow a definition to be provided for a queued block" do
-      block = Proc.new do |options| end
-      @builder.queue :test_block, &block
-      container = @builder.queued_blocks.first
-      container.block.should eql block
-    end
-  end
-
-  describe "render_template method" do
-    it "should attempt to render a partial specified as the :template parameter" do
-      view = mock()
-      builder = Blocks::Base.new(view)
-      view.expects(:render).with{ |template, options| template == "my_template"}
-      builder.render_template("my_template")
-    end
-
-    it "should set all of the global options as local variables to the partial it renders" do
-      view = mock()
-      builder = Blocks::Base.new(view)
-      view.expects(:render).with { |template, options| template == 'some_template' && options[:blocks] == builder }
-      builder.render_template("some_template")
-    end
-
-    it "should capture the data of a block if a block has been specified" do
-      block = Proc.new { |options| "my captured block" }
-      builder = Blocks::Base.new(@view)
-      @view.expects(:render).with { |tempate, options| options[:captured_block] == "my captured block" }
-      builder.render_template("template", &block)
-    end
-
-    it "should by default add a variable to the partial called 'blocks' as a pointer to the Blocks::Base instance" do
-      view = mock()
-      builder = Blocks::Base.new(view)
-      view.expects(:render).with { |template, options| options[:blocks] == builder }
-      builder.render_template("some_template")
-    end
-
-    it "should allow the user to override the local variable passed to the partial as a pointer to the Blocks::Base instance" do
-      view = mock()
-      builder = Blocks::Base.new(view, :variable => "my_variable")
-      view.expects(:render).with { |template, options| options[:blocks].should be_nil }
-      builder.render_template("some_template")
-    end
-  end
-
   describe "before method" do
     it "should be aliased with prepend" do
       block = Proc.new { |options| }
@@ -406,13 +314,12 @@ describe Blocks::Base do
       @builder.render :some_block, :value1 => 1, :value2 => 2, &block
     end
 
-    it "should override hash options for a block by merging the runtime options the define default options into the queue level options into the global options" do
+    it "should override hash options for a block by merging the runtime options into the define default options into the queue level options into the global options" do
       block = Proc.new {|options|}
       @builder.global_options.merge!(:param1 => "global level", :param2 => "global level", :param3 => "global level", :param4 => "global level")
-      @builder.queue(:my_before_block, :param1 => "queue level", :param2 => "queue level")
+      block_container = @builder.send(:define_block_container, :my_before_block, :param1 => "queue level", :param2 => "queue level")
       @builder.define(:my_before_block, :param1 => "define level", :param2 => "define level", :param3 => "define level", &block)
-      block_container = @builder.queued_blocks.first
-      @view.expects(:capture).with(:param4 => 'global level', :param1 => 'use level', :param2 => 'queue level', :param3 => 'define level')
+      @view.expects(:capture).with(:param1 => 'use level', :param2 => 'queue level', :param3 => 'define level', :param4 => 'global level')
       @builder.render block_container, :param1 => "use level"
     end
 
@@ -587,30 +494,4 @@ describe Blocks::Base do
       @builder.render :my_after_block, :param1 => "top level"
     end
   end
-
-  describe "method_missing method" do
-    it "should start a new block group if a method is missing" do
-      @builder.some_method
-      queued_blocks = @builder.block_groups[:some_method]
-      queued_blocks.should eql []
-    end
-
-    it "should add items to a queue when a new block group is started" do
-      @builder.some_method do
-        @builder.queue :myblock1
-        @builder.queue :myblock2
-      end
-      @builder.some_method2 do
-        @builder.queue :myblock3
-      end
-      queued_blocks = @builder.block_groups[:some_method]
-      queued_blocks.length.should eql 2
-      queued_blocks.first.name.should eql :myblock1
-      queued_blocks.second.name.should eql :myblock2
-      queued_blocks = @builder.block_groups[:some_method2]
-      queued_blocks.length.should eql 1
-      queued_blocks.first.name.should eql :myblock3
-      @builder.queued_blocks.should eql []
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'ruby-debug'
 
 require 'blocks' # and any other gems you need
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blocks
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-05 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: 709572836072334068
+      hash: 1012298278410896826
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: