ducktrails 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbf690b1296a9de6e0cf9e70843900c366836428
-  data.tar.gz: b69671826c7dd007ef7688647a1c65d406625eea
+  metadata.gz: df465aae8845fba74f32ed951aee5d7cc9509e36
+  data.tar.gz: 0b7fc7bd4dd5b4a8241e398bad0e6760ed2d754b
 SHA512:
-  metadata.gz: fb63bd77873ac042ec08435c11e2a68ea0cac911bf20e3c8a5fd1ffe8e4e34b4d9776324978c12c9d22542401bd990006a3989d108abce45b9c623e8c989db77
-  data.tar.gz: c054b643724161eccb18480ece94c1da7efa41fecc3167befb96c11a06467c037eb2550300c82e55e4d86261bcf77a4128ef852942fc0ab83610c6758df9e72b
+  metadata.gz: d7c3328e29ba82ee8bab8d429d68d2db8649bc26857f7d163296967756ce6a9060fd9ad893a32314f7147b921da96af628b48a238cfe90114c09bf89b4b659d4
+  data.tar.gz: '02539d3d583729da538d27cefe76c9f83bb1fbc580bf8d8b782cef98cb1f85f7b4e4921ba3c2abfbf6ea895a0cf99efee4ce79cbc0f4aaecce8fed8b51da984c'

data/README.md

@@ -10,11 +10,40 @@ Automatically generates breadcrumbs based on routes.
 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}`
+Putting `<%= breadcrumbs %>` in the (erb) view.
 
 Would render:
 
 `Home / All Users / user-name / All Posts / post-name`
 
+Simply include `= breadcrumbs` in your view. `breadcrumbs` takes a block argument.  The block isn't required but if you want to set some objects for the uri resources (recommend) you can follow the guide below.
+
+Resources are inferred and will be used to manipulate each URI segment. If a resource is not found, Ducktrails will fallback to the URI.
+
+Possible keys for a breadcrumb resource are: `resource, key, policy, collection_prefix`. The key and collection prefix can be configured in the `Ducktrails.rb` initializer described below.
+
+```erb
+<%=breadcrumbs do
+    {
+      users: {
+        resource: @user,
+        key: :first_name,
+        collection_prefix: 'Some'
+      }
+    }
+  end
+%>
+```
+
+Will output
+
+Action | Breadcrumb
+---|---
+index |`Home / Some Users`
+show |`Home / Some Users / Kevin`
+new |`Home / Some Users / New`
+edit |`Home /Some Users / Kevin / edit`
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -32,6 +61,20 @@ Or install it yourself as:
 $ gem install ducktrails
 ```
 
+## Configuration
+Ducktrails provides a standard initializer file:
+**Note**: Currently `ducktrails` is the only template theme provided
+
+```ruby
+Ducktrails.configure do |config|
+  config.root_path = '/'
+  config.home_name = 'Home'
+  config.collection_prefix = 'All'
+  config.default_key = :id
+  config.theme = 'ducktrails'
+end
+```
+
 ## 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.

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

@@ -1,7 +1,9 @@
 <div class="breadcrumb-container">
   <div class="container">
     <ol class="breadcrumb">
-      <li><%= home_crumb %></li>
+      <li>
+        <%= link_to(Ducktrails.config.home_name, Ducktrails.config.root_path) %>
+      </li>
       <% links.each do |link| %>
         <%= render partial: 'ducktrails/crumb_link', locals: { link: link } %>
       <% end %>

data/lib/ducktrails.rb

@@ -1,4 +1,5 @@
 module Ducktrails
+  VALID_RESOURCES = %i(resource collection_prefix as policy key).freeze
 end
 
 begin

data/lib/ducktrails/config.rb

@@ -11,34 +11,24 @@ module Ducktrails
 
   # Global settings for Ducktrails
   def self.config
-    @config
+    @config ||= self.config
   end
 
-  class Configuration #:nodoc:
+  class Configuration
     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
+    config_accessor :theme,
+      :home_name,
+      :root_path,
+      :collection_prefix,
+      :default_key
   end
 
-  # this is ugly. why can't we pass the default value to config_accessor...?
   configure do |config|
-    config.root_path = '/'
+    config.theme = 'ducktrails'
     config.home_name = 'Home'
+    config.root_path = '/'
     config.collection_prefix = 'All'
     config.default_key = :id
-    config.fallback_to_uri = true
   end
 end

data/lib/ducktrails/link_collection.rb

@@ -3,108 +3,60 @@ require 'concerns/configurable'
 DEFAULTS = {
   key: :name,
   policy: true
-}
+}.freeze
 
 module Ducktrails
-  class LinkCollection < Array
+  class LinkCollection
     include Configurable
 
-    attr_accessor :resources, :current_uri, :request
+    attr_accessor :resources, :current_uri
 
-    def initialize(resources, current_uri, request)
-      @resources ||= set_default_resources(resources)
+    def initialize(resources, current_uri)
+      @resources ||= 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)
+        links << Resource.new(resources, uri_resource, current_uri)
+          .link
       end.compact
     end
 
-    def build_link(text, uri)
-      {
-        text: text,
-        uri: uri
-      }
-    end
+    private
 
-    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
+    def split_uri
+      @split_uri ||= current_uri.split('/').reject(&:empty?)
     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)
+    def default_resources(yield_resources = nil)
+      return {} if yield_resources.nil?
+      yield_resources.inject({}) do |resources, resource|
+        resource[1].assert_valid_keys(Ducktrails::VALID_RESOURCES)
+        @resource = resource[1]
+        resources.merge(
+          resource[0] => DEFAULTS.merge(sanitized_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?)
+    # Used to filter and sanitize decorated resources
+    def sanitized_resource
+      return @resource if @resource.is_a?(String)
+      return unobjectified_resource if resource_decorated?
+      @resource
     end
 
-    def action
-      @action ||= request_pattern[:action]
+    def unobjectified_resource
+      @resource[:resource] = @resource[:resource].object
+      @resource
     end
 
-    def set_default_resources(yield_resources)
-      yield_resources.inject({}) do |resources, resource|
-        resources.merge(
-          {
-            resource[0] => DEFAULTS.merge(resource[1])
-          }
-        )
-      end
+    def resource_decorated?
+      @resource[:resource].respond_to?(:decorated?) &&
+        @resource[:resource].decorated?
+    rescue NoMethodError
+      @resource
     end
   end
 end

data/lib/ducktrails/resource.rb

@@ -0,0 +1,116 @@
+require_relative 'utils/deep_struct'
+# TODO: below
+# 1. Too many conflicting name-spaces remaining from the first version
+# 2. Class doesn't do 1 thing
+# 3. Some redundancy between methods
+
+module Ducktrails
+  class Resource
+    include Configurable
+
+    attr_reader :resources, :resource, :current_uri
+
+    def initialize(resources, resource, current_uri)
+      @resources = DeepStruct.new(resources)
+      @resource = resource
+      @current_uri = current_uri
+    end
+
+    def link
+      # Build resource link
+      # example /institutions/:institution_id/iterations/:id
+      if resources.send(resource.to_sym).present?
+        return unless resources[resource.to_sym][:policy]
+        build_link(link_text(resources[resource.to_sym]))
+      elsif (show_action || new_action || edit_action) && current_resource.present?
+        return unless current_resource[:policy]
+        build_link(link_text(current_resource))
+      else
+        # build links based off of uri
+        build_link(link_text(resource.underscore.titleize))
+      end
+    rescue ActionController::RoutingError
+      nil
+    end
+
+    private
+
+    def split_uri
+      @split_uri ||= current_uri.split('/').reject(&:empty?)
+    end
+
+    def uri_index
+      split_uri.index(resource)
+    end
+
+    # TODO: Refactor this to use a resource given by the view_helpers?
+    def current_resource
+      resources[request_pattern[:controller].split('/').last.to_sym]
+    end
+
+    def build_link(text)
+      {
+        text: text,
+        uri: progressive_uri
+      }
+    end
+
+    def progressive_uri
+      split_uri[0..uri_index].join('/').prepend('/')
+    end
+
+    def link_text(resource)
+      return string_resource if resource.is_a?(String)
+
+      if resource.nil? || resource.resource.nil?
+        return resource.as.prepend(col_prefix) unless resource.resource.present? || resource.as.nil?
+        return controller_resource_title
+      end
+
+      case request_pattern(progressive_uri)[:action]
+      when 'show'
+        resource[:resource].send(resource[:key])
+      when 'edit'
+        'Edit ' + resource[:resource].send(resource[:key])
+      when 'new'
+        'New ' + resourcer(resource.try(:resource)).singularize
+      else
+        resourcer(resource.try(:resource))
+      end
+    end
+
+    def string_resource
+      return resource.titleize if show_action || edit_action || new_action
+      resource.titleize.prepend(col_prefix)
+    end
+
+    def resourcer(resource)
+      resource.class.name.split('::').first.underscore.titleize.pluralize.prepend(col_prefix)
+    end
+
+    def request_pattern(url = nil)
+      @request_pattern ||= Rails.application.routes.recognize_path(url || current_uri)
+    end
+
+    def controller_resource_title
+      return string_resource if request_pattern[:controller].split('/')[uri_index].nil?
+      request_pattern[:controller].split('/')[uri_index].underscore.titleize.pluralize.
+        prepend(col_prefix)
+    end
+
+    def col_prefix
+      return '' if new_action || edit_action
+      if resources[resource]&.collection_prefix.present?
+        resources[resource].collection_prefix.concat(' ')
+      else
+        collection_prefix
+      end
+    end
+
+    %w(index show edit new).each do |action_name|
+      define_method("#{action_name}_action") do
+        request_pattern(progressive_uri)[:action].eql?(action_name)
+      end
+    end
+  end
+end

data/lib/ducktrails/tags.rb

@@ -15,8 +15,8 @@ module Ducktrails
 
     def partial_path
       [
-       'ducktrails',
-       self.class.name.demodulize.underscore
+        Ducktrails.config.theme,
+        self.class.name.demodulize.underscore
       ].compact.join("/")
     end
   end

data/lib/ducktrails/utils/deep_struct.rb

@@ -0,0 +1,18 @@
+class DeepStruct < OpenStruct
+  def initialize(hash = nil)
+    @table = {}
+    @hash_table = {}
+
+    return unless hash
+    hash.each do |k, v|
+      @table[k.to_sym] = (v.is_a?(Hash) ? self.class.new(v) : v)
+      @hash_table[k.to_sym] = v
+
+      new_ostruct_member(k)
+    end
+  end
+
+  def to_h
+    @hash_table
+  end
+end

data/lib/ducktrails/version.rb

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

data/lib/ducktrails/view_helpers.rb

@@ -5,23 +5,18 @@ 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)
+    def breadcrumbs(&block)
+      resources = build_resource(&block)
+      ducktrail_render(LinkCollection.new(resources, current_uri).links)
     end
 
-    def home_crumb(options = {})
-      link_to(Ducktrails.config.home_name, '/')
+    def build_resource(&block)
+      block_given? ? yield : nil
     end
 
     private
@@ -30,10 +25,6 @@ module Ducktrails
       request.fullpath
     end
 
-    def current_request
-      request
-    end
-
     def current_action
       Rails.application.routes.recognize_path(current_uri)[:action]
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ducktrails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Kevin Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: mocha
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -62,7 +76,6 @@ 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
@@ -70,7 +83,9 @@ files:
 - lib/ducktrails/config.rb
 - lib/ducktrails/engine.rb
 - lib/ducktrails/link_collection.rb
+- lib/ducktrails/resource.rb
 - lib/ducktrails/tags.rb
+- lib/ducktrails/utils/deep_struct.rb
 - lib/ducktrails/version.rb
 - lib/ducktrails/view_helpers.rb
 homepage: http://github.com/proctoru/ducktrails

data/app/config/routes.rb

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