hensel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08c2d34b1ceac0afa538c237967ef7ce7fd6e9d8
-  data.tar.gz: 710a9707597f29eddc79e054bf4ce83b91277f9a
+  metadata.gz: acc9a789f685382612bac321c291e9cfe1d5b42d
+  data.tar.gz: 3e0e9e435e490ded71fc8d64ed87809b3d95d6e7
 SHA512:
-  metadata.gz: d3bc09b7389bdefdc9f524bdd0f790bbde158629d057299f00991c226ea03fb2fc1e1040f4fc7701f22c1e252a4f3aa7ea7204fdf1027e3ebcfa24fe360d688b
-  data.tar.gz: ced520e15fd2121ae7bb279d2cad07bb4970762ea1cc8ddf2171ed4601cdcc393444c6c08ec013d18d8b9eec9fbb19d40b4e2a6f1a90d174d761b43aee1ab365
+  metadata.gz: b007e8ef81416d5e682c50d848f71d87d24cefda9d0b4ca06998d8d9297acf6cb6765f9e5948796b101ec5431f54c2b8b8f51b3fdd23487c72e8e299f46eb143
+  data.tar.gz: 3077a490553b985be304c173a9a31552a564a5c457c0d9ac34ee340fc47f38c4f5e982d44589c8e2c9cbe55381d68fc68a29ace895b74d16cd4201312d809a3e

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hensel.gemspec
 gemspec
+
+group :test do
+  gem 'rspec-html-matchers'
+  gem 'rack-test', require: 'rack/test'
+  gem 'sinatra'
+end

data/README.md

@@ -47,6 +47,7 @@ Hensel.configure do |config|
   config.attr_wrapper   = "'"
   config.whitespace     = "  "
   config.parent_element = :ul
+  config.before_load    = nil
 end
 ```
 
@@ -189,6 +190,18 @@ It will be somthing below.
 
 **If `parent_element` is set to a name string, it will be used as a name of the parent element.**
 
+**If `before_load` is set to Proc, it will be evaluated within the context of `Hensel::Builder`.**
+It will be something below.
+
+```ruby
+Hensel.configuration.before_load = proc { add("Home", "/") }
+builder = Hensel::Builder.new
+home = builder.items.first
+home.text #=> "Home"
+home.url #=> "/"
+```
+
+
 ### Builder
 
 #### `add(text, url, **options) -> Hensel::Builder::Item`
@@ -278,9 +291,15 @@ end
 
 ### Helpers
 
-The helper is prepared for use in Sinatra and Padrino.
+The helper can be used in your web application.
 
-### with Sinatra
+#### Basic
+
+```ruby
+include Hensel::Helpers
+```
+
+#### with Sinatra
 
 ```ruby
 class Sample < Sinatra::Base
@@ -300,7 +319,7 @@ class Sample < Sinatra::Base
 end
 ```
 
-### with Padrino
+#### with Padrino
 
 ```ruby
 # config/boot.rb
@@ -323,6 +342,31 @@ class Sample < Padrino::Application
 end
 ```
 
+### Sinatra/Padrino Helpers
+
+If you want to customize more, you should use SinatraHelpers.
+It can be used both in Sinatra and in Padrino.
+
+```ruby
+class Sample < Sinatra::Base
+  helpers Hensel::Helpers::SinatraHelpers
+  set :hensel, builder_options: { class: "this-is-parent-class-name" },
+               renderer: proc { node(:custom_element_name){ item.text }}
+
+  configure do
+    Hensel.configure do |config|
+      config.attr_wrapper = '"'
+      config.whitespace   = '  '
+    end
+  end
+
+  get "/" do
+    breadcrumbs.add("home", "/")
+    breadcrumbs.render
+  end
+end
+```
+
 ## TODO
 
 * Support Rails

data/hensel.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "nyan-cat-formatter"
-  spec.add_development_dependency "rspec-html-matchers"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-shell"
   spec.add_development_dependency "guard-rspec"

data/lib/hensel/builder/node.rb

@@ -31,9 +31,7 @@ module Hensel
           begin
             return self if self.instance_of?(Hensel::Builder::Item)
             ancestor = parent
-            while ancestor.instance_of?(Hensel::Builder::Node)
-              ancestor = ancestor.parent
-            end
+            ancestor = ancestor.parent while ancestor.instance_of?(Hensel::Builder::Node)
             ancestor
           end
       end

data/lib/hensel/builder.rb

@@ -11,6 +11,7 @@ module Hensel
     def initialize(**options)
       @items   = []
       @options = options
+      instance_eval(&Hensel.configuration.before_load) if Hensel.configuration.before_load
     end
 
     # Adds an item to items
@@ -53,8 +54,13 @@ module Hensel
       !!@processed
     end
 
+    def item_filters
+      @item_filters ||= []
+    end
+
     private
 
+    # @!visibility private
     def map_items
       items_length = items.length.pred
       items.map.with_index do |item, index|
@@ -70,10 +76,6 @@ module Hensel
       end
     end
 
-    def item_filters
-      @item_filters ||= []
-    end
-
     # @!visibility private
     def process!
       configuration = Hensel.configuration

data/lib/hensel/configuration.rb

@@ -13,7 +13,7 @@ module Hensel
     attr_boolean_accessor :indentation
     attr_boolean_accessor :last_item_link
 
-    attr_accessor :attr_wrapper, :whitespace, :parent_element, :richsnippet
+    attr_accessor :attr_wrapper, :whitespace, :parent_element, :richsnippet, :before_load
 
     def initialize
       @bootstrap      = false
@@ -24,6 +24,7 @@ module Hensel
       @attr_wrapper   = "'"
       @whitespace     = "  "
       @parent_element = :ul 
+      @before_load    = nil
     end
 
     def [](key)

data/lib/hensel/helpers/sinatra_helpers.rb

@@ -0,0 +1,31 @@
+module Hensel
+  module Helpers
+    module SinatraHelpers
+      def __hensel
+        @__hensel ||= settings.respond_to?(:hensel) ? settings.hensel : {}
+      end
+
+      def breadcrumbs
+        @__breadcrumbs ||=
+          begin
+            builder = Hensel::Builder.new(__hensel[:builder_options] || {})
+            renderer = __hensel[:renderer]
+            if renderer && renderer.instance_of?(Proc)
+              builder.singleton_class.send(:define_method, :render) do |&block|
+                if block.instance_of?(Proc)
+                  super(&block)
+                else
+                  concatenated_items =
+                    map_items do |item|
+                      renderer.arity.zero? ? item.instance_eval(&renderer) : renderer.call(item)
+                    end.join(Hensel.configuration.indentation? ? "\n" : "")
+                  content_tag(Hensel.configuration.parent_element, concatenated_items, options)
+                end
+              end
+            end
+            builder
+          end
+      end
+    end
+  end
+end

data/lib/hensel/helpers.rb

@@ -3,7 +3,7 @@ require 'hensel/builder'
 module Hensel
   module Helpers
     def breadcrumbs
-      @breadcrumbs ||= Builder.new
+      @__breadcrumbs ||= Builder.new
     end
   end
 end

data/lib/hensel/sinatra.rb

@@ -0,0 +1,2 @@
+require 'hensel'
+require 'hensel/helpers/sinatra_helpers'

data/lib/hensel/version.rb

@@ -1,3 +1,3 @@
 module Hensel
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/configuration_spec.rb

@@ -1,8 +1,9 @@
 require 'spec_helper'
 
 describe Hensel::Configuration do
+  let(:configuration){ Hensel::Configuration.new }
+  let(:variables){ configuration.instance_variables.map{|v| v[1..-1] } }
   describe ".attr_boolean_accessor" do
-    let(:configuration){ Hensel::Configuration.new }
     it "can define an accessor and boolean methods" do
       expect(configuration.respond_to?(:sample)).to be_false
       Hensel::Configuration.attr_boolean_accessor :sample
@@ -11,8 +12,31 @@ describe Hensel::Configuration do
   end
 
   describe "#[]" do
+    it "can get value of instance variables" do
+      variables.each.with_index do |variable, index|
+        configuration.send("#{variable}=", index)
+        expect(configuration[variable]).to eq(index)
+      end
+    end
   end
 
   describe "#[]=" do
+    it "can set value to instance variables" do
+      variables.each.with_index do |variable, index|
+        configuration.send(:[]=, variable, index)
+        expect(configuration[variable]).to eq(index)
+      end
+    end
+  end
+
+  describe "before_load" do
+    before do
+      Hensel.configuration.before_load = proc{ add("Home", "/") }
+    end
+
+    it "should be evaluated within the context of `Hensel::Builder`" do
+      builder = Hensel::Builder.new
+      expect(builder.items.length).to eq(1)
+    end
   end
 end

data/spec/sinatra_helpers_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require File.expand_path("../../lib/hensel/sinatra", __FILE__)
+
+describe Hensel::Helpers::SinatraHelpers do
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+
+  def mock_app(&block)
+    @app = Sinatra::Application
+    block_given? ? @app.instance_eval(&block) : @app
+  end
+
+  describe "basic usage" do
+    before do
+      mock_app do
+        helpers Hensel::Helpers::SinatraHelpers
+        set :hensel, builder_options: { class: 'custom-breadcrumbs' },
+                     renderer: proc { node(:custom){ item.text }}
+
+        configure do
+          Hensel.configure do |config|
+            config.before_load = proc { add "Home", "/" }
+            config.indentation = false
+          end
+        end
+
+        get '/hey' do
+          breadcrumbs.add("Hey", "/hey")
+          breadcrumbs.render
+        end
+
+        get '/ho' do
+          breadcrumbs.add("Ho", "/ho")
+          breadcrumbs.render do
+            node(:awesome){ item.text }
+          end
+        end
+      end
+    end
+
+    it "can change the settings of hensel using `set` method" do
+      get '/hey'
+      expect(last_response.body).to have_tag(:ul, class: "custom-breadcrumb") do
+        with_tag(:custom, text: "Home")
+        with_tag(:custom, text: "Hey")
+      end
+    end
+
+    it "should respect it when render is passed block as an argument" do
+      get '/ho'
+      expect(last_response.body).to have_tag(:ul, class: "custom-breadcrumb") do
+        with_tag(:awesome, text: "Home")
+        with_tag(:awesome, text: "Ho")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 require File.expand_path('../../lib/hensel', __FILE__)
-require 'rspec-html-matchers'
+require 'bundler' unless defined?(Bunlder)
+Bundler.require(:test)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hensel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - namusyaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-html-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -144,13 +130,16 @@ files:
 - lib/hensel/configuration.rb
 - lib/hensel/filters.rb
 - lib/hensel/helpers.rb
+- lib/hensel/helpers/sinatra_helpers.rb
 - lib/hensel/helpers/tag_helpers.rb
+- lib/hensel/sinatra.rb
 - lib/hensel/version.rb
 - spec/builder_spec.rb
 - spec/configuration_spec.rb
 - spec/helpers_spec.rb
 - spec/item_spec.rb
 - spec/node_spec.rb
+- spec/sinatra_helpers_spec.rb
 - spec/spec_helper.rb
 - spec/tag_helpers_spec.rb
 homepage: https://github.com/namusyaka/hensel
@@ -183,6 +172,7 @@ test_files:
 - spec/helpers_spec.rb
 - spec/item_spec.rb
 - spec/node_spec.rb
+- spec/sinatra_helpers_spec.rb
 - spec/spec_helper.rb
 - spec/tag_helpers_spec.rb
 has_rdoc: