journea 0.1.0

data/config/locales/simple_form.en.yml

@@ -0,0 +1,31 @@
+en:
+  simple_form:
+    "yes": 'Yes'
+    "no": 'No'
+    required:
+      text: 'required'
+      mark: '*'
+      # You can uncomment the line below if you need to overwrite the whole required html.
+      # When using html, text and mark won't be used.
+      # html: '<abbr title="required">*</abbr>'
+    error_notification:
+      default_message: "Please review the problems below:"
+    # Examples
+    # labels:
+    #   defaults:
+    #     password: 'Password'
+    #   user:
+    #     new:
+    #       email: 'E-mail to sign in.'
+    #     edit:
+    #       email: 'E-mail.'
+    # hints:
+    #   defaults:
+    #     username: 'User name to sign in.'
+    #     password: 'No special characters, please.'
+    # include_blanks:
+    #   defaults:
+    #     age: 'Rather not say'
+    # prompts:
+    #   defaults:
+    #     age: 'Select your age'

data/config/routes.rb

@@ -0,0 +1,5 @@
+Journea::Engine.routes.draw do
+  resources :journeys, only: [:create], path: "/" do
+    resources :steps, only: [:edit, :update]
+  end
+end

data/db/migrate/20161201153630_create_journey_transitions.rb

@@ -0,0 +1,22 @@
+class CreateJourneyTransitions < ActiveRecord::Migration[5.0]
+  def change
+    create_table :journea_journey_transitions do |t|
+      t.string :to_state, null: false
+      t.text :metadata, default: "{}"
+      t.integer :sort_key, null: false
+      t.integer :journey_id, null: false
+      t.boolean :most_recent, null: false
+      t.timestamps null: false
+    end
+
+    add_index(:journea_journey_transitions,
+              [:journey_id, :sort_key],
+              unique: true,
+              name: "index_journey_transitions_parent_sort")
+    add_index(:journea_journey_transitions,
+              [:journey_id, :most_recent],
+              unique: true,
+              where: "most_recent",
+              name: "index_journey_transitions_parent_most_recent")
+  end
+end

data/db/migrate/20161201162349_create_journeys_table.rb

@@ -0,0 +1,10 @@
+class CreateJourneysTable < ActiveRecord::Migration[5.0]
+  def change
+    create_table :journea_journeys do |t|
+      t.string :key
+      t.string :value
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20161202162350_create_keyvalues_table.rb

@@ -0,0 +1,11 @@
+class CreateKeyvaluesTable < ActiveRecord::Migration[5.0]
+  def change
+    create_table :journea_keyvalues do |t|
+      t.integer :journey_id
+      t.string :key
+      t.string :value
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/journea/install_generator.rb

@@ -0,0 +1,76 @@
+module Journea
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def init
+      @steps = []
+      @install_assets = false
+    end
+
+    def setup_deps
+      @install_assets = yes?("Do you want to install the GOV.UK styles?")
+      if @install_assets
+        gem "govuk_template"
+        gem "govuk_frontend_toolkit"
+        gem "govuk_elements_rails"
+      end
+      gem "haml-rails", "~> 0.9"
+      Bundler.with_clean_env do
+        run "bundle install"
+      end
+    end
+
+    def setup_assets
+      return unless @install_assets
+
+      copy_file "views/application.html.haml", "app/views/layouts/application.html.haml"
+      remove_file "app/views/layouts/application.html.erb"
+      copy_file "assets/application.js", "app/assets/javascripts/application.js"
+      copy_file "assets/application.scss", "app/assets/stylesheets/application.scss"
+      remove_file "app/assets/stylesheets/application.css"
+    end
+
+    def create_start_page
+      return unless yes?("Do you need a start page?")
+
+      puts "Generating start page..."
+      copy_file "views/pages/start.html.haml.example", "app/views/pages/start.html.haml"
+      copy_file "controllers/pages_controller.rb.example", "app/controllers/pages_controller.rb"
+      route "root 'pages#start'"
+    end
+
+    def generate_steps
+      begin
+        puts "How many steps do you need to generate?"
+        step_number = gets.chomp
+        step_number = Integer(step_number)
+      rescue
+        print "Please enter an integer number:"
+        retry
+      end
+
+      if step_number > 0
+        copy_file "views/shared/error_messages.html.haml.example", "app/views/shared/_error_messages.html.haml"
+      end
+
+      step_number.times do |i|
+        name = ask "What is the name of step #{i + 1}?"
+        puts "Generating #{name} step..."
+        @name = name.downcase.strip
+        @steps << name
+        create_file "app/steps/#{@name}_step.rb", "class #{name.capitalize}Step < Journea::Step \nend"
+        template "views/steps/step.html.haml.example", "app/views/steps/#{@name}.html.haml"
+      end
+    end
+
+    def create_initializer
+      puts "generating initializer"
+      inside "config" do
+        inside "initializers" do
+          template "journea.rb"
+        end
+      end
+      route "mount Journea::Engine, at: '/journey'"
+    end
+  end
+end

data/lib/generators/journea/templates/assets/application.js

@@ -0,0 +1,23 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require details.polyfill
+//= require vendor/polyfills/bind
+//= require govuk_toolkit
+//= require_tree .
+
+$( document ).ready(function() {
+  var $buttons = $('label input[type=radio], label input[type=checkbox]')
+  var selectionButtons = new GOVUK.SelectionButtons($buttons)
+});

data/lib/generators/journea/templates/assets/application.scss

@@ -0,0 +1,49 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+ @import 'govuk-elements';
+
+ .error {
+   label {
+     @extend .form-label-bold;
+   }
+   .selection-button-radio {
+     @extend .form-label;
+   }
+ }
+
+.radio_buttons .radio {
+  label {
+    @extend .block-label;
+    @extend .selection-button-radio;
+    margin-bottom: 10px !important;
+  }
+}
+
+.check_boxes .checkbox {
+  label {
+    @extend .block-label;
+    @extend .selection-button-checkbox;
+    margin-bottom: 10px !important;
+  }
+}
+
+td.numeric {
+  font-size: 19px !important;
+  &.bold {
+    font-weight: bold;
+  }
+}

data/lib/generators/journea/templates/config/initializers/journea.rb

@@ -0,0 +1,23 @@
+Journea.configure_steps do
+  # step :first_step, initial: true
+  # step :second_step
+  #
+  # transition from: :first_step, to: :second
+  #
+  # before_transition(to: :second_step) do |journea|
+  # end
+
+<% @steps.each_with_index do |step, i| -%>
+<% if i == 0 -%>
+  step :<%= step %>, initial: true
+<% else -%>
+  step :<%= step %>
+<% end -%>
+<% end -%>
+
+<% @steps.each_with_index do |step, i| -%>
+<% if @steps[i + 1].present? -%>
+  transition from: :<%= step %>, to: :<%= @steps[i + 1] %>
+<% end -%>
+<% end -%>
+end

data/lib/generators/journea/templates/config/initializers/journea2.rb

@@ -0,0 +1,24 @@
+Journea.configure_steps do
+  # step :first_step, initial: true
+  # step :second_step
+  #
+  # transition from: :first_step, to: :second
+  #
+  # before_transition(to: :second_step) do |journea|
+  # end
+
+  <%- @steps.each_with_index do |step, i| -%>
+    <%- if i == 0 %>
+*      step :<%= step %>, initial: true
+    <%- else -%>
+      step :<%= step %>
+    <%- end -%>
+  <%- end -%>
+
+  <% @steps.each_with_index do |step, i| %>
+  <% if @steps[i + 1].present? %>
+  transition from: :<%= step -%>, to: :<%= @steps[i + 1] -%>
+
+  <% end %>
+  <% end %>
+end

data/lib/generators/journea/templates/controllers/pages_controller.rb.example

@@ -0,0 +1,2 @@
+class PagesController < ApplicationController
+end

data/lib/generators/journea/templates/views/application.html.haml

@@ -0,0 +1,20 @@
+- content_for(:head) do
+  = stylesheet_link_tag "application", media: "all"
+  /[if IE 8] <haml_loud> stylesheet_link_tag &quot;ie8&quot; </haml_loud>
+  = javascript_include_tag "application"
+  = csrf_meta_tags
+- content_for :header_class, 'with-proposition'
+- content_for :proposition_header do
+  .header-proposition
+    .content
+      %nav#proposition-menu
+        = link_to t('global_proposition_header'), '/', id: "proposition-name"
+- content_for(:content) do
+  %main#content{:role => "main"}
+    = yield :datashift_journey_state_jumper
+    .phase-banner-alpha
+      %p
+        %strong.phase-tag= t(".proof_of_concept")
+    = render 'back_link'
+    = yield
+= render template: "layouts/govuk_template"

data/lib/generators/journea/templates/views/pages/start.html.haml.example

@@ -0,0 +1,12 @@
+%body
+  .grid-row.start-page
+    .column-two-thirds
+      %header.text
+        %h1#groupLabel.form-title.heading-large
+          Start
+      %h2.heading-small Summary
+      %ul.list.list-bullet.text
+        %li Requirement 1
+        %li Requirement 2
+
+      = link_to 'Start now', journea.journeys_path, class: 'button button-start', role: 'button', method: :post

data/lib/generators/journea/templates/views/shared/error_messages.html.haml.example

@@ -0,0 +1,7 @@
+- if @step.errors.any?
+  .error-summary
+    .heading-medium.error-summary-heading
+      There #{'is'.pluralize(@step.errors.count)} #{pluralize(@step.errors.count, "error")} with the information you've provided.
+    %ul.error-summary-list
+      - @step.errors.messages.each do |element, message|
+        = link_to_input_with_error(element, message)

data/lib/generators/journea/templates/views/steps/step.html.haml.example

@@ -0,0 +1,8 @@
+.grid-row
+  .column-two-thirds
+    = simple_form_for @step do |f|
+      = render 'shared/error_messages'
+
+      %h1.heading-medium <%= @name.capitalize %>
+
+      = f.button :submit, 'Continue'

data/lib/journea.rb

@@ -0,0 +1,25 @@
+# Auto require all dependencies in the gemspec
+Gem.loaded_specs["journea"].dependencies.each do |d|
+  begin
+    require d.name
+
+    # At this point in time unsure why exceptions are being swallowed here so
+    # am having to disable the cop for this section of code.
+    # rubocop:disable Lint/HandleExceptions
+  rescue(LoadError)
+    # Gem require failed
+    # puts "Couldn't require #{d.name}"
+  end
+  # rubocop:enable Lint/HandleExceptions
+end
+
+require "journea/engine"
+require "journea/step"
+require "journea/state_machine"
+require "journea/data"
+
+module Journea
+  def self.configure_steps(&block)
+    StateMachine.class_eval(&block)
+  end
+end

data/lib/journea/data.rb

@@ -0,0 +1,20 @@
+module Journea
+  class Data
+
+    attr_reader :keyvalues
+
+    def initialize(keyvalue_collection)
+      @keyvalues = keyvalue_collection
+    end
+
+    # TODO: Currently having to eat this rubocop error until such time as we
+    # understand what form the respond_to_missing? should take
+    # rubocop:disable Style/MethodMissing
+    def method_missing(method_sym, *arguments, &block)
+      val = keyvalues.find_by(key: method_sym).value
+      return val if val.present?
+      super
+    end
+    # rubocop:enable Style/MethodMissing
+  end
+end

data/lib/journea/engine.rb

@@ -0,0 +1,27 @@
+module Journea
+  class Engine < ::Rails::Engine
+    isolate_namespace Journea
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: "spec/factories"
+      g.assets false
+      g.helper false
+    end
+
+    initializer :append_migrations do |app|
+      # From: https://blog.pivotal.io/labs/labs/leave-your-migrations-in-your-rails-engines
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+    initializer :statesman, before: :load_config_initializers do
+      Statesman.configure do
+        storage_adapter(Statesman::Adapters::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/journea/state_machine.rb

@@ -0,0 +1,40 @@
+module Journea
+  class StateMachine
+    include Statesman::Machine
+
+    def self.step(*args)
+      # Instead of using Statesman 'state', this let's us use 'step'
+      state(*args)
+    end
+
+    def previous_step
+      return nil unless last_transition.present?
+      last_transition.metadata["previous_state"]
+    end
+
+    def next_step
+      raise "No next step defined" if allowed_transitions.empty?
+      allowed_transitions.first.to_sym
+    end
+
+    def transition_to_next_step
+      transition_to!(next_step, previous_state: current_state)
+    end
+
+    def in_initial_state?
+      current_state
+    end
+
+    # Monkey patch to prevent hard fail on transitioning between unsupported routes
+    def validate_transition(options = { from: nil, to: nil, metadata: nil })
+      from = to_s_or_nil(options[:from])
+      to   = to_s_or_nil(options[:to])
+
+      # Call all guards, they raise exceptions if they fail
+      guards_for(from: from, to: to).each do |guard|
+        guard.call(@object, last_transition, options[:metadata])
+      end
+    end
+
+  end
+end