Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README for unstable position data interface #15609

Merged
merged 1 commit into from
Feb 21, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,38 @@ bundle exec rake test:all
bundle exec rake
```

## Internal documentation

### Interacting with unstable data

We use data from the `unstable/positions.csv` file in a legislature's
directory to display cabinet memberships on the website. Because this data
is unstable there currently aren't methods in [the `everypolitician`
gem](https://github.com/everypolitician/everypolitician-ruby) for
interacting with it, so viewer-sinatra has some of its own classes for
dealing with it. These classes live in the
`lib/everypolitician_extensions.rb` file and are documented below.

#### Get all cabinet memberships for a person

To print all of the known cabinet memberships for a person, you can do the
following:

```ruby
house_of_commons = Everypolitician::Index.new.country('UK').legislature('Commons')
person = house_of_commons.popolo.persons.find_by(name: 'Gordon Brown')

person.cabinet_memberships.each do |membership|
puts "#{person.name} was #{membership.label} #{membership.start_date} - #{membership.end_date}"
end
```

Which will output something like this:

```
Gordon Brown was Prime Minister of the United Kingdom 2007-06-27 - 2010-05-11
Gordon Brown was Chancellor of the Exchequer 1997-05-02 - 2007-06-27
```

## Sinatra, SASS, styling

Expand Down