ducktrails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbf690b1296a9de6e0cf9e70843900c366836428
+  data.tar.gz: b69671826c7dd007ef7688647a1c65d406625eea
+SHA512:
+  metadata.gz: fb63bd77873ac042ec08435c11e2a68ea0cac911bf20e3c8a5fd1ffe8e4e34b4d9776324978c12c9d22542401bd990006a3989d108abce45b9c623e8c989db77
+  data.tar.gz: c054b643724161eccb18480ece94c1da7efa41fecc3167befb96c11a06467c037eb2550300c82e55e4d86261bcf77a4128ef852942fc0ab83610c6758df9e72b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Kevin Brown
+
+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,52 @@
+# 🦆 Ducktrails
+
+Automatically generates breadcrumbs based on routes.
+
+**Warning: This API is still alpha; we welcome PRs and ideas as issues.**
+
+[![Ducktails Theme](http://i.imgur.com/g0PXjHX.png)](https://www.youtube.com/watch?v=CMU2NwaaXEA "Ducktails Theme")
+
+## Usage
+For basic applications using a restful architecture, ducktrails should generate the breadcrumbs automatically.
+
+For example, if the uri is `/users/#{user-id}/posts/#{post-id}`
+
+Would render:
+
+`Home / All Users / user-name / All Posts / post-name`
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ducktrails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ducktrails
+```
+
+## Contributing
+
+Please refer to each project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
+
+1. Fork the repo on GitHub
+2. Clone the project to your own machine
+  1. `bundle`
+  2. Create the test db `bundle exec rake --rakefile test/dummy/Rakefile db:setup`
+  3. `bundle exec rake` to test.
+3. Ensure your test coverage is A+
+4. Commit changes to your own branch
+5. Push your work back up to your fork
+6. Submit a Pull request so that we can review your changes
+
+NOTE: **Be sure to merge the latest from "upstream" before making a pull request!**
+
+## 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,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+
+task default: :test

data/app/config/routes.rb

@@ -0,0 +1,2 @@
+Ducktrails::Engine.routes.draw do
+end

data/app/views/ducktrails/_breadcrumber.html.erb

@@ -0,0 +1,10 @@
+<div class="breadcrumb-container">
+  <div class="container">
+    <ol class="breadcrumb">
+      <li><%= home_crumb %></li>
+      <% links.each do |link| %>
+        <%= render partial: 'ducktrails/crumb_link', locals: { link: link } %>
+      <% end %>
+    </ol>
+  </div>
+</div>

data/app/views/ducktrails/_crumb_link.html.erb

@@ -0,0 +1,3 @@
+<li>
+  <%= link_to(link[:text], link[:uri]) %>
+</li>

data/lib/ducktrails/concerns/configurable.rb

@@ -0,0 +1,12 @@
+module Configurable
+  include ActiveSupport::Concern
+  private
+
+  def collection_prefix
+    "#{Ducktrails.config.collection_prefix} "
+  end
+
+  def home_name
+    Ducktrails.config.home_name
+  end
+end

data/lib/ducktrails/config.rb

@@ -0,0 +1,44 @@
+require 'active_support/configurable'
+
+module Ducktrails
+  # Configures global settings for Ducktrails
+  #   Ducktrails.configure do |config|
+  #     config.default_per_page = 10
+  #   end
+  def self.configure(&block)
+    yield @config ||= Ducktrails::Configuration.new
+  end
+
+  # Global settings for Ducktrails
+  def self.config
+    @config
+  end
+
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :root_path
+    config_accessor :home_name
+    # TODO: How to set this?
+    config_accessor :collection_prefix
+    config_accessor :default_key
+    config_accessor :fallback_to_uri
+    config
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
+    end
+
+    # define param_name writer (copied from AS::Configurable)
+    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    singleton_class.class_eval writer, __FILE__, line
+    class_eval writer, __FILE__, line
+  end
+
+  # this is ugly. why can't we pass the default value to config_accessor...?
+  configure do |config|
+    config.root_path = '/'
+    config.home_name = 'Home'
+    config.collection_prefix = 'All'
+    config.default_key = :id
+    config.fallback_to_uri = true
+  end
+end

data/lib/ducktrails/engine.rb

@@ -0,0 +1,6 @@
+module Ducktrails
+  class Engine < ::Rails::Engine
+    isolate_namespace Ducktrails
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+  end
+end

data/lib/ducktrails/link_collection.rb

@@ -0,0 +1,110 @@
+require 'concerns/configurable'
+
+DEFAULTS = {
+  key: :name,
+  policy: true
+}
+
+module Ducktrails
+  class LinkCollection < Array
+    include Configurable
+
+    attr_accessor :resources, :current_uri, :request
+
+    def initialize(resources, current_uri, request)
+      @resources ||= set_default_resources(resources)
+      @current_uri ||= current_uri
+      @request ||= request
+    end
+
+    def links
+      build_links
+    end
+
+    private
+
+    # All the logic to build the links
+    # Should render an index & show if action is show
+    # Should render an index & new/edit if action is new/edit
+    # Should render an index as _current_page if action is index
+    # If resources are empty, generate breadcrumbs from the uri?
+    def build_links
+      return generate_uri_breadcrumbs if Ducktrails.config.fallback_to_uri
+      raise 'Please provide block configuration for breadcrumbs.'
+    end
+
+    def generate_uri_breadcrumbs
+      split_uri.inject([]) do |links, uri_resource|
+        links << build_uri_link(uri_resource)
+      end.compact
+    end
+
+    def build_link(text, uri)
+      {
+        text: text,
+        uri: uri
+      }
+    end
+
+    def build_uri_link(uri_segment)
+      index = split_uri.index(uri_segment)
+      if resources[uri_segment.to_sym].present?
+        return unless resources[uri_segment.to_sym][:policy]
+        # Build resource link
+        # example /institutions/:institution_id/iterations/:id
+        build_link(text_link(resources[uri_segment.to_sym], index.odd?), split_uri[0..index].join('/').prepend('/'))
+      elsif index.odd? && resources[split_uri[index - 1].to_sym].present?
+        return unless resources[split_uri[index - 1].to_sym][:policy]
+        build_link(text_link(resources[split_uri[index - 1].to_sym], index.odd?), split_uri[0..index].join('/').prepend('/'))
+      else
+        # build links based off of uri
+        build_link(text_link(uri_segment.underscore.humanize, index.odd?), split_uri[0..index].join('/').prepend('/'))
+      end
+    end
+
+    # TODO factor out the resource & key to use config if key is nil
+    def text_link(resource, show_action = nil)
+      if resource.is_a?(String)
+        return resource if show_action
+        return resource.prepend(collection_prefix)
+      end
+
+      if resource[:resource].nil?
+        return request_pattern[:controller].split('/').last.underscore.humanize.pluralize.prepend(collection_prefix)
+      end
+
+      if show_action
+        return resource[:resource].send(resource[:key])
+      else
+        return resourcer(resource)
+      end
+    end
+
+    def resourcer(resource)
+      resource = resource[:resource].object if resource[:resource].respond_to?(:object)
+      resource.class.name.split('::').first.underscore.humanize.pluralize.prepend(collection_prefix)
+    end
+
+    def request_pattern
+      @request_pattern ||= Rails.application.routes.recognize_path(current_uri)
+    end
+
+    def split_uri
+      @split_uri ||= current_uri.split('/').reject(&:empty?)
+    end
+
+    def action
+      @action ||= request_pattern[:action]
+    end
+
+    def set_default_resources(yield_resources)
+      yield_resources.inject({}) do |resources, resource|
+        resources.merge(
+          {
+            resource[0] => DEFAULTS.merge(resource[1])
+          }
+        )
+      end
+    end
+  end
+end

data/lib/ducktrails/tags.rb

@@ -0,0 +1,23 @@
+module Ducktrails
+  class Tag
+    include ::ActionView::Context
+
+    def initialize(template, options = {})
+      @template = template
+      @options = options.dup
+      @params = template
+      @views_prefix = @options.delete(:views_prefix)
+    end
+
+    def to_s(locals = {})
+      @template.render partial_path, links: locals[:links]
+    end
+
+    def partial_path
+      [
+       'ducktrails',
+       self.class.name.demodulize.underscore
+      ].compact.join("/")
+    end
+  end
+end

data/lib/ducktrails/version.rb

@@ -0,0 +1,3 @@
+module Ducktrails
+  VERSION = '0.0.1'
+end

data/lib/ducktrails/view_helpers.rb

@@ -0,0 +1,47 @@
+require 'action_view'
+require 'action_view/context'
+require 'ducktrails/tags'
+
+module Ducktrails
+  module ViewHelpers
+    class Breadcrumber < Tag
+
+      def initialize(options = {})
+        @template = options[:template]
+        @output_buffer = ActionView::OutputBuffer.new
+      end
+
+      def render(&block)
+        @output_buffer
+      end
+    end
+
+    def breadcrumbs(options = {})
+      ducktrail_render(LinkCollection.new(yield, current_uri, current_request).links)
+    end
+
+    def home_crumb(options = {})
+      link_to(Ducktrails.config.home_name, '/')
+    end
+
+    private
+
+    def current_uri
+      request.fullpath
+    end
+
+    def current_request
+      request
+    end
+
+    def current_action
+      Rails.application.routes.recognize_path(current_uri)[:action]
+    end
+
+    def ducktrail_render(links)
+      @_ducktrail_render ||= Breadcrumber.new(template: self).to_s(links: links)
+    end
+  end
+
+  ActionView::Base.send :include, Ducktrails::ViewHelpers
+end

data/lib/ducktrails.rb

@@ -0,0 +1,22 @@
+module Ducktrails
+end
+
+begin
+  require 'rails'
+rescue LoadError
+  #do nothing
+end
+
+$stderr.puts <<-EOC if !defined?(Rails)
+warning: no framework detected.
+
+Your Gemfile might not be configured properly.
+---- e.g. ----
+Rails:
+    gem 'ducktrails'
+EOC
+
+require 'ducktrails/config'
+require 'ducktrails/engine'
+require 'ducktrails/tags'
+require 'ducktrails/view_helpers'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ducktrails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: RESTful breadcrumbs
+email:
+- chevinbrown@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/config/routes.rb
+- app/views/ducktrails/_breadcrumber.html.erb
+- app/views/ducktrails/_crumb_link.html.erb
+- lib/ducktrails.rb
+- lib/ducktrails/concerns/configurable.rb
+- lib/ducktrails/config.rb
+- lib/ducktrails/engine.rb
+- lib/ducktrails/link_collection.rb
+- lib/ducktrails/tags.rb
+- lib/ducktrails/version.rb
+- lib/ducktrails/view_helpers.rb
+homepage: http://github.com/proctoru/ducktrails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: 'Ducktrails: Breadcrumbs that are duckin'' awesome.'
+test_files: []