everypolitician-popolo 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 262682eaaa9963c7749cd96f5a5134fab88e815f
-  data.tar.gz: 3d90b328a132fba3ea0a3d2100f5a00e585dd1b1
+  metadata.gz: c51032c9ca912048c8d0c49fce9d6226da6247eb
+  data.tar.gz: f89f6deb7b30f34d2d148801da1c7ac6470f4737
 SHA512:
-  metadata.gz: 29f9a20d955a4281608a4482fc8374c5dee19d75c0b040f6f7a46aeaa70715c1104000b6c074655394c48717226bffd755396d873a6a56bd946f146649fd5786
-  data.tar.gz: 593e9de9b997aa687a2e3967918938ed49a30b2964953e772b3fd7dd0369d0caf4462f8c0765a769c6e21f8d6e4ec0bed0e75328276f1dcb2dc2e6bc9d574dc9
+  metadata.gz: dd0c15c730568c77cdf45ccc8d5edf8d751cea35bd489b1999d87b0aa0f2d65665460961a2d2799e8b34e6c3640d9dbffa8f41bf970935bac9eb38b219c9d513
+  data.tar.gz: d53eb7d691c1c4f263442358669ba66708fd160d95305396017063c652aab7abc503dc309a9ecb5bd912ca4b58e40caad8f566088f8c2113cac5d3996d578a98

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rubocop-https---raw-githubusercontent-com-everypolitician-everypolitician-data-master--rubocop-base-yml

data/CHANGELOG.md

@@ -3,6 +3,44 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.8.0] - 2016-10-28
+
+### Added
+
+- `Popolo#latest_term` replaces `Popolo#current_term` and has the same
+  functionality. It will return the most recent term for the legislature
+  but it is not guaranteed that the term will be a current one. You
+  should check the `start_date` and `end_date` of the term to determine that.
+- Added `Election` and `LegislativePeriod` classes for `Event`s.
+- `Collection#where` now returns a `Collection` rather than an `Array`
+- Added the following shortcut methods:
+  - `Membership#area`
+  - `Membership#legislative_period` or `Membership#term`
+  - `Membership#person`
+  - `Membership#on_behalf_of` or `Membership#party`
+  - `Membership#organization`
+  - `Membership#post`
+  - `Post#organization`
+  - `Person#memberships`
+
+### Changed
+
+- Accessors are no longer generated dynamically for Popolo properties,
+  which means that all normal accessor methods will now exist even where
+  a record doesn’t have that property.
+
+### Deprecated
+
+- `Popolo#current_term` - use `latest_term` instead.
+
+## [0.7.0] - 2016-09-26
+
+### Added
+
+- Property lookups are now cached the first time they are used so
+  multiple searches on the same property should be much quicker,
+  especially on large data sets.
+
 ## [0.6.1] - 2016-09-12
 
 ### Fixes
@@ -75,3 +113,5 @@ exist, rather than blowing up.
 [0.4.0]: https://github.com/everypolitician/everypolitician-popolo/compare/v0.3.0...v0.4.0
 [0.5.0]: https://github.com/everypolitician/everypolitician-popolo/compare/v0.4.0...v0.5.0
 [0.6.0]: https://github.com/everypolitician/everypolitician-popolo/compare/v0.5.0...v0.6.0
+[0.7.0]: https://github.com/everypolitician/everypolitician-popolo/compare/v0.6.0...v0.7.0
+[0.8.0]: https://github.com/everypolitician/everypolitician-popolo/compare/v0.7.0...v0.8.0

data/everypolitician-popolo.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'require_all'
+
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'

data/lib/everypolitician/popolo.rb

@@ -1,13 +1,7 @@
-require 'everypolitician/popolo/version'
-require 'everypolitician/popolo/collection'
-require 'everypolitician/popolo/entity'
-require 'everypolitician/popolo/person'
-require 'everypolitician/popolo/organization'
-require 'everypolitician/popolo/area'
-require 'everypolitician/popolo/event'
-require 'everypolitician/popolo/post'
-require 'everypolitician/popolo/membership'
 require 'json'
+require 'require_all'
+
+require_rel 'popolo'
 
 module Everypolitician
   module Popolo
@@ -30,38 +24,46 @@ module Everypolitician
       end
 
       def persons
-        People.new(popolo[:persons], self)
+        @persons ||= People.new(popolo[:persons], self)
       end
 
       def organizations
-        Organizations.new(popolo[:organizations], self)
+        @organizations ||= Organizations.new(popolo[:organizations], self)
       end
 
       def areas
-        Areas.new(popolo[:areas], self)
+        @areas ||= Areas.new(popolo[:areas], self)
       end
 
       def events
-        Events.new(popolo[:events], self)
+        # do the sorting at the popolo level so we still get an Events object back
+        @events ||= Events.new(popolo[:events].to_a.sort_by { |e| e[:start_date] }, self)
       end
 
       def posts
-        Posts.new(popolo[:posts], self)
+        @posts ||= Posts.new(popolo[:posts], self)
       end
 
       def memberships
-        Memberships.new(popolo[:memberships], self)
+        @memberships ||= Memberships.new(popolo[:memberships], self)
+      end
+
+      def elections
+        @elections ||= events.elections
       end
 
       def legislative_periods
-        events.where(classification: 'legislative period').sort_by(&:start_date)
+        @legislative_periods ||= events.legislative_periods
       end
       alias terms legislative_periods
 
-      def current_legislative_period
-        legislative_periods.last
+      def latest_legislative_period
+        legislative_periods.max_by(&:start_date)
       end
-      alias current_term current_legislative_period
+      alias latest_term latest_legislative_period
+
+      alias current_legislative_period latest_legislative_period
+      alias current_term latest_legislative_period
     end
   end
 end

data/lib/everypolitician/popolo/area.rb

@@ -1,6 +1,29 @@
 module Everypolitician
   module Popolo
-    class Areas < Collection; end
-    class Area < Entity; end
+    class Area < Entity
+      def identifiers
+        document.fetch(:identifiers, [])
+      end
+
+      def name
+        document.fetch(:name, nil)
+      end
+
+      def other_names
+        document.fetch(:other_names, [])
+      end
+
+      def type
+        document.fetch(:type, nil)
+      end
+
+      def wikidata
+        identifier('wikidata')
+      end
+    end
+
+    class Areas < Collection
+      entity_class Area
+    end
   end
 end

data/lib/everypolitician/popolo/collection.rb

@@ -6,9 +6,18 @@ module Everypolitician
       attr_reader :documents
       attr_reader :popolo
 
+      # set the class that represents individual items in the
+      # collection
+      def self.entity_class(entity = nil)
+        @entity_class ||= entity
+      end
+
       def initialize(documents, popolo = nil)
-        @documents = documents ? documents.map { |p| klass.new(p, popolo) } : []
+        @entity_class = {}
+        @documents = documents ? documents.map { |p| class_for_entity(p).new(p, popolo) } : []
         @popolo = popolo
+        @indexes = {}
+        @of_collection = {}
       end
 
       def each(&block)
@@ -25,32 +34,29 @@ module Everypolitician
       end
 
       def where(attributes = {})
-        select do |object|
-          attributes.all? { |k, v| object.send(k) == v }
-        end
+        new_collection(attributes.map { |k, v| index_for(k.to_sym)[v].to_a }.reduce(:&))
+      end
+
+      def empty?
+        count.zero?
+      end
+
+      def of_collection(collection)
+        @of_collection[collection] ||= new_collection(select { |e| e.class == collection.entity_class }, collection)
       end
 
       private
 
-      # TODO: This feels pretty nasty, is there a better way of working out the
-      # class name?
-      def klass
-        case self.class.to_s.split('::').last
-        when 'People'
-          Person
-        when 'Organizations'
-          Organization
-        when 'Memberships'
-          Membership
-        when 'Events'
-          Event
-        when 'Posts'
-          Post
-        when 'Areas'
-          Area
-        else
-          raise "Unknown class: #{self.class}"
-        end
+      def index_for(attr)
+        @indexes[attr] ||= group_by(&attr)
+      end
+
+      def new_collection(entities, klass = self.class)
+        klass.new(entities.to_a.map(&:document), popolo)
+      end
+
+      def class_for_entity(_document)
+        self.class.entity_class
       end
     end
   end

data/lib/everypolitician/popolo/election.rb

@@ -0,0 +1,10 @@
+module Everypolitician
+  module Popolo
+    class Election < Event
+      classification 'general election'
+    end
+    class Elections < Collection
+      entity_class Election
+    end
+  end
+end

data/lib/everypolitician/popolo/entity.rb

@@ -1,10 +1,22 @@
 module Everypolitician
   module Popolo
     class Entity
-      attr_accessor :id
       attr_reader :document
       attr_reader :popolo
 
+      def self.classification(classification = nil)
+        @classification ||= classification
+      end
+
+      def self.inherited(subclass)
+        @subclasses ||= []
+        @subclasses.push(subclass)
+      end
+
+      def self.subclasses
+        @subclasses || []
+      end
+
       def initialize(document, popolo = nil)
         @document = document
         @popolo = popolo
@@ -18,6 +30,10 @@ module Everypolitician
         end
       end
 
+      def id
+        document.fetch(:id, nil)
+      end
+
       def [](key)
         document[key]
       end
@@ -38,6 +54,10 @@ module Everypolitician
       def identifier(scheme)
         identifiers.find(-> { {} }) { |i| i[:scheme] == scheme }[:identifier]
       end
+
+      def wikidata
+        identifier('wikidata')
+      end
     end
   end
 end

data/lib/everypolitician/popolo/event.rb

@@ -1,8 +1,43 @@
 module Everypolitician
   module Popolo
-    class Events < Collection; end
     class Event < Entity
-      attr_accessor :start_date, :end_date
+      def start_date
+        document.fetch(:start_date, nil)
+      end
+
+      def end_date
+        document.fetch(:end_date, nil)
+      end
+
+      def name
+        document.fetch(:name, nil)
+      end
+
+      def classification
+        document.fetch(:classification, nil)
+      end
+
+      def organization_id
+        document.fetch(:organization_id, nil)
+      end
+    end
+
+    class Events < Collection
+      entity_class Event
+
+      def elections
+        of_collection(Elections)
+      end
+
+      def legislative_periods
+        of_collection(LegislativePeriods)
+      end
+
+      def class_for_entity(document)
+        @entity_class[document[:classification]] ||= self.class.entity_class.subclasses.find do |e|
+          e.classification == document[:classification]
+        end || self.class.entity_class
+      end
     end
   end
 end

data/lib/everypolitician/popolo/legislative_period.rb

@@ -0,0 +1,14 @@
+module Everypolitician
+  module Popolo
+    class LegislativePeriod < Event
+      classification 'legislative period'
+
+      def memberships
+        @memberships ||= popolo.memberships.where(legislative_period_id: id, organization_id: organization_id)
+      end
+    end
+    class LegislativePeriods < Collection
+      entity_class LegislativePeriod
+    end
+  end
+end

data/lib/everypolitician/popolo/membership.rb

@@ -1,13 +1,78 @@
 module Everypolitician
   module Popolo
-    class Memberships < Collection; end
-
     class Membership < Entity
-      attr_accessor :person_id, :on_behalf_of_id, :organization_id, :area_id, :role, :start_date, :end_date
+      def person_id
+        document.fetch(:person_id, nil)
+      end
+
+      def on_behalf_of_id
+        document.fetch(:on_behalf_of_id, nil)
+      end
+
+      def organization_id
+        document.fetch(:organization_id, nil)
+      end
+
+      def area_id
+        document.fetch(:area_id, nil)
+      end
+
+      def legislative_period_id
+        document.fetch(:legislative_period_id, nil)
+      end
+
+      def post_id
+        document.fetch(:post_id, nil)
+      end
+
+      def role
+        document.fetch(:role, nil)
+      end
+
+      def start_date
+        document.fetch(:start_date, nil)
+      end
+
+      def end_date
+        document.fetch(:end_date, nil)
+      end
 
       def person
         popolo.persons.find_by(id: person_id)
       end
+
+      def organization
+        popolo.organizations.find_by(id: organization_id)
+      end
+
+      def legislative_period
+        popolo.events.find_by(id: legislative_period_id)
+      end
+
+      alias term legislative_period
+
+      def on_behalf_of
+        popolo.organizations.find_by(id: on_behalf_of_id)
+      end
+
+      alias party on_behalf_of
+
+      def area
+        popolo.areas.find_by(id: area_id)
+      end
+
+      def post
+        popolo.posts.find_by(id: post_id)
+      end
+
+      def ==(other)
+        self.class == other.class && instance_variables.all? { |v| instance_variable_get(v) == other.instance_variable_get(v) }
+      end
+      alias eql? ==
+    end
+
+    class Memberships < Collection
+      entity_class Membership
     end
   end
 end

data/lib/everypolitician/popolo/organization.rb

@@ -1,11 +1,45 @@
 module Everypolitician
   module Popolo
-    class Organizations < Collection; end
-
     class Organization < Entity
-      def wikidata
-        identifier('wikidata')
+      def classification
+        document.fetch(:classification, nil)
+      end
+
+      def identifiers
+        document.fetch(:identifiers, [])
+      end
+
+      def image
+        document.fetch(:image, nil)
+      end
+
+      def links
+        document.fetch(:links, [])
+      end
+
+      def name
+        document.fetch(:name, nil)
       end
+
+      def other_names
+        document.fetch(:other_names, [])
+      end
+
+      # TODO: this should be pushed into a Legislature class when we split
+      # this into Party and Legislature classes
+      def seats
+        document.fetch(:seats, nil)
+      end
+
+      def srgb
+        document.fetch(:srgb, nil)
+      end
+      alias associated_colour srgb
+      alias associated_color srgb
+    end
+
+    class Organizations < Collection
+      entity_class Organization
     end
   end
 end

data/lib/everypolitician/popolo/person.rb

@@ -1,11 +1,47 @@
 module Everypolitician
   module Popolo
-    class People < Collection; end
-
     class Person < Entity
       class Error < StandardError; end
 
-      attr_accessor :name, :email, :image, :gender, :birth_date, :death_date, :honorific_prefix, :honorific_suffix
+      def name
+        document.fetch(:name, nil)
+      end
+
+      def email
+        document.fetch(:email, nil)
+      end
+
+      def image
+        document.fetch(:image, nil)
+      end
+
+      def gender
+        document.fetch(:gender, nil)
+      end
+
+      def national_identity
+        document.fetch(:national_identity, nil)
+      end
+
+      def summary
+        document.fetch(:summary, nil)
+      end
+
+      def birth_date
+        document.fetch(:birth_date, nil)
+      end
+
+      def death_date
+        document.fetch(:death_date, nil)
+      end
+
+      def honorific_prefix
+        document.fetch(:honorific_prefix, nil)
+      end
+
+      def honorific_suffix
+        document.fetch(:honorific_suffix, nil)
+      end
 
       def links
         document.fetch(:links, [])
@@ -39,14 +75,38 @@ module Everypolitician
         link('facebook')
       end
 
-      def wikidata
-        identifier('wikidata')
-      end
-
       def sort_name
         name
       end
 
+      def family_name
+        document.fetch(:family_name, nil)
+      end
+
+      def given_name
+        document.fetch(:given_name, nil)
+      end
+
+      def patronymic_name
+        document.fetch(:patronymic_name, nil)
+      end
+
+      def identifiers
+        document.fetch(:identifiers, [])
+      end
+
+      def images
+        document.fetch(:images, [])
+      end
+
+      def other_names
+        document.fetch(:other_names, [])
+      end
+
+      def sources
+        document.fetch(:sources, [])
+      end
+
       def name_at(date)
         return name unless key?(:other_names)
         historic = other_names.select { |n| n.key?(:end_date) }
@@ -63,5 +123,9 @@ module Everypolitician
         popolo.memberships.where(person_id: id)
       end
     end
+
+    class People < Collection
+      entity_class Person
+    end
   end
 end

data/lib/everypolitician/popolo/post.rb

@@ -1,8 +1,20 @@
 module Everypolitician
   module Popolo
-    class Posts < Collection; end
     class Post < Entity
-      attr_reader :label
+      def label
+        document.fetch(:label, nil)
+      end
+
+      def organization_id
+        document.fetch(:organization_id, nil)
+      end
+
+      def organization
+        popolo.organizations.find_by(id: organization_id)
+      end
+    end
+    class Posts < Collection
+      entity_class Post
     end
   end
 end

data/lib/everypolitician/popolo/version.rb

@@ -1,5 +1,5 @@
 module Everypolitician
   module Popolo
-    VERSION = '0.6.1'.freeze
+    VERSION = '0.8.0'.freeze
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: everypolitician-popolo
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Chris Mytton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -103,8 +117,10 @@ files:
 - lib/everypolitician/popolo.rb
 - lib/everypolitician/popolo/area.rb
 - lib/everypolitician/popolo/collection.rb
+- lib/everypolitician/popolo/election.rb
 - lib/everypolitician/popolo/entity.rb
 - lib/everypolitician/popolo/event.rb
+- lib/everypolitician/popolo/legislative_period.rb
 - lib/everypolitician/popolo/membership.rb
 - lib/everypolitician/popolo/organization.rb
 - lib/everypolitician/popolo/person.rb