parliament-utils 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9a7896fa357fb4169dd17eb9a3583e21013e72e
-  data.tar.gz: a0609152b4b8509c4017df31665e55c1a169616f
+  metadata.gz: 8dd780d300055a0f0b7926bbb9cd7e604c870784
+  data.tar.gz: c406ecc6dffe5d212a973565d49c14db6b5a8580
 SHA512:
-  metadata.gz: 29f95d2ba7b0eeabaf4826e6bb68f76fa6e37d6341e5187819c7450a33f379ec58e6d440d3912bcd6dddbfbe4bc54bbcb3c5fa036d2502da99436126d1dd7c2b
-  data.tar.gz: 82c66428fbd06ef442e91afc3875a4d852d9c72ae82c8210b530219cef6808c2f305ebc2fc69297443fce7d05a40e56bf4a427e9291c90320b137eef4e7352d8
+  metadata.gz: 76c5da6b9d37ecb2e8d002eb2a535697ac45d9dade4304aee132a6f455e8319cae06f3415cbc9ae4af62ff4583dea6381e3f8a5745a826db450cdc7982b58d8a
+  data.tar.gz: 3c39bf491a242dab05ae476c3a26a4b060044e8ea04a74f3a43a50a65677f29374cde618bcf50560a07f084514918fc6b2804652704b058eb9b532645037ad83

data/.travis.yml

@@ -1,7 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.15.1
+  - 2.5.1
+before_install: gem install bundler
 env:
   - PARLIAMENT_BASE_URL=https://api.parliament.uk/Staging/fixed-query

data/lib/parliament/utils/helpers/history_helper.rb

@@ -0,0 +1,88 @@
+module Parliament
+  module Utils
+    module Helpers
+      module HistoryHelper
+        # Builds a history object, separating and sorting data into time periods
+        include Parliament::NTriple::Utils
+
+        attr_writer :year_separator
+
+        # Returns year_separator variable (getter method)
+        #
+        # @return [Integer] Number of years used to divide up the timeline into time periods
+        def self.year_separator
+          @year_separator ||= 10
+        end
+
+        # Creates/sets an empty history object
+        #
+        # @return [Hash] Object with properties of start, current and years
+        def self.history
+          @history ||= {
+            start:   nil,
+            current: [],
+            # Keys are the time periods
+            # Value is array of Grom::Nodes that have occured during this time period
+            years:   {}
+          }
+        end
+
+        # Resets history
+        #
+        # @return [nil] Resets history to nil
+        def self.reset
+          @history = nil
+        end
+
+        # Adds data to history object, separating current Grom::Nodes from historic Grom::Nodes
+        # and setting start date of earliest Grom::Node
+        #
+        # @param data [Array] Array of Grom::Nodes
+        # @return [Hash] History object with Grom::Nodes divided into historic and current
+        def self.add(data)
+          return if data.nil? || data.empty?
+          # Set history if it has not already been set
+          history
+          data.each do |entry|
+            # Current
+            @history[:current] << entry if entry.try(:end_date).nil?
+
+            # Exit if there is no end date or if the end date is not a date
+            next if entry.try(:end_date).try(:year).try(:to_f).nil?
+
+            # e.g. If current year is 2017, end date is 2008 and year_separator is 10...
+            # year = ((2017-2008)/10).ceil) * 10 = 0
+            # But as it happened within the last 10 years, we want it to be placed in the 10 year time period, not 0
+            year = ((Time.now.year.to_f - entry.end_date.year.to_f) / year_separator).ceil * year_separator
+            year = year_separator if year == 0
+
+            @history[:years][year] = [] unless @history[:years][year]
+            @history[:years][year] << entry
+
+            if entry.respond_to?(:start_date)
+              @history[:start] = entry.start_date if @history[:start].nil? || @history[:start] > entry.start_date
+            end
+          end
+
+          # Sort current Grom::Nodes by start date
+          @history[:current].sort_by!(&:start_date).reverse!
+          sort_history
+        end
+
+        # Sorts Grom::Nodes first by end date, then by start date (if same end date)
+        #
+        # @return [Hash] History object with divided and sorted Grom::Nodes
+        def self.sort_history
+          @history[:years].keys.each do |year|
+            @history[:years][year] = Parliament::NTriple::Utils.multi_direction_sort(
+              {
+                list:       @history[:years][year],
+                parameters: { end_date: :desc, start_date: :desc }
+              }
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/parliament/utils/helpers.rb

@@ -10,6 +10,7 @@ require_relative './helpers/v_card_helper'
 require_relative './helpers/grouping_helper'
 require_relative './helpers/role_grouping_helper'
 require_relative './helpers/business_item_grouping_helper'
+require_relative './helpers/history_helper'
 
 require 'parliament/grom/decorator'
 

data/lib/parliament/utils/version.rb

@@ -1,5 +1,5 @@
 module Parliament
   module Utils
-    VERSION = '0.10.0'.freeze
+    VERSION = '0.10.1'.freeze
   end
 end

data/parliament-utils.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.12'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'timecop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parliament-utils
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Rebecca Appleyard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-10 00:00:00.000000000 Z
+date: 2018-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parliament-ruby
@@ -290,6 +290,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: Parliament Utils gem.
 email:
 - rklappleyard@gmail.com
@@ -336,6 +350,7 @@ files:
 - lib/parliament/utils/helpers/filter_helper.rb
 - lib/parliament/utils/helpers/flag_helper.rb
 - lib/parliament/utils/helpers/grouping_helper.rb
+- lib/parliament/utils/helpers/history_helper.rb
 - lib/parliament/utils/helpers/houses_helper.rb
 - lib/parliament/utils/helpers/markdown_helper.rb
 - lib/parliament/utils/helpers/parliament_helper.rb