easy_breadcrumbs 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fcf9be5056635f695ed430f771d5ca29e4246a22
+  data.tar.gz: 32c198b059cad879a487b54ff286c29b53451bf1
+SHA512:
+  metadata.gz: e55a3be879f425b60a06f768171ce920dd644f11043b34cec8c99e31a2a9c07761bc77f45e9e39ab97c1ef30674834359f80d7d7fac2e1d3fae1c95a476dff1a
+  data.tar.gz: c584c9494c1eca7fd9b53ce63cdce7b723106cbb80397ee0f34891a34214b99a4f2effd6a710fe3990a240f1ac52510249eb523657c425658fdfdb0dcfc5d883

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eliathah Boda
+
+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,128 @@
+# EasyBreadcrumbs
+
+Provides an `easy_breadcrumbs` view helper for automatically generating bootstrap breadcrumbs for your Sinatra Application.
+
+* It's able to properly generate the html for many different types of complex routes (See Below).
+* It only generates breadcrumbs for the routes you've defined, so if you have a route `/categories/10/contacts/5`, but haven't defined an index view route for `/categories`, that item will be left out.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_breadcrumbs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_breadcrumbs
+
+## Usage
+
+### Step 1
+
+If you're building a classic style Sinatra app, simply add this line to your sinatra application file:
+
+    require "easy_breadcrumbs"
+
+If you're building a modular style Sinatra app, you'll also need to explicitly register the module within your application.
+
+    class HelloApp < Sinatra::Base
+      helpers Sinatra::EasyBreadcrumbs
+
+      get "/hello" do
+        h "1 < 2"
+      end
+    end
+
+### Step 2
+
+And then use the helper method in your layout or view:
+    
+    <%= easy_breadcrumbs %>
+
+### Step 3
+
+And last but not least, make sure you have bootstrap installed. You can install bootstrap's css by adding this line to your applications layout template.
+
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.5/css/bootstrap.min.css" integrity="sha384-AysaV+vQoT3kOAXZkl02PThvDr8HYKPZhNT5h/CXfBThSRXQ6jW5DO2ekP5ViFdi" crossorigin="anonymous">
+
+## Details
+
+Easy Breadcrumbs is able to handle a variety of complex routes. Here are some examples:
+
+### Simple path to page
+```
+Path: /about
+Breadcrumb: Home > About
+```
+
+### Path to resource index page
+```
+Path: /contacts
+Breadcrumb: Home > Contacts
+```
+
+###Path to specific resource
+```
+Path: /contacts/28
+Breadcrumb: Home > Contacts > Contact
+```
+
+### Path to resource new view
+```
+Path: /contacts/new
+Breadcrumb: Home > Contacts > New Contact
+```
+
+### Path to edit specific resource
+```
+Path: /contacts/28/edit
+Breadcrumb: Home > Contacts > Contact > Edit Contact
+```
+
+### Path to nested resource index page
+```
+Path: /categories/5/contacts
+Breadcrumb: Home > Categories > Category > Contacts
+```
+
+### Path to specific nested resource
+```
+Path: /categories/5/contacts/10
+Breadcrumb: Home > Categories > Category > Contacts > Contact
+```
+
+### Path to nested resource new view
+```
+Path: /categories/5/contacts/new
+Breadcrumb: Home > Categories > Category > Contacts > New Contact
+```
+
+### Path to edit specific nested resource
+```
+Path: /categories/5/contacts/10/edit
+Breadcrumb: Home > Categories > Category > Contacts > Contact > Edit Contact
+```
+
+## Road Map
+
+* Add configuration for showing individual resource name/title as breadcrumb (e.g. "Ada Lovelace") anchor text rather than resource type name (e.g. "Contact")
+* Integration for Rails
+* A simple means of configuration for things like:
+  * Turning on and off specific routes
+  * Setting breadcrumb styles (maybe provide an option for a different framework like Foundation, or just provide a few different styling presets)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nerboda/easy_breadcrumbs.
+
+
+## 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 "easy_breadcrumbs"
+
+# 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

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/easy_breadcrumbs.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_breadcrumbs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_breadcrumbs"
+  spec.version       = EasyBreadcrumbs::VERSION
+  spec.authors       = ["Eliathah Boda"]
+  spec.email         = ["nerboda@gmail.com"]
+
+  spec.summary       = %q{Automatically add bootstrap breadcrumbs to your Sinatra app.}
+  spec.description   = %q{Provides an `easy_breadcrumbs` view helper for automatically generating bootstrap breadcrumbs for your Sinatra Application.}
+  spec.homepage      = ""
+  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 "sinatra"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "erubis"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack-test"
+end

data/lib/assets/breadcrumbs.eruby

@@ -0,0 +1,14 @@
+<ol class="breadcrumb">
+  <% if @links.empty? %>
+  <li class="breadcrumb-item active">Home</li>
+  <% else %>
+  <li class="breadcrumb-item"><a href="/">Home</a></li>
+  <% end %>
+<% @links.each do |link| %>
+  <% if link.path == @links.last.path %>
+  <li class="breadcrumb-item active"><%= link.text %></li>
+  <% else %>
+  <li class="breadcrumb-item"><a href="<%= link.path %>"><%= link.text %></a></li>
+  <% end %>
+<% end %>
+</ol>

data/lib/easy_breadcrumbs.rb

@@ -0,0 +1,26 @@
+require 'sinatra/base'
+require 'easy_breadcrumbs/version'
+require 'easy_breadcrumbs/breadcrumb'
+
+module Sinatra
+  include ::EasyBreadcrumbs
+
+  module EasyBreadcrumbs
+    Breadcrumb = ::EasyBreadcrumbs::Breadcrumb
+
+    def easy_breadcrumbs
+      # Path from current Rack::Request object
+      request_path = request.path
+
+      # All GET request routes
+      route_matchers = self.class.routes['GET'].map { |route| route[0] }
+
+      # The rest is handled by Breadcrumb class
+      breadcrumb = Breadcrumb.new(request_path, route_matchers)
+      breadcrumb.to_html
+    end
+  end
+
+  # Register helper with Sinatra::Application
+  helpers EasyBreadcrumbs
+end

data/lib/easy_breadcrumbs/breadcrumb.rb

@@ -0,0 +1,76 @@
+require 'erubis'
+require 'active_support/inflector/methods'
+
+module EasyBreadcrumbs
+  # Breadcrumb class. Converts a URL path into Bootstrap breadcrumbs
+  class Breadcrumb
+    include ActiveSupport::Inflector
+
+    def initialize(request_path, route_matchers, options = {})
+      @configuration = options
+      @routes = route_matchers
+      @directories = request_path.scan(%r{\/[^\/]+})
+      @links = []
+
+      build_links!
+    end
+
+    def to_html
+      path = File.expand_path('../../assets/breadcrumbs.eruby', __FILE__)
+      template = File.read(path)
+
+      eruby = Erubis::Eruby.new(template)
+      eruby.result(binding)
+    end
+
+    private
+
+    Link = Struct.new(:path, :text)
+
+    def build_links!
+      @directories.each_with_index do |directory, index|
+        full_path = @directories[0..index].join
+
+        if defined_route?(full_path)
+          anchor_text = to_anchor_text(directory, index)
+          @links << Link.new(full_path, anchor_text)
+        end
+      end
+    end
+
+    def to_anchor_text(directory, index)
+      if directory =~ /\d/
+        format_for_specific_resource(index)
+      elsif %w(/edit /new).include?(directory)
+        format_with_view_prefix(directory, index)
+      else
+        clean_and_capitalize(directory)
+      end
+    end
+
+    def format_for_specific_resource(index)
+      previous_directory = @directories[index - 1]
+      text_for_anchor = clean_and_capitalize(previous_directory)
+      singularize(text_for_anchor)
+    end
+
+    def format_with_view_prefix(directory, index)
+      previous_index = directory == "/edit" ? index - 2 : index - 1
+      previous_directory = @directories[previous_index]
+      
+      view_prefix = clean_and_capitalize(directory)
+      rest_of_anchor = clean_and_capitalize(previous_directory)
+      singularized = singularize(rest_of_anchor)
+      
+      "#{view_prefix} #{singularized}"
+    end
+
+    def clean_and_capitalize(directory)
+      directory.delete('/').capitalize
+    end
+
+    def defined_route?(path)
+      @routes.any? { |route| path =~ route }
+    end
+  end
+end

data/lib/easy_breadcrumbs/version.rb

@@ -0,0 +1,3 @@
+module EasyBreadcrumbs
+  VERSION = "0.4.0"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: easy_breadcrumbs
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Eliathah Boda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: Provides an `easy_breadcrumbs` view helper for automatically generating
+  bootstrap breadcrumbs for your Sinatra Application.
+email:
+- nerboda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy_breadcrumbs.gemspec
+- lib/assets/breadcrumbs.eruby
+- lib/easy_breadcrumbs.rb
+- lib/easy_breadcrumbs/breadcrumb.rb
+- lib/easy_breadcrumbs/version.rb
+homepage: ''
+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.8
+signing_key: 
+specification_version: 4
+summary: Automatically add bootstrap breadcrumbs to your Sinatra app.
+test_files: []