govuk_navigation_helpers 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68f75d61c3b660e079b9c64a30e3a99cc04850b3
-  data.tar.gz: f018b0023a25f3dba8ec58742c4abcce083a3d8c
+  metadata.gz: f4176c900f1ecc9f326253506091426c84a04185
+  data.tar.gz: 1382b484bfbdf27857da344c9eab90ea44f6cecb
 SHA512:
-  metadata.gz: 781df8adc2fa3e43335f89da904a7ffc389943fe6906756f6ba5e933322e70cb85515c2ce0cbaf21d78d10ab8c298bd24efc2bc2bb26223df344e3386c1af0f2
-  data.tar.gz: caadaeab8b6cb296803094498591c2e0ed7780dd03f70a6dac5fff41c0fd35f8d5ae1fcd8c2143c2fd70ecbfc96386f1df242d3a2f9602c987e86beb7d967efc
+  metadata.gz: 8382fe5f7de451bdba0ca038f1e0a481ede4a19d9e05231178e5c7e2fa166783e11896755ae7c999330760f73c3b5ac0bf6a18b56391f054803d88c467f103a7
+  data.tar.gz: f8862c700764b6e0fea0cc61a6307b5f2661d255ef99ec350620f4233913b0dde4d83d2f996c53ee814c85825d300fb088bc4c95aa8ad365f78766792098d078

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+* Functionality to generate data for the breadcrumb component

data/LICENCE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (C) 2016 Crown copyright (Government Digital Service)
+
+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

@@ -2,7 +2,15 @@
 
 This is a gem to share code between GOV.UK frontends.
 
-## Installation
+## Nomenclature
+
+- **content item**: An object returned by the content store
+
+## Technical documentation
+
+These helpers format data from the [content store](https://github.com/alphagov/content-store) for use with [GOV.UK Components](http://govuk-component-guide.herokuapp.com/about).
+
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -14,6 +22,35 @@ And then execute:
 
     $ bundle
 
-## Usage
+### Usage
+
+Get the JSON representation of a page and initialise the helper:
+
+```ruby
+def some_controller_method
+  content_item = Services.content_store.content_item("/register-to-vote")
+  @navigation = GovukNavigationHelpers::NavigationHelper.new(content_item)
+end
+```
+
+Render the component:
+
+```ruby
+<%= render partial: 'govuk_component/breadcrumbs', locals: { breadcrumbs: @navigation.breadcrumbs }
+```
+
+### Running the test suite
+
+`bundle exec rake`
+
+### Documentation
+
+See [RubyDoc](http://www.rubydoc.info/gems/govuk_navigation_helpers) for some limited documentation.
+
+To run a Yard server locally to preview documentation, run:
+
+    $ bundle exec yard server --reload
+
+## Licence
 
-TBD.
+    [MIT License](LICENCE.txt)

data/Rakefile

@@ -1,17 +1,18 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "gem_publisher"
 
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-end
-
-task :default => [:spec]
+RSpec::Core::RakeTask.new(:spec)
 
-require "gem_publisher"
+task default: [:spec, :lint]
 
 desc "Publish gem to RubyGems"
-task :publish_gem do |t|
+task :publish_gem do |_t|
   published_gem = GemPublisher.publish_if_updated("govuk_navigation_helpers.gemspec", :rubygems)
   puts "Published #{published_gem}" if published_gem
 end
+
+desc "Run govuk-lint with similar params to CI"
+task "lint" do
+  sh "bundle exec govuk-lint-ruby --format clang"
+end

data/govuk_navigation_helpers.gemspec

@@ -22,6 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "gem_publisher", "~> 1.5.0"
+  spec.add_development_dependency "govuk-lint", "~> 1.2.1"
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "govuk_schemas", "~> 0.1"
 
   spec.required_ruby_version = ">= 2.3.1"
 end

data/jenkins.sh

@@ -36,6 +36,21 @@ git clean -fdx
 # is master.
 git merge --no-commit origin/master || git merge --abort
 
+echo "Running ruby linter"
+bundle install --path "${HOME}/bundles/${JOB_NAME}"
+bundle exec govuk-lint-ruby \
+  --format html --out rubocop-${GIT_COMMIT}.html \
+  --format clang
+
+  # Clone govuk-content-schemas depedency for contract tests
+  rm -rf /tmp/govuk-content-schemas
+  git clone git@github.com:alphagov/govuk-content-schemas.git /tmp/govuk-content-schemas
+  (
+    cd /tmp/govuk-content-schemas
+    git checkout ${SCHEMA_GIT_COMMIT:-"master"}
+  )
+  export GOVUK_CONTENT_SCHEMAS_PATH=/tmp/govuk-content-schemas
+
 # Bundle and run tests against multiple ruby versions
 for version in 2.3.1; do
   rm -f Gemfile.lock

data/lib/govuk_navigation_helpers.rb

@@ -1,5 +1,21 @@
 require "govuk_navigation_helpers/version"
+require "govuk_navigation_helpers/breadcrumbs"
 
 module GovukNavigationHelpers
-  # Your code goes here...
+  class NavigationHelper
+    def initialize(content_item)
+      @content_item = content_item
+    end
+
+    # Generate a breacrumb trail
+    #
+    # @return [Array<Hash>] Each item is a hash containing `:title` and `:url` for one link in the breadcrumb
+    def breadcrumbs
+      Breadcrumbs.new(content_item).breadcrumbs
+    end
+
+  private
+
+    attr_reader :content_item
+  end
 end

data/lib/govuk_navigation_helpers/breadcrumbs.rb

@@ -0,0 +1,30 @@
+module GovukNavigationHelpers
+  class Breadcrumbs
+    def initialize(content_item)
+      @content_item = content_item
+    end
+
+    def breadcrumbs
+      direct_parent = content_item.dig("links", "parent", 0)
+
+      ordered_parents = []
+
+      while direct_parent
+        ordered_parents << {
+          title: direct_parent["title"],
+          url: direct_parent["base_path"],
+        }
+
+        direct_parent = direct_parent.dig("links", "parent", 0)
+      end
+
+      ordered_parents << { title: "Home", url: "/" }
+
+      ordered_parents.reverse
+    end
+
+  private
+
+    attr_reader :content_item
+  end
+end

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "0.0.1"
+  VERSION = "1.0.0".freeze
 end

data/spec/breadcrumbs_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'govuk_navigation_helpers'
+require 'govuk_schemas'
+
+RSpec.describe GovukNavigationHelpers::Breadcrumbs do
+  describe "#breadcrumbs" do
+    it "can handle any valid content item" do
+      generator = GovukSchemas::RandomExample.for_schema("placeholder", schema_type: "frontend")
+
+      50.times do
+        expect {
+          described_class.new(generator.payload).breadcrumbs
+        }.to_not raise_error
+      end
+    end
+
+    it "returns the root when parent is not specified" do
+      content_item = { "links" => {} }
+      breadcrumbs = breadcrumbs_for(content_item)
+
+      expect(breadcrumbs).to eq(
+        [
+          { title: "Home", url: "/" },
+        ]
+      )
+    end
+
+    it "returns the root when parent is empty" do
+      content_item = content_item_with_parents([])
+      breadcrumbs = breadcrumbs_for(content_item)
+
+      expect(breadcrumbs).to eq(
+        [
+          { title: "Home", url: "/" },
+        ]
+      )
+    end
+
+    it "places parent under the root when there is a parent" do
+      parent = {
+        "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+        "locale" => "en",
+        "title" => "A-parent",
+        "base_path" => "/a-parent",
+      }
+
+      content_item = content_item_with_parents([parent])
+      breadcrumbs = breadcrumbs_for(content_item)
+
+      expect(breadcrumbs).to eq(
+        [
+          { title: "Home", url: "/" },
+          { title: "A-parent", url: "/a-parent" }
+        ]
+      )
+    end
+
+    it "includes grandparent when available" do
+      grandparent = {
+        "title" => "Another-parent",
+        "base_path" => "/another-parent",
+        "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+        "locale" => "en",
+      }
+
+      parent = {
+        "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+        "locale" => "en",
+        "title" => "A-parent",
+        "base_path" => "/a-parent",
+        "links" => {
+          "parent" => [grandparent]
+        }
+      }
+
+      content_item = content_item_with_parents([parent])
+      breadcrumbs = breadcrumbs_for(content_item)
+
+      expect(breadcrumbs).to eq(
+        [
+          { title: "Home", url: "/" },
+          { title: "Another-parent", url: "/another-parent" },
+          { title: "A-parent", url: "/a-parent" }
+        ]
+      )
+    end
+  end
+
+  def content_item_with_parents(parents)
+    {
+      "links" => { "parent" => parents }
+    }
+  end
+
+  def breadcrumbs_for(content_item)
+    generator = GovukSchemas::RandomExample.for_schema("placeholder", schema_type: "frontend")
+    fully_valid_content_item = generator.merge_and_validate(content_item)
+
+    # Use the main class instead of GovukNavigationHelpers::Breadcrumbs, so that
+    # we're testing both at the same time.
+    GovukNavigationHelpers::NavigationHelper.new(fully_valid_content_item).breadcrumbs
+  end
+end

data/spec/spec_helper.rb

@@ -16,6 +16,9 @@
 # users commonly want.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'pry-byebug'
+
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2016-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: govuk-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: govuk_schemas
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: Gem to transform items from the content-store into payloads for GOV.UK
   components
 email:
@@ -77,14 +133,17 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
-- LICENSE.txt
+- LICENCE.txt
 - README.md
 - Rakefile
 - govuk_navigation_helpers.gemspec
 - jenkins.sh
 - lib/govuk_navigation_helpers.rb
+- lib/govuk_navigation_helpers/breadcrumbs.rb
 - lib/govuk_navigation_helpers/version.rb
+- spec/breadcrumbs_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/alphagov/govuk_navigation_helpers
 licenses:
@@ -111,4 +170,5 @@ signing_key:
 specification_version: 4
 summary: Gem to transform items from the content-store into payloads for GOV.UK components
 test_files:
+- spec/breadcrumbs_spec.rb
 - spec/spec_helper.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2016 Tijmen Brommet
-
-MIT License
-
-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.