hensel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08c2d34b1ceac0afa538c237967ef7ce7fd6e9d8
+  data.tar.gz: 710a9707597f29eddc79e054bf4ce83b91277f9a
+SHA512:
+  metadata.gz: d3bc09b7389bdefdc9f524bdd0f790bbde158629d057299f00991c226ea03fb2fc1e1040f4fc7701f22c1e252a4f3aa7ea7204fdf1027e3ebcfa24fe360d688b
+  data.tar.gz: ced520e15fd2121ae7bb279d2cad07bb4970762ea1cc8ddf2171ed4601cdcc393444c6c08ec013d18d8b9eec9fbb19d40b4e2a6f1a90d174d761b43aee1ab365

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,20 @@
+lang: ruby
+before_install: gem install bundler --pre
+install:
+  - gem update --system
+  - bundle update
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - jruby-head
+  - rbx
+notifications:
+  recipients:
+    - namusyaka@gmail.com
+branches:
+  only:
+    - master
+matrix:
+  allow_failures:
+    - rvm: rbx
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hensel.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+guard 'rspec', version: 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})          {|m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
+  watch('spec/spec_helper.rb')       { "spec" }
+end
+
+# Add files and commands to this file, like the example:
+#   watch(%r{file/path}) { `command(s)` }
+#
+guard 'shell' do
+  watch(/(.*).txt/) {|m| `tail #{m[0]}` }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 namusyaka
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,337 @@
+# Hensel
+
+[![Build Status](https://travis-ci.org/namusyaka/hensel.svg)](https://travis-ci.org/namusyaka/hensel)
+  
+Hensel makes it easy to build the breadcrumbs.
+
+Especially, want to recommend for use in Sinatra and Padrino.
+    
+## Installation 
+        
+Add this line to your application's Gemfile:
+
+    gem 'hensel'
+
+And then execute:
+    
+    $ bundle
+    
+Or install it yourself as:
+    
+    $ gem install hensel
+
+## Requirements
+
+* MRI 2.0+
+    
+## Overview
+
+Hensel can be used easily in your web applications, and it has powerful flexibility.
+You can use it as helper and builder.
+In the next section, will explain in detail how to use them.
+
+## Usage
+      
+### Configuration
+      
+```ruby
+require 'hensel'
+    
+Hensel.configure do |config|
+  # Default values
+  config.bootstrap      = false
+  config.escape_html    = true
+  config.indentation    = true
+  config.last_item_link = false
+  config.richsnippet    = :microdata
+  config.attr_wrapper   = "'"
+  config.whitespace     = "  "
+  config.parent_element = :ul
+end
+```
+
+**If `bootstrap` is set to `true`, the parent element of breadcrumbs will contain `breadcrumb` as class attrbiute, and the last item will contain `active` as class attrbiute as well.**
+It will be something like below.
+
+```html
+<ul class='breadcrumb'>
+  <li>
+    <a href='/'>
+      index
+    </a>
+  </li>
+  <li class='active'>
+    current
+  </li>
+</ul>
+```
+
+**If `escape_html` is set to `true`, the text of item and all value of attributes will be escaped.**
+
+**If `indentation` is set to `true`, the breadcrumbs will be indented.**
+
+**If `richsnippet` is set to correct symbol, the breadcrumbs will follow the rules of the rich snippets that have been specified.**
+There is a `:microdata` and `:rdfa`, please specify `nil` if not required type.
+It will be something like below.
+
+```html
+<!-- microdata -->
+<ul>
+  <li itemscope itemtype='http://data-vocabulary.org/Breadcrumb'>
+    <a href='/' itemprop='url'>
+      <span itemprop='title'>
+        index
+      </span>
+    </a>
+  </li>
+  <li itemscope itemtype='http://data-vocabulary.org/Breadcrumb'>
+    <span itemprop='title'>
+      current
+    </span>
+  </li>
+</ul>
+
+<!-- RDFa -->
+<ul xmlns:v='http://rdf.data-vocabulary.org/#'>
+  <li typeof='v:Breadcrumb'>
+    <a href='/' rel='v:url' property="v:title">
+      index
+    </a>
+  </li>
+  <li typeof='v:Breadcrumb'>
+    <span property="v:title">
+      current
+    </span>
+  </li>
+</ul>
+```
+
+*If don't have special reason, you should enable the option.*
+*Microdata and RDFa are supported by [google](https://support.google.com/webmasters/answer/185417?hl=en).*
+
+
+**If `last_item_link` is set to `true`, the link of the last item will contain `a` element as with other elements.**
+It will be something below.
+
+```html
+<!-- If `last_item_link` is set to `true` -->
+<ul class="breadcrumb">
+  <li>
+    <a href="/">
+      index
+    </a>
+  </li>
+  <li>
+    <a href="/foo">
+      foo
+    </a>
+  </li>
+</ul>
+<!-- If `last_item_link` is set to `false` -->
+<ul class="breadcrumb">
+  <li>
+    <a href="/">
+      index
+    </a>
+  </li>
+  <li>
+    <span>
+      foo
+    </span>
+  </li>
+</ul>
+```
+
+
+**If `attr_wrapper` is set to a wrapper string, all attributes will be used it as the attribute wrapper.**
+It will be somthing below.
+
+```html
+<!-- If `attr_wrapper` is set to `'"'` -->
+<ul class="breadcrumb">
+  <li>
+    <a href="/">
+      index
+    </a>
+  </li>
+</ul>
+<!-- If `attr_wrapper` is set to `nil` -->
+<ul class=breadcrumb>
+  <li>
+    <a href=/>
+      index
+    </a>
+  </li>
+</ul>
+```
+
+**If `whitespace` is set to a whitespace string, all indentation will be used it as the indentation space.**
+It will be somthing below.
+
+```html
+<!-- If `whitespace` is set to `" "` -->
+<ul>
+ <li>
+  <a href="/">
+   index
+  </a>
+ </li>
+</ul>
+<!-- If `attr_wrapper` is set to `"    "` -->
+<ul>
+    <li>
+        <a href="/">
+            index
+        </a>
+    </li>
+</ul>
+```
+
+**If `parent_element` is set to a name string, it will be used as a name of the parent element.**
+
+### Builder
+
+#### `add(text, url, **options) -> Hensel::Builder::Item`
+
+Adds a new item to items, and returns a fresh instance of `Hensel::Builder::Item` built by the builder.
+
+```ruby
+builder = Hensel::Builder.new
+item = builder.add("home", "/")
+item.text #=> "home"
+item.url #=> "/"
+```
+
+#### `add(**parameters) -> Hensel::Builder::Item`
+
+```ruby
+builder = Hensel::Builder.new
+item = builder.add(text: "home", url: "/")
+item.text #=> "home"
+item.url #=> "/"
+```
+
+#### `remove(text)`
+
+Removes the item from items.
+
+```ruby
+builder = Hensel::Builder.new
+builder.add(text: "home", url: "/")
+
+builder.items.empty? #=> false
+builder.remove("home")
+builder.items.empty? #=> true
+```
+
+#### `remove{|item| ... }`
+
+```ruby
+builder = Hensel::Builder.new
+builder.add(text: "home", url: "/")
+
+builder.items.empty? #=> false
+builder.remove{|item| item.text == "home" }
+builder.items.empty? #=> true
+```
+
+#### `render -> String`
+
+Renders the breadcrumbs, and returns the html of breadcrumbs rendered by this method.
+
+```ruby
+builder = Hensel::Builder.new
+builder.add(text: "home", url: "/")
+
+builder.render #=> "<ul> ... </ul>"
+```
+
+#### `render{ ... } -> String`
+
+This method is for customize breadcrumbs.
+
+If this method has a parameter, it will be an instance of `Hensel::Builder::Item`.
+
+If this method does not have parameter, the block will be evaluated as an instance of `Hensel::Builder::Item`.
+
+However, if you use `render` with block, a few configuration(`richsnippets`, `last_item_link`) will be ignored.
+
+```ruby
+builder = Hensel::Builder.new
+builder.add(text: "home", url: "/")
+
+builder.render {|item| "<li>#{item.text}</li>" } #=> "<ul><li>home</li></ul>"
+builder.render do
+  if last?
+    node(:li) do
+      node(:span){ item.text }
+    end
+  else
+    node(:li) do
+      node(:a, href: item.url) do
+        node(:span){ item.text }
+      end
+    end
+  end
+end
+```
+
+### Helpers
+
+The helper is prepared for use in Sinatra and Padrino.
+
+### with Sinatra
+
+```ruby
+class Sample < Sinatra::Base
+  helpers Hensel::Helpers
+
+  configure do
+    Hensel.configure do |config|
+      config.attr_wrapper = '"'
+      config.whitespace   = '  '
+    end
+  end
+
+  get "/" do
+    breadcrumbs.add("home", "/")
+    breadcrumbs.render
+  end
+end
+```
+
+### with Padrino
+
+```ruby
+# config/boot.rb
+Padrino.before_load do
+  Hensel.configure do |config|
+    config.attr_wrapper = '"'
+    config.whitespace   = '  '
+  end
+end
+```
+
+```ruby
+class Sample < Padrino::Application
+  helpers Hensel::Helpers
+
+  get :index do
+    breadcrumbs.add("home", ?/)
+    breadcrumbs.render
+  end
+end
+```
+
+## TODO
+
+* Support Rails
+* New syntax for Sinatra and Padrino
+
+## Contributing
+
+1. Fork it ( https://github.com/namusyaka/hensel/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all specs."
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = %w(--format NyanCatFormatter)
+end
+task default: :spec

data/hensel.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hensel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hensel"
+  spec.version       = Hensel::VERSION
+  spec.authors       = ["namusyaka"]
+  spec.email         = ["namusyaka@gmail.com"]
+  spec.summary       = %q{Hensel makes it easy to build the breadcrumbs.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/namusyaka/hensel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  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"
+end

data/lib/hensel/builder/item.rb

@@ -0,0 +1,43 @@
+require 'forwardable'
+require 'hensel/builder/node'
+
+module Hensel
+  class Builder
+    class Item < Node
+      extend Forwardable
+
+      attr_accessor :text, :url, :options
+      attr_accessor :_first, :_last, :renderer
+
+      def_delegators :@options, :[], :[]=
+
+      def initialize(text, url, **options)
+        @text    = h(text)
+        @url     = url
+        @options = options
+      end
+
+      def render
+        if renderer
+          instance_eval(&renderer)
+        else
+          node(:li, **options) do
+            if !Hensel.configuration.last_item_link? && item.last?
+              node(:span){ item.text }
+            else
+              node(:a, href: item.url){ item.text }
+            end
+          end
+        end
+      end
+
+      def first?
+        !!_first
+      end
+
+      def last?
+        !!_last
+      end
+    end
+  end
+end

data/lib/hensel/builder/node.rb

@@ -0,0 +1,53 @@
+require 'hensel/helpers/tag_helpers'
+
+module Hensel
+  class Builder
+    class Node < Struct.new(:name, :attributes, :content, :parent, :indent)
+      include Hensel::Helpers::TagHelpers
+
+      def node(name, content = nil, **attributes, &block)
+        element = Node.new(name, attributes, content, self, child_indent)
+        content =
+          if block_given?
+            result = element.instance_eval(&block)
+            element.children.length.zero? ? result : element.render
+          else
+            content
+          end
+        children << (child = content_tag(name, content, attributes.merge!(indent: child_indent), &block))
+        child
+      end
+
+      def render
+        children.join(Hensel.configuration.indentation? ? "\n" : "")
+      end
+
+      def children
+        @children ||= []
+      end
+
+      def item
+        @item ||=
+          begin
+            return self if self.instance_of?(Hensel::Builder::Item)
+            ancestor = parent
+            while ancestor.instance_of?(Hensel::Builder::Node)
+              ancestor = ancestor.parent
+            end
+            ancestor
+          end
+      end
+
+      private
+
+      def child_indent
+        @child_indent ||= 
+          if Hensel.configuration.indentation?
+            indent ? indent + 1 : 1
+          else
+            0
+          end
+      end
+    end
+  end
+end

data/lib/hensel/builder.rb

@@ -0,0 +1,105 @@
+require 'hensel/builder/item'
+require 'hensel/helpers/tag_helpers'
+require 'hensel/filters'
+
+module Hensel
+  class Builder
+    include Helpers::TagHelpers
+
+    attr_reader :items, :options
+
+    def initialize(**options)
+      @items   = []
+      @options = options
+    end
+
+    # Adds an item to items
+    def add(*arguments)
+      items << (item = Item.new(*parse_arguments(arguments)))
+      item.parent = self
+      item
+    end
+
+    # Removes the item from items
+    # @example without block
+    #   builder = Hensel::Builder.new
+    #   builder.add("Index", "/")
+    #   builder.remove("Index")
+    #
+    # @example with block
+    #   builder = Hensel::Builder.new
+    #   builder.add("Index", "/")
+    #   builder.remove{|item| item.text == "Index" }
+    def remove(text = nil, &block)
+      block_given? ? items.delete_if(&block) : items.delete_if{|item| text == item.text }
+    end
+
+    # Renders the breadcrumb html
+    def render(&block)
+      process! unless processed?
+
+      concatenated_items = map_items do |item|
+        if block_given?
+          block.arity.zero? ? item.instance_eval(&block) : block.call(item)
+        else
+          item.render
+        end
+      end.join(Hensel.configuration.indentation? ? "\n" : "")
+
+      content_tag(Hensel.configuration.parent_element, concatenated_items, options)
+    end
+
+    def processed?
+      !!@processed
+    end
+
+    private
+
+    def map_items
+      items_length = items.length.pred
+      items.map.with_index do |item, index|
+        if index == items_length
+          item._last = true
+        elsif index.zero?
+          item._first = true
+        else
+          item._first = item._last = false
+        end
+        item_filters.each{|filter| item.instance_eval(&filter) } unless item_filters.empty?
+        yield item
+      end
+    end
+
+    def item_filters
+      @item_filters ||= []
+    end
+
+    # @!visibility private
+    def process!
+      configuration = Hensel.configuration
+
+      Hensel::Filters.filters[:filters].each_pair do |name, block|
+        instance_eval(&block) if configuration.send(:"#{name}?")
+      end
+      richsnippet_filter = Hensel::Filters.filters[:richsnippets][configuration.richsnippet]
+      item_filters << richsnippet_filter if richsnippet_filter
+      @processed = true
+    end
+
+    # @!visibility private
+    def parse_arguments(arguments)
+      case arguments.length
+      when 3
+        arguments
+      when 2
+        arguments << {}
+      when 1
+        if (options = arguments.first) && options.instance_of?(Hash)
+          [ options.delete(:text) || options.delete(:content), options.delete(:path) || options.delete(:url), options ]
+        else
+          raise ArgumentError
+        end
+      end
+    end
+  end
+end