easy_breadcrumbs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcf9be5056635f695ed430f771d5ca29e4246a22
-  data.tar.gz: 32c198b059cad879a487b54ff286c29b53451bf1
+  metadata.gz: da48440d6066a1f709e0f1a08d3e2e845c0351eb
+  data.tar.gz: f9bf00269eb7de2c967d2874c4eecb25c005654c
 SHA512:
-  metadata.gz: e55a3be879f425b60a06f768171ce920dd644f11043b34cec8c99e31a2a9c07761bc77f45e9e39ab97c1ef30674834359f80d7d7fac2e1d3fae1c95a476dff1a
-  data.tar.gz: c584c9494c1eca7fd9b53ce63cdce7b723106cbb80397ee0f34891a34214b99a4f2effd6a710fe3990a240f1ac52510249eb523657c425658fdfdb0dcfc5d883
+  metadata.gz: 1f9b9fb5ee030f4912922587912733d3c6a37c8610210d160ac8c020d41e5a617ee24e1e842ae25c11a55fcfb55f2fe8e66299c0b30d2c3b16df47cc47ac09c7
+  data.tar.gz: 2941b856493d0e4c3f1ca38c6eb77cee6c3d6f33e9d9bce665f30e352b7d745980211b03eebd6d9de8a6f099ae319018c25b041827c1a14a7bd777d978faa6dd

data/README.md

@@ -4,6 +4,7 @@ Provides an `easy_breadcrumbs` view helper for automatically generating bootstra
 
 * 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.
+* It can automatically detect certain name attributes for specific resources.
 
 ## Installation
 
@@ -53,7 +54,27 @@ And last but not least, make sure you have bootstrap installed. You can install
 
 ## Details
 
-Easy Breadcrumbs is able to handle a variety of complex routes. Here are some examples:
+**NEW: Auto Name Detection**
+
+Easy Breadcrumbs can now detect names for specific resources.
+```
+Path: /contacts/10
+Old Breadcrumb Format: Home > Contacts > Contact
+New Breadcrumb Format: Home > Contacts > Ada Lovelace
+```
+
+It's able to detect the name with the following limitations:
+  * The resource is either a Hash or a Custom object
+  * The resource has a key (Hash) or accessor method (custom object) of one of the following 3 commonly used name attributes:
+    * :name
+    * :title
+    * :subject
+
+If this condition fails, it will default to the old format.
+
+**Easy Breadcrumbs is able to handle a variety of complex routes.**
+
+Here are some examples:
 
 ### Simple path to page
 ```
@@ -111,11 +132,13 @@ 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)
+* Allow for custom configuration of name attributes for resources
+  * Should be able to do something like `set :easy_breadcrumbs, user: :name, post: :title`
+* More robust spec suite
+  * Explore more edge cases for both unit and integration tests
+  * Eliminate repetition in specs
+  * Other development gems that would help with this?
+* Update gemspec with depencency version restrictions and bump gem version to 1.0
 
 ## Contributing
 

data/easy_breadcrumbs.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   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.homepage      = "https://github.com/nerboda/easy_breadcrumbs"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/assets/breadcrumbs.eruby

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

data/lib/easy_breadcrumbs.rb

@@ -1,23 +1,57 @@
 require 'sinatra/base'
 require 'easy_breadcrumbs/version'
-require 'easy_breadcrumbs/breadcrumb'
+require 'easy_breadcrumbs/breadcrumbs'
 
 module Sinatra
   include ::EasyBreadcrumbs
 
   module EasyBreadcrumbs
-    Breadcrumb = ::EasyBreadcrumbs::Breadcrumb
+    Breadcrumbs = ::EasyBreadcrumbs::Breadcrumbs
 
     def easy_breadcrumbs
-      # Path from current Rack::Request object
+      breadcrumb = Breadcrumbs.new(config)
+      breadcrumb.to_html
+    end
+
+    private
+
+    EXCLUDED_VARS = [:@default_layout, :@preferred_extension,
+                     :@app, :@template_cache, :@template_cache,
+                     :@env, :@request, :@response, :@params]
+
+    Configuration = Struct.new(:request_path, :route_matchers, :view_variables)
+
+    def config
+      # The name of the current Sinatra Application
+      app = self.class
+
+      # The Rack::Request object
       request_path = request.path
 
-      # All GET request routes
-      route_matchers = self.class.routes['GET'].map { |route| route[0] }
+      # All defined GET request routes
+      route_matchers = app.routes['GET'].map { |route| route[0] }
 
-      # The rest is handled by Breadcrumb class
-      breadcrumb = Breadcrumb.new(request_path, route_matchers)
-      breadcrumb.to_html
+      Configuration.new(request_path, route_matchers, view_variables)
+    end
+
+    # All user defined instance variables for current request.
+    def view_variables
+      instance_variables
+        .select { |var| additional_var?(var) }
+        .map { |var| fetch_ivar_value(var) }
+    end
+
+    # Walk through all instance variables and fetch value.
+    def fetch_ivar_value(var)
+      name = var.to_s.delete('@').to_sym
+      value = instance_eval(var.to_s)
+
+      { name: name, value: value }
+    end
+
+    # Ignore pre-existing Sinatra instance variables.
+    def additional_var?(var)
+      !EXCLUDED_VARS.include?(var)
     end
   end
 

data/lib/easy_breadcrumbs/auto_detect.rb

@@ -0,0 +1,27 @@
+module EasyBreadcrumbs
+  module AutoDetect
+    COMMON_NAME_ATTRIBUTES = %i[name title subject]
+
+    def detect_name(resource)
+      name_attribute = find_common_accessor_method(resource)
+      return resource[name_attribute] if name_attribute
+
+      name_attribute = find_common_hash_symbol(resource)
+      return resource[name_attribute] if name_attribute
+    end
+
+    private
+
+    def find_common_accessor_method(resource)
+      COMMON_NAME_ATTRIBUTES.find do |method|
+        resource.respond_to?(method)
+      end
+    end
+
+    def find_common_hash_symbol(resource)
+      COMMON_NAME_ATTRIBUTES.find do |method|
+        resource.key?(method)
+      end
+    end
+  end
+end

data/lib/easy_breadcrumbs/breadcrumb.rb

@@ -1,76 +1,57 @@
-require 'erubis'
 require 'active_support/inflector/methods'
+require_relative 'auto_detect'
 
 module EasyBreadcrumbs
-  # Breadcrumb class. Converts a URL path into Bootstrap breadcrumbs
+  # Breadcrumb class properly formats it's data depending on:
+  # => Where within the set of breadcrumbs it falls
+  # => Whether it's a path to a specific resource
+  # => Whether it's a path to a `new` or `edit` view
   class Breadcrumb
     include ActiveSupport::Inflector
+    include AutoDetect
 
-    def initialize(request_path, route_matchers, options = {})
-      @configuration = options
-      @routes = route_matchers
-      @directories = request_path.scan(%r{\/[^\/]+})
-      @links = []
+    attr_reader :path, :text
 
-      build_links!
-    end
-
-    def to_html
-      path = File.expand_path('../../assets/breadcrumbs.eruby', __FILE__)
-      template = File.read(path)
+    def initialize(directories, directory)
+      @directories = directories
+      @directory = directory
 
-      eruby = Erubis::Eruby.new(template)
-      eruby.result(binding)
+      @path = directory.full_path
+      @text = format_anchor_text
     end
 
     private
 
-    Link = Struct.new(:path, :text)
+    attr_reader :directories, :directory
 
-    def build_links!
-      @directories.each_with_index do |directory, index|
-        full_path = @directories[0..index].join
+    def format_anchor_text
+      return specific_resource if directory.ends_in_digit?
+      return with_view_prefix if directory.new_or_edit_view?
 
-        if defined_route?(full_path)
-          anchor_text = to_anchor_text(directory, index)
-          @links << Link.new(full_path, anchor_text)
-        end
-      end
+      directory.name.capitalize
     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)
+    def specific_resource
+      previous_directory = other_directory(-1)
+
+      if previous_directory.resource
+        detect_name(previous_directory.resource)
       else
-        clean_and_capitalize(directory)
+        singularize(previous_directory.name).capitalize
       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 with_view_prefix
+      relative_index = directory.edit_view? ? -2 : -1
+      previous_directory = other_directory(relative_index)
+      view_prefix = directory.name.capitalize
+      rest_of_anchor = singularize(previous_directory.name).capitalize
 
-    def clean_and_capitalize(directory)
-      directory.delete('/').capitalize
+      "#{view_prefix} #{rest_of_anchor}"
     end
 
-    def defined_route?(path)
-      @routes.any? { |route| path =~ route }
+    def other_directory(relative_index)
+      directories[directory.index + relative_index]
     end
   end
 end

data/lib/easy_breadcrumbs/breadcrumbs.rb

@@ -0,0 +1,72 @@
+require 'erubis'
+require 'active_support/inflector/methods'
+
+require_relative 'breadcrumb'
+require_relative 'directory'
+
+module EasyBreadcrumbs
+  # Breadcrumbs class: Converts a URL path into Bootstrap breadcrumbs.
+  class Breadcrumbs
+    include ActiveSupport::Inflector
+
+    TEMPLATE = 'breadcrumbs.eruby'.freeze
+
+    def initialize(configuration)
+      @view_variables = configuration.view_variables
+      @routes = configuration.route_matchers
+      @path = configuration.request_path
+
+      @directories = []
+      @breadcrumbs = []
+
+      build_directories!
+      build_breadcrumbs!
+    end
+
+    def to_html
+      path = File.expand_path('../../assets/' + TEMPLATE, __FILE__)
+      template = File.read(path)
+      eruby = Erubis::Eruby.new(template)
+
+      eruby.result(binding)
+    end
+
+    private
+
+    attr_reader :view_variables, :routes, :path,
+                :directories, :breadcrumbs
+
+    def build_directories!
+      parsed = path.scan(%r{\/[^\/]+})
+
+      parsed.map.with_index do |current, index|
+        full_path = parsed[0..index].join
+        name = current.delete('/')
+        resource = fetch_variable_value(name)
+
+        data = { full_path: full_path, name: name,
+                 resource: resource, index: index }
+
+        @directories << Directory.new(data)
+      end
+    end
+
+    def build_breadcrumbs!
+      directories.each do |directory|
+        next unless defined_route?(directory.full_path)
+        @breadcrumbs << Breadcrumb.new(directories, directory)
+      end
+    end
+
+    def defined_route?(path)
+      routes.any? { |route| path =~ route }
+    end
+
+    def fetch_variable_value(resource_name)
+      symbol = singularize(resource_name).to_sym
+      variable = view_variables.find { |var| var[:name] == symbol }
+
+      variable[:value] if variable
+    end
+  end
+end

data/lib/easy_breadcrumbs/directory.rb

@@ -0,0 +1,33 @@
+module EasyBreadcrumbs
+  # Directory class makes things easier on the Breadcrumb class.
+  class Directory
+    attr_reader :full_path, :name, :index, :resource
+
+    def initialize(data)
+      @full_path = data.fetch(:full_path)
+      @name = data.fetch(:name)
+      @resource = data.fetch(:resource)
+      @index = data.fetch(:index)
+    end
+
+    def root_path?
+      index.zero?
+    end
+
+    def ends_in_digit?
+      name =~ %r{\d+\/?$}
+    end
+
+    def new_view?
+      name == 'new'
+    end
+
+    def edit_view?
+      name == 'edit'
+    end
+
+    def new_or_edit_view?
+      new_view? || edit_view?
+    end
+  end
+end

data/lib/easy_breadcrumbs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_breadcrumbs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Eliathah Boda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -128,9 +128,12 @@ files:
 - easy_breadcrumbs.gemspec
 - lib/assets/breadcrumbs.eruby
 - lib/easy_breadcrumbs.rb
+- lib/easy_breadcrumbs/auto_detect.rb
 - lib/easy_breadcrumbs/breadcrumb.rb
+- lib/easy_breadcrumbs/breadcrumbs.rb
+- lib/easy_breadcrumbs/directory.rb
 - lib/easy_breadcrumbs/version.rb
-homepage: ''
+homepage: https://github.com/nerboda/easy_breadcrumbs
 licenses:
 - MIT
 metadata: {}