parliament-routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9b8b90010e2446af9ae99a63c9805f9c6d55c35
+  data.tar.gz: b3eaebef9fee56364eb449440320373f1ee84225
+SHA512:
+  metadata.gz: d0ca45ef0829340632f6464a3543dc3271cb15fc5768200b486a482fc9a98f3b9712245081f3832c08c6b57d7899214e3602f002467b35cc5530de5fedc63175
+  data.tar.gz: 28c1c53c4cda52766db3154760ae8c70a0c8946ba775843c55d5ae90aa35c3898c867a922fdeb91c529f10374e196cc14279e8112357a1f642cf4a24c2ba8444

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Bryony Watson
+
+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/README.md

@@ -0,0 +1,67 @@
+# Parliament.uk-routes
+
+[Parliament.uk-routes](https://github.com/ukparliament/parliament.uk-routes "Parliament.uk-routes") is an engine created by the [Parliamentary Digital Service](https://github.com/ukparliament "Parliamentary Digital Service") that holds all of the routes for the UK parliament prototype website, which can then be called upon by any applications that include this gem.
+
+> **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.
+
+### Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Getting Started with Development](#getting-started-with-development)
+  - [Running the tests](#running-the-tests)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Requirements
+[Parliament.uk-routes](https://github.com/ukparliament/parliament.uk-routes "Parliament.uk-routes") requires the following:
+* [Ruby](https://www.ruby-lang.org/en/)
+* [Bundler](http://http://bundler.io/)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'parliament-routes'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install parliament-routes
+```
+
+## Usage
+The engine works in the background adding routes to the application that uses it.
+
+## Getting Started with Development
+To clone the repository and set up the dependencies, run the following:
+```bash
+git clone https://github.com/ukparliament/parliament.uk-routes.git
+cd parliament-routes
+bundle install
+```
+
+### Running the tests
+We use [RSpec](http://rspec.info/) as our testing framework and tests can be run using:
+```bash
+bundle exec rspec
+```
+
+## Contributing
+If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.
+
+1. Fork the repository
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Ensure your changes are tested using [Rspec][rspec]
+1. Create a new Pull Request
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'routes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/lib/ext/action_dispatch/routing/mapper.rb

@@ -0,0 +1,77 @@
+module ActionDispatch
+  module Routing
+    class Mapper
+      # Mapper class provides methods for routes.rb
+      ID_FORMAT_REGEX = /\w{8}/
+
+      # @since 0.0.1
+      # Creates routes for listables
+      #
+      # @param [String] a_z_action a to z route.
+      # @param [String] letter_action letter route.
+      def listable(a_z_action, letter_action)
+        scope '/a-z', as: 'a_z' do
+          get '/',    to: a_z_action
+
+          scope '/:letter', as: 'letter' do
+            get '/', to: letter_action
+          end
+        end
+      end
+
+      # Creates routes for lookupable
+      #
+      # @param [String] action lookup by letter route.
+      def lookupable(action)
+        get '/:letters', to: action
+      end
+
+      # Creates default routes
+      #
+      # @param [String] route_name multiple base routes.
+      # @param [Boolean] current indicates whether to use only current (defaults to true).
+      # @param [Boolean] lookup indicates whether to use lookup (defaults to true).
+      # @param [Boolean] postcode indicates whether to use postcode (defaults to true).
+
+      def build_default_routes(route_name, current: true, lookup: true, postcode: true)
+        get '/', to: "#{route_name}#index"
+        get '/current', to: "#{route_name}#current" if current
+        get '/lookup', to: "#{route_name}#lookup" if lookup
+        post '/postcode_lookup', to: "#{route_name}#postcode_lookup", as: 'postcode_lookup' if postcode
+      end
+
+      # Creates base routes and current routes
+      #
+      # @param [String] parent_route_name parent route.
+      # @param [String] route_name current route.
+      def build_root_and_current_routes(parent_route_name, route_name)
+        scope "/#{route_name}", as: route_name do
+          get '/',        to: "#{parent_route_name}#index"
+          get '/current', to: "#{parent_route_name}#current"
+        end
+      end
+
+      # Creates members routes
+      #
+      # @param [String] route_name members route.
+      # @param [Boolean] current indicates whether to use current (defaults to true).
+      def build_members_routes(route_name, current: true)
+        scope '/members', as: 'members' do
+          get '/', to: "#{route_name}#index"
+
+          listable("#{route_name}#a_to_z", "#{route_name}#letters")
+
+          scope '/current', as: 'current' do # /route_name/:id/members/current
+            if current
+              get '/', to: "#{route_name}#current"
+
+              listable("#{route_name}#a_to_z_current", "#{route_name}#current_letters")
+            end
+          end
+
+          yield if block_given?
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,287 @@
+# require mapper class which holds methods for routing
+require_relative '../app/lib/ext/action_dispatch/routing/mapper.rb'
+
+# Using Rails.application.routes.draw as we want to
+# add to the host application's routes, not the engine's routes
+
+Rails.application.routes.draw do
+  id_format_regex = self.class::ID_FORMAT_REGEX
+
+  ### Root ###
+  # /
+  root 'home#index'
+
+  ### MPs ###
+  # /mps
+  get '/mps', to: 'home#mps'
+
+  ### People ###
+  # /people (multiple 'people' scope)
+  scope '/people', as: 'people' do
+    build_default_routes('people', current: false)
+    listable('people#a_to_z', 'people#letters')
+
+    # /people/members
+    build_members_routes('people/members', current: true)
+  end
+
+  # /people (single 'person' scope)
+  scope '/people', as: 'person' do
+    # /people/:person_id
+    scope '/:person_id' do
+      get '/', to: 'people#show', person_id: id_format_regex
+
+      # /people/:person_id/constituencies
+      build_root_and_current_routes('people/constituencies', 'constituencies')
+
+      get '/contact-points', to: 'people/contact_points#index'
+
+      # /people/:person_id/houses
+      build_root_and_current_routes('people/houses', 'houses')
+
+      # /people/:person_id/parties
+      build_root_and_current_routes('people/parties', 'parties')
+    end
+
+    # Allow lookups - but ensure they are SECOND in the routes list after /people/:person_id
+    lookupable('people#lookup_by_letters')
+  end
+
+  ### Parties ###
+  # /parties (multiple 'parties' scope)
+  scope '/parties', as: 'parties' do
+    build_default_routes('parties', postcode: false)
+    listable('parties#a_to_z', 'parties#letters')
+  end
+
+  # /parties (single 'party' scope)
+  scope '/parties', as: 'party' do
+    # /parties/:party_id
+    scope '/:party_id' do
+      get '/', to: 'parties#show', party_id: id_format_regex
+
+      # /parties/:party_id/members
+      build_members_routes('parties/members', current: true)
+    end
+
+    # Allow lookups - but ensure they are SECOND in the routes list after /parties/:party_id
+    lookupable('parties#lookup_by_letters')
+  end
+
+  ### Postcodes ###
+  # /postcodes (multiple 'postcodes' scope)
+  scope '/postcodes', as: 'postcodes' do
+    get '/', to: 'postcodes#index'
+    post '/lookup', to: 'postcodes#lookup'
+  end
+
+  # /postcodes (single 'postcode' scope)
+  scope '/postcodes', as: 'postcode' do
+    # /postcodes/:postcode
+    scope '/:postcode' do
+      get '/', to: 'postcodes#show'
+    end
+  end
+
+  ### Constituencies ###
+  # /constituencies (multiple 'constituencies' scope)
+  scope '/constituencies', as: 'constituencies' do
+    build_default_routes('constituencies', current: false)
+    listable('constituencies#a_to_z', 'constituencies#letters')
+
+    # /constituencies/current
+    scope '/current', as: 'current' do
+      get '/', to: 'constituencies#current'
+
+      listable('constituencies#a_to_z_current', 'constituencies#current_letters')
+    end
+  end
+
+  # /constituencies (single 'constituency' scope)
+  scope '/constituencies', as: 'constituency' do
+    # /constituencies/:constituency_id
+    scope '/:constituency_id' do
+      get '/', to: 'constituencies#show', constituency_id: id_format_regex
+      get '/contact-point', to: 'constituencies/contact_points#index'
+      get '/map', to: 'constituencies#map'
+
+      # /constituencies/:constituency_id/members
+      build_root_and_current_routes('constituencies/members', 'members')
+    end
+
+    # Allow lookups - but ensure they are SECOND in the routes list after /constituencies/:constituency_id
+    lookupable('constituencies#lookup_by_letters')
+  end
+
+  ## Contact Points ##
+  # /contact-points  (multiple 'contact_points' scope)
+  scope '/contact-points', as: 'contact_points' do
+    get '/', to: 'contact_points#index'
+  end
+
+  # /contact-points (single 'contact_point' scope)
+  scope '/contact-points', as: 'contact_point' do
+    # /contact-points/:contact_point_id
+    scope '/:contact_point_id' do
+      get '/', to: 'contact_points#show', contact_point_id: id_format_regex
+    end
+  end
+
+  ## Houses ##
+  # /houses (multiple 'houses' scope)
+  scope '/houses', as: 'houses' do
+    build_default_routes('houses', current: false, postcode: false)
+  end
+
+  # /houses (single 'house' scope)
+  scope '/houses', as: 'house' do
+    # /houses/:house_id
+    scope '/:house_id' do
+      get '/', to: 'houses#show', house_id: id_format_regex
+
+      # /houses/:house_id/members
+      build_members_routes('houses/members', current: true)
+
+      # /houses/:house_id/parties
+      scope '/parties', as: 'parties' do
+        get '/', to: 'houses/parties#index'
+        get '/current', to: 'houses/parties#current'
+
+        # /houses/:house_id/parties/:party_id
+        scope '/:party_id', as: 'party' do
+          get '/', to: 'houses/parties#show'
+
+          # /houses/:house_id/parties/:party_id/members
+          scope '/members', as: 'members' do
+            get '/', to: 'houses/parties/members#index'
+
+            listable('houses/parties/members#a_to_z', 'houses/parties/members#letters')
+
+            # /houses/:house_id/parties/:party_id/members/current
+            scope '/current', as: 'current' do
+              get '/', to: 'houses/parties/members#current'
+
+              listable('houses/parties/members#a_to_z_current', 'houses/parties/members#current_letters')
+            end
+          end
+        end
+      end
+    end
+
+    # Allow lookups - but ensure they are SECOND in the routes list after /houses/:house_id
+    lookupable('houses#lookup_by_letters')
+  end
+
+  ### Parliaments ###
+  # /parliaments (multiple 'parliaments' scope)
+  scope '/parliaments', as: 'parliaments' do
+    build_default_routes('parliaments', postcode: false)
+    get '/previous', to: 'parliaments#previous'
+    get '/next', to: 'parliaments#next'
+  end
+
+  # /parliaments (single 'parliament' scope)
+  scope '/parliaments', as: 'parliament' do
+    # /parliaments/:parliament_id
+    scope '/:parliament_id' do
+      get '/', to: 'parliaments#show', parliament_id: id_format_regex
+
+      # /parliaments/:parliament_id/next
+      get '/next', to: 'parliaments#next_parliament'
+
+      # /parliaments/:parliament_id/previous
+      get '/previous', to: 'parliaments#previous_parliament'
+
+      build_members_routes('parliaments/members', current: false)
+
+      scope '/houses', as: 'houses' do
+        # /parliaments/:parliament_id/houses
+        get '/', to: 'parliaments/houses#index'
+      end
+
+      scope '/houses', as: 'house' do
+        scope ':house_id' do
+          # /parliaments/:parliament_id/houses/:house_id
+          get '/', to: 'parliaments/houses#show', house_id: id_format_regex
+
+          scope '/members', as: 'members' do
+            # /parliaments/:parliament_id/houses/:house_id/members
+            get '/', to: 'parliaments/houses/members#index'
+
+            listable('parliaments/houses/members#a_to_z', 'parliaments/houses/members#letters')
+          end
+
+          scope '/parties', as: 'parties' do
+            # /parliaments/:parliament_id/houses/:house_id/parties
+            get '/', to: 'parliaments/houses/parties#index'
+          end
+
+          scope '/parties', as: 'party' do
+            scope ':party_id' do
+              # /parliaments/:parliament_id/houses/:house_id/parties/:party_id
+              get '/', to: 'parliaments/houses/parties#show', party_id: id_format_regex
+
+              scope '/members', as: 'members' do
+                # /parliaments/:parliament_id/houses/:house_id/parties/:party_id/members
+                get '/', to: 'parliaments/houses/parties/members#index'
+
+                listable('parliaments/houses/parties/members#a_to_z', 'parliaments/houses/parties/members#letters')
+              end
+            end
+          end
+        end
+      end
+
+      scope '/parties', as: 'parties' do
+        # parliaments/:parliament_id/parties
+        get '/', to: 'parliaments/parties#index'
+      end
+
+      scope '/parties', as: 'party' do
+        scope '/:party_id' do
+          # /parliaments/:parliament_id/parties/:party_id
+          get '/', to: 'parliaments/parties#show', party_id: id_format_regex
+
+          scope '/members', as: 'members' do
+            # /parliaments/:parliament_id/parties/:party_id/members
+            get '/', to: 'parliaments/parties/members#index'
+
+            listable('parliaments/parties/members#a_to_z', 'parliaments/parties/members#letters')
+          end
+        end
+      end
+
+      scope '/constituencies', as: 'constituencies' do
+        # parliaments/:parliament_id/constituencies
+        get '/', to: 'parliaments/constituencies#index'
+
+        listable('parliaments/constituencies#a_to_z', 'parliaments/constituencies#letters')
+      end
+    end
+  end
+  
+  ## Resource
+  # /resource/
+  scope '/resource', as: 'resource' do
+    get '/', to: 'resource#index'
+    scope '/:resource_id' do
+      get '/', to: 'resource#show', resource_id: id_format_regex
+    end
+  end
+
+  ## Meta ##
+  # /meta
+  scope '/meta', as: 'meta' do
+    get '/', to: 'meta#index'
+    get '/cookie-policy', to: 'meta#cookie_policy'
+  end
+
+  ## Media
+  # /media/
+  scope '/media', as: 'media' do
+    get '/', to: 'media#index'
+    scope '/:medium_id' do
+      get '/', to: 'media#show', medium_id: id_format_regex
+    end
+  end
+end

data/lib/parliament/engine.rb

@@ -0,0 +1,19 @@
+module Parliament
+  module Engine
+    def load!
+  		register_rails_files if rails?
+    end
+
+    private
+
+    def rails?
+      defined?(::Rails)
+    end
+
+    def register_rails_files
+      require 'parliament/engine/engine'
+		end
+  end
+end
+
+Parliament::Engine.load!

data/lib/parliament/engine/engine.rb

@@ -0,0 +1,11 @@
+module Parliament
+  module Engine
+    class Engine < ::Rails::Engine
+    # Parliament::Engine::Engine class defines routes for host application
+    # @since 0.0.1
+      config.generators do |g|
+        g.test_framework :rspec
+      end
+    end
+  end
+end

data/lib/parliament/engine/version.rb

@@ -0,0 +1,5 @@
+module Parliament
+  module Engine
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: parliament-routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryony Watson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- watsonb@parliament.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/lib/ext/action_dispatch/routing/mapper.rb
+- config/routes.rb
+- lib/parliament/engine.rb
+- lib/parliament/engine/engine.rb
+- lib/parliament/engine/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Summary of routes.
+test_files: []