parliament-utils 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc4a06941ea0dea090c59a94a451411e507b0286
-  data.tar.gz: 175819e752aa2584803059792de65808d33d3437
+  metadata.gz: 57e8942631d85dd3ef9e374d3c69ef92162358ce
+  data.tar.gz: 3eebabcc83b7826f713b1d32a1cf765a29b8c25f
 SHA512:
-  metadata.gz: f24e4ab9875fa9abe90779da5cbdab723e3097aba1b2bfeabdbd7ad41ecd62e87b566baf5528305d0041af71173f7b647fd96c8f93551941dd252bacac7fcedc
-  data.tar.gz: e83122d7a8c75636140dfa6a94ff3aaa7ac909f48ee565f10b6735031fe80225c8d355ec8e1fbe7c409b8e1d74477fb8cd07a052c2436d84b2a7e030effc7234
+  metadata.gz: ec0fe535a22f52654d41d86518ad7f09fccfaf90cb0c0f37031372faf2c9c1921cc5189e87f22df9d3f8b3dae1237ed410235ce41b8c65032e113ff4d0eb1856
+  data.tar.gz: bae9c631bc25f9088b1f7f83e5857129b3df8f82c7a02d2e9f1fbed19adb6a20031875f403874eb28066a02140038c77831b6287d3d30fd265561986fa8c5eb9

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

@@ -0,0 +1,35 @@
+module Parliament
+  module Utils
+    module Helpers
+      class BusinessItemGroupingHelper
+        extend Parliament::Utils::Helpers::GroupingHelper
+        # Finds Grom::Nodes that can be grouped and builds BusinessItemGroupingHelper::BusinessItemGroupedObject objects
+        #
+        # @return date [DateTime] Date of all Grom::Nodes
+        # @return nodes [Array] Array of Grom::Nodes
+        # @return type [String] Type of all grouped Grom::Nodes
+        class BusinessItemGroupedObject
+          attr_accessor :date, :nodes, :type
+        end
+
+        # Creates new BusinessItemGroupingHelper::BusinessItemGroupedObject, for each set of Grom::Nodes that have been grouped (nodes) and unknown
+        # Each instance of BusinessItemGroupingHelper::BusinessItemGroupedObject is assigned properties of laying_date, nodes and type
+        #
+        # @param data_hash [Hash] Keys identify grouping, with each value being an array of grouped, ungrouped and unknown Grom::Nodes
+        # @param key [String] Key identifies grouping of Grom::Nodes
+        # @return [Array] with instances of GroupingHelper::GroupedObject
+        def self.create_grouped_objects(data_hash, key)
+          grouped = []
+
+          grouped_object = BusinessItemGroupingHelper::BusinessItemGroupedObject.new
+          grouped_object.nodes = data_hash[key].sort_by(&:shortest_distance_of_procedure_steps)
+
+          # Set properties of the object
+          grouped_object.type = grouped_object.nodes.first.type
+          grouped_object.date = grouped_object.nodes.first.date
+          grouped << grouped_object
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Parliament
+  module Utils
+    module Helpers
+      module GroupingHelper
+        # Groups objects by category where possible
+        #
+        # @param data [Array] Array of Grom::Nodes to be grouped
+        # @param grouping_methods [Symbol] One or more methods that should be called on Grom::Node to find suitable nodes for grouping
+        # @return [Array] Single array of grouped, ungrouped and unknown objects
+        def group(data, *grouping_methods)
+          grouped_data = group_data(data, grouping_methods)
+          create_sorted_array(grouped_data)
+        end
+
+        # Where grouping methods can be called (e.g. #category and #id), this method groups by the result of calling each of those methods in succession on each Grom::Node
+        # If a grouping cannot be found, adds 'UNKNOWN' as key of the hash
+        #
+        # @param data [Array] Array of Grom::Nodes to be grouped
+        # @param grouping_methods [Array] One or more methods that should be called on Grom::Node to find suitable nodes for grouping
+        # @return [Hash] Keys identify grouping (grouped by category.property), with each value being an array of grouped, ungrouped and unknown Grom::Nodes
+        #
+        # e.g. { 12345678 => [...], 23456789 => [...], "UNKNOWN" => [...] }
+        def group_data(data, grouping_methods)
+          data.group_by do |data_point|
+            grouping_methods.inject(data_point) { |point, method| point.try(method) } || 'UNKNOWN'
+          end
+        end
+
+        # Places unknown and ungrouped Grom::Nodes into sorted_array without calling any further methods on them
+        # For Grom::Nodes that need to be grouped, calls create_grouped_objects method and places result into sorted_array
+        #
+        # @param data_hash [Hash] Keys identify grouping, with each value being an array of grouped, ungrouped and unknown Grom::Nodes
+        # @return [Array] Array of unknown and ungrouped Grom::Nodes, and sorted and grouped instances of GroupingHelper::GroupedObject
+        def create_sorted_array(data_hash)
+          sorted_array = []
+          data_hash.each do |key, value|
+            # Identify Grom::Nodes that don't need to be grouped (either UNKNOWN or singular values)
+            sorted_array << if key == 'UNKNOWN' || value.length == 1
+              value
+            else
+              create_grouped_objects(data_hash, key)
+            end
+          end
+          sorted_array.flatten
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Parliament
+  module Utils
+    module Helpers
+      class RoleGroupingHelper
+        extend Parliament::Utils::Helpers::GroupingHelper
+        # Finds Grom::Nodes that can be grouped and builds GroupingHelper::GroupedObject objects
+        #
+        # @return start_date [DateTime] Earliest start date
+        # @return end_date [DateTime] Latest end date
+        # @return nodes [Array] Array of Grom::Nodes
+        # @return type [String] Type of all grouped Grom::Nodes
+        class RoleGroupedObject
+          attr_accessor :start_date, :end_date, :nodes, :type
+        end
+
+        # Creates new GroupingHelper::GroupedObject, for each set of Grom::Nodes that have been grouped (nodes)
+        # Each instance of GroupingHelper::GroupedObject is assigned properties of start_date, end_date, nodes and type
+        # Once object has been created, calls sort_grouped_nodes_by_date method to sort that object's nodes by date
+        #
+        # @param data_hash [Hash] Keys identify grouping, with each value being an array of grouped, ungrouped and unknown Grom::Nodes
+        # @param key [String] Key identifies grouping of Grom::Nodes
+        # @return [Array] with instances of GroupingHelper::GroupedObject
+        def self.create_grouped_objects(data_hash, key)
+          grouped = []
+
+          grouped_object = RoleGroupingHelper::RoleGroupedObject.new
+          grouped_object.nodes = data_hash[key]
+
+          start_date = nil
+          end_date = nil
+          current_nodes = []
+
+          grouped_object.nodes.each do |node|
+            # Find nodes that represents current roles
+            current_nodes << node if node.try(:end_date).nil? || node.end_date.nil?
+            # Find earliest start date and latest end date
+            start_date = node.start_date if start_date.nil? || node.start_date < start_date
+            end_date = node.end_date if current_nodes.empty? && (end_date.nil? || node.end_date > end_date)
+          end
+
+          # Set properties of the object
+          # TODO: Might need to adjust to allow for multiple roles roles and memberships of a committee
+          grouped_object.type = grouped_object.nodes.first.type
+          grouped_object.start_date = start_date
+          grouped_object.end_date = current_nodes.empty? ? end_date : nil
+
+          # Add sorted object to the array
+          sort_grouped_nodes_by_date(grouped_object, current_nodes)
+          grouped << grouped_object
+        end
+
+        # Sorts an array of grouped Grom::Nodes by end date, placing the most current Grom::Node at the start of the array
+        #
+        # @param grouped_object [Instance object] Instance of GroupingHelper::GroupedObject
+        # @param current_node [Grom::Node] Grom::Node with no end date (representing current)
+        # @return [Instance object] Returns the same instance, with nodes sorted by end date
+        def self.sort_grouped_nodes_by_date(grouped_object, current_nodes)
+          grouped_object.nodes -= current_nodes unless current_nodes.empty?
+          grouped_object.nodes.sort_by!(&:end_date).reverse!
+          grouped_object.nodes.unshift(current_nodes).flatten! unless current_nodes.empty?
+        end
+      end
+    end
+  end
+end

data/lib/parliament/utils/helpers.rb

@@ -7,6 +7,9 @@ require_relative './helpers/parliament_helper'
 require_relative './helpers/postcode_helper'
 require_relative './helpers/request_helper'
 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 'parliament/grom/decorator'
 

data/lib/parliament/utils/version.rb

@@ -1,5 +1,5 @@
 module Parliament
   module Utils
-    VERSION = '0.9.0'.freeze
+    VERSION = '0.9.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parliament-utils
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Rebecca Appleyard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parliament-ruby
@@ -331,13 +331,16 @@ files:
 - lib/parliament/utils/config/initializers/wrap_parameters.rb
 - lib/parliament/utils/helpers.rb
 - lib/parliament/utils/helpers/application_helper.rb
+- lib/parliament/utils/helpers/business_item_grouping_helper.rb
 - 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/houses_helper.rb
 - lib/parliament/utils/helpers/markdown_helper.rb
 - lib/parliament/utils/helpers/parliament_helper.rb
 - lib/parliament/utils/helpers/postcode_helper.rb
 - lib/parliament/utils/helpers/request_helper.rb
+- lib/parliament/utils/helpers/role_grouping_helper.rb
 - lib/parliament/utils/helpers/translation_helper.rb
 - lib/parliament/utils/helpers/v_card_helper.rb
 - lib/parliament/utils/railtie.rb