govuk_navigation_helpers 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 068eb3be3f3916e3e73b4e9f9d20fa57f880b400
-  data.tar.gz: a5161e592acfd1b4a18969eb0340ec63d5d119e3
+  metadata.gz: 871ba5edc031b3cad2d1efac31fa8850fbf0e3e2
+  data.tar.gz: ec6709e88652bf135ce86ed2f897236d8b59c60d
 SHA512:
-  metadata.gz: 78ff87bc456090a32b844065d1d682e5654f7623556cb79174586fd0ea5a1013f6dde2fa82370d5d7c166685b44ef5c5dec25057c7bc80832e33b3969f3bc088
-  data.tar.gz: 58d2455c36389887901ad9026e9f9338815a0060d5dab7d9a0756587272664c47080f2c0bf0b9b9a6c476b604b69d88c823c5671d982bac7b13de51cf9ef174a
+  metadata.gz: 356d955ac7d17e35a9277b1c4f57da97b1c476bc2d5a410bf18f0627824566d7b7f53e062670af10c0b696e2a8d2f83c175058d63acfc2e94717c9e3142a510e
+  data.tar.gz: 81d2310474c16f54d99636ef143db8d7bef3ce1d1ea37d68c7badf0ef7067926fc358c645b23d4f446662a0ddd273c27415e5d8e35048bf23e5fba829c02b22a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.1.0
+
+* Allow a statsd client to be passed in via configuration options. This will
+  allow us to track how many Rummager searches we run and how long they take.
+
 ## 3.0.2
 
 * Sort parent taxons by title before picking the first one for the breadcrumbs.

data/README.md

@@ -22,6 +22,16 @@ And then execute:
 
     $ bundle
 
+### Configuration
+
+This gem allows the configuration of:
+
+- an error handler class (e.g. `Airbrake`), that implements a `notify` method
+  which takes an exception object (by default, it prints the exception to stdout
+  when not configured);
+- a statsd client - when not configured, it does not do anything. This client
+  should implement `increment(metric)` and `time(metric, &block)`.
+
 ### Usage
 
 Get the JSON representation of a page and initialise the helper:

data/lib/govuk_navigation_helpers/configuration.rb

@@ -8,16 +8,25 @@ module GovukNavigationHelpers
   end
 
   class Configuration
-    attr_writer :error_handler
-
-    def initialize
-      @configuration = {}
-    end
+    attr_writer :error_handler, :statsd
 
     def error_handler
       @error_handler ||= NoErrorHandler.new
     end
 
+    def statsd
+      @statsd ||= NoStatsd.new
+    end
+
+    class NoStatsd
+      def increment(*)
+      end
+
+      def time(*)
+        yield
+      end
+    end
+
     class NoErrorHandler
       def notify(exception, *_args)
         puts exception

data/lib/govuk_navigation_helpers/taxonomy_sidebar.rb

@@ -16,6 +16,10 @@ module GovukNavigationHelpers
 
   private
 
+    def statsd
+      GovukNavigationHelpers.configuration.statsd
+    end
+
     def taxons
       parent_taxons = @content_item.parent_taxons
       parent_taxons.map do |parent_taxon|
@@ -32,25 +36,29 @@ module GovukNavigationHelpers
     # temporary method that uses search to achieve this. This behaviour is to be moved into
     # the content store
     def content_related_to(taxon)
-      begin
-        results = Services.rummager.search(
-          similar_to: @content_item.base_path,
-          start: 0,
-          count: 3,
-          filter_taxons: [taxon.content_id],
-          filter_content_store_document_type: Guidance::DOCUMENT_TYPES,
-          fields: %w[title link],
-        )['results']
-
-        results.map do |result|
-          {
-            title: result['title'],
-            link: result['link'],
-          }
+      statsd.time(:taxonomy_sidebar_search_time) do
+        begin
+          results = Services.rummager.search(
+            similar_to: @content_item.base_path,
+            start: 0,
+            count: 3,
+            filter_taxons: [taxon.content_id],
+            filter_content_store_document_type: Guidance::DOCUMENT_TYPES,
+            fields: %w[title link],
+          )['results']
+
+          statsd.increment(:taxonomy_sidebar_searches)
+
+          results.map do |result|
+            {
+              title: result['title'],
+              link: result['link'],
+            }
+          end
+        rescue StandardError => e
+          GovukNavigationHelpers.configuration.error_handler.notify(e)
+          []
         end
-      rescue StandardError => e
-        GovukNavigationHelpers.configuration.error_handler.notify(e)
-        []
       end
     end
   end

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "3.0.2".freeze
+  VERSION = "3.1.0".freeze
 end

data/spec/taxonomy_sidebar_spec.rb

@@ -41,6 +41,12 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
 
     context 'given a content item tagged to taxons' do
       it 'returns a sidebar hash containing a list of parent taxons and related content' do
+        expect(GovukNavigationHelpers.configuration.statsd).to receive(
+          :increment
+        ).with(
+          :taxonomy_sidebar_searches
+        ).twice
+
         content_item = content_item_tagged_to_taxon
 
         expect(sidebar_for(content_item)).to eq(
@@ -84,6 +90,10 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
         GovukNavigationHelpers.configure do |config|
           config.error_handler = error_handler
         end
+
+        expect(GovukNavigationHelpers.configuration.statsd).to_not receive(
+          :increment
+        )
       end
 
       it 'does not re-raise' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters