crumpet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff07876004a5baf64ff855d2dafaed1513da8c3a
+  data.tar.gz: 01ac5cf988059efd166e1ad67724ad0ac0009415
+SHA512:
+  metadata.gz: 45bae82065598dcd96b5cd52ddc5794a9cc9cf39b991fe5fa122ab2217e86975e4be12a2f74dbb7fa5c1746aa3ec37405873cc5b83381b727007937a740e3541
+  data.tar.gz: 56891cdef1da17ae37e68a80657a6b6202e2b3b97133c75f411b05e31c62df9145071f848ec030c46fd8793118df47bc9d740f187bf7da092c9eda4b9d913373

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6
+notifications:
+  email:
+    - blaknite@thelanbox.com.au

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at blaknite@thelanbox.com.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Grant Colegate
+
+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,53 @@
+# Crumpet
+
+[![Build Status](https://travis-ci.org/blaknite/crumpet.svg?branch=master)](https://travis-ci.org/blaknite/crumpet)
+
+Simple breadcrumbs for Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crumpet'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Basic usage:
+
+```ruby
+class ApplicationController
+  crumbs do
+    add_crumb "Home", root_path
+  end
+end
+
+class WidgetsController < ApplicationController
+  crumbs do
+    add_crumb @widget.parent_widget.name, widget_path(@widget.parent_widget)
+    add_crumb @widget.name, widget_path(@widget)
+  end
+
+  crumbs_for :edit do
+    add_crumb 'Edit'
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/blaknite/crumpet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "crumpet"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/crumpet.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crumpet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crumpet"
+  spec.version       = Crumpet::VERSION
+  spec.authors       = ["Grant Colegate"]
+  spec.email         = ["blaknite@thelanbox.com.au"]
+
+  spec.summary       = "Simple breadcrumbs for Rails"
+  spec.homepage      = "http://example.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 3"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/crumpet/configuration.rb

@@ -0,0 +1,33 @@
+module Crumpet
+  class Configuration
+    attr_accessor :format
+    attr_accessor :link
+    attr_accessor :separator
+    attr_accessor :default_crumb_class
+    attr_accessor :first_crumb_class
+    attr_accessor :last_crumb_class
+    attr_accessor :link_last_crumb
+    attr_accessor :truncate
+    attr_accessor :escape
+    attr_accessor :wrapper
+    attr_accessor :default_wrapper_class
+    attr_accessor :container
+    attr_accessor :default_container_class
+
+    def initialize
+      @format = :html
+      @link = true
+      @separator = " » ".html_safe
+      @default_crumb_class = nil
+      @first_crumb_class = nil
+      @last_crumb_class = nil
+      @link_last_crumb = true
+      @truncate = nil
+      @escape = true
+      @wrapper = nil
+      @default_wrapper_class = nil
+      @container = nil
+      @default_container_class = nil
+    end
+  end
+end

data/lib/crumpet/controller_additions.rb

@@ -0,0 +1,29 @@
+module Crumpet
+  module ControllerAdditions
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def add_crumb(name = nil, url = nil, options = {})
+      Crumpet.repository.add_crumb(name, url, options)
+    end
+
+    def clear_crumbs
+      Crumpet.repository.clear
+    end
+
+    module ClassMethods
+      def crumbs(&block)
+        crumbs_for(&block)
+      end
+
+      def crumbs_for(*args, &block)
+        options = {}
+        options[:only] = args if args.present?
+        before_action(options) do |instance|
+          instance.instance_exec(&block) if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/crumpet/crumb.rb

@@ -0,0 +1,49 @@
+module Crumpet
+  class Crumb
+    attr_reader :name, :url, :options
+
+    def initialize(name, url = nil, options = {})
+      @name = name
+      @url = url
+      @options = options
+    end
+
+    def link?
+      url.present? && option_or_default(:link).present?
+    end
+
+    def escape?
+      option_or_default(:escape)
+    end
+
+    def truncate?
+      truncate.present?
+    end
+
+    def truncate
+      option_or_default(:truncate)
+    end
+
+    def wrap?
+      wrapper.present?
+    end
+
+    def wrapper
+      option_or_default(:wrapper)
+    end
+
+    def item_options
+      options.fetch(:item_options, {})
+    end
+
+    def wrapper_options
+      options.fetch(:wrapper_options, {})
+    end
+
+    private
+
+    def option_or_default(option)
+      options.fetch(option, Crumpet.config.send(option.to_sym).clone)
+    end
+  end
+end

data/lib/crumpet/railtie.rb

@@ -0,0 +1,21 @@
+module Crumpet
+  class Railtie < Rails::Railtie
+    initializer 'crumpet.setup_action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        self.class_eval do
+          include Crumpet::ControllerAdditions
+
+          before_action :clear_crumbs
+        end
+      end
+    end
+
+    initializer 'crumpet.setup_action_view' do |app|
+      ActiveSupport.on_load :action_view do
+        self.class_eval do
+          include Crumpet::ViewHelpers
+        end
+      end
+    end
+  end
+end

data/lib/crumpet/renderer.rb

@@ -0,0 +1,119 @@
+module Crumpet
+  class Renderer
+    include ActionView::Helpers::UrlHelper
+    include ERB::Util
+
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def render
+      case option_or_default(:format)
+      when :html
+        output = repository.map{ |crumb| render_html(crumb) }.join(option_or_default(:separator)).html_safe
+        output = content_tag(option_or_default(:container).to_sym, output, build_container_options) if option_or_default(:container).present?
+        output
+      when :xml
+        output = repository.map{ |crumb| render_xml(crumb) }.join
+        output = content_tag(:crumbs, output)
+        output
+      when :json
+        repository.map{ |crumb| render_json(crumb) }.to_json
+      else
+        raise NotImplementedError, "unsupported format: #{option_or_default(:format)}"
+      end
+    end
+
+    private
+
+    def repository
+      Crumpet.repository
+    end
+
+    def render_html(crumb)
+      name            = render_name(crumb)
+      item_options    = build_html_options(crumb)
+      wrapper_options = build_wrapper_options(crumb)
+
+      output = link?(crumb) ? link_to(name, crumb.url, item_options) : content_tag(:span, name, item_options)
+      output = content_tag(crumb.wrapper, output, wrapper_options) if crumb.wrap?
+      output
+    end
+
+    def render_xml(crumb)
+      item_options = build_item_options(crumb)
+      item_options = item_options.merge(href: crumb.url) if link?(crumb)
+
+      content_tag(:crumb, render_name(crumb), item_options)
+    end
+
+    def render_json(crumb)
+      output = build_item_options(crumb).merge(name: render_name(crumb))
+      output = output.merge(href: crumb.url) if link?(crumb)
+      output
+    end
+
+    def render_name(crumb)
+      name = crumb.name
+      name = name.truncate(crumb.truncate) if crumb.truncate?
+      name = h(name) if crumb.escape?
+      name.html_safe
+    end
+
+    def render_container(content)
+      content_tag(option_or_default(:container).to_sym, content, build_container_options)
+    end
+
+    def build_html_options(crumb)
+      item_options = options.fetch(:item_options, {}).merge(crumb.item_options)
+
+      item_options[:class] = Array(item_options.fetch(:class, []))
+      item_options[:class] << option_or_default(:default_crumb_class).presence
+      item_options[:class] << option_or_default(:first_crumb_class).presence if crumb == repository.first
+      item_options[:class] << option_or_default(:last_crumb_class).presence if crumb == repository.last
+      item_options[:class].compact!
+      item_options[:class].uniq!
+      item_options.delete(:class) if item_options[:class].blank?
+
+      item_options
+    end
+
+    def build_item_options(crumb)
+      options.fetch(:item_options, {}).merge(crumb.item_options)
+    end
+
+    def build_wrapper_options(crumb)
+      wrapper_options = options.fetch(:wrapper_options, {}).merge(crumb.wrapper_options)
+
+      wrapper_options[:class] = Array(wrapper_options.fetch(:class, []))
+      wrapper_options[:class] << option_or_default(:default_wrapper_class).presence
+      wrapper_options[:class].compact!
+      wrapper_options[:class].uniq!
+      wrapper_options.delete(:class) if wrapper_options[:class].blank?
+
+      wrapper_options
+    end
+
+    def build_container_options
+      container_options = options.fetch(:container_options, {})
+
+      container_options[:class] = Array(container_options.fetch(:class, []))
+      container_options[:class] << option_or_default(:default_container_class).presence
+      container_options[:class].compact!
+      container_options[:class].uniq!
+      container_options.delete(:class) if container_options[:class].blank?
+
+      container_options
+    end
+
+    def link?(crumb)
+      option_or_default(:link) && crumb.link? && ( option_or_default(:link_last_crumb) || crumb != repository.last )
+    end
+
+    def option_or_default(option)
+      options.fetch(option, Crumpet.config.send(option.to_sym)).clone
+    end
+  end
+end

data/lib/crumpet/repository.rb

@@ -0,0 +1,12 @@
+module Crumpet
+  class Repository < Array
+    def add_crumb(name = nil, url = nil, options = {})
+      self << Crumpet::Crumb.new(name, url, options)
+    end
+
+    def <<(crumb)
+      fail ArgumentError, 'crumb must be a Crumpet::Crumb' unless crumb.is_a? Crumpet::Crumb
+      super
+    end
+  end
+end

data/lib/crumpet/version.rb

@@ -0,0 +1,3 @@
+module Crumpet
+  VERSION = "0.1.0"
+end

data/lib/crumpet/view_helpers.rb

@@ -0,0 +1,11 @@
+module Crumpet
+  module ViewHelpers
+    def render_crumbs(options = {})
+      Crumpet.render(options)
+    end
+
+    def crumbs
+      Crumpet.repository
+    end
+  end
+end

data/lib/crumpet.rb

@@ -0,0 +1,26 @@
+require 'crumpet/configuration'
+require 'crumpet/crumb'
+require 'crumpet/controller_additions'
+require 'crumpet/railtie'
+require 'crumpet/renderer'
+require 'crumpet/repository'
+require 'crumpet/version'
+require 'crumpet/view_helpers'
+
+module Crumpet
+  module_function def config
+    @config ||= Crumpet::Configuration.new
+  end
+
+  module_function def repository
+    @repository ||= Crumpet::Repository.new
+  end
+
+  def self.render(options = {})
+    Crumpet::Renderer.new(options).render
+  end
+
+  def self.configure
+    yield config
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: crumpet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grant Colegate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- blaknite@thelanbox.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crumpet.gemspec
+- lib/crumpet.rb
+- lib/crumpet/configuration.rb
+- lib/crumpet/controller_additions.rb
+- lib/crumpet/crumb.rb
+- lib/crumpet/railtie.rb
+- lib/crumpet/renderer.rb
+- lib/crumpet/repository.rb
+- lib/crumpet/version.rb
+- lib/crumpet/view_helpers.rb
+homepage: http://example.com
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Simple breadcrumbs for Rails
+test_files: []