loaf 0.5.0 → 0.6.0

data/gemfiles/rails5.0.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "ammeter", "~> 1.1.4"
+gem "appraisal", "~> 2.2.0"
+gem "yard", "~> 0.9.9"
+gem "capybara", "~> 2.15.4"
+gem "rspec-rails", "~> 3.6.1"
+gem "nokogiri", "~> 1.6.8"
+gem "public_suffix", "~> 2.0.5"
+gem "sqlite3", "~> 1.3.13", platforms: :ruby
+gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.23", platforms: :jruby
+gem "rails", "~> 5.0.6"
+
+group :metrics do
+  gem "coveralls", "0.8.17"
+  gem "simplecov", "~> 0.12.0"
+  gem "yardstick", "~> 0.9.9"
+end
+
+gemspec path: "../"

data/gemfiles/rails5.1.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "ammeter", "~> 1.1.4"
+gem "appraisal", "~> 2.2.0"
+gem "yard", "~> 0.9.9"
+gem "capybara", "~> 2.15.4"
+gem "rspec-rails", "~> 3.6.1"
+gem "nokogiri", "~> 1.6.8"
+gem "public_suffix", "~> 2.0.5"
+gem "sqlite3", "~> 1.3.13", platforms: :ruby
+gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.23", platforms: :jruby
+gem "rails", "~> 5.1.4"
+
+group :metrics do
+  gem "coveralls", "0.8.17"
+  gem "simplecov", "~> 0.12.0"
+  gem "yardstick", "~> 0.9.9"
+end
+
+gemspec path: "../"

data/lib/loaf.rb

@@ -1,15 +1,5 @@
-# encoding: utf-8
-
-require 'loaf/configuration'
-require 'loaf/errors'
-require 'loaf/railtie'
-require 'loaf/crumb'
-require 'loaf/builder'
-require 'loaf/translation'
-require 'loaf/controller_extensions'
-require 'loaf/view_extensions'
-require 'loaf/crumb_formatter'
-require 'loaf/options_validator'
+require_relative 'loaf/configuration'
+require_relative 'loaf/railtie'
 
 module Loaf
   # Set global configuration
@@ -34,14 +24,4 @@ module Loaf
   def self.configure
     yield configuration
   end
-
-  if defined? Rails::Railtie
-    require 'loaf/railtie'
-  else
-    autoload :ControllerExtensions, 'loaf/controller_extensions'
-    autoload :Helpers, 'loaf/view_extensions'
-
-    ::ActionController::Base.send :include, Loaf::ControllerExtensions
-    ::ActionController::Base.helper Loaf::ViewExtensions
-  end
 end # Loaf

data/lib/loaf/breadcrumb.rb

@@ -0,0 +1,30 @@
+module Loaf
+  # A container for breadcrumb values
+  #  @api public
+  class Breadcrumb
+    attr_reader :name
+
+    attr_reader :path
+    alias url path
+
+    def self.[](*args)
+      new(*args)
+    end
+
+    def initialize(name, path, current)
+      @name = name
+      @path = path
+      @current = current
+      freeze
+    end
+
+    def current?
+      @current
+    end
+
+    def to_ary
+      [@name, @path, @current]
+    end
+    alias to_a to_ary
+  end # Breadcrumb
+end # Loaf

data/lib/loaf/configuration.rb

@@ -1,15 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Loaf
   class Configuration
     VALID_ATTRIBUTES = [
       :locales_path,
-      :style_classes,
       :crumb_length,
-      :last_crumb_linked,
-      :capitalize,
-      :root
-    ]
+      :capitalize
+    ].freeze
 
     attr_accessor(*VALID_ATTRIBUTES)
 
@@ -28,9 +25,11 @@ module Loaf
     # Setup this configuration
     #
     # @api public
-    def initialize
+    def initialize(attributes = {})
       VALID_ATTRIBUTES.each do |attr|
-        send("#{attr}=", self.class.const_get("DEFAULT_#{attr.to_s.upcase}"))
+        default = self.class.const_get("DEFAULT_#{attr.to_s.upcase}")
+        attr_value = attributes.fetch(attr) { default }
+        send("#{attr}=", attr_value)
       end
     end
 

data/lib/loaf/controller_extensions.rb

@@ -1,4 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative 'crumb'
 
 module Loaf
   module ControllerExtensions
@@ -19,16 +21,23 @@ module Loaf
       # @api public
       def breadcrumb(name, url, options = {})
         normalizer = method(:_normalize_name)
-        before_filter(options) do |instance|
+        send(_filter_name, options) do |instance|
           normalized_name = normalizer.call(name, instance)
           normalized_url  = normalizer.call(url, instance)
           instance.send(:breadcrumb, normalized_name, normalized_url, options)
         end
       end
-      alias_method :add_breadcrumb, :breadcrumb
+      alias add_breadcrumb breadcrumb
 
       private
 
+      # Choose available filter name
+      #
+      # @api private
+      def _filter_name
+        respond_to?(:before_action) ? :before_action : :before_filter
+      end
+
       # @api private
       def _normalize_name(name, instance)
         case name
@@ -42,24 +51,6 @@ module Loaf
     end # ClassMethods
 
     module InstanceMethods
-      # Add collection of nested breadcrumbs.
-      # * <tt>collection</tt> - required collection of object for iteration
-      # * <tt>field</tt> - required object attribute name
-      #
-      def add_breadcrumbs(collection, field, options = {})
-        namespace = nil
-        item_set = if _check_if_nested collection
-           items = collection.pop
-           namespace = collection
-           items
-        else
-          collection
-        end
-        item_set.each do |item|
-          add_breadcrumb item.send(field.to_sym), [ namespace, item ].flatten.compact
-        end
-      end
-
       # Add breadcrumb in controller as instance method
       #
       # @param [String] name
@@ -70,7 +61,7 @@ module Loaf
       def breadcrumb(name, url, options = {})
         _breadcrumbs << Loaf::Crumb.new(name, url, options)
       end
-      alias_method :add_breadcrumb, :breadcrumb
+      alias add_breadcrumb breadcrumb
 
       # Collection of breadcrumbs
       #
@@ -85,12 +76,6 @@ module Loaf
       def clear_breadcrumbs
         _breadcrumbs.clear
       end
-
-      private
-
-      def _check_if_nested(collection)
-        collection.last.is_a? Array
-      end
     end # InstanceMethods
   end # ControllerExtensions
 end # Loaf

data/lib/loaf/crumb.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Loaf
   # Basic crumb container
@@ -7,12 +7,13 @@ module Loaf
 
     attr_reader :url
 
-    attr_reader :force
+    attr_reader :match
 
     def initialize(name, url, options = {})
       @name  = name
       @url   = url
-      @force = options.fetch(:force) { false }
+      @match = options.delete(:match) { :inclusive }
+      freeze
     end
-  end
+  end # Crumb
 end # Loaf

data/lib/loaf/crumb_formatter.rb

@@ -1,4 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative 'translation'
 
 module Loaf
   # A mixin for formatting crumb name

data/lib/loaf/errors.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Loaf #:nodoc:
-
   # Default Loaf error for all custom errors.
   #
   class LoafError < StandardError
@@ -28,5 +27,4 @@ module Loaf #:nodoc:
       )
     end
   end
-
 end # Loaf

data/lib/loaf/options_validator.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'loaf/errors'
+require_relative 'errors'
 
 module Loaf
   # A mixin to validate configuration options

data/lib/loaf/railtie.rb

@@ -3,27 +3,33 @@
 require 'action_controller'
 require 'action_view'
 
-module Loaf
-  if defined? Rails::Railtie
-    class Railtie < Rails::Railtie
-      initializer "loaf.extend_action_controller_base" do |app|
-        ActiveSupport.on_load :action_controller do
-          Loaf::Railtie.insert_controller
-          Loaf::Railtie.insert_view
-        end
-      end
-    end
-  end
+require_relative 'controller_extensions'
+require_relative 'view_extensions'
 
-  class Railtie
+module Loaf
+  class RailtieHelpers
     class << self
       def insert_view
         ActionController::Base.helper Loaf::ViewExtensions
       end
+
       def insert_controller
         ActionController::Base.send :include, Loaf::ControllerExtensions
       end
     end
-  end # Railtie
+  end # RailtieHelpers
 
+  if defined?(Rails::Railtie)
+    class Railtie < Rails::Railtie
+      initializer "loaf.extend_action_controller_base" do |app|
+        ActiveSupport.on_load :action_controller do
+          Loaf::RailtieHelpers.insert_controller
+          Loaf::RailtieHelpers.insert_view
+        end
+      end
+    end
+  else
+    Loaf::RailtieHelpers.insert_controller
+    Loaf::RailtieHelpers.insert_view
+  end
 end # Loaf

data/lib/loaf/translation.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Loaf
   module Translation

data/lib/loaf/version.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Loaf
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end # Loaf

data/lib/loaf/view_extensions.rb

@@ -1,7 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'loaf/crumb_formatter'
-require 'loaf/options_validator'
+require_relative 'breadcrumb'
+require_relative 'crumb'
+require_relative 'crumb_formatter'
+require_relative 'options_validator'
 
 module Loaf
   # A mixin to define view extensions
@@ -36,37 +38,86 @@ module Loaf
     def breadcrumb(name, url, options = {})
       _breadcrumbs << Loaf::Crumb.new(name, url, options)
     end
-    alias_method :add_breadcrumb, :breadcrumb
+    alias add_breadcrumb breadcrumb
 
     # Renders breadcrumbs inside view.
     #
     # @param [Hash] options
     #
     # @api public
-    def breadcrumbs(options = {}, &block)
-      # builder = Loaf::Builder.new(options)
-      return enum_for(:breadcrumbs) unless block_given?
+    def breadcrumb_trail(options = {})
+      return enum_for(:breadcrumb_trail) unless block_given?
+
       valid?(options)
       options = Loaf.configuration.to_hash.merge(options)
       _breadcrumbs.each do |crumb|
-        name   = format_name(crumb.name, options)
-        url    = url_for(_process_url_for(crumb.url))
-        styles = ''
-        if current_page?(url) || crumb.force
-          styles << "#{options[:style_classes]}"
-        end
-        block.call(name, url, styles)
+        name = format_name(crumb.name, options)
+        path = url_for(_expand_url(crumb.url))
+        current = current_crumb?(path, crumb.match)
+
+        yield(Loaf::Breadcrumb[name, path, current])
+      end
+    end
+
+    # Check if breadcrumb is current based on the pattern
+    #
+    # @param [String] path
+    # @param [Object] pattern
+    #   the pattern to match on
+    #
+    # @api public
+    def current_crumb?(path, pattern = :inclusive)
+      return false unless request.get? || request.head?
+
+      origin_path = URI.parser.unescape(path).force_encoding(Encoding::BINARY)
+
+      request_uri = request.fullpath
+      request_uri = URI.parser.unescape(request_uri)
+      request_uri.force_encoding(Encoding::BINARY)
+
+      # strip away trailing slash
+      if origin_path.start_with?('/') && origin_path != '/'
+        origin_path.chomp!('/')
+        request_uri.chomp!('/')
+      end
+
+      if %r{^\w+://} =~ origin_path
+        origin_path.chomp!('/')
+        request_uri.insert(0, "#{request.protocol}#{request.host_with_port}")
+      end
+
+      case pattern
+      when :inclusive
+        !request_uri.match(/^#{Regexp.escape(origin_path)}(\/.*|\?.*)?$/).nil?
+      when :exclusive
+        !request_uri.match(/^#{Regexp.escape(origin_path)}\/?(\?.*)?$/).nil?
+      when :exact
+        request_uri == origin_path
+      when :force
+        true
+      when Regexp
+        !request_uri.match(pattern).nil?
+      when Hash
+        query_params = URI.encode_www_form(pattern)
+        !request_uri.match(/^#{Regexp.escape(origin_path)}\/?(\?.*)?.*?#{query_params}.*$/).nil?
+      else
+        raise ArgumentError, "Unknown `:#{pattern}` match option!"
       end
     end
 
     private
 
+    # Expand url in the current context of the view
+    #
     # @api private
-    def _process_url_for(url)
-      if url.is_a?(String) || url.is_a?(Symbol)
-        return respond_to?(url) ? send(url) : url
+    def _expand_url(url)
+      case url
+      when String, Symbol
+        respond_to?(url) ? send(url) : url
+      when Proc
+        url.call(self)
       else
-        return url
+        url
       end
     end
   end # ViewExtensions