parliamentarian 0.8.8 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8b5a3028c73a5863acb868b3f12ef9b945f484b3c69f590d4f25154a911a3fa
-  data.tar.gz: 15f40db79771b83704c75c328503dd5686af7a6aaba4be5ea34af008788a43c2
+  metadata.gz: abc1c18e10a9b730253ef89418b8a41f23a536abb4cc71bf92994cd3ee00b036
+  data.tar.gz: a0ab9f0d96adcb030c7bdd137d055b3445767f46c5945c9778fca790ba55b00d
 SHA512:
-  metadata.gz: 8f1d8013a232ea47b941e881c0a8df3f2eeb0dbcc87342978aec8b3b33841c1ec0214f25403af7dc797cac1ad3391cdabd4df2a2cd07ee12fb95e61467be3c2e
-  data.tar.gz: a2ab3ac29a7cf2469da5b483bcd383cdc3f396d50cb25a2fcbdc5374986dc9897231a2ac853241694708f1e73d16c26bbccaaf87af5f9c6cb4963ec3f1b09e0a
+  metadata.gz: eefa05d120b1e295ed88ef26a9890d95506bacb6b0d7bd4c50ad3cdd13addb8bc0aab8b640641de8edcb44ed42027591a8ee13a10241c03ac3826d18e5e29eae
+  data.tar.gz: 9263f573247b1ab11f0c21c7b8aa8c5c8dc37ac98a4015cde228d92e1d336f1367d2f091b2057e1a0ab832ee5cd30bc36fdd61b64d8695e05eee8f734c5bf017

data/CHANGELOG

@@ -0,0 +1,38 @@
+# CHANGELOG
+
+## 20260913
+
+0.9.0: + README.md, CHANGELOG, Rakefile.
+
+1. + README.md: what the library does, the two parliaments it covers, the method per chamber, and that a row's attributes are the CSV's own headings underscored. 31 of the 32 gems here carry one and this was the exception.
+2. + CHANGELOG: this file. The commit subjects name a version from 0.8.6 back; before that the history is the import of 20210408 and says nothing about releases.
+3. + Rakefile: a rake/testtask naming test/Parliamentarian/**/*.rb. The tests carry no _test suffix, so the usual glob finds nothing, and they are named directly rather than through test/Parliamentarian.rb: that runner shares its name with the library, so requiring it under rake's loader makes `require 'Parliamentarian'` from within a test resolve back to the runner which is still loading, and the constant is never defined.
+4. ~ parliamentarian.gemspec: + 'CHANGELOG', 'README.md' and 'Rakefile' to spec.files, without which the three sit in the repository and the gem does not carry them; and the list reordered, the gemspec first and then the globs and the rest alphabetically, which is how the estate writes it.
+5. ~ Parliamentarian::VERSION: /0.8.8/0.9.0/
+
+0.8.8: ~ test/Parliamentarian/Australia/Victoria.rb: the council stub returned the assembly's rows.
+
+
+## 20260911
+
+0.8.7: ~ lib/Parliamentarian.rb: + require of Parliamentarian/VERSION; ~ VERSION.rb: /class/module/, the library declaring a module; + test/Parliamentarian/VERSION.rb
+
+
+## 20260822
+
+0.8.6: + LICENSE, and the gemspec: /Ruby/MIT/, - spec.date.
+
+1. ~ parliamentarian.gemspec: /Ruby/MIT/, it having named a licence the repository never carried; - spec.date, which rubygems sets from the build.
+2. + .gitignore, for .DS_Store and *.gem, and - lib/.DS_Store and the four under test/. Both 20210409, the day after 0.8.5, and recorded here as the first versioned commit after them.
+3. ~ Parliamentarian::VERSION: /0.8.5/0.8.6/
+
+
+## 20210408
+
+0.8.5: + VERSION, the gemspec, and the required lib files; ~ Gemfile: + webmock.
+
+1. + VERSION file.
+2. + parliamentarian.gemspec.
+3. ~ Gemfile to include webmock.
+4. + required lib files, to be broken out later.
+5. Taken from lib/parliamentarian.rb's in-source change log, items 10 to 13 under its 4/5 marker.

data/README.md

@@ -0,0 +1,99 @@
+# Parliamentarian
+
+## Description
+
+Download and parse the current list of members of parliament, and their contact
+details, from the parliaments which publish one as a CSV.
+
+Two are covered so far: the federal parliament of Australia, and the parliament of
+the State of Victoria. Each chamber is a method, and each row comes back as an
+object whose attributes are the column headings underscored, so a CSV which gains
+a column gains an attribute without anything here being changed.
+
+## Installation
+
+### 0. Have a recent version of Ruby installed
+
+### 1. Via RubyGems
+
+```shell
+$ gem install parliamentarian
+```
+
+Or in a Gemfile:
+
+```ruby
+gem 'parliamentarian'
+```
+
+## Usage
+
+### Australia, federally
+
+```ruby
+require 'parliamentarian'
+
+Parliamentarian::Australia::Federal.senators
+# => [#<Parliamentarian::Australia::Federal>, ...], the Senate
+
+Parliamentarian::Australia::Federal.members
+# => [#<Parliamentarian::Australia::Federal>, ...], the House of Representatives
+
+Parliamentarian::Australia::Federal.all
+# => both chambers together
+```
+
+### Victoria
+
+```ruby
+Parliamentarian::Australia::Victoria.legislative_councillors
+# => [#<Parliamentarian::Australia::Victoria>, ...], the upper house
+
+Parliamentarian::Australia::Victoria.legislative_assemblymembers
+# => [#<Parliamentarian::Australia::Victoria>, ...], the lower house
+
+Parliamentarian::Australia::Victoria.all
+# => both houses together
+```
+
+### A member
+
+The attributes are the CSV's own column headings, underscored:
+
+```ruby
+member = Parliamentarian::Australia::Victoria.legislative_councillors.first
+
+member.last_name        # => "Smith"
+member.preferred_name   # => "Jane"
+member.electorate       # => "Southern Metropolitan"
+member.party            # => "Australian Labor Party"
+member.eo_postcode      # => "3000", taken from the electorate office address
+```
+
+`first_name`, `firstname`, `lastname` and `surname` are aliases, the two
+parliaments not agreeing on which of them to publish.
+
+### Reading from a file rather than the web
+
+Each method takes a path, which is what the tests use and what a cached copy
+wants:
+
+```ruby
+Parliamentarian::Australia::Victoria.legislative_councillors('councilmembers.csv')
+Parliamentarian::Australia::Victoria.all('councilmembers.csv', 'assemblymembers.csv')
+```
+
+A path is read from disk and anything with an `http` or `https` scheme is
+fetched, so the same method serves both.
+
+## Contributing
+
+1. Fork it: `https://github.com/thoran/Parliamentarian/fork`
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Create a new pull request
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,14 @@
+# Rakefile
+
+require 'rake/testtask'
+
+# The tests carry no _test suffix, so the usual glob finds nothing, and they are
+# named directly rather than through test/Parliamentarian.rb: that runner shares
+# its name with the library, so requiring it under rake's loader makes
+# `require 'Parliamentarian'` from within a test resolve back to the runner which
+# is still loading.  Each test puts lib on the load path for itself.
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/Parliamentarian/**/*.rb']
+end
+
+task default: :test

data/lib/Parliamentarian/VERSION.rb

@@ -1,5 +1,5 @@
 module Parliamentarian
 
-  VERSION = '0.8.8'
+  VERSION = '0.9.0'
 
 end

data/parliamentarian.gemspec

@@ -14,11 +14,14 @@ Gem::Specification.new do |spec|
   spec.license = 'MIT'
 
   spec.files = [
+    'parliamentarian.gemspec',
     Dir['lib/**/*.rb'],
     Dir['test/**/*.rb'],
+    'CHANGELOG',
     'Gemfile',
     'LICENSE',
-    'parliamentarian.gemspec',
+    'README.md',
+    'Rakefile',
   ].flatten
   spec.required_ruby_version = '>= 2.5'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parliamentarian
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.9.0
 platform: ruby
 authors:
 - thoran
@@ -59,8 +59,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG
 - Gemfile
 - LICENSE
+- README.md
+- Rakefile
 - lib/Array/blankQ.rb
 - lib/Array/extract_optionsX.rb
 - lib/Array/peek_options.rb