locomotive-subnav 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b4a11d0319c1a984dc5f82dea237a0203982d7e
+  data.tar.gz: 4bec0b6a521647ba0d54c2088b3a8209a4b86857
+SHA512:
+  metadata.gz: 9613635ae7f0ed362326d8743f2c0e4ba446284968815103ea23d82475d606c3c12db19733e2622446c03d97a3ef394582ea0d36988532c29bdf887003084e1c
+  data.tar.gz: 3768f96e426bac6b30363c3fdbc3d82a2d5d6e2d260d20cee90ce048c4454d2af1e2adc03fb11bcafa8c584a4da02f3bd0e0d1758fd0e0431662cbbc0689ff69

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress --out tmp/test.report
+--format progress

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tibor@gmah.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in locomotive-subnav.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tibor Claassen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# locomotive-subnav
+
+Provide your LocomotiveCMS site with a context aware set of nested navigation
+links that represent the currently selected branch of the page. Typical use
+cases are a subnavigation inside a sidebar or breadcrumbs.
+
+## Installation
+
+Add a dependency to the Gemfile of *both* your Wagon site and the Locomotive
+Rails application.
+
+```ruby
+gem 'locomotive-subnav'
+```
+
+## Usage
+
+Put the following Liquid tags inside any of your Wagon template files:
+
+### breadcrumbs
+
+For a simple breadcrumb trail use the `breadcrumbs` tag.
+
+```liquid
+{% breadcrumbs (<options>) %}
+```
+
+##### Options
+
+| Name    | Type      | Description                               | Default |
+| ---     | ---       | ---                                       | ---     |
+| `level` | `Integer` | Show ancestors including specified level. | `0`     |
+
+##### Example
+
+```liquid
+{% breadcrumbs level: 1 %}
+```
+
+### subnav
+
+For a subtree navigation that will also display the siblings of ancestors use
+the `subnav` tag.
+
+```liquid
+{% subnav (<options>) %}
+```
+
+##### Options
+
+| Name       | Type                               | Description                                    | Default |
+| ---        | ---                                | ---                                            | ---     |
+| `level`    | `Integer`                          | Show ancestor trail including specified level. | `0`     |
+| `collapse` | `Integer` or `Array` of `Integer`s | Only show selected item on given level(s).     | `[]`    |
+
+##### Example
+
+```liquid
+{% subnav level: 1, collapse: 1 %}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/codebeige/locomotive-subnav. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "locomotive/subnav"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/locomotive/steam/page_repository.rb

@@ -0,0 +1,10 @@
+module Locomotive
+  module Steam
+    class PageRepository
+      def ancestors_with_children(page, level = 0)
+        all(k(:parent_id, :in) => page.parent_ids + [page._id, nil],
+            k(:depth, :gte) => level)
+      end
+    end
+  end
+end

data/lib/locomotive/subnav/liquid/tags/breadcrumbs.rb

@@ -0,0 +1,34 @@
+require_relative 'tag'
+
+module Locomotive
+  module Subnav
+    module Liquid
+      module Tags
+        class Breadcrumbs < Tag
+          def render(context)
+            current_page = context.registers[:page]
+            container 'breadcrumbs' do
+              list do
+                ancestors_and_self(current_page, context).map do |page|
+                  attrs = page_attributes(page, context)
+                  item attrs[:title], attrs[:path]
+                end.join "\n"
+              end
+            end
+          end
+
+          protected
+
+          def list
+            %(<ol>#{indent yield}</ol>)
+          end
+
+          def ancestors_and_self(page, context)
+            page_repository = context.registers[:services].repositories.page
+            page_repository.ancestors_of(page).select { |p| display? p }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/locomotive/subnav/liquid/tags/subnav.rb

@@ -0,0 +1,51 @@
+require_relative 'tag'
+
+module Locomotive
+  module Subnav
+    module Liquid
+      module Tags
+        class Subnav < Tag
+          def render(context)
+            current_page = context.registers[:page]
+            container 'subnav' do
+              levels = current_branch(current_page, context)
+              selection = current_page.parent_ids.push + [current_page._id]
+              render_levels(levels, selection, context)
+            end
+          end
+
+          def collapsed_levels
+            @_collapsed_levels ||= [*@attributes[:collapse]].map(&:to_i)
+          end
+
+          protected
+
+          def render_levels(levels, selection, context)
+            return if levels.empty?
+            current_level = levels.first
+            rest = levels.drop(1)
+            name = 'current' if rest.empty?
+            list(name) do
+              current_level.map do |page|
+                attrs = page_attributes(page, context)
+                if selection.include? page._id
+                  item 'selected', attrs[:title], attrs[:path] do
+                    render_levels rest, selection, context
+                  end
+                elsif !collapsed_levels.include? page.depth
+                  item(attrs[:title], attrs[:path])
+                end
+              end.compact.join "\n"
+            end
+          end
+
+          def current_branch(page, context)
+            page_repository = context.registers[:services].repositories.page
+            pages = page_repository.ancestors_with_children(page, level)
+            pages.select { |p| display? p }.group_by(&:depth).values
+          end
+        end
+      end
+    end
+  end
+end

data/lib/locomotive/subnav/liquid/tags/tag.rb

@@ -0,0 +1,95 @@
+module Locomotive
+  module Subnav
+    module Liquid
+      module Tags
+        class Tag < ::Liquid::Tag
+
+          def self.inherited(subclass)
+            tag_name = subclass.name.split('::').last.downcase.freeze
+            ::Liquid::Template.register_tag(tag_name, subclass)
+          end
+
+          DEFAULT_ATTRIBUTES = {level: 0}.freeze
+
+          def initialize(name, source, options = {})
+            parsed_attributes = parse_attributes(source)
+            @attributes = DEFAULT_ATTRIBUTES.merge(parsed_attributes)
+          end
+
+          def level
+            @attributes[:level].to_i
+          end
+
+          protected
+
+          def indent(markup, drop_leading_line_break = false)
+            unless markup.nil?
+              indented = %(#{markup.gsub(/^/, '  ')}\n)
+              if drop_leading_line_break
+                indented
+              else
+                %(\n#{indented})
+              end
+            else
+              ''
+            end
+          end
+
+          def container(name)
+            %(<nav class="#{name}">#{indent yield}</nav>)
+          end
+
+          def list(name = nil)
+            attrs = if name then %( class="#{name}") else '' end
+            %(<ul#{attrs}>#{indent yield}</ul>)
+          end
+
+          def item(name = nil, label, path)
+            markup = ''
+            markup << if name then %(<li class="#{name}">) else '<li>' end
+            link = %(<a href="#{path}">#{label}</a>)
+            if block_given?
+              markup << indent(link)
+              markup << indent(yield, true)
+            else
+              markup << link
+            end
+            markup << '</li>'
+          end
+
+          def display?(page)
+            page.depth >= level &&
+            page.published? &&
+            page.listed? &&
+            !page.templatized?
+          end
+
+          def page_attributes(page, context)
+            url_builder = context.registers[:services].url_builder
+            translated_page = translate_page(page, context)
+            {title: translated_page.title,
+             path: url_builder.url_for(translated_page)}
+          end
+
+          def translate_page(page, context)
+            Locomotive::Steam::Decorators::I18nDecorator.new(
+              page,
+              context.registers[:locale],
+              context.registers[:site].default_locale
+            )
+          end
+
+          private
+
+          def parse_attributes(source)
+            {}.tap do |attributes|
+              source.scan(::Liquid::TagAttributes) do |key, value|
+                attributes[key.to_sym] = value.gsub(/['"]+/, '')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/locomotive/subnav/liquid/tags.rb

@@ -0,0 +1,2 @@
+require_relative 'tags/breadcrumbs'
+require_relative 'tags/subnav'

data/lib/locomotive/subnav/version.rb

@@ -0,0 +1,5 @@
+module Locomotive
+  module Subnav
+    VERSION = "0.1.0"
+  end
+end

data/lib/locomotive/subnav.rb

@@ -0,0 +1,5 @@
+require 'locomotive/steam'
+require 'locomotive/steam/page_repository'
+
+require_relative 'subnav/version'
+require_relative 'subnav/liquid/tags'

data/locomotive-subnav.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locomotive/subnav/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "locomotive-subnav"
+  spec.version       = Locomotive::Subnav::VERSION
+  spec.authors       = ["Tibor Claassen"]
+  spec.email         = ["tibor@gmah.net"]
+
+  spec.summary       = %q{Navigate current section}
+  spec.description   = %q(Provides Liquid tags for rendering breadcrumbs and
+                          subnavigation of a LocomotiveCMS site.
+                       ).gsub(/^\s*/, '')
+  spec.homepage      = "https://github.com/codebeige/locomotive-subnav"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                         f.match(%r{^(test|spec|features)/})
+                       end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "locomotivecms_steam", "~> 1.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-html-matchers", "~> 0.7.1"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: locomotive-subnav
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tibor Claassen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: locomotivecms_steam
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: |
+  Provides Liquid tags for rendering breadcrumbs and
+  subnavigation of a LocomotiveCMS site.
+email:
+- tibor@gmah.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/locomotive/steam/page_repository.rb
+- lib/locomotive/subnav.rb
+- lib/locomotive/subnav/liquid/tags.rb
+- lib/locomotive/subnav/liquid/tags/breadcrumbs.rb
+- lib/locomotive/subnav/liquid/tags/subnav.rb
+- lib/locomotive/subnav/liquid/tags/tag.rb
+- lib/locomotive/subnav/version.rb
+- locomotive-subnav.gemspec
+homepage: https://github.com/codebeige/locomotive-subnav
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Navigate current section
+test_files: []