loaf 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cca72395f0a519e2c8e167a945f0a7aef2904405
-  data.tar.gz: 073bea2f84cbe624dc1b281eb945607be99ee091
+SHA256:
+  metadata.gz: 1345a409b2a725846ac573193095c6a53b398a23e87bcace96c0cc06d0ff1c27
+  data.tar.gz: 3f60d6a1921ead6fd51654aa2f3e80fbd85ee53955f9e3aa40cd850fd1d00a86
 SHA512:
-  metadata.gz: 1011debf785a3fa61247244b1db86937bba310dfc54621759eca9c1dd2d8e1eb7f6d88a7a67b5a2fd99795c26881cc365306aeb5b6f6ebe6267c7614e64f9731
-  data.tar.gz: 36daede4d09914f3a488f3dee1c0a1c5250fb0b2b3a8604d77a229d66cb464723d788b075ea553714d25faa7c06dd2a941cbd572e81589ca0e2565ec9ee4fdd6
+  metadata.gz: 7689bbb410e7b440ba0a4bec01ad93f17d4d42412913732f530e862c6abed8a4a4519bf0d1064566da2346c798e9c04673edf97c8e3e76543bc21cb7f041adc5
+  data.tar.gz: ee103f98f0a5ddde85c4594e3efafeebe76acfc316147524e6922dca990282fc334d626550091eec0a50d0bc14c35b7bdefd08be690001d977b86cbc81584d00

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log
 
+## [v0.8.0] - 2018-08-07
+
+### Changed
+* Change Translation to skip translating nil and empty string
+* Change view extension to only lookup breadcrumb name translation
+* Remove Configuration #crumb_length and #capitalize options
+* Remove CrumbFormatter to skip truncating and formatting crumb names
+
+## Fix
+* Fix issue with breadcrumb names being modified
+
 ## [v0.7.0] - 2018-06-20
 
 ### Added
@@ -67,7 +78,7 @@
 ### Fixed
 * Fix bug with url parameter to allow for regular rails path variables
 
-## [0.3.0] - 2012-02-25
+## [v0.3.0] - 2012-02-25
 
 ### Added
 * Add loaf gem errors
@@ -78,13 +89,13 @@
 * Renamed main gem helpers for adding breadcrumbs from `add_breadcrumb` to
   `breadcrumb`, both inside controllers and views.
 
-## [0.2.1] - 2012-02-22
+## [v0.2.1] - 2012-02-22
 
 ### Added
 * Add more integration tests and fixed bug with adding breadcrumbs inside view
 * Add specs for controller extensions
 
-## [0.2.0] - 2012-02-18
+## [v0.2.0] - 2012-02-18
 
 ### Added
 * Add integration tests for breadcrumbs view rendering
@@ -100,6 +111,7 @@
 
 * Initial implementation and release
 
+[v0.8.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.7.0...v0.8.0
 [v0.7.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.6.2...v0.7.0
 [v0.6.2]: https://github.com/piotrmurach/tty-spinner/compare/v0.6.1...v0.6.2
 [v0.6.1]: https://github.com/piotrmurach/tty-spinner/compare/v0.6.0...v0.6.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    loaf (0.7.0)
+    loaf (0.8.0)
       rails (>= 3.2)
 
 GEM

data/README.md

@@ -163,6 +163,18 @@ class CommentsController < ApplicationController
 end
 ```
 
+You may wish to define breadcrumbs over a collection. This is easy within views, and controller actions (just loop your collection), but if you want to do this in the controller class you can use the `before_action` approach:
+
+```ruby
+before_action do
+  ancestors.each do |ancestor|
+    breadcrumb ancestor.name, [:admin, ancestor]
+  end
+end
+```
+
+Assume `ancestors` method is defined inside the controller.
+
 #### 2.1.2 view
 
 **Loaf** adds `breadcrumb` helper also to the views. Together with controller breadcrumbs, the view breadcrumbs are appended as the last in breadcrumb trail. For instance, to specify view breadcrumb do:
@@ -228,9 +240,10 @@ For example, you can add the following semantic markup to show breadcrumbs using
   </ol>
 </nav>
 ```
+For Bootstrap 4:
 
-For bootstrap,
 ```erb
+<% #erb %>
 <nav aria-label="breadcrumb">
   <ol class='breadcrumbs'>
     <% breadcrumb_trail do |crumb| %>
@@ -242,23 +255,30 @@ For bootstrap,
 </nav>
 ```
 
+and if you are using HAML do:
+
+```haml
+  - # haml
+  %ol.breadcrumbs
+    - breadcrumb_trail do |crumb|
+      %li.breadcrumb-item{class: crumb.current? ? 'active' : '' }
+        = link_to_unless crumb.current?, crumb.name, crumb.url, (crumb.current? ? {'aria-current' => 'page'} : {})
+```
 
-Usually best practice is to put such snippet inside its own partial.
+Usually best practice is to put such snippet inside its own `_breadcrumbs.html.erb` partial.
 
 ## 3. Configuration
 
 There is a small set of custom opinionated defaults. The following options are valid parameters:
 
 ```ruby
-:capitalize    # set breadcrumbs to have initial letter uppercase, default false
-:crumb_length  # breadcrumb length in integer, default length is 30 characters
-:match         # set match type, default :inclusive
+:match # set match type, default :inclusive (see [:match](#213-match) for more details)
 ```
 
 You can override them in your views by passing them to the view `breadcrumb` helper
 
 ```erb
-<% breadcrumb_trail crumb_length: 20 do |name, url, styles| %>
+<% breadcrumb_trail(match: :exclusive) do |name, url, styles| %>
   ..
 <% end %>
 ```
@@ -267,7 +287,7 @@ or by configuring an option in `config/initializers/loaf.rb`:
 
 ```ruby
 Loaf.configure do |config|
-  config.crumb_length = 20
+  config.match = :exclusive
 end
 ```
 

data/lib/loaf/configuration.rb

@@ -4,8 +4,6 @@ module Loaf
   class Configuration
     VALID_ATTRIBUTES = [
       :locales_path,
-      :crumb_length,
-      :capitalize,
       :match
     ].freeze
 
@@ -13,18 +11,8 @@ module Loaf
 
     DEFAULT_LOCALES_PATH = '/'
 
-    DEFAULT_STYLE_CLASSES = 'selected'
-
-    DEFAULT_CRUMB_LENGTH = 30
-
-    DEFAULT_LAST_CRUMB_LINKED = false
-
-    DEFAULT_CAPITALIZE = false
-
     DEFAULT_MATCH = :inclusive
 
-    DEFAULT_ROOT = true
-
     # Setup this configuration
     #
     # @api public

data/lib/loaf/translation.rb

@@ -2,12 +2,15 @@
 
 module Loaf
   module Translation
-    extend self
-
     # Returns translation lookup
+    #
+    # @return [String]
+    #
+    # @api private
     def translation_scope
-      "loaf.breadcrumbs"
+      'loaf.breadcrumbs'
     end
+    module_function :translation_scope
 
     # Translate breadcrumb title
     #
@@ -18,12 +21,17 @@ module Loaf
     # @option options [String] :default
     #   The default translation
     #
+    # @return [String]
+    #
     # @api public
     def find_title(title, options = {})
+      return title if title.nil? || title.empty?
+
       options[:scope] ||= translation_scope
       options[:default] = Array(options[:default])
       options[:default] << title if options[:default].empty?
-      I18n.t("#{title}", options)
+      I18n.t(title.to_s, options)
     end
+    module_function :find_title
   end # Translation
 end # Loaf

data/lib/loaf/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Loaf
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'.freeze
 end # Loaf

data/lib/loaf/view_extensions.rb

@@ -2,13 +2,12 @@
 
 require_relative 'breadcrumb'
 require_relative 'crumb'
-require_relative 'crumb_formatter'
 require_relative 'options_validator'
+require_relative 'translation'
 
 module Loaf
   # A mixin to define view extensions
   module ViewExtensions
-    include Loaf::CrumbFormatter
     include Loaf::OptionsValidator
 
     def initialize(*)
@@ -51,7 +50,7 @@ module Loaf
       valid?(options)
       options = Loaf.configuration.to_hash.merge(options)
       _breadcrumbs.each do |crumb|
-        name = format_name(crumb.name, options)
+        name = title_for(crumb.name)
         path = url_for(_expand_url(crumb.url))
         current = current_crumb?(path, crumb.match)
 
@@ -107,6 +106,15 @@ module Loaf
 
     private
 
+    # Find title translation for a crumb name
+    #
+    # @return [String]
+    #
+    # @api private
+    def title_for(name)
+      Translation.find_title(name)
+    end
+
     # Expand url in the current context of the view
     #
     # @api private

data/spec/unit/configuration_spec.rb

@@ -1,29 +1,23 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe Loaf::Configuration do
   it "allows to set and read attributes" do
     config = Loaf::Configuration.new
-
-    config.crumb_length = 4
-    expect(config.crumb_length).to eq(4)
-
     config.match = :exact
     expect(config.match).to eq(:exact)
   end
 
   it "accepts attributes at initialization" do
-    options = { crumb_length: 12, match: :exact }
+    options = { locales_path: '/lib', match: :exact }
     config = Loaf::Configuration.new(options)
 
-    expect(config.crumb_length).to eq(12)
+    expect(config.locales_path).to eq('/lib')
     expect(config.match).to eq(:exact)
   end
 
   it "exports configuration as hash" do
     config = Loaf::Configuration.new
     expect(config.to_hash).to eq({
-      capitalize: false,
-      crumb_length: 30,
       locales_path: '/',
       match: :inclusive
     })

data/spec/unit/options_validator_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Loaf::OptionsValidator, '.valid?' do
   let(:klass) { Class.extend Loaf::OptionsValidator }
 
   it 'validates succesfully known option' do
-    expect(klass.valid?(crumb_length: 10)).to eq(true)
+    expect(klass.valid?(match: :exact)).to eq(true)
   end
 
   it 'validates unknown option with an error' do

data/spec/unit/translation_spec.rb

@@ -6,6 +6,14 @@ RSpec.describe Loaf::Translation do
 
   after { I18n.backend.reload! }
 
+  it "doesn't translate empty title" do
+    expect(described_class.find_title('')).to eql('')
+  end
+
+  it "skips translation if doesn't find a matching scope" do
+    expect(described_class.find_title('unknown')).to eql('unknown')
+  end
+
   it 'translates breadcrumb title' do
     I18n.backend.store_translations 'en', loaf: { breadcrumbs: { home: 'Home'}}
     expect(described_class.find_title('home')).to eql('Home')

data/spec/unit/view_extensions/breadcrumb_trail_spec.rb

@@ -196,8 +196,21 @@ RSpec.describe Loaf::ViewExtensions, '#breadcrumb_trail' do
     }.to raise_error(Loaf::InvalidOptions)
   end
 
+  it "permits arbitrary length crumb names" do
+    view = DummyView.new
+    view.breadcrumb('<span class="fa fa-home"></span>', :home_path)
+    view.set_path('/posts')
+
+    yielded = []
+    block = -> (crumb) { yielded << crumb.to_a }
+    view.breadcrumb_trail(&block)
+
+    expect(yielded).to eq([
+      ['<span class="fa fa-home"></span>', '/', false]
+    ])
+  end
+
   it 'uses global configuration for crumb formatting' do
-    allow(Loaf.configuration).to receive(:crumb_length).and_return(10)
     view = DummyView.new
     view.breadcrumb('home-sweet-home', :home_path)
     view.breadcrumb('posts-for-everybody', :posts_path)
@@ -208,13 +221,12 @@ RSpec.describe Loaf::ViewExtensions, '#breadcrumb_trail' do
     view.breadcrumb_trail(&block)
 
     expect(yielded).to eq([
-      ['home-sw...', '/', false],
-      ['posts-f...', '/posts', true]
+      ['home-sweet-home', '/', false],
+      ['posts-for-everybody', '/posts', true]
     ])
   end
 
   it "allows to overwrite global configuration" do
-    allow(Loaf.configuration).to receive(:crumb_length).and_return(10)
     view = DummyView.new
     view.breadcrumb('home-sweet-home', :home_path)
     view.breadcrumb('posts-for-everybody', :posts_path)
@@ -222,11 +234,11 @@ RSpec.describe Loaf::ViewExtensions, '#breadcrumb_trail' do
 
     yielded = []
     block = -> (crumb) { yielded << crumb.to_a }
-    view.breadcrumb_trail(crumb_length: 15, &block)
+    view.breadcrumb_trail(match: :exact, &block)
 
     expect(yielded).to eq([
       ['home-sweet-home', '/', false],
-      ['posts-for-ev...', '/posts', true]
+      ['posts-for-everybody', '/posts', true]
     ])
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loaf
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -93,7 +93,6 @@ files:
 - lib/loaf/configuration.rb
 - lib/loaf/controller_extensions.rb
 - lib/loaf/crumb.rb
-- lib/loaf/crumb_formatter.rb
 - lib/loaf/errors.rb
 - lib/loaf/options_validator.rb
 - lib/loaf/railtie.rb
@@ -147,7 +146,6 @@ files:
 - spec/support/load_routes.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/controller_extensions_spec.rb
-- spec/unit/crumb_formatter_spec.rb
 - spec/unit/crumb_spec.rb
 - spec/unit/generators/install_generator_spec.rb
 - spec/unit/options_validator_spec.rb
@@ -180,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Loaf manages and displays breadcrumb trails in your Rails application.
@@ -231,7 +229,6 @@ test_files:
 - spec/support/load_routes.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/controller_extensions_spec.rb
-- spec/unit/crumb_formatter_spec.rb
 - spec/unit/crumb_spec.rb
 - spec/unit/generators/install_generator_spec.rb
 - spec/unit/options_validator_spec.rb

data/lib/loaf/crumb_formatter.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'translation'
-
-module Loaf
-  # A mixin for formatting crumb name
-  module CrumbFormatter
-    # @param [String] name
-    #   the name to format
-    #
-    # @api public
-    def format_name(name, options = {})
-      return name if name.nil? || name.empty?
-
-      formatted = name.to_s.dup
-      formatted = Loaf::Translation.find_title(formatted)
-      formatted = formatted.capitalize if options[:capitalize]
-      if options[:crumb_length]
-        formatted = truncate(formatted, length: options[:crumb_length])
-      end
-      formatted
-    end
-  end # CrumbFormatter
-end # Loaf

data/spec/unit/crumb_formatter_spec.rb

@@ -1,36 +0,0 @@
-# encoding: utf-8
-
-RSpec.describe Loaf::CrumbFormatter, '.format_name' do
-  let(:formatter) {
-    Class.new do
-      extend Loaf::CrumbFormatter
-
-      def self.truncate(name, options)
-        name
-      end
-    end
-  }
-
-  it 'returns name error if breadcrumb name is nil' do
-    expect(formatter.format_name('')).to eql('')
-  end
-
-  it "doesn't capitalize by default" do
-    name = 'some random name'
-    formatted = formatter.format_name(name)
-    expect(formatted).to eql(name)
-  end
-
-  it 'capitalizes crumb name with capitalize option' do
-    name = 'some random name'
-    formatted = formatter.format_name(name, capitalize: true)
-    expect(formatted).to eql('Some random name')
-  end
-
-  it 'shortens crumb to provided length' do
-    name = 'very long name that is more that 30 characters long'
-    allow(formatter).to receive(:truncate).with(name, length: 30).
-      and_return(name[0..30])
-    expect(formatter.format_name(name, crumb_length: 30)).to eql(name[0..30])
-  end
-end