middleman-breadcrumbs 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f28f33311aeea9d77f7ec173c0bdc852d06b968b
-  data.tar.gz: 2bffa6753dc31d7b112d9a2f300a9660215017b3
+  metadata.gz: cb327948a5ee3560e75c08cc83863aeeaf8eb696
+  data.tar.gz: cf55b9802002900e4968cdbe9065abfb2f8d35a6
 SHA512:
-  metadata.gz: 20bc774d51ba1982b1132b2e7c4342d2145e28895b97fc99bb6e38fe128575088e0bd1756ca54c7f0b4b85ca410776416e03ea5c280c92c054d86f84492913e9
-  data.tar.gz: f3dbfdfdf09cb4a734bcad7aa714cb117f0a43c24fc393b1b10770a3f371acf9b8caabea33d13b79976bfbfa63578d937446e66bdff8ab3ef14e32a62ad99723
+  metadata.gz: 9c823d04dc7ab7a6a69b79e72284cb50a948dc290083617545acb21d65443f587f12666ab01a6a2e35788deccf28eb8195a8e56e536d7d5820ab2ea618aafc44
+  data.tar.gz: 3d878201540499d3e3d4fd584dac972279273be754810e0a75530d534079d03b3457a2737cb0839b74e27f67239d8cc2ad48172cb91c428e456739407213d1be

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 0.4.0 / 2016-04-26
+
+* Create config options for default separator and wrapper. [#8]
+* Require Middleman 4.
+
 ## 0.3.3 / 2015-12-09
 
 * Fix loading bug. [#6]

data/README.md

@@ -2,7 +2,7 @@
 
 # middleman-breadcrumbs
 
-Breadcrumbs helper for Middleman
+Breadcrumbs helper for [Middleman](https://middlemanapp.com/)
 
 ## Installation
 
@@ -10,23 +10,28 @@ Install the gem as usual: put `gem 'middleman-breadcrumbs'` in Gemfile, then run
 
 Put `activate :breadcrumbs` in config.rb (*not* in the `configure :build` block).
 
-## Usage
+## Configuration
+
+This gem has two configuration options, which are set in the [usual way for Middleman extensions](https://middlemanapp.com/advanced/configuration/#configuring-extensions).
 
-In your view files, just call `breadcrumbs(current_page)` to display breadcrumbs.
+<dl>
+  <dt>`:separator`</dt>
+  <dd>String that separates the breadcrumb levels. Default is ` > `.</dd>
+  <dt>`:wrapper`</dt>
+  <dd>Tag name (as a symbol) in which to wrap each breadcrumb level. Default is `nil`, which means no wrapping.</dd>
+</dl>
 
-### Options
+For example, if you wanted to wrap the breadcrumb levels in `<li>` elements and separate them with bullets, you would put the following in `config.rb`:
 
-#### `:separator`
+```ruby
+activate :breadcrumbs, separator: ' • ', wrapper: :li
+```
 
-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`
+## Usage
 
-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:
+In your view files, just call `breadcrumbs(current_page)` to display breadcrumbs. If you want to override the separator or wrapper defined in the `config.rb` file, pass the appropriate options to the `breadcrumbs` method:
 
 ```erb
-<ul>
-  <%= breadcrumbs current_page, wrapper: :li, separator: nil %>
-</ul>
+<%= breadcrumbs(current_page, separator: ' ||| ', wrapper: :div) %>
 ```
-This will wrap each breadcrumb level in a `<li>` element.

data/lib/middleman-breadcrumbs.rb

@@ -1,5 +1,3 @@
 Dir[File.join File.dirname(__FILE__), 'middleman-breadcrumbs', '**', '*.rb'].each {|file| puts file; require file }
 
-Breadcrumbs.helpers BreadcrumbsHelper
-
-::Middleman::Extensions.register :breadcrumbs, Breadcrumbs
+::Middleman::Extensions.register :breadcrumbs, Breadcrumbs

data/lib/middleman-breadcrumbs/breadcrumbs.rb

@@ -1,9 +1,32 @@
 require 'middleman'
 require File.join(File.dirname(__FILE__), 'version')
+require 'rack/utils'
+require 'padrino-helpers'
 
 class Breadcrumbs < Middleman::Extension
   include BreadcrumbsVersion
-  def initialize(app, options_hash={}, &block)
+  include Padrino::Helpers
+
+  option :separator, ' > ', 'Default separator between breadcrumb levels'
+  option :wrapper, nil, 'Name of tag (as symbol) in which to wrap each breadcrumb level, or nil for no wrapping'
+
+  expose_to_template :breadcrumbs
+
+  def initialize(app, options_hash = {}, &block)
     super
+    @separator = options.separator
+    @wrapper = options.wrapper
+  end
+
+  def breadcrumbs(page, separator: @separator, wrapper: @wrapper)
+    hierarchy = [page]
+    hierarchy.unshift hierarchy.first.parent while hierarchy.first.parent
+    hierarchy.collect {|page| wrap link_to(page.data.title, "/#{page.path}"), wrapper: wrapper }.join(h separator)
+  end
+
+  private
+
+  def wrap(content, wrapper: wrapper)
+    wrapper ? content_tag(wrapper) { content } : content
   end
 end

data/lib/middleman-breadcrumbs/version.rb

@@ -1,3 +1,3 @@
 module BreadcrumbsVersion
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/middleman-breadcrumbs.gemspec

@@ -14,10 +14,10 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.0'
 
-  s.add_runtime_dependency "middleman", '>= 3.3.5'
+  s.add_runtime_dependency "middleman", '>= 4.0.0'
   [
     'byebug',
-    ['guard', '~> 2.10.5'],
+    ['guard', '>= 2.10.5'],
     'guard-minitest',
     ['faker', '~> 1.5.0'],
     'rake'

data/spec/{breadcrumbs_helper_spec.rb → breadcrumbs_spec.rb}

@@ -1,35 +1,23 @@
 require_relative './spec_helper'
 require 'ostruct'
-require 'middleman-breadcrumbs/breadcrumbs_helper'
+require 'middleman-breadcrumbs/breadcrumbs'
 
-describe BreadcrumbsHelper do
+describe Breadcrumbs do
   before do
-    @helper = Object.new
-    @helper_class = @helper.singleton_class
-  end
-
-  describe '.included' do
-    describe 'link_to is defined' do
-      it 'does not include Padrino::Helpers' do
-        methods = @helper_class.instance_methods
-        @helper_class.stub :instance_methods, methods + [:link_to] do
-          @helper_class.send :include, BreadcrumbsHelper
-          @helper_class.wont_include Padrino::Helpers
-        end
+    @app = Class.new do
+      [:after_configuration, :initialized, :instance_available].each do |method|
+        define_method(method) { true }
       end
-    end
+    end.new
+    @helper = Breadcrumbs.new @app
+  end
 
-    describe 'link_to is not defined' do
-      it 'includes Padrino::Helpers' do
-        @helper_class.send :include, BreadcrumbsHelper
-        @helper_class.must_include Padrino::Helpers
-      end
-    end
+  it 'includes Padrino::Helpers' do
+    Breadcrumbs.must_include Padrino::Helpers
   end
 
   describe '#breadcrumbs' do
     before do
-      @helper.singleton_class.send :include, BreadcrumbsHelper
       self.singleton_class.send :include, Padrino::Helpers
       @page = page
     end
@@ -52,7 +40,6 @@ describe BreadcrumbsHelper 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 breadcrumb_links.join separator
           end
 
@@ -64,8 +51,23 @@ describe BreadcrumbsHelper do
         end
 
         describe 'not specified' do
-          it 'uses " > " as the separator' do
-            @helper.breadcrumbs(@page).must_equal breadcrumb_links.join ' > '
+          describe 'default separator' do
+            describe 'specified in config' do
+              before do
+                @default_separator = Faker::Lorem.characters(5)
+                @helper = Breadcrumbs.new @app, separator: @default_separator
+              end
+
+              it 'uses the specified default separator' do
+                @helper.breadcrumbs(@page).must_equal breadcrumb_links.join @default_separator
+              end
+            end
+
+            describe 'not specified in config' do
+              it 'uses " > " as the separator' do
+                @helper.breadcrumbs(@page).must_equal breadcrumb_links.join ' > '
+              end
+            end
           end
         end
       end
@@ -80,8 +82,24 @@ describe BreadcrumbsHelper do
         end
 
         describe 'not specified' do
-          it 'does not wrap breadcrumbs in tags' do
-            @helper.breadcrumbs(@page, separator: nil).must_equal breadcrumb_links.join
+          describe 'default wrapper' do
+            describe 'specified in config' do
+              before do
+                @default_wrapper = Faker::Lorem.word.to_sym
+                @helper = Breadcrumbs.new @app, wrapper: @default_wrapper
+              end
+
+              it 'wraps breadcrumbs in the specified element type' do
+                wrapped_links = breadcrumb_links.collect {|link| content_tag(@default_wrapper) { link } }
+                @helper.breadcrumbs(@page, separator: nil).must_equal wrapped_links.join
+              end
+            end
+
+            describe 'not specified in config' do
+              it 'does not wrap breadcrumbs in tags' do
+                @helper.breadcrumbs(@page, separator: nil).must_equal breadcrumb_links.join
+              end
+            end
           end
         end
       end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: middleman-breadcrumbs
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Marnen Laibow-Koser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.5
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.5
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: byebug
   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: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.10.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.10.5
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   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: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 description: Breadcrumbs helper for Middleman
@@ -112,10 +112,9 @@ files:
 - bin/setup
 - lib/middleman-breadcrumbs.rb
 - lib/middleman-breadcrumbs/breadcrumbs.rb
-- lib/middleman-breadcrumbs/breadcrumbs_helper.rb
 - lib/middleman-breadcrumbs/version.rb
 - middleman-breadcrumbs.gemspec
-- spec/breadcrumbs_helper_spec.rb
+- spec/breadcrumbs_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/marnen/middleman-breadcrumbs
 licenses:
@@ -127,20 +126,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Breadcrumbs helper for Middleman
 test_files:
-- spec/breadcrumbs_helper_spec.rb
+- spec/breadcrumbs_spec.rb
 - spec/spec_helper.rb

data/lib/middleman-breadcrumbs/breadcrumbs_helper.rb

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