wrap_it 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05664633d5a6ca78537354a368c2240cef45996e
-  data.tar.gz: 1872c2bcbf2038d3174ce42709ccff0040549789
+  metadata.gz: 3759c791d02ed6b869c3cdf07885e5d86a7874fd
+  data.tar.gz: f7e262fcbf4959d240e4f28e5b548d300419cf4d
 SHA512:
-  metadata.gz: f041b82c008a526fe1aff1ce404da32c586ae4c7f2a79bdcc11cf0be1f819db9a2e08777729a9bd5412e287a719300de0fcbe7aecd89155cea91ee266b640d3f
-  data.tar.gz: 7b46861af7625ff2e10b1f768bd07635ba25e6dac5a33ee98aadb604dba81c81656a1127bd8ba7903011dd546e0a4aa57dcd86f99911f7ff4dc4e77c7c34a84b
+  metadata.gz: 66c55ca42c817b786051694bfa5f0eb4b8efa8b327a318665cde8534dc4aa3d4e8ee3da8145bbec4afbeae7c392b16cd4f6e41ebe8bc342ef44b954672e59f19
+  data.tar.gz: b1c067ff3b920291ef2dc1bc5d5dcf95231a5dca556c59c78287d145d96935df53285ec77ef45a552745b27721094249396ab6bf5a211c55f59ef9e05b0392f7

data/README.md

@@ -180,6 +180,14 @@ If block given, it will be called each time enum changes its value in context of
 
 ### Instance methods
 
+#### wrap(*args, &block)
+
+Wraps element with another.
+
+You can provide wrapper directly or specify wrapper class as first argument. In this case wrapper will created with specified set of arguments and options. If wrapper class ommited, WrapIt::Base will be used.
+
+If block present, it will be called when wrapper will rendered.
+
 #### html_class
 
 Returns array of html classes
@@ -236,6 +244,14 @@ element.html_class? { |x| x == 'a' } #=> true
 
 Determines whether element doesn't contains class, satisfied by conditions, specified in method arguments. See `html_class?`.
 
+#### set_html_data(name, value)
+
+Sets HTML data attribute named `name` to `value`.
+
+#### remove_html_data(name)
+
+Removes HTML data attribute named `name`.
+
 ## WrapIt::Container
 
 ### DSL methods
@@ -253,6 +269,12 @@ Creates your own DSL method to create child items. In arguments, you should spec
 
 # Changes
 
+`0.1.2`
+* fixed: double callbacks inclusion issue
+* added: Base#wrap
+* added: HTML data attribute processing
+* test improvements
+
 `0.1.1`
 * WrapIt.helpers fails if no helper registered
 

data/lib/wrap_it/base.rb

@@ -2,6 +2,20 @@ module WrapIt
   #
   # Base class for all HTML helper classes
   #
+  # @example Prevent user from changing element tag
+  #   class Helper < WrapIt::Base
+  #     after_initialize { @tag = 'table' }
+  #   end
+  # @example Including some simple HTML into content
+  #   class Helper < WrapIt::Base
+  #     after_initialize do
+  #       @icon = optioins.delete(:icon)
+  #     end
+  #     after_capture do
+  #       unless @icon.nil?
+  #       @content = html_safe("<i class=\"#{@icon}\"></i>") + @content
+  #     end
+  #   end
   # @author Alexey Ovchinnikov <alexiss@cybernetlab.ru>
   #
   class Base
@@ -11,6 +25,7 @@ module WrapIt
     callback :initialize, :capture, :render
 
     include HTMLClass
+    include HTMLData
     include Switches
     include Enums
     include Renderer
@@ -38,25 +53,35 @@ module WrapIt
       self.class.get_derived(:@omit_content)
     end
 
+    #
+    # Renders element to template
+    #
+    # @override render([content, ...])
+    # @param  content [String] additional content that will be appended
+    #                          to element content
+    # @yield [element] Runs block after capturing element content and before
+    #                  rendering it. Returned value appended to content.
+    # @yieldparam element [Base] rendering element.
+    # @yieldreturn [String, nil] content to append to HTML
+    #
+    # @return [String] rendered HTML for element
     def render(*args, &render_block)
       # return cached copy if it available
       return @content unless @content.nil?
       @content = empty_html
 
-      # capture content from block
       do_capture
+
       # add to content string args and block result if its present
       args.flatten.each { |a| @content << a if a.is_a? String }
-      block_given? && @content << instance_exec(self, &render_block)
-
-      # cleanup options from empty values
-      @options.select! { |k, v| !v.nil? && !v.empty? }
-      # render element
-      run_callbacks :render do
-        @content = content_tag(@tag, @content, @options)
+      if block_given?
+        result = instance_exec(self, &render_block) || empty_html
+        result.is_a?(String) && @content << result
       end
 
-#      @content = @wrapper.render(@content.html_safe) if @wrapper.is_a?(Base)
+      do_render
+      do_wrap
+
       if @template.output_buffer.nil?
         # when render called from code, just return content as a String
         @content
@@ -67,6 +92,38 @@ module WrapIt
       end
     end
 
+    #
+    # Wraps element with another.
+    #
+    # You can provide wrapper directly or specify wrapper class as first
+    # argument. In this case wrapper will created with specified set of
+    # arguments and options. If wrapper class ommited, WrapIt::Base will
+    # be used.
+    #
+    # If block present, it will be called when wrapper will rendered.
+    #
+    # @override wrap(wrapper)
+    # @param  wrapper [Base] wrapper instance.
+    #
+    # @override wrap(wrapper_class, [arg, ...], options = {})
+    # @param  wrapper_class [Class] WrapIt::Base subclass for wrapper.
+    # @param  arg [String, Symbol] wrapper creation arguments.
+    # @param  options [Hash] wrapper creation options.
+    #
+    # @override wrap([arg, ...], options = {})
+    # @param  arg [String, Symbol] wrapper creation arguments.
+    # @param  options [Hash] wrapper creation options.
+    #
+    # @return [void]
+    def wrap(*args, &block)
+      if args.first.is_a?(Base)
+        @wrapper = args.shift
+      else
+        wrapper_class = args.first.is_a?(Class) ? args.shift : Base
+        @wrapper = wrapper_class.new(@template, *args, &block)
+      end
+    end
+
     protected
 
     #
@@ -96,6 +153,8 @@ module WrapIt
       @options = hash
     end
 
+    private
+
     def do_capture
       run_callbacks :capture do
         @content ||= empty_html
@@ -104,5 +163,17 @@ module WrapIt
         end
       end
     end
+
+    def do_render
+      # cleanup options from empty values
+      @options.select! { |k, v| !v.nil? && !v.empty? }
+      run_callbacks :render do
+        @content = content_tag(tag, @content, options)
+      end
+    end
+
+    def do_wrap
+      @wrapper.is_a?(Base) && @content = @wrapper.render(html_safe(@content))
+    end
   end
 end

data/lib/wrap_it/derived_attributes.rb

@@ -16,7 +16,7 @@ module WrapIt
       def get_derived(name)
         return instance_variable_get(name) if instance_variable_defined?(name)
         ancestors.each do |ancestor|
-          break if ancestor == Base
+          break if ancestor == Object
           next unless ancestor.instance_variable_defined?(name)
           return ancestor.instance_variable_get(name)
         end
@@ -25,8 +25,11 @@ module WrapIt
 
       def collect_derived(name, initial = [], method = :concat)
         result = initial
+        # if instance_variable_defined?(name)
+        #  result = result.send(method, instance_variable_get(name))
+        # end
         ancestors.each do |ancestor|
-          break if ancestor == Base
+          break if ancestor == Object
           next unless ancestor.instance_variable_defined?(name)
           result = result.send(method, ancestor.instance_variable_get(name))
         end

data/lib/wrap_it/enums.rb

@@ -12,7 +12,8 @@ module WrapIt
       )
       extend DerivedAttributes
       base.extend ClassMethods
-      base.after_initialize :enums_init
+      # include :after_initialize callback only once
+      base.after_initialize :enums_init if base == Base
     end
 
     private

data/lib/wrap_it/no_rails.rb

@@ -32,6 +32,8 @@ module WrapIt
   # Non rails render implementation
   #
   module Renderer
+    protected
+
     def empty_html
       ''
     end

data/lib/wrap_it/rails.rb

@@ -5,6 +5,8 @@ module WrapIt
   # @author Alexey Ovchinnikov <alexiss@cybernetlab.ru>
   #
   module Renderer
+    protected
+
     def empty_html
       ''.html_safe
     end

data/lib/wrap_it/switches.rb

@@ -12,7 +12,8 @@ module WrapIt
       )
       extend DerivedAttributes
       base.extend ClassMethods
-      base.after_initialize :switches_init
+      # include :after_initialize callback only once
+      base.after_initialize :switches_init if base == Base
     end
 
     private
@@ -60,7 +61,7 @@ module WrapIt
         options.symbolize_keys!
         name = name.to_sym
         options.merge!(block: block, name: name)
-        names = [name] + [[options[:aliases]] || []].flatten
+        names = [name] + [[options[:aliases]] || []].flatten.compact
         var = "@#{name}".to_sym
         define_method("#{name}?") { instance_variable_get(var) == true }
         define_method("#{name}=") do |value|

data/lib/wrap_it/version.rb

@@ -1,4 +1,4 @@
 #
 module WrapIt
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/wrap_it.rb

@@ -64,6 +64,7 @@ require 'wrap_it/derived_attributes'
 require 'wrap_it/callbacks'
 require 'wrap_it/arguments_array'
 require 'wrap_it/html_class'
+require 'wrap_it/html_data'
 require 'wrap_it/switches'
 require 'wrap_it/enums'
 if defined? Rails

data/spec/lib/base_spec.rb

@@ -10,6 +10,10 @@ describe WrapIt::Base do
     expect(successor.tag).to eq 'a'
   end
 
+  it 'gets tag name from options' do
+    expect(successor(tag: 'p').tag).to eq 'p'
+  end
+
   it 'extends @arguments with ArgumentsArray module' do
     expect(
       successor.instance_variable_get(:@arguments)

data/spec/rails/base_spec.rb

@@ -1,20 +1,67 @@
 require 'spec_helper'
 
-=begin
-class UsersHelperTest < ActionView::TestCase
+describe WrapIt::Base do
   it 'includes framework-specific methods' do
     methods = successor_class.protected_instance_methods(true)
     expect(methods).to include :concat, :capture, :output_buffer
   end
 
   it 'renders base as div' do
-    render '<%= successor %>'
+    render '<%= successor_helper %>'
     expect(rendered).to have_tag 'div', count: 1
   end
 
-  it 'captures block content' do
-    render '<%= successor do %>Some text<% end %>'
-    expect(rendered).to have_tag 'div', count: 1, text: /Some text/
+  describe 'self.omit_content' do
+    it 'captures block content' do
+      render '<%= successor_helper do %>Some text<% end %>'
+      expect(rendered).to have_tag 'div', count: 1, text: /Some text/
+    end
+
+    it 'omits block content with omit_content' do
+      successor_class.class_eval { omit_content }
+      render '<%= successor_helper do %>Some text<% end %>'
+      expect(rendered).to have_tag 'div', count: 1, text: ''
+    end
+  end
+
+  describe '#render' do
+    it 'adds content from arguments' do
+      expect(
+        successor.render('text', :and, ' from arguments')
+      ).to have_tag 'div', text: 'text from arguments'
+    end
+
+    it 'adds content from block' do
+      expect(successor.render { 'text' }).to have_tag 'div', text: 'text'
+    end
+  end
+
+  describe '#wrap' do
+    it 'wraps with WrapIt::Base by default' do
+      render '<%= successor_helper(tag: :p) { |s| s.wrap } %>'
+      expect(rendered).to have_tag 'div > p'
+    end
+
+    it 'wraps with WrapIt::Base and creating options' do
+      render '<%= successor_helper(tag: :p) { |s| s.wrap tag: :nav } %>'
+      expect(rendered).to have_tag 'nav > p'
+    end
+
+    it 'wraps with class and creating options' do
+      render <<-EOL
+        <% w = Class.new(WrapIt::Base) { switch :sw, html_class: 'act' } %>
+        <%= successor_helper(tag: :p) { |s| s.wrap w, :sw, tag: :nav } %>'
+      EOL
+      expect(rendered).to have_tag 'nav.act > p'
+    end
+
+    it 'wraps with block' do
+      render <<-EOL
+        <%= successor_helper(tag: :p) { |s| s.wrap do
+          |w| w.add_html_class 'nav'
+        end } %>'
+      EOL
+      expect(rendered).to have_tag 'div.nav > p'
+    end
   end
 end
-=end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wrap_it
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alexey Ovchinnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2014-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,6 +135,7 @@ files:
 - spec/support/example_groups/rails_example_group.rb
 - spec/support/example_groups/wrap_it_example_group.rb
 - wrap_it-0.1.0.gem
+- wrap_it-0.1.1.gem
 - wrap_it.gemspec
 homepage: https://github.com/cybernetlab/wrap_it
 licenses: