datashift_journey 0.1.2

data/spec/dummy/db/migrate/20161221100703_datashift_journey_create_collector.rb

@@ -0,0 +1,56 @@
+class DatashiftJourneyCreateCollector < ActiveRecord::Migration
+  def change
+
+    # The Container - one per journey - in most situations this would belong to a user account
+    # of person logged in and taking journey
+
+    create_table :dsj_collectors do |t|
+      t.string :state, index: true, null: false
+      t.string :reference, index: true, unique: true, null: false
+      t.timestamps null: false
+    end
+
+    create_table :dsj_page_states do |t|
+      t.string :form_name,    index: true,  null: false
+      t.timestamps null: false
+    end
+
+    create_table :dsj_form_fields do |t|
+      t.references :page_state,  index: true,  null: false
+      t.string     :field, index: true,  null: false, :limit => 100
+      t.string     :field_type,          null: false
+      t.string     :field_presentation,  limit: 100
+      t.timestamps null: false
+    end
+
+    create_table :dsj_collectors_data_nodes do |t|
+      t.references  :collector,  null: false
+      t.references  :form_field, null: false
+      t.text        :field_value
+      t.timestamps  null: false
+    end
+
+    create_table :dsj_snippets do |t|
+      t.text        :raw_text
+      t.string      :I18n_key, index: true
+      t.timestamps  null: false
+    end
+
+    create_table :dsj_page_states_snippets do |t|
+      t.references  :page_state, null: false
+      t.references  :snippet, null: false
+    end
+
+    create_table :dsj_fields_snippets do |t|
+      t.references  :form_field, null: false
+      t.references  :snippet, null: false
+    end
+
+
+    add_foreign_key :collectors_data_nodes, :dsj_collectors, column: :form_field_id
+
+    add_index :dsj_collectors_data_nodes, [:collector_id, :form_field_id], unique: true,
+              name: 'collectors_data_nodes_collector_id_form_field_id'
+
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,142 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20161221100703) do
+
+  create_table "addresses", force: :cascade do |t|
+    t.string   "premises",       limit: 200
+    t.string   "street_address", limit: 160
+    t.string   "locality",       limit: 70
+    t.string   "city",           limit: 30
+    t.string   "postcode",       limit: 8
+    t.string   "country_iso",    limit: 3
+    t.datetime "created_at",                 null: false
+    t.datetime "updated_at",                 null: false
+  end
+
+  create_table "datashift_journey_checkout_as", force: :cascade do |t|
+    t.string   "checkout_a"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "datashift_journey_checkout_bs", force: :cascade do |t|
+    t.string   "checkout_b"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "datashift_journey_checkout_cs", force: :cascade do |t|
+    t.string   "checkout_c"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "datashift_journey_checkout_ds", force: :cascade do |t|
+    t.string   "checkout_d"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "datashift_journey_checkout_empties", force: :cascade do |t|
+    t.string   "checkout_empty"
+    t.datetime "created_at",     null: false
+    t.datetime "updated_at",     null: false
+  end
+
+  create_table "datashift_journey_checkout_es", force: :cascade do |t|
+    t.string   "checkout_e"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "datashift_journey_checkout_fs", force: :cascade do |t|
+    t.string   "checkout_f"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "datashift_journey_checkouts", force: :cascade do |t|
+    t.string   "state"
+    t.datetime "created_at",      null: false
+    t.datetime "updated_at",      null: false
+    t.string   "token"
+    t.integer  "bill_address_id"
+    t.integer  "ship_address_id"
+    t.integer  "payment_id"
+    t.index ["bill_address_id"], name: "index_datashift_journey_checkouts_on_bill_address_id"
+    t.index ["payment_id"], name: "index_datashift_journey_checkouts_on_payment_id"
+    t.index ["ship_address_id"], name: "index_datashift_journey_checkouts_on_ship_address_id"
+  end
+
+  create_table "datashift_journey_payments", force: :cascade do |t|
+    t.string   "name"
+    t.string   "card"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "dsj_collectors", force: :cascade do |t|
+    t.string   "state",      null: false
+    t.string   "reference",  null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["reference"], name: "index_dsj_collectors_on_reference"
+    t.index ["state"], name: "index_dsj_collectors_on_state"
+  end
+
+  create_table "dsj_collectors_data_nodes", force: :cascade do |t|
+    t.integer  "collector_id",  null: false
+    t.integer  "form_field_id", null: false
+    t.text     "field_value"
+    t.datetime "created_at",    null: false
+    t.datetime "updated_at",    null: false
+    t.index ["collector_id", "form_field_id"], name: "collectors_data_nodes_collector_id_form_field_id", unique: true
+  end
+
+  create_table "dsj_fields_snippets", force: :cascade do |t|
+    t.integer "form_field_id", null: false
+    t.integer "snippet_id",    null: false
+  end
+
+  create_table "dsj_form_fields", force: :cascade do |t|
+    t.integer  "page_state_id",                  null: false
+    t.string   "field",              limit: 100, null: false
+    t.string   "field_type",                     null: false
+    t.string   "field_presentation", limit: 100
+    t.datetime "created_at",                     null: false
+    t.datetime "updated_at",                     null: false
+    t.index ["field"], name: "index_dsj_form_fields_on_field"
+    t.index ["page_state_id"], name: "index_dsj_form_fields_on_page_state_id"
+  end
+
+  create_table "dsj_page_states", force: :cascade do |t|
+    t.string   "form_name",  null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["form_name"], name: "index_dsj_page_states_on_form_name"
+  end
+
+  create_table "dsj_page_states_snippets", force: :cascade do |t|
+    t.integer "page_state_id", null: false
+    t.integer "snippet_id",    null: false
+  end
+
+  create_table "dsj_snippets", force: :cascade do |t|
+    t.text     "raw_text"
+    t.string   "I18n_key"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["I18n_key"], name: "index_dsj_snippets_on_I18n_key"
+  end
+
+end

data/spec/dummy/lib/version.rb

@@ -0,0 +1 @@
+VERSION = "0.0.1".freeze

data/spec/factories/collector_factory.rb

@@ -0,0 +1,16 @@
+FactoryGirl.define do
+  factory :collector, class: DatashiftJourney::Collector::Collector do
+    reference FFaker::Product.model
+    # N.B state must be a valid state from the defined journey
+    # state :new_or_renew
+
+    # TODO: - Good way to define a journey for RSepc
+    #     DatashiftJourney::Journey::MachineBuilder.create_journey_plan(initial: :new_or_renew) do
+    #
+    #       branch_sequence :new_sequence, [:business_type]
+    #
+    #       branch_sequence :renew_sequence, [:enter_reg_number]
+    # ...
+    #     end
+  end
+end

data/spec/factories/collector_snippet_factory.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :snippet, class: DatashiftJourney::Collector::Snippet do
+    raw_text { FFaker::Lorem.sentence }
+  end
+
+  factory :i18n_snippet, class: DatashiftJourney::Collector::Snippet do
+    I18n_key :rspec_snippet_text
+  end
+end

data/spec/factories/collector_state_page_factory.rb

@@ -0,0 +1,12 @@
+FactoryGirl.define do
+  factory :collector_page_state, class: DatashiftJourney::Collector::PageState do
+    form_name { FFaker::Book.title }
+
+    trait :with_snippets do
+      after(:create) do |object|
+        object.snippets = create_list(:snippet, 3)
+        object.save!
+      end
+    end
+  end
+end

data/spec/factories/data_node_factory.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :form_field, class: DatashiftJourney::Collector::FormField do
+    form 'BusinessDetailsForm'
+    field :company_name
+    field_presentation 'Enter your Company Name'
+    field_type :string
+    field_value 'Acme Ltd'
+  end
+end

data/spec/factories/form_factory.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :form, class: DatashiftJourney::Collector::PageState do
+    form_name 'Home AddressForm'
+    presentation 'Please Enter your Home Address'
+  end
+end

data/spec/features/basic_navigation_spec.rb

@@ -0,0 +1,125 @@
+require 'rails_helper'
+module DatashiftJourney
+
+  RSpec.describe 'Basic Navigation Feature' do
+    before(:all) do
+      DatashiftJourney.journey_plan_class = 'DatashiftJourney::Collector::Collector'
+    end
+
+    scenario 'home page' do
+      visit root_path
+      expect(page).to have_text 'New or renew'
+    end
+
+    scenario 'move on from home page by clicking Continue' do
+      visit root_path
+      click_button('Continue')
+      expect(page).to have_text 'New or renew'
+    end
+
+    scenario 'move on from home page by clicking Continue' do
+      visit root_path
+      fill_in 'data_nodes_field', with: "My Company Name"
+      click_button('Continue')
+      expect(page).to have_text 'Business type'
+    end
+
+    #
+    #       scenario "happy path straight through Other journey and back" do
+    #         journey.each_with_index do |po, _i|
+    #           po.advance_page
+    #           po
+    #         end
+    #
+    #         expect(page).to be_on_page_object reviewing_page
+    #
+    #         (journey.size..0).each do |i|
+    #           click_link(I18n.t("back"))
+    #           expect(page).to be_on_page_object journey[i]
+    #         end
+    #       end
+    #     end
+    #
+    #     context "Given I'm on the Correspondence (Main) Contact Email page" do
+    #       before(:each) do
+    #         page_object.visit_page
+    #       end
+    #
+    #       scenario "When I enter my valid email address" do
+    #         page_object.advance_page
+    #         expect(Enrollment.last.correspondence_contact.email_address).to eq page_object.field_filled_wth
+    #       end
+    #     end
+    #
+    #     context "When revisiting this page (after a succesful submission), via back button or review page " do
+    #       scenario "Then the email confirmation field should display the current email" do
+    #         page_object.advance_page
+    #
+    #         expect(page).to_not be_on_page_object page_object
+    #
+    #         page_object.click_back_link
+    #
+    #         expect(page).to be_on_page_object page_object
+    #
+    #         page_object.confirmation_field_matches_email
+    #       end
+    #
+    #       scenario "Then if I don't enter an email in correct format, Then I expect to see error" do
+    #         page_object.advance_page
+    #
+    #         expect(page).to_not be_on_page_object page_object
+    #
+    #         page_object.click_back_link
+    #
+    #         ["t@", "@env.com", "e@e"].each do |e|
+    #           page_object.advance_page_with e
+    #           expect(page).to be_on_page_object page_object
+    #
+    #           expect(page).to have_text I18n.t("#{form_class.locale_key}.errors.email_address.format")
+    #
+    #           expect(page).to have_error_anchors :email_address
+    #         end
+    #       end
+    #     end
+    #
+    #     context "Validation" do
+    #       scenario "When I don't enter an email, Then I expect to see error" do
+    #         page_object.advance_page_with("")
+    #         expect(page).to be_on_page_object page_object
+    #
+    #         expect(page).to have_text I18n.t("#{form_class.locale_key}.errors.email_address.blank")
+    #
+    #         expect(page).to have_error_anchors :email_address
+    #       end
+    #
+    #       scenario "When I don't enter an email in correct format, Then I expect to see error" do
+    #         ["t@", "@env.com", "e@e"].each do |e|
+    #           page_object.advance_page_with e
+    #           expect(page).to be_on_page_object page_object
+    #
+    #           expect(page).to have_text I18n.t("#{form_class.locale_key}.errors.email_address.format")
+    #
+    #           expect(page).to have_error_anchors :email_address
+    #         end
+    #       end
+    #
+    #       scenario "When I don't enter a confirmation, Then I expect to see error" do
+    #         page_object.advance_page_with(page_object.generate_data, "")
+    #         expect(page).to be_on_page_object page_object
+    #
+    #         expect(page).to have_text I18n.t("#{form_class.locale_key}.errors.email_address_confirmation.blank")
+    #
+    #         expect(page).to have_error_anchors :email_address_confirmation
+    #       end
+    #
+    #       scenario "When I don't enter a confirmation that matches email, Then I expect to see error" do
+    #         page_object.advance_page_with(page_object.generate_data, "blah#{Time.current}@blah.co.uk")
+    #         expect(page).to be_on_page_object page_object
+    #
+    #         expect(page).to have_text I18n.t("#{form_class.locale_key}.errors.email_address_confirmation.format")
+    #
+    #         expect(page).to have_error_anchors :email_address_confirmation
+    #       end
+    #     end
+  end
+end

data/spec/helpers/application_helper_spec.rb

@@ -0,0 +1,40 @@
+require 'rails_helper'
+
+RSpec.describe DatashiftJourney::ApplicationHelper, type: :helper do
+  describe '#journey_plan_partial_location' do
+    it 'returns partial location for a state' do
+      state = 'site_address'
+      DatashiftJourney::Configuration.call.partial_location = ''
+      expect(helper.journey_plan_partial_location(state)).to eq "/#{state}"
+
+      DatashiftJourney::Configuration.call.partial_location = nil
+      expect(helper.journey_plan_partial_location(state)).to eq "/#{state}"
+    end
+
+    it 'returns partial location, correctly joining paths for a state' do
+      state = 'site_address'
+      DatashiftJourney::Configuration.call.partial_location = 'shared/states'
+      expect(helper.journey_plan_partial_location(state)).to eq "shared/states/#{state}"
+
+      DatashiftJourney::Configuration.call.partial_location = 'states/'
+      expect(helper.journey_plan_partial_location(state)).to eq "states/#{state}"
+    end
+  end
+
+  describe '#error_link_anchor' do
+    it 'still returns basic string from empty string' do
+      attribute = ''
+      expect(helper.error_link_id(attribute)).to eq 'form_group_'
+    end
+
+    it 'returns attribute from plain attribute' do
+      attribute = 'full_name'
+      expect(helper.error_link_id(attribute)).to eq 'form_group_full_name'
+    end
+
+    it 'returns field only from nested attribute' do
+      attribute = 'journey_plan.applicant_contact.full_name'
+      expect(helper.error_link_id(attribute)).to eq 'form_group_full_name'
+    end
+  end
+end

data/spec/integration/collector/page_state_spec.rb

@@ -0,0 +1,45 @@
+require 'rails_helper'
+require 'swagger_helper'
+
+require 'page_state'
+
+module DatashiftJourney
+  describe Collector::PageState do
+
+    path '/api/v1/page_states' do
+
+      post 'Creates a page_state' do
+        tags 'PageState'
+        consumes 'application/json', 'application/xml'
+        parameter name: :page_state, in: :body, schema: {
+            type: :object,
+            properties: {
+                form_name: { type: :string }
+            },
+            required: [ 'form_name' ]
+        }
+
+        response '201', 'page_state created' do
+          let(:page_state) { { form_name: 'BrandNewPage' } }
+
+          #before do |example|
+            # pp example.metadata
+          #end
+
+          pending("can rwsag support modules?")
+          # To fix - does not seem to handle namespaces
+          #   Failure/Error: raise LoadError, "Unable to autoload constant #{qualified_name}, expected #{file_path} to define it" unless from_mod.const_defined?(const_name, false)
+          #   LoadError:
+          #     Unable to autoload constant PageState, expected /data/users/thomas.statter/SoftwareDev/git/datashift_journey/lib/datashift_journey/collector/page_state.rb to define it
+          #run_test!
+        end
+
+        response '422', 'invalid request' do
+          let(:page_state) { { for: 'foo' } }
+          #run_test!
+        end
+      end
+    end
+
+  end
+end

data/spec/models/collector/collector_spec.rb

@@ -0,0 +1,100 @@
+require 'rails_helper'
+
+module DatashiftJourney
+  RSpec.describe Collector::Collector, type: :model do
+    context('Empty') do
+      let(:collector) { create(:collector, state: :contact_details) }
+
+      it { is_expected.to have_many(:form_fields).dependent(false) }
+      it { is_expected.to have_many(:data_nodes).dependent(:destroy) }
+
+      it 'can save nodes for any given PageState and Field', duff: true do
+        name_field = Collector::FormField.new(
+          page_state: create(:collector_page_state),
+          field: :name,
+          field_presentation: 'Enter your Name',
+          field_type: :string
+        )
+
+        expect(name_field).to be_valid
+
+        collector.form_fields << name_field
+        collector.save
+        collector.reload
+        expect(collector.form_fields.size).to eq 1
+      end
+    end
+
+    context('Populated') do
+      let(:collector) { create(:collector) }
+
+      let(:page_state) { Collector::PageState.create(form_name: 'BusinessDetailsForm') }
+
+      let(:page_snippet) {
+        Collector::FieldSnippet.create(
+          form_field: page_state,
+          snippet: Collector::Snippet.create(raw_text: 'Enter your Company Name')
+        )
+      }
+
+      let(:form_field) do
+        Collector::FormField.create(
+          page_state: page_state,
+          field: :company_name,
+          field_presentation: 'Enter your Company Name',
+          field_type: :string
+        )
+      end
+      let(:email_form_field) do
+        Collector::FormField.create(
+          page_state: page_state,
+          field: :company_email,
+          field_presentation: 'Enter your Company Email',
+          field_type: :string
+        )
+      end
+
+      context('PageState Fields') do
+        before(:each) do
+          collector.form_fields << form_field
+        end
+
+        it 'returns the node for a given PageState and Field', duff: true do
+          node = collector.node_for_form_and_field('BusinessDetailsForm', 'company_name')
+          expect(node).to be_a Collector::CollectorDataNode
+        end
+
+        it 'can store multiple Fields against the same PageState' do
+          collector.form_fields << Collector::FormField.create(
+            page_state: page_state,
+            field: :company_email,
+            field_presentation: 'Enter your Company Email',
+            field_type: :string
+          )
+
+          collector.reload
+          expect(collector.form_fields.size).to eq 2
+        end
+      end
+
+      context('Populated - Data Nodes') do
+        it 'can store store data against a Field in a DataNode' do
+          email = FFaker::Internet.email
+          collector.data_nodes.create(form_field: email_form_field, field_value: email)
+
+          collector.reload
+          expect(collector.form_fields.size).to eq 1
+
+          expect(collector.form_fields.first.page_state.form_name).to eq 'BusinessDetailsForm'
+
+          data_nodes = collector.nodes_for_form('BusinessDetailsForm')
+
+          expect(data_nodes).to be_a Array
+          expect(data_nodes.size).to eq 1
+
+          expect(data_nodes.first.field_value).to eq email
+        end
+      end
+    end
+  end
+end

data/spec/models/collector/page_state_spec.rb

@@ -0,0 +1,30 @@
+require 'rails_helper'
+
+module DatashiftJourney
+  module Collector
+    RSpec.describe PageState, type: :model do
+      context('Empty') do
+        let(:collector) { create(:collector, state: :contact_details) }
+
+        it { is_expected.to have_many(:snippets).dependent(false) }
+
+        it { is_expected.to validate_presence_of(:form_name) }
+
+        it 'is valid when the associated Form name supplied' do
+          business_details_form = PageState.new(form_name: 'BusinessDetailsForm')
+          expect(business_details_form).to be_valid
+        end
+      end
+
+      context('Populated') do
+        let(:page_state) { create(:collector_page_state, :with_snippets) }
+
+        it 'returns the snippets as a single header paragraph' do
+          expect(page_state.snippets.size).to eq 3
+          expect(page_state.header).to include  page_state.snippets.first.raw_text
+          expect(page_state.header).to include  page_state.snippets.last.raw_text
+        end
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,73 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+require 'spec_helper'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  StateMachines::Machine.ignore_method_conflicts = true
+
+  config.use_transactional_fixtures = false
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  config.include FactoryGirl::Syntax::Methods
+
+  ActiveRecord::Migration.maintain_test_schema!
+
+  # Use seed data in some places rather than Factories so don't clean
+  # certain 'static' tables
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with :truncation, except: %w(ar_internal_metadata)
+    # DatabaseCleaner.clean
+  end
+
+  config.before do |example|
+    md = example.metadata
+    DatabaseCleaner.strategy = :transaction
+
+    Capybara.current_driver =
+      if md[:driver].present?
+        md[:driver]
+      elsif md[:js] || md[:javascript]
+        :poltergeist
+      else
+        :rack_test
+      end
+
+    unless Capybara.current_driver == :rack_test
+      DatabaseCleaner.strategy = :truncation, DB_CLEANER_TRUNCATION_OPTS
+    end
+
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean_with :truncation, except: %w(ar_internal_metadata)
+  end
+
+  # Enables shortcut, t() instead of I18n.t() in tests
+  config.include AbstractController::Translation
+end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end