simple_breadcrumbs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c657f2df38cd282d1f14ea5af190e4d63819189b
+  data.tar.gz: 7a0892b36489537f399471243e159f72fdead9b1
+SHA512:
+  metadata.gz: ab9a308d04b6dbcf292aa4f3b84ab804330ee39d8700606098ba7730a4504767828d88982ef0cc1d7c52b621a08e27f3cf23e4a0f785efd0971151da8b790c29
+  data.tar.gz: 49a333a5f08a37eefffc5f42f832697512afd2e7c7a31407c578cf3e26a9dd088bc4d04dc3e504ea7854f3dfbb58fb73b378d4b44da34d09996516905db3f5b8

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 has_breadcrumb.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Squaremouth Inc.
+
+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,59 @@
+# SimpleBreadcrumbs
+
+This gem provides a simple and flexible way to create breadcrumbs with Rails active record 
+models. Setting `has_breadcrumb` on a model will enable a view method,
+`breadcrumb()`, which will show the links to the page and its parents in
+a breadcrumb format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_breadcrumbs'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In your model:
+
+    class User < ActiveRecord::Base
+      has_breadcrumb :title => :username
+    end
+
+To display a model as a child of another model, you state the parent
+by using the `:parent` parameter:
+
+    class UserProfile < ActiveRecord::Base
+      has_breadcrumb :parent => :user, :title => "Profile"
+    end
+
+As can be seen here, `has_breadcrumb` can accept a `String` on the
+`:title` option, which is useful in the case where there is no field in
+the model which would be suitable. The `:parent` option however, must
+take a `Symbol`.
+
+Breadcrumb links are displayed in a view by including the `breadcrumb` erb tag. 
+For example in an erb view for creating a new user,
+
+    <h2 class="subtitle"><%= breadcrumb @user, 'New' %></h2>
+
+will provide a link which includes the Index page and the controller
+action to which this page is related.
+
+Other options allowed by the `breadcrumb` method include
+`:forced_parent`, which links to a non-natural parent of the current
+view page.
+
+By default, `breadcrumb` includes a link to the index of an object when only
+one level exists.
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/has_breadcrumb/has_breadcrumb.rb

@@ -0,0 +1,24 @@
+module HasBreadcrumb
+  module ClassMethods
+    def has_breadcrumb options = {}
+      define_method :breadcrumb_parent do
+        return nil if options[:parent].nil?
+        self.send(options[:parent])
+      end
+
+      define_method :breadcrumb_name do
+        return "" if options[:title].nil?
+        case options[:title].class.name
+          when "Symbol"
+            self.send(options[:title])
+          else
+            options[:title]
+        end
+      end
+    end
+  end
+
+  def self.included(receiver)
+    receiver.extend  ClassMethods
+  end
+end

data/lib/has_breadcrumb/railtie.rb

@@ -0,0 +1,8 @@
+module HasBreadcrumb
+  class Railtie < Rails::Railtie
+    config.before_initialize do
+      ActiveRecord::Base.class_eval { include HasBreadcrumb }
+      ActionView::Base.class_eval { include ShowBreadcrumb }
+    end
+  end
+end

data/lib/has_breadcrumb/show_breadcrumb.rb

@@ -0,0 +1,33 @@
+module ShowBreadcrumb
+  # Recursive function to lookup through parent breadcrumbs
+  def collect_crumbs(obj, crumbs=[])
+    crumbs << obj
+    crumbs = collect_crumbs(obj.breadcrumb_parent, crumbs) unless obj.breadcrumb_parent.nil?
+    crumbs
+  end
+
+  # View helper to generate breadcrumbs
+  def breadcrumb(obj, action = nil, options = {})
+    crumb_html = ""
+    crumbs = collect_crumbs(obj)
+
+    if options.has_key?(:forced_parent)
+      crumb_link = url_for :controller => options[:forced_parent].class.to_s.underscore.pluralize, :action => "show", :id => options[:forced_parent].id
+      crumb_html = link_to options[:forced_parent].breadcrumb_name, crumb_link
+    elsif crumbs.length == 1
+      crumb_link = url_for :controller => obj.class.to_s.underscore.pluralize
+      crumb_html = link_to obj.class.model_name.human.pluralize, crumb_link
+    end
+
+    crumbs.reverse.each do |crumb_obj|
+      unless crumb_obj.id.nil?
+        crumb_html += ' > ' if crumb_html.length > 0
+        crumb_link = url_for :controller => crumb_obj.class.to_s.underscore.pluralize, :action => "show", :id => crumb_obj.id
+        crumb_html += link_to crumb_obj.breadcrumb_name, crumb_link
+      end
+    end
+
+    crumb_html += ' > ' + action + ' ' + obj.class.model_name.human.titleize if !action.nil?
+    crumb_html.html_safe
+  end
+end

data/lib/has_breadcrumb/version.rb

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

data/lib/has_breadcrumb.rb

@@ -0,0 +1,4 @@
+require "has_breadcrumb/version"
+require "has_breadcrumb/has_breadcrumb.rb"
+require "has_breadcrumb/show_breadcrumb.rb"
+require "has_breadcrumb/railtie" if defined?(Rails)

data/simple_breadcrumbs.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_breadcrumb/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simple_breadcrumbs"
+  gem.version       = HasBreadcrumb::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Tim Harvey", "Matt Outten"]
+  gem.email         = ["developers@squaremouth.com"]
+  gem.description   = %q{Provides a simple and flexible way to create breadcrumbs with Rails active record models.}
+  gem.summary       = %q{Setting has_breadcrumb on a model will enable a view method, breadcrumb(), which will show the links to the page and its parents in a breadcrumb format.}
+  gem.homepage      = "https://github.com/sqm/simple_breadcrumbs"
+  gem.license       = "MIT"
+
+  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|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'activerecord', ['>= 3.0', '< 5.0']
+  gem.add_dependency 'activesupport', ['>= 3.0', '< 5.0']
+
+  gem.add_development_dependency 'rspec-rails', '~> 2.13'
+  gem.add_development_dependency 'sqlite3', '~> 1.3'
+end

data/spec/has_breadcrumb/has_breadcrumb_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'has_breadcrumb'
+
+class Father
+  include HasBreadcrumb
+
+  has_breadcrumb title: "Father"
+end
+
+class Son
+  include HasBreadcrumb
+
+  attr_accessor :father, :name
+
+  has_breadcrumb parent: :father, title: :name
+end
+
+class Daughter
+  include HasBreadcrumb
+
+  attr_reader :father
+
+  has_breadcrumb parent: :father
+end
+
+describe HasBreadcrumb do
+  let(:father){ Father.new }
+  let(:son){ Son.new }
+  let(:daughter) { Daughter.new }
+
+  describe "#breadcrumb_parent" do
+    context "when the parent is nil" do
+      it "should return nil" do
+        expect(father.breadcrumb_parent).to eq(nil)
+      end
+    end
+
+    context "when a parent is given" do
+      it "should define a breadcrumb parent" do
+        father = Object.new
+        son.father = father
+        expect(son.breadcrumb_parent).to eq(father)
+      end
+    end
+  end
+
+  describe "#breadcrumb_name" do
+    context "when no title is given" do
+      it "should return an empty string" do
+        expect(daughter.breadcrumb_name).to eq("")
+      end
+    end
+
+    context "when a name is given" do
+      it "should return a title when a Symbol is passed" do
+        son.name = "Jimmy"
+        expect(son.breadcrumb_name).to eq("Jimmy")
+      end
+
+      it "should return a title when a string is passed" do
+        expect(father.breadcrumb_name).to eq("Father")
+      end
+    end
+  end
+
+  describe ".included" do
+    it "should respond to has_breadcrumb" do
+      Father.should respond_to(:has_breadcrumb)
+    end
+  end
+end

data/spec/has_breadcrumb/show_breadcrumb_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+class ObjectWithBreadcrumb
+  include ShowBreadcrumb
+end
+
+describe ShowBreadcrumb do
+  let(:admin) { Admin.create(name: "Admins") }
+  let(:manager) { Manager.create(name: "Managers") }
+  let(:user) { User.create(name: "Users") }
+  let(:controller) { ActionController::Base.new }
+
+  describe "#collect_crumbs" do
+    subject(:object_with_breadcrumb) { ObjectWithBreadcrumb.new }
+
+    context "when an object has no parent" do
+      it "should return an array containing itself" do
+        crumbs = object_with_breadcrumb.collect_crumbs(admin, [])
+        expect(crumbs).to eq([admin])
+      end
+    end
+
+    context "when an object has a parent" do
+      it "should return an array with itself and parents" do
+        user.manager = manager
+        crumbs = object_with_breadcrumb.collect_crumbs(user, [])
+        expect(crumbs).to eq([user, manager])
+      end
+    end
+  end
+
+  describe "#breadcrumbs" do
+    before { controller.stub(url_for: "fake_url") }
+
+    context "when :forced_parent is passed" do
+      it "should link to the forced parent" do
+        breadcrumb = controller.breadcrumb(user, "Add", forced_parent: admin)
+        expect(breadcrumb).to eq("<a href=\"fake_url\">Admin</a> &gt; <a href=\"fake_url\">Users</a> &gt; Add User")
+      end
+    end
+
+    context "when there is only one crumb" do
+      it "should not return a parent link" do
+        breadcrumb = controller.breadcrumb(admin, "Add")
+        expect(breadcrumb).to eq("<a href=\"fake_url\">Admins</a> &gt; <a href=\"fake_url\">Admin</a> &gt; Add Admin")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rails/all'
+require 'rspec/rails'
+require 'has_breadcrumb'
+
+ActiveSupport.on_load(:active_record) do
+  include HasBreadcrumb
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include ActionView::Helpers
+  include ShowBreadcrumb
+end
+
+I18n.enforce_available_locales = false
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/adapters/active_record.rb

@@ -0,0 +1,4 @@
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)

data/spec/support/models/admin.rb

@@ -0,0 +1,5 @@
+class Admin < ActiveRecord::Base
+  has_many :managers
+
+  has_breadcrumb :title => 'Admin'
+end

data/spec/support/models/intern.rb

@@ -0,0 +1,5 @@
+class Intern < ActiveRecord::Base
+  belongs_to :manager
+
+  has_breadcrumb :parent => :manager
+end

data/spec/support/models/manager.rb

@@ -0,0 +1,6 @@
+class Manager < ActiveRecord::Base
+  belongs_to :admin
+  has_many :users, :foreign_key => :admin_id
+
+  has_breadcrumb :parent => :admin, :title => :name
+end

data/spec/support/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  belongs_to :manager
+
+  has_breadcrumb :parent => :manager, :title => :name
+end

data/spec/support/schema.rb

@@ -0,0 +1,22 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :admins, :force => true do |t|
+    t.string :name
+  end
+
+  create_table :managers, :force => true do |t|
+    t.string :name
+    t.integer :admin_id
+  end
+
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.integer :manager_id
+  end
+
+  create_table :interns, :force => true do |t|
+    t.string :name
+    t.integer :manager_id
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: simple_breadcrumbs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tim Harvey
+- Matt Outten
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  prerelease: false
+  name: activerecord
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  prerelease: false
+  name: activesupport
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  prerelease: false
+  name: rspec-rails
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+  name: sqlite3
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+description: Provides a simple and flexible way to create breadcrumbs with Rails active
+  record models.
+email:
+- developers@squaremouth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/has_breadcrumb.rb
+- lib/has_breadcrumb/has_breadcrumb.rb
+- lib/has_breadcrumb/railtie.rb
+- lib/has_breadcrumb/show_breadcrumb.rb
+- lib/has_breadcrumb/version.rb
+- simple_breadcrumbs.gemspec
+- spec/has_breadcrumb/has_breadcrumb_spec.rb
+- spec/has_breadcrumb/show_breadcrumb_spec.rb
+- spec/spec_helper.rb
+- spec/support/adapters/active_record.rb
+- spec/support/models/admin.rb
+- spec/support/models/intern.rb
+- spec/support/models/manager.rb
+- spec/support/models/user.rb
+- spec/support/schema.rb
+homepage: https://github.com/sqm/simple_breadcrumbs
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Setting has_breadcrumb on a model will enable a view method, breadcrumb(),
+  which will show the links to the page and its parents in a breadcrumb format.
+test_files:
+- spec/has_breadcrumb/has_breadcrumb_spec.rb
+- spec/has_breadcrumb/show_breadcrumb_spec.rb
+- spec/spec_helper.rb
+- spec/support/adapters/active_record.rb
+- spec/support/models/admin.rb
+- spec/support/models/intern.rb
+- spec/support/models/manager.rb
+- spec/support/models/user.rb
+- spec/support/schema.rb
+has_rdoc: