parliament-utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '09e15bd64d19537e0e9fa58d9a4076d8ef45fe09'
+  data.tar.gz: bd42b87e7a053ec1545f7bfe4aae4a0a69a30fd2
+SHA512:
+  metadata.gz: 4d716e8c3d204adf87ca949f62a5533c662a70b8c76b71121f976e5fe17851c2918e389bdcacc24f56e1f5e81eba438d2a1995d4299ee9dc162cbd225c677f9d
+  data.tar.gz: f0109a25216eb6c706ec6f485519171e822f66a7bfc62d2f3baef53883b5937b9b065bd4eb8017310ecc85a9186c52b53bc4fb97241188a03356d2d820059418

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.hound.yml

@@ -0,0 +1,4 @@
+ruby:
+  config_file: .rubocop.yml
+
+fail_on_violations: true

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,55 @@
+Metrics/LineLength:
+  Description: 'Limit lines to 120 characters.'
+  Max: 120
+  IgnoredPatterns: ['\A#', '\A([ ]{2}|[ ]{4})#']
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/AlignHash:
+  Severity: fatal
+  Enabled: true
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SpaceAroundOperators:
+  # When true, allows most uses of extra spacing if the intent is to align
+  # with an operator on the previous or next line, not counting empty lines
+  # or comment lines.
+  AllowForAlignment: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'vendor/**/*'
+    - 'spec/**/*'
+    - 'tmp/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mattrayner1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parliament-utils.gemspec
+gemspec
+
+# Include coveralls for CI coverage reports
+gem 'coveralls', require: false

data/Instructions - Steps to include in app.md

@@ -0,0 +1,95 @@
+## Integration into Parliament Applications
+
+The following steps can be followed to include this gem in your application:
+
+*Gemfile*
+
+1. Add `gem 'parliament-utils'` to Gemfile, below `parliament-grom-decorators`
+2. Ensure latest version of `pugin` gem _version tbc_
+
+*config*
+3. Delete `config/initializers` folder
+4. Delete `config/puma.rb` file
+5. Add `require 'parliament/utils'` to `config/application.rb` file, below `require 'pugin'`
+
+*spec/spec_helper*
+5. Remove all contents from `spec/spec_helper`
+
+*spec/rails_helper*
+6. Remove VCR and RSpec configuration blocks
+7. Remove the following code, if it exists
+
+```ruby
+`require 'parliament/ntriple'`
+`require 'vcr'`
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+```
+
+8. Add the following code:
+
+```ruby
+require 'parliament/utils/test_helpers'
+RSpec.configure do |config|
+  Parliament::Utils::TestHelpers.included_modules.each do |m|
+    m.load_rspec_config(config)
+  end
+end
+```
+
+*spec/helpers*
+
+9. Delete `flag_helper_spec.rb` file, if it exists
+
+*spec/controllers/concerns*
+
+10. Delete `postcode_helper_spec.rb` file, if it exists
+
+*app/controllers/concerns*
+
+11. Delete `format_helper.rb`, `houses_helper.rb`, `parliament_helper.rb`, `postcode_helper.rb`, `request_helper.rb`, `v_card_helper.rb` files, if they exist
+
+*app/controllers/application_controller*
+12. Remove the following references to Helpers, if they exist
+
+```
+require 'houses_helper'
+require 'request_helper'
+require 'parliament_helper'
+require 'format_helper'
+require 'v_card_helper'
+include HousesHelper
+include RequestHelper
+include ParliamentHelper
+include FormatHelper
+include VCardHelper
+```
+
+14. Add `require 'parliament/utils'`
+15. Add the following `include` statements to the `ApplicationController` class (ResourceHelper and VCardHelper may not be required in all apps)
+
+```ruby
+include ResourceHelper
+include Parliament::Utils::Helpers::ApplicationHelper
+include Parliament::Utils::Helpers::VCardHelper
+```
+
+16. Remove `data_check`, `data_url`, `build_request`, `populate_alternates` methods, if they exist
+
+*app/helpers*
+
+17. Delete `application_helper.rb`, `flag_helper.rb` files, if they exist
+
+*Referencing new gem modules*
+
+18. Find all instances of the Helpers mentioned below (in entire project) and replace as required:
+
+```
+Replace `ApplicationHelper` with `Parliament::Utils::Helpers::ApplicationHelper`
+Replace `FlagHelper` with `Parliament::Utils::Helpers::FlagHelper`
+Replace `FormatHelper` with `Parliament::Utils::Helpers::FormatHelper`
+Replace `HousesHelper` with `Parliament::Utils::Helpers::HousesHelper`
+Replace `ParliamentHelper` with `Parliament::Utils::Helpers::ParliamentHelper`
+Replace `PostcodeHelper` with `Parliament::Utils::Helpers::PostcodeHelper`
+Replace `RequestHelper` with `Parliament::Utils::Helpers::RequestHelper`
+Replace `VCardHelper` with `Parliament::Utils::Helpers::VCardHelper`
+```

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016-2017 United Kingdom Parliament
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Makefile

@@ -0,0 +1,16 @@
+gemset:
+	rvm gemset create parliament-utils
+	rvm --force gemset empty parliament-utils
+	rvm gemset use parliament-utils
+
+test: gemset
+	bundle install
+	bundle exec rake
+
+build:
+	rm -f parliament-utils-*.gem
+	gem build parliament-utils.gemspec
+
+release: build test
+	gem push parliament-utils-*.gem
+	rm parliament-utils-*.gem

data/README.md

@@ -0,0 +1,177 @@
+# Parliament::Utils
+
+[parliament-utils][parliament-utils], created by the Parliamentary Digital Service, holds all reusable application configuration, test set up and generic helper methods. It is intended to be used across all applications making up the UK Parliament's website.
+
+> **NOTE:** This gem is in active development and is likely to change at short notice. It is not recommended that you use this in any production environment.
+
+## Requirements
+
+[parliament-utils][parliament-utils] requires the following:
+
+* [Ruby][ruby] - [click here][ruby-version] for the exact version
+* [Bundler][bundler]
+
+## Installation
+
+Within your application, add this line to your application's `Gemfile`:
+
+```ruby
+gem 'parliament-utils'
+```
+
+Once you add the gem to your `Gemfile` run:
+
+```ruby
+bundle install
+```
+
+### Usage
+
+Follow installation instructions below to integrate the [parliament-utils][parliament-utils] gem into an existing application
+
+Now all application configuration, test set up and helper methods should be available within your application.
+
+### Instructions
+
+The following steps can be followed to include this gem in your application:
+
+*Gemfile*
+
+1. Add `gem 'parliament-utils'` to Gemfile, below `parliament-grom-decorators`
+2. Ensure latest version of `pugin` gem _version tbc_
+
+*config*
+3. Delete `config/initializers` folder
+4. Delete `config/puma.rb` file
+5. Add `require 'parliament/utils'` to `config/application.rb` file, below `require 'pugin'`
+
+*spec/spec_helper*
+5. Remove all contents from `spec/spec_helper`
+
+*spec/rails_helper*
+6. Remove VCR and RSpec configuration blocks
+7. Remove the following code, if it exists
+
+```ruby
+`require 'parliament/ntriple'`
+`require 'vcr'`
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+```
+
+8. Add the following code:
+
+```ruby
+require 'parliament/utils/test_helpers'
+RSpec.configure do |config|
+  Parliament::Utils::TestHelpers.included_modules.each do |m|
+    m.load_rspec_config(config)
+  end
+end
+```
+
+*spec/helpers*
+
+9. Delete `flag_helper_spec.rb` file, if it exists
+
+*spec/controllers/concerns*
+
+10. Delete `postcode_helper_spec.rb` file, if it exists
+
+*app/controllers/concerns*
+
+11. Delete `format_helper.rb`, `houses_helper.rb`, `parliament_helper.rb`, `postcode_helper.rb`, `request_helper.rb`, `v_card_helper.rb` files, if they exist
+
+*app/controllers/application_controller*
+12. Remove the following references to Helpers, if they exist
+
+```
+require 'houses_helper'
+require 'request_helper'
+require 'parliament_helper'
+require 'format_helper'
+require 'v_card_helper'
+include HousesHelper
+include RequestHelper
+include ParliamentHelper
+include FormatHelper
+include VCardHelper
+```
+
+14. Add `require 'parliament/utils'`
+15. Add the following `include` statements to the `ApplicationController` class (ResourceHelper and VCardHelper may not be required in all apps)
+
+```ruby
+include ResourceHelper
+include Parliament::Utils::Helpers::ApplicationHelper
+include Parliament::Utils::Helpers::VCardHelper
+```
+
+16. Remove `data_check`, `data_url`, `build_request`, `populate_alternates` methods, if they exist
+
+*app/helpers*
+
+17. Delete `application_helper.rb`, `flag_helper.rb` files, if they exist
+
+*Referencing new gem modules*
+
+18. Find all instances of the Helpers mentioned below (in entire project) and replace/use as required:
+
+```
+Replace `ApplicationHelper` with `Parliament::Utils::Helpers::ApplicationHelper`
+Replace `FlagHelper` with `Parliament::Utils::Helpers::FlagHelper`
+Replace `FormatHelper` with `Parliament::Utils::Helpers::FormatHelper`
+Replace `HousesHelper` with `Parliament::Utils::Helpers::HousesHelper`
+Replace `ParliamentHelper` with `Parliament::Utils::Helpers::ParliamentHelper`
+Replace `PostcodeHelper` with `Parliament::Utils::Helpers::PostcodeHelper`
+Replace `RequestHelper` with `Parliament::Utils::Helpers::RequestHelper`
+Replace `VCardHelper` with `Parliament::Utils::Helpers::VCardHelper`
+```
+
+## Getting Started with Development
+
+To clone the repository and set up the dependencies, run the following:
+
+```bash
+git clone https://github.com/ukparliament/parliament-utils.git
+cd parliament-utils
+bundle install
+```
+
+### Running Tests
+
+We use [Rspec][rspec] as our testing framework and tests can be run using:
+
+```bash
+bundle exec rake
+```
+
+## Contributing
+
+1. Fork the repository
+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. Ensure your changes are tested using [Rspec][rspec]
+6. Create a new Pull Request
+
+## License
+
+[parliament-utils][parliament-utils] is licensed under the [Open Parliament Licence][info-license].
+
+[ruby]:                   https://www.ruby-lang.org/en/
+[bundler]:                http://bundler.io
+[rspec]:                  http://rspec.info
+[parliament-utils]: 	    https://github.com/ukparliament/parliament.uk-parliament-utils
+[pds]:                    https://www.parliament.uk/mps-lords-and-offices/offices/bicameral/parliamentary-digital-service/
+[ruby-version]:           https://github.com/ukparliament/pugin/blob/master/.ruby-version
+[rails]:                  http://rubyonrails.org
+[haml]:                   http://haml.info
+
+[info-travis]:            https://travis-ci.org/ukparliament/pugin
+[shield-travis]:          https://img.shields.io/travis/ukparliament/pugin.svg
+
+[info-coveralls]:         https://coveralls.io/github/ukparliament/pugin
+[shield-coveralls]:       https://img.shields.io/coveralls/ukparliament/pugin.svg
+
+[info-license]:           http://www.parliament.uk/site-information/copyright/open-parliament-licence/
+[shield-license]:         https://img.shields.io/badge/license-Open%20Parliament%20Licence-blue.svg

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "parliament/utils"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here