govuk_publishing_components 5.2.3 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 783e6b85b53649ff2075bf833cfe3713ce018789f6ca8569a6d0fd5383628646
-  data.tar.gz: efe68ac7148834ab878113d659110abc33ef5c8a0f71667830f25cd585bb4d44
+  metadata.gz: b4902da197a494c6f39c5ed16ecb9ef84a8c8f56cf037a14130793141048274d
+  data.tar.gz: 0c614a237b36b5e919a705805de3bbedf2503efab958da940dd78abb74fb8b28
 SHA512:
-  metadata.gz: 1c6d4212608687f381b8084441552f1ea632e23fdc872862e809fcbf452b7b03f8fa4bc55344cd37bbdb5f07e5d127072d07b37fa1b94bdb785f35031b8fad31
-  data.tar.gz: 40afc265848b6c40680f0a3429ed683987caaad74c6f564a42689c21fa4423a09d7a072fbe1f84564809dc7e79398963d0435c35bc527ab0cd5c489f2b41a415
+  metadata.gz: da1bfcf8e9bf7ec67e07e2f90b901905ac214311bfd503d6d1a15756965befca953be7afa9921fa216236bb52b858bf7b35961eb4b40c25c7a2556e158b056f6
+  data.tar.gz: 3043a55019d7ebc3c91fc6f7bd600e4720ef4d8e140e2731fb1c79a5c336197f600533180846508ae25e417125b511070bd09ac36a713b190da7c5332e29e08a

data/lib/govuk_publishing_components.rb

@@ -3,5 +3,8 @@ require "govuk_publishing_components/engine"
 require "govuk_publishing_components/components/step_by_step_nav_helper"
 require "govuk_publishing_components/components/related_navigation_helper"
 
+require "govuk_publishing_components/step_nav"
+require "govuk_publishing_components/step_nav_helper"
+
 module GovukPublishingComponents
 end

data/lib/govuk_publishing_components/step_nav.rb

@@ -0,0 +1,23 @@
+module GovukPublishingComponents
+  class StepNav
+    def initialize(content_item)
+      @content_item = content_item.deep_symbolize_keys
+    end
+
+    def title
+      content_item[:title]
+    end
+
+    def base_path
+      content_item[:base_path]
+    end
+
+    def content
+      @content ||= content_item.dig(:details, :step_by_step_nav)
+    end
+
+  private
+
+    attr_reader :content_item
+  end
+end

data/lib/govuk_publishing_components/step_nav_helper.rb

@@ -0,0 +1,86 @@
+module GovukPublishingComponents
+  class StepNavHelper
+    def initialize(content_store_response, current_path)
+      @content_item = content_store_response.to_h
+      @current_path = current_path
+    end
+
+    def step_navs
+      @step_navs ||= parsed_step_navs.map do |step_nav|
+        StepNav.new(step_nav)
+      end
+    end
+
+    def show_sidebar?
+      step_navs.count == 1
+    end
+    alias_method :show_header?, :show_sidebar?
+
+    def show_related_links?
+      step_navs.any? && step_navs.count < 5
+    end
+
+    def related_links
+      step_navs.map do |step_nav|
+        {
+          href: step_nav.base_path,
+          text: step_nav.title
+        }
+      end
+    end
+
+    def sidebar
+      if show_sidebar?
+        @sidebar ||= first_step_nav.content.tap do |sb|
+          configure_for_sidebar(sb)
+          sb.merge!(small: true, heading_level: 3)
+        end
+      end
+    end
+
+    def header
+      if show_header?
+        {
+          title: first_step_nav.title,
+          path: first_step_nav.base_path
+        }
+      else
+        {}
+      end
+    end
+
+  private
+
+    attr_reader :content_item, :current_path
+
+    def first_step_nav
+      step_navs.first
+    end
+
+    def steps
+      @steps ||= step_nav[:steps]
+    end
+
+    def parsed_step_navs
+      content_item.dig("links", "part_of_step_navs").to_a
+    end
+
+    def configure_for_sidebar(step_nav_content)
+      step_nav_content[:steps].each_with_index do |step, step_index|
+        step[:contents].each do |content|
+          next unless content[:contents]
+
+          content[:contents].each do |link|
+            if link[:href] == current_path
+              link[:active] = true
+              step_nav_content[:show_step] = step_index + 1
+              step_nav_content[:highlight_step] = step_index + 1
+              return step_nav_content
+            end
+          end
+        end
+      end
+      step_nav_content
+    end
+  end
+end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '5.2.3'.freeze
+  VERSION = '5.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 5.2.3
+  version: 5.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.64'
+- !ruby/object:Gem::Dependency
+  name: gds-api-adapters
+  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: govuk_schemas
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +248,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: pry-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'
 description: A gem to document components in GOV.UK frontend applications
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -327,6 +355,8 @@ files:
 - lib/govuk_publishing_components/config.rb
 - lib/govuk_publishing_components/engine.rb
 - lib/govuk_publishing_components/minitest/component_guide_test.rb
+- lib/govuk_publishing_components/step_nav.rb
+- lib/govuk_publishing_components/step_nav_helper.rb
 - lib/govuk_publishing_components/version.rb
 - lib/tasks/govuk_publishing_components_tasks.rake
 homepage: https://github.com/alphagov/govuk_publishing_components