middleman-breadcrumbs 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e54e14f32555c4b4e3b49bafcad3dfd8e87d3655
-  data.tar.gz: 7e15f3e860f159ce68438bce687d40dbd1c895f6
+  metadata.gz: fa37cb3fa7f5f6c9acc99458288862060c9d0247
+  data.tar.gz: 5a74693d11318ef62bd3c6b9818c667e9ddecc4d
 SHA512:
-  metadata.gz: e60c78c75b42d7f8dfda9d7f97253c49e13084307ee97cbe28f85bbc95782344c5ee38b5adf9a44b15eb1d5cd7235f1db1e1eafa5c999e9de3d65fbd6e9df31a
-  data.tar.gz: b67ba7c704b4c61fc4dbc2890394a2632c7d2a76bcc3ecc298624858b19178ce10d251cf4cc63b4a447273110d3460cdb6d5947358a4a6262d496e1a0d050b07
+  metadata.gz: fd81e3bbfe2ab33dc2d370ec988cef61c0a5d3fb6b8c3fe5616d7c6fd71371bdb49d14fa8a81ee4a3662249e63a7d2a34157941cfc084a918f8e54c8b00f1308
+  data.tar.gz: d583f0a4cb89ddbd2c0e7dea0994e12563a6be369fa3de7ec0b7f5a2757e7d1544b5831384863ba80fd1bee1965375bbf69e0c92f9da35e260d523eea3dbde20

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 0.3.0 / 2015-10-27
+
+* Add `:separator` and `:wrapper` options to support a wider range of output styles. [#2]
+* Switch from ffaker to new improved Faker.
+
 ## 0.2.0 / 2015-10-25
 
 * Remove setup and console executables from gem. [#3]

data/README.md

@@ -1,11 +1,26 @@
-middleman-breadcrumbs
-=====================
+# middleman-breadcrumbs
 
 Breadcrumbs helper for Middleman
 
-Usage
------
+## Usage
 
 In config.rb: `activate :breadcrumbs`.
 
 In your view files, just call `breadcrumbs(current_page)`.
+
+### Options
+
+#### `:separator`
+
+The breadcrumb levels are separated with ` > ` by default. If you want a different separator, use the `:separator` option—e.g.,  `breadcrumbs(current_page, separator: '|||')`.
+
+#### `:wrapper`
+
+If you want to wrap each breadcrumb level in a tag, pass the tag name to the `:wrapper` option. For example, if you want your breadcrumbs in a list:
+
+```erb
+<ul>
+  <%= breadcrumbs current_page, wrapper: :li, separator: nil %>
+</ul>
+```
+This will wrap each breadcrumb level in a `<li>` element.

data/lib/middleman-breadcrumbs/breadcrumbs_helper.rb

@@ -6,9 +6,15 @@ module BreadcrumbsHelper
     klass.send(:include, Padrino::Helpers) unless klass.instance_methods.include? :link_to
   end
 
-  def breadcrumbs(page)
+  def breadcrumbs(page, separator: ' > ', wrapper: nil)
     hierarchy = [page]
     hierarchy.unshift hierarchy.first.parent while hierarchy.first.parent
-    hierarchy.collect {|page| link_to page.data.title, "/#{page.path}" }.join(h ' > ')
+    hierarchy.collect {|page| wrap link_to(page.data.title, "/#{page.path}"), wrapper: wrapper }.join(h separator)
   end
-end
+
+  private
+
+  def wrap(content, wrapper: wrapper)
+    wrapper ? content_tag(wrapper) { content } : content
+  end
+end

data/lib/middleman-breadcrumbs/version.rb

@@ -1,2 +1,2 @@
 require File.join(File.dirname(__FILE__), 'breadcrumbs')
-Breadcrumbs::VERSION = '0.2.0'
+Breadcrumbs::VERSION = '0.3.0'

data/middleman-breadcrumbs.gemspec

@@ -13,7 +13,13 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
 
   s.add_runtime_dependency "middleman", '>= 3.3.5'
-  ['byebug', ['guard', '~> 2.10.5'], 'guard-minitest', 'ffaker', 'rake'].each {|gem| s.add_development_dependency *gem }
+  [
+    'byebug',
+    ['guard', '~> 2.10.5'],
+    'guard-minitest',
+    ['faker', '~> 1.5.0'],
+    'rake'
+  ].each {|gem| s.add_development_dependency *gem }
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/breadcrumbs_helper_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-
+require 'ostruct'
 require 'middleman-breadcrumbs/breadcrumbs_helper'
 
 describe BreadcrumbsHelper do
@@ -41,15 +41,58 @@ describe BreadcrumbsHelper do
     end
 
     describe 'non-top-level page' do
-      it 'joins all links to parent pages with > signs' do
-        parent = page
-        grandparent = page
-        @page.parent = parent
-        @page.parent.parent = grandparent
+      before do
+        @parent = page
+        @grandparent = page
+        @page.parent = @parent
+        @page.parent.parent = @grandparent
+      end
+
+      describe 'separator' do
+        describe 'specified' do
+          it 'joins all links to parent pages with the specified separator' do
+            separator = Faker::Lorem.characters(5)
+
+            @helper.breadcrumbs(@page, separator: separator).must_equal([@grandparent, @parent, @page].collect do |level|
+              link_to level.data.title, "/#{level.path}"
+            end.join separator)
+          end
+
+          describe 'nil' do
+            it 'does not use a separator' do
+              @helper.breadcrumbs(@page, separator: nil).must_equal ([@grandparent, @parent, @page].collect do |level|
+                link_to level.data.title, "/#{level.path}"
+              end.join)
+            end
+          end
+        end
 
-        @helper.breadcrumbs(@page).must_equal([grandparent, parent, @page].collect do |level|
-          link_to level.data.title, "/#{level.path}"
-        end.join ' > ')
+        describe 'not specified' do
+          it 'uses " > " as the separator' do
+            @helper.breadcrumbs(@page).must_equal([@grandparent, @parent, @page].collect do |level|
+              link_to level.data.title, "/#{level.path}"
+            end.join ' > ')
+          end
+        end
+      end
+
+      describe 'wrapper' do
+        describe 'specified' do
+          it 'wraps breadcrumbs in the specified element type' do
+            wrapper = Faker::Lorem.word.to_sym
+            @helper.breadcrumbs(@page, wrapper: wrapper, separator: nil).must_equal([@grandparent, @parent, @page].collect do |level|
+              content_tag(wrapper) { link_to level.data.title, "/#{level.path}" }
+            end.join)
+          end
+        end
+
+        describe 'not specified' do
+          it 'does not wrap breadcrumbs in tags' do
+            @helper.breadcrumbs(@page, separator: nil).must_equal([@grandparent, @parent, @page].collect do |level|
+              link_to level.data.title, "/#{level.path}"
+            end.join)
+          end
+        end
       end
     end
   end
@@ -57,9 +100,9 @@ describe BreadcrumbsHelper do
   private
 
   def page
-    path = Faker::Internet.http_url
+    path = Faker::Internet.url
     title = Faker::Lorem.sentence
     data = OpenStruct.new title: title
     OpenStruct.new data: data, path: path
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'minitest/autorun'
 require 'byebug'
 require 'middleman'
-require 'ffaker'
+require 'faker'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-breadcrumbs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Marnen Laibow-Koser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-25 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ffaker
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement