bready 0.0.1

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,65 @@
+Bready is a tool for building breadcrumbs
+
+Install
+-----------
+In console: 
+```
+gem install bready
+```
+or in your Gemfile:
+```
+gem 'bready'
+```
+
+
+Configure
+-----------
+It can work with or without Rails. Here is an example of usage when you want to use it with the Ruby on Rails framework.
+First you need to create a configuration file config/initializers/bready.rb
+
+```ruby
+Bready::Breadcrumbs.setup do |config|
+  # delimiter between parts of breadcrumbs
+  config.delimiter = ' | '
+  
+  # Root chunk that will be used as a first chunk always
+  config.root_chunk = ['Home', '/']
+  
+  # the name of the tag that wraps breadcrumbs
+  config.block_tag = 'div'
+
+  # set the class for tag that was described above
+  config.block_class = 'breadcrumbs'
+end
+```
+
+
+Usage
+-----------
+You can pass an array of breadcrumb chunks into initializer method like this:
+
+```ruby
+bready = Bready::Breadcrumbs.new([
+  ['Categories', '/Categories/'],
+  ['Products', '/Products/'],
+])
+```
+
+You can add more chunks later on. Here are examples of how to do it:
+
+```ruby
+bready.add_chunk(['Products', '/Products/'])
+```
+
+To add more than one chunk:
+
+```ruby
+bready.add_chunks([['Products', '/Products/'], ['Products2', '/Products2/']])
+```
+
+
+In the view you can render breadcrumbs by simply calling render method of an instance:
+
+```ruby
+bready.render
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bready.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bready/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bready"
+  gem.version       = Bready::VERSION
+  gem.authors       = ["HeeL"]
+  gem.email         = ["parizhskiy@gmail.com"]
+  gem.description   = %q{Bready is a tool for building breadcrumbs}
+  gem.summary       = %q{Build customized breadcrumbs, using Google Rich Snippets}
+  gem.homepage      = "https://github.com/heel/bready"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('test-unit', '2.4.3')
+  gem.add_development_dependency('shoulda', '2.11.3')
+  gem.add_development_dependency('shoulda-matchers', '1.2.0')
+
+end

data/lib/bready.rb

@@ -0,0 +1,65 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require_relative "bready/version"
+
+module Bready
+  class Breadcrumbs
+    @@delimiter = ' > '
+    @@block_class = 'breadcrumbs'
+    @@block_tag = 'div'
+    @@root_chunk = []
+
+    def initialize(chunks)
+      @chunks = chunks
+    end
+
+    def self.setup
+      yield self
+    end
+
+    def self.delimiter= value
+      @@delimiter = value
+    end
+
+    def self.block_class= value
+      @@block_class = value
+    end
+
+    def self.block_tag= value
+      @@block_tag = value
+    end
+
+    def self.root_chunk= value
+      @@root_chunk = value
+    end
+
+    def add_chunks(chunks)
+      chunks.each{|chunk| add_chunk(chunk)}
+    end
+
+    def add_chunk(chunk)
+      @chunks << chunk
+    end
+
+    def render
+      "<#{@@block_tag} class='#{@@block_class}' xmlns:v='http://rdf.data-vocabulary.org/#'>#{render_chunks}</#{@@block_tag}>"
+    end
+
+    private
+
+    def render_chunks
+      rendered = ''
+      @chunks.unshift(@@root_chunk).map do |label, url|
+        rendered << @@delimiter unless rendered.empty?
+        if url
+          rendered << "<span typeof='v:Breadcrumb'><a href='#{url}' rel='v:url' property='v:title'>#{label}</a></span>"
+        else
+          rendered << "<span>#{label}</span>"
+        end
+      end
+      rendered
+    end
+
+  end
+
+end

data/lib/bready/version.rb

@@ -0,0 +1,3 @@
+module Bready
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: bready
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- HeeL
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Bready is a tool for building breadcrumbs
+email:
+- parizhskiy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bready.gemspec
+- lib/bready.rb
+- lib/bready/version.rb
+homepage: https://github.com/heel/bready
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Build customized breadcrumbs, using Google Rich Snippets
+test_files: []