breadnbutter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26e1b2c693ceb291448b5e92e23494ccb033972b
+  data.tar.gz: bd4e47e2270eeb929ce481ce49ddfd36159bf4d4
+SHA512:
+  metadata.gz: 63b9ead3df6b7394011f0e93ccf6cc91a28e7b25022a125238859701149b1ce383a52687c277034d5852660814f72a480f4a6ec056bfc07adae9ca5c9e2d774e
+  data.tar.gz: 49926b2b506b1496a99fecda4294802f67f9596919a230004679e860e0a2e40c34dd28a9f601fbbd5a064ac5336701b5eece02c718a56be9c104ef5bdd29d764

data/.gitignore

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

data/CHANGELOG

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial Release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jack Desert
+
+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,77 @@
+# BreadnButter
+
+Creates a linkable breadcrumb trail based on your url:
+
+[Home](http://github.com/jackdesert/breadnbutter) » [Projects](http://github.com/jackdesert/breadnbutter/projects) » [Mow the Yard](http://github.com/jackdesert/breadnbutter/projects/mow-the-yard) » Edit
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'breadnbutter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install breadnbutter
+
+## Requirements
+
+Requires Rails 3.1 or greater, since it uses Engine and Railtie
+
+## Usage
+
+On any view that you want breadcrumbs, call
+ 
+    <%= render_breadcrumbs %>
+
+Typically it makes sense to put this in app/views/layouts/application.html.erb
+
+## Customization
+
+The following can be set to further customize BreadnButter
+    
+    # config/application.rb
+
+    # Use a different character between crumbs
+    config.breadnbutter_joiner = ':'
+
+    # Specify any text elements you want hidden
+    config.breadnbutter_hidden_elements = ['Hide Me']
+
+    # Change the text for the 'Home' link
+    config.breadnbutter_home_text = 'Noteworthy Name'
+
+    # Change the url for the 'Home' link
+    config.breadnbutter_home_url = 'http://classy_url.com/'
+
+## Styling
+
+For the aesthete in you, add some styling and tweak to taste.
+    
+    #breadnbutter{
+      padding: 1ex 1ex;
+      font-size: 20px;
+      background-color: black;
+      joiner{
+        padding: 0 0.5ex;
+        color: grey;
+      }
+      crumb a{
+        color: gold;
+      }
+      crumb{
+        color: grey;
+      }
+    }
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/app/views/breadnbutter/_crumb.html.erb

@@ -0,0 +1,8 @@
+<div id='breadnbutter'>
+  <% breadcrumbs.each_with_index do |crumb, index| %>
+    <% unless index == 0 %>
+      <joiner><%= crumb.joiner %></joiner>
+    <% end %>
+    <crumb><%= link_to_if(crumb.linkable, crumb.text, crumb.url) %></crumb>
+  <% end %>
+</div>

data/breadnbutter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'breadnbutter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "breadnbutter"
+  spec.version       = BreadnButter::VERSION
+  spec.authors       = ["Jack Desert"]
+  spec.email         = ["jackdesert@gmail.com"]
+  spec.description   = %q{Craft generic breadcrumbs from the controller path}
+  spec.summary       = %q{Most of the times when I use a breadcrumb, the requirements are really simple: show me what object I'm looking, and what its parent is, and give me links back to either the parent, the view, or the root.}
+  spec.homepage      = "http://github.com/jackdesert/breadnbutter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

data/lib/breadnbutter.rb

@@ -0,0 +1,112 @@
+require "breadnbutter/version"
+
+if Rails.version < '3.1'
+  raise "Rails 3.1 or greater is required to run BreadnButter"
+end
+
+require 'breadnbutter/railtie' 
+require 'breadnbutter/engine'
+
+module BreadnButter
+  class Crumb
+    JOINER = "&raquo;".html_safe
+    HIDDEN_ELEMENTS = []
+    HOME_URL = '/'
+    HOME_TEXT = 'HOME'
+
+    attr_accessor :url, :text
+
+    def linkable
+      url.present?
+    end
+
+    def hidden?
+      hidden_elements.include? text
+    end
+
+    def joiner
+      begin
+        Rails.configuration.breadnbutter_joiner
+      rescue NoMethodError
+        JOINER
+      end
+    end
+
+    def hidden_elements
+      begin
+        Rails.configuration.breadnbutter_hidden_elements
+      rescue NoMethodError
+        HIDDEN_ELEMENTS
+      end
+    end
+
+    def self.home_text
+      begin
+        Rails.configuration.breadnbutter_home_text
+      rescue NoMethodError
+        HOME_TEXT
+      end
+    end
+
+    def self.home_url
+      begin
+        Rails.configuration.breadnbutter_home_url
+      rescue NoMethodError
+        HOME_URL
+      end
+    end
+
+    def self.new_from_hash(hash)
+      new_crumb = self.new
+      new_crumb.text = value_from_key(:text, hash)
+      new_crumb.url = value_from_key(:url, hash)
+      new_crumb
+    end
+
+    def self.get_text_from_element(element, previous_element)
+      if element =~ /^[0-9]+$/      
+        model = previous_element.classify.constantize
+        begin
+          text = model.find(element).name
+        rescue NoMethodError
+          text = element
+        end
+      else
+        text = element
+      end
+      text.titleize
+    end
+
+    def self.override_first(array)
+      first = self.new_from_hash(text: home_text, url: home_url)
+      array[0] = first
+      array
+    end
+
+    def self.generate_crumbs_from_url(in_url)
+      output = []
+      used_elements = []
+      elements = in_url.split('/')
+      last_index = elements.length - 1
+      elements.each_with_index do |element, index|
+        used_elements << element
+        url = used_elements.join('/')
+        previous_element = elements[index -1]
+        text = self.get_text_from_element(element, previous_element)
+        output_url = (index < last_index) ? url : nil
+        new_crumb = self.new_from_hash(url: output_url, text: text)
+        output << new_crumb unless new_crumb.hidden?
+      end
+      self.override_first(output)
+    end
+
+
+    protected
+
+    def self.value_from_key(key, hash)
+      hash[key.to_s] || hash[key.to_sym]
+    end
+  end
+
+end
+

data/lib/breadnbutter/engine.rb

@@ -0,0 +1,10 @@
+module BreadnButter
+  class Engine < Rails::Engine
+
+    # initialize "abreadnbutter.load_app_instance_data" do |app|
+    #   BreadnButter.setup do |config|
+    #     # config.app_root = app.root
+    #   end
+    # end
+  end
+end

data/lib/breadnbutter/helpers.rb

@@ -0,0 +1,15 @@
+module BreadnButter::Helpers
+  # Include this module in any controller you want to use breadcrumbs
+  def get_breadcrumbs
+    # note controller.request.env instead of controller.env
+    # so that it works in both development, staging, 
+    # and in our controller specs which render views
+    url = controller.request.env['PATH_INFO']
+    BreadnButter::Crumb.generate_crumbs_from_url(url)
+  end
+
+  def render_breadcrumbs
+    render :partial => 'breadnbutter/crumb', :locals => {:breadcrumbs => get_breadcrumbs}
+  end
+end
+

data/lib/breadnbutter/railtie.rb

@@ -0,0 +1,8 @@
+require 'breadnbutter/helpers'
+module BreadnButter
+  class Railtie < Rails::Railtie
+    initializer "breadnbutter.view_helpers" do
+      ActionView::Base.send :include, Helpers
+    end
+  end
+end

data/lib/breadnbutter/version.rb

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: breadnbutter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jack Desert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Craft generic breadcrumbs from the controller path
+email:
+- jackdesert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/breadnbutter/_crumb.html.erb
+- breadnbutter.gemspec
+- lib/breadnbutter.rb
+- lib/breadnbutter/engine.rb
+- lib/breadnbutter/helpers.rb
+- lib/breadnbutter/railtie.rb
+- lib/breadnbutter/version.rb
+homepage: http://github.com/jackdesert/breadnbutter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: 'Most of the times when I use a breadcrumb, the requirements are really simple:
+  show me what object I''m looking, and what its parent is, and give me links back
+  to either the parent, the view, or the root.'
+test_files: []