inferred_crumpets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13af999973296c174d049d114cda22ede1083232
+  data.tar.gz: 1bd786c49e8d565ed6ae677f5ed9f67075182313
+SHA512:
+  metadata.gz: a56502ba97d10d61c9e8acd720b93e3d2da2e030b0b310f3ac6b821e45889dbbc7c96cc045700b8516cb0677560e0f6ab219cdbe9329e3f570e21fc1c95904a9
+  data.tar.gz: 1fc88f0a6d160c3935e2523cc4c5950e140b323f50887b60d3cdce81997d14d9aeafd2be006a9dff1a6bc11aa26b53ed9a3d26a0d11dcf92b545ae64b1da2421

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 SeaLink Travel Group
+
+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,34 @@
+# InferredCrumpets
+
+[![Build Status](https://travis-ci.org/sealink/inferred_crumpets.svg?branch=master)](https://travis-ci.org/sealink/inferred_crumpets)
+
+Automatic breadcrumbs for Rails. Built with [crumpet](https://github.com/blaknite/crumpet).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inferred_crumpets'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In the view call `render_inferred_crumbs`
+
+## 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/sealink/inferred_crumpets. 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 "inferred_crumpets"
+
+# 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/inferred_crumpets.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inferred_crumpets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inferred_crumpets"
+  spec.version       = InferredCrumpets::VERSION
+  spec.authors       = ["Grant Colegate"]
+  spec.email         = ["support@travellink.com.au"]
+
+  spec.summary       = "Automatic breadcrumbs for Rails."
+  spec.description   = "Automatic breadcrumbs for Rails."
+  spec.homepage      = "https://github.com/sealink/inferred_crumpets"
+  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_dependency "crumpet", ">= 0.1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/inferred_crumpets/builder.rb

@@ -0,0 +1,123 @@
+module InferredCrumpets
+  class Builder
+    attr_reader :view_context, :subject, :parents
+
+    def self.build_inferred_crumbs!(view_context)
+      subject = view_context.current_object rescue view_context.collection rescue nil
+      return unless subject
+      parents = [view_context.parent_object].compact
+      build_all!(view_context, subject, parents)
+    end
+
+    def self.build_all!(view_context, subject, parents = [])
+      new(view_context, subject, parents).build_all!
+    end
+
+    def self.build_single!(view_context, subject)
+      new(view_context, subject).build_single!
+    end
+
+    def initialize(view_context, subject, parents = [])
+      @view_context = view_context
+      @subject      = subject
+      @parents      = parents
+    end
+
+    def build_all!
+      build_crumbs_for_parents!
+      build_crumb_for_collection!
+      build_crumb_for_action!
+    end
+
+    def build_single!
+      build_crumb_for_subject!
+    end
+
+    private
+
+    def build_crumbs_for_parents!
+      parents.each do |parent|
+        Builder.build_single!(view_context, parent)
+      end
+    end
+
+    def build_crumb_for_collection!
+      if action == 'index'
+        Crumpet.crumbs.add_crumb subject_name.pluralize.titleize
+      else
+        Crumpet.crumbs.add_crumb subject.class.table_name.titleize, url_for_collection
+      end
+    end
+
+    def build_crumb_for_action!
+      if %w(new create).include?(action)
+        Crumpet.crumbs.add_crumb 'New', wrapper_options: { class: 'active' }
+      elsif %w(edit update).include?(action)
+        build_crumb_for_subject!
+        Crumpet.crumbs.add_crumb 'Edit', wrapper_options: { class: 'active' }
+      elsif action != 'index'
+        build_crumb_for_subject!
+      end
+    end
+
+    def build_crumb_for_subject!
+      Crumpet.crumbs.add_crumb(subject_name, url_for_subject)
+    end
+
+    def url_for_subject
+      return unless can_route?(:show, id: subject.id)
+      view_context.url_for(shallow? ? subject : subject_with_parents)
+    end
+
+    def url_for_collection
+      return view_context.objects_path if view_context.objects_path.present?
+      return unless can_route?(:index)
+      view_context.url_for(class_with_parents)
+    end
+
+    def subject_requires_transformation?
+      subject.respond_to?(:becomes) && view_context.url_for((parents + [subject.class]).compact).blank?
+    rescue NoMethodError
+      true
+    end
+
+    def transformed_subject
+      subject_requires_transformation? ? subject.becomes(subject.class.base_class) : subject
+    end
+
+    def shallow?
+      view_context.url_for(subject)
+    rescue NoMethodError
+      false
+    end
+
+    def can_route?(action, params = {})
+      view_context.url_for({
+        action:     action,
+        controller: subject.class.table_name,
+      }.merge(params))
+    rescue ActionController::RoutingError
+      false
+    end
+
+    def action
+      view_context.params[:action]
+    end
+
+    def subject_name
+      subject.respond_to?(:name) && subject.name.present? ? subject.name : subject.to_s
+    end
+
+    def class_with_parents
+      (parents + [transformed_subject.class]).compact
+    end
+
+    def subject_with_parents
+      (parents + [transformed_subject]).compact
+    end
+
+    def inherited_resources?
+      defined?(InheritedResources) && view_context.controller.responder == InheritedResources::Responder
+    end
+  end
+end

data/lib/inferred_crumpets/railtie.rb

@@ -0,0 +1,11 @@
+module InferredCrumpets
+  class Railtie < Rails::Railtie
+    initializer 'inferred_crumpets.setup_action_view' do |app|
+      ActiveSupport.on_load :action_view do
+        self.class_eval do
+          include InferredCrumpets::ViewHelpers
+        end
+      end
+    end
+  end
+end

data/lib/inferred_crumpets/version.rb

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

data/lib/inferred_crumpets/view_helpers.rb

@@ -0,0 +1,8 @@
+module InferredCrumpets
+  module ViewHelpers
+    def render_inferred_crumbs(options = {})
+      InferredCrumpets::Builder.build_inferred_crumbs!(self)
+      render_crumbs(options)
+    end
+  end
+end

data/lib/inferred_crumpets.rb

@@ -0,0 +1,6 @@
+require "inferred_crumpets/builder"
+require "inferred_crumpets/railtie"
+require "inferred_crumpets/version"
+require "inferred_crumpets/view_helpers"
+
+module InferredCrumpets; end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: inferred_crumpets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grant Colegate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-19 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: crumpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !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: Automatic breadcrumbs for Rails.
+email:
+- support@travellink.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
+- inferred_crumpets.gemspec
+- lib/inferred_crumpets.rb
+- lib/inferred_crumpets/builder.rb
+- lib/inferred_crumpets/railtie.rb
+- lib/inferred_crumpets/version.rb
+- lib/inferred_crumpets/view_helpers.rb
+homepage: https://github.com/sealink/inferred_crumpets
+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: Automatic breadcrumbs for Rails.
+test_files: []