crummy-schema-dot-org 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c73e692824e6b5c66d82c932e62fbf255434c47217a8790698ff2cae90e55f1
+  data.tar.gz: cc320bbdc1cea5760f19b0aebbf2043c0a07b8e7c1de5f9944703efa60c7feef
+SHA512:
+  metadata.gz: 89f7f623c15e0af2d0a0f006e9201f57cf1a1a3138169538081dcccf670ee8161687738e84c27cd68e7d373202276bbfe4d726a89c5740380572ad0c082c12bb
+  data.tar.gz: 17a4539328022c18c33533c384e9f6a5c2ec25ada60216c2ba7f915ff891f6894f81ca613eca2fed5d7721e674960f682fe2a23a932f978ecdffb0da13e4f833

data/.gitignore

@@ -0,0 +1,8 @@
+rdoc
+nbproject
+*.gem
+.bundle
+pkg/*
+Gemfile.lock
+*.gemfile.lock
+.idea

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-head@crummy"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.17.7 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+ - 1.9.3
+ - 2.2.2
+gemfile:
+ - gemfiles/rails3_2.gemfile
+ - gemfiles/rails4_0.gemfile

data/Appraisals

@@ -0,0 +1,9 @@
+appraise "rails3_2" do
+  gem 'activesupport', '>= 3.0', '< 4'
+  gem 'actionpack', '>= 3.0', '< 4'
+end
+
+appraise "rails4_0" do
+  gem 'activesupport', '>= 4.0.0.beta', '< 5'
+  gem 'actionpack', '>= 4.0.0.beta', '< 5'
+end

data/CHANGELOG

@@ -0,0 +1,47 @@
+1.8.0
+* [ADDED] You can now set each parameters individually for each crumb
+* [ADDED] You can now set each crumb on right or left side
+* [ADDED] You can now use a html in a crumb name
+* [REFACTORED] Don't render empty html_options for tags.
+
+1.7.2
+* [ADDED] :truncate option to shorten text in breadcrumbs
+* [ADDED] Added ability to pass html link options through to renderer
+
+1.7.1
+* [ADDED] :last_crumb_linked option to disable linking crumb on current page
+
+1.7.0
+* [ADDED] Added option for google microdata
+* [REFACTORED] Cleaned up development internals
+
+1.6.0
+* [FIXED] A fix for the escaped html problem in :html_list
+
+1.5
+* [ADDED] Global configuration options
+* [REFACTORED] HTML now uses content_tags
+
+1.3.6
+* [FIXED] :li_class fixed in StandardRenderer#crumb_to_html_list
+
+1.3.5
+* [FIXED] Spacing in name argument was causing errors.
+* [FIXED] Bug where everything was getting parsed as an Array.
+
+1.3
+* [FIXED] html_safe! is no longer called by default. That's the user's prerogative to do now.
+* [ADDED] Allow record to respond to to_s even if you pass a url or block.
+* [ADDED] Allow name to be a proc or lambda method
+* [ADDED] clear crumbs as before filter
+
+1.2
+* [ADDED] html_list format option
+* [FIXED] Bug with Passenger and REE deployments
+
+1.1.1
+
+* [FIXED] issue with undefined method escape_once for Rails 3.
+* [FIXED] spelling of separator
+
+1.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Zach Inglis
+
+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,216 @@
+# Crummy with Schema.org support
+
+Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.
+
+## Install
+
+Simply add the dependency to your Gemfile:
+
+```ruby
+gem "crummy-schema-dot-org", "~> 1.9.0"
+```
+
+# Example
+
+In your controllers you may add\_crumb either like a before\_filter or
+within a method (It is also available to views).
+
+```ruby
+class ApplicationController
+  add_crumb "Home", '/'
+end
+
+class BusinessController < ApplicationController
+  add_crumb("Businesses") { |instance| instance.send :businesses_path }
+  add_crumb("Comments", only: "comments") { |instance| instance.send :businesses_comments_path }
+  before_filter :load_comment, only: "show"
+  add_crumb :comment, only: "show"
+
+  # Example for nested routes:
+  add_crumb(:document) { [:account, :document] }
+
+  def show
+    add_crumb @business.display_name, @business
+  end
+
+  def load_comment
+    @comment = Comment.find(params[:id])
+  end
+end
+```
+
+Then in your view:
+
+```erb
+<%= render_crumbs %>
+```
+
+## Html options for breadcrumb link
+
+You can set the html options with *link_html_options*.
+These are added to the *a* tag.
+
+```ruby
+add_crumb "Home", '/', link_html_options: {title: "my link title"}
+```
+
+##You can set html instead text in first parameter.
+If tag <code>a</code> present in this html, tag a not be a wrapper.
+
+```ruby
+add_crumb "<a class='glyphicons shield' href='/support'><i></i>Support</a>".html_safe, "", {}
+```
+
+## Options for render\_crumbs
+
+`render_crumbs` renders the list of crumbs as either html or xml
+
+The output format. Can either be :xml or :html or :html\_list. Defaults
+to :html
+
+```ruby
+format: (:html|:html_list|:xml)
+```
+
+The separator text. It does not assume you want spaces on either side so
+you must specify. Defaults to `&raquo;` for :html and
+`<crumb>` for :xml
+
+```ruby
+separator: string
+```
+
+Render links in the output. Defaults to *true*
+
+```ruby
+links: false
+```
+
+Render
+[Richsnipet](http:/support.google.com/webmasters/bin/answer.py?hl=en&answer=99170&topic=1088472&ctx=topic/)
+Default to *false*
+
+```ruby
+microdata: true
+```
+
+Optionally disable linking of the last crumb, Defaults to *true*
+
+```ruby
+last_crumb_linked: false
+```
+
+With this option, output will be blank if there are no breadcrumbs.
+
+```ruby
+skip_if_blank: true
+```
+
+### Examples
+
+```ruby
+render_crumbs                     #=> <a href="/">Home</a> &raquo; <a href="/businesses">Businesses</a>
+render_crumbs separator: ' | '    #=> <a href="/">Home</a> | <a href="/businesses">Businesses</a>
+render_crumbs format: :xml        #=> <crumb href="/">Home</crumb><crumb href="/businesses">Businesses</crumb>
+render_crumbs format: :html_list  #=> <ol class="" id=""><li class=""><a href="/">Home</a></li><li class=""><a href="/">Businesses</a></li></ol>
+render_crumbs format: :html_list, :microdata => true
+                                  #=> <ol class="" id=""><li class="" itemscope="itemscope" itemtype="http://data-vocabulary.org/Breadcrumb">
+                                  #     <a href="/" itemprop="url"><span itemprop="title">Home</span></a></li></ol>
+add_crumb support_link, {:right_side => true, :links => "/support", :li_right_class => "pull-right hidden-phone"}
+                                  #=> <li class="pull-right hidden-phone">
+                                  #=>  <span><a class="glyphicons shield" href="/support">
+                                  #=>   <i></i>Support</a>
+                                  #=>  </span>
+                                  #=> </li>
+                                  #=> <li class="divider pull-right hidden-phone"></li>
+```
+
+A crumb with a nil argument for the link will output an unlinked crumb.
+
+With `format: :html_list` you can specify additional `params: :li_class, :ol_class, :ol_id`
+
+### App-wide configuration
+
+You have the option to pre-configure any of the Crummy options in an
+application-wide configuration. The options above are available to
+configure, with the exception of `:separator`, as well as many others.
+
+The biggest difference is that `:separator` is not an option. Instead,
+you have format-specific configuration options: `:html_separator`,
+`:xml_separator`, and `:html_list_separator`. `:separator` can still be
+overridden in the view.
+
+Insert the following in a file named `config/initializers/crummy.rb`:
+
+```ruby
+Crummy.configure do |config|
+  config.format = :xml
+end
+```
+
+Possible parameters for configuration are:
+
+```ruby
+:format
+:links
+:skip_if_blank
+:html_separator
+:xml_separator
+:html_list_separator
+:html_list_right_separator
+:first_class
+:last_class
+:ol_id
+:ol_class
+:li_class
+:li_right_class
+:microdata
+:last_crumb_linked
+:truncate
+:right_side
+```
+
+See `lib/crummy.rb` for a list of these parameters and their defaults.
+
+###Individually for each crumb configuration:
+```ruby
+add_crumb support_link, {:right_side => true, :links => "/support", : li_class => "my_class", :li_right_class => "pull-right hidden-phone"}
+```
+Simple add that parameter to options hash.
+
+
+## Live example application
+
+An example application is available right inside this gem. That application is documented, see `example/README` for details about usage.
+
+## Todo
+
+-   Accept collections of models as a single argument
+-   Accept instances of models as a single argument
+-   Allow for variables in names. (The workaround is to do your own
+    before\_filter for that currently)
+-   Make a crumbs? type method
+
+## Credits
+
+-   [Zach Inglis](http://zachinglis.com) of [Superhero Studios](http://superhero-studios.com)
+-   [Andrew Nesbitt](http://github.com/andrew)
+-   [Rein Henrichs](http://reinh.com)
+-   [Les Hill](http://blog.leshill.org/)
+-   [Sandro Turriate](http://turriate.com/)
+-   [Przemysław
+    Kowalczyk](http://szeryf.wordpress.com/2008/06/13/easy-and-flexible-breadcrumbs-for-rails/)
+    - feature ideas
+-   [Sharad Jain](http://github.com/sjain)
+-   [Max Riveiro](http://github.com/kavu)
+-   [Kamil K. Lemański](http://kml.jogger.pl)
+-   [Brian Cobb](http://bcobb.net/)
+-   [Kir Shatrov](http://github.com/shatrov) ([Evrone
+    company](http://evrone.com))
+-   [sugilog](http://github.com/sugilog)
+-   [Trond Arve Nordheim](http://github.com/tanordheim)
+-   [Jan Szumiec](http://github.com/jasiek)
+-   [Jeff Browning](http://github.com/jbrowning)
+-   [Bill Turner](http://github.com/billturner)
+
+**Copyright 2008-2013 Zach Inglis, released under the MIT license**

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'appraisal'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+require 'rake/testtask'
+desc 'Test the crummy plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+require 'rdoc/task'
+
+desc 'Generate documentation for the crummy plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Crummy: Tasty Breadcrumbs'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/crummy-schema-dot-org.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "crummy/version"
+
+Gem::Specification.new do |s|
+  s.name = "crummy-schema-dot-org"
+  s.version = Crummy::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zach Inglis", "Andrew Nesbitt", "Gowtham Gts"]
+  s.summary = "Tasty breadcrumbs!"
+  s.description = "Crummy Schema.org is an extension to original crummy gem supporting schema.org type"
+  s.email = "gts+crummy@gowtham.dev"
+  s.extra_rdoc_files = ["README.md"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.homepage = "http://github.com/gowthamgts/crummy-schema-dot-org"
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.8}
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler',     '~> 1.0'
+  s.add_development_dependency 'activesupport'
+  s.add_development_dependency 'actionpack'
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'test-unit'
+end

data/example/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/

data/example/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/example/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-head@crummy-test"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.17.7 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi