datashift_journey 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c69a2e39ef25608483ad7d2597251e7a3579c8b40cfb62c77bce84e51bceca9
-  data.tar.gz: 272adc891084777add171f204ce3f39f7b768ed34effde573288ca7e3939cc0f
+  metadata.gz: 38960531f2efc930e4265265c45c32e6287ee5a85ae83769ad1c5017aa7ba35e
+  data.tar.gz: 472072a1e034aed32958819e0156721ecb2366228eb99460232b2b9e440d262d
 SHA512:
-  metadata.gz: cf5f9ab13ff5643093f7daac5fcbcfc9cfb08f7e843b9e07cfa701978905e64a125f74d309e752cc600010e6feb222a274c274b4b0a1d2db5df3e13f7c5acafd
-  data.tar.gz: 00c8c8b31b4094289182568be0a93e2f22942978105118dd41318aef9cdc07f9e9e0d5039180861c71245739f666b1233693e7350fc8dfb3342e07b9f6c27416
+  metadata.gz: 8e320a5ea4b6791988f29d866efd0e3f0304c32d79ebe3a3f2c6adf0c040169ee9c881b97b793e12b36276434f68619a56994f662d5e6597b2db1d945bc474e8
+  data.tar.gz: 60fb3beea2b19076906b53b1b70b0b2f792f96551f1b835a1e41430d902a706d435d5407ca1c14c9e525d3c294002f24f1c15ddb28e518ef8c7a14de897baeb1

data/app/controllers/datashift_journey/abandonments_controller.rb

@@ -10,6 +10,10 @@ module DatashiftJourney
 
     def show
       logger.info('User has abandoned')
+
+      # high voltage expects  id => name of page
+      # params[:id] = params['page']
+
       super
     end
   end

data/app/controllers/datashift_journey/errors_controller.rb

@@ -1,7 +1,7 @@
 module DatashiftJourney
   class ErrorsController < ApplicationController
     def show
-      @exception = env['action_dispatch.exception']
+      @exception = request.env['action_dispatch.exception']
       action = request.path[1..-1].gsub(/[^0-9]/, '')
       action = 500 if action.blank?
 
@@ -10,7 +10,7 @@ module DatashiftJourney
           trace = Rails.backtrace_cleaner.clean(@exception.backtrace)
           Rails.logger.fatal trace.join("#\n")
 
-          ActionDispatch::ExceptionWrapper.new(env, @exception).status_code
+          ActionDispatch::ExceptionWrapper.new(request.env, @exception).status_code
         else
           action.to_i
         end

data/app/controllers/datashift_journey/journey_plans_controller.rb

@@ -9,7 +9,7 @@ module DatashiftJourney
     # Run BEFORE other filters to ensure the current journey_plan has been selected from the DB
     prepend_before_action :set_journey_plan, only: [:new, :destroy, :back_a_state]
 
-    prepend_before_action :set_reform_object, only: [:create, :edit, :update]
+    prepend_before_action :set_reform_object, only: [:edit, :update]
 
     # Validate state and state related params - covers certain edge cases such as browser refresh
     before_action :validate_state, only: [:edit, :update]
@@ -22,35 +22,12 @@ module DatashiftJourney
     end
 
     def create
-      # TOFIX - Validation from params is now broken
-      # NoMethodError (undefined method `each_with_index' for #<ActionController::Parameters:0x000055eacfa2c370>):
-      # result = form.validate(params)
-      # logger.debug("VALIDATION FAILED - Form Errors [#{form.errors.inspect}]") unless result
-      journey_plan = journey_plan_class.new
+      set_journey_plan_class
+      @reform = FormObjectFactory.form_object_for(journey_plan_class.create!)
 
-      form_fields_to_data_nodes
+      @reform.save(params)
 
-      move_next(journey_plan)
-    end
-
-    def back_a_state
-      respond_to do |format|
-        logger.debug("BACK Requested - current [#{journey_plan.state}] - previous [#{journey_plan.previous_state_name}]")
-
-        journey_plan.back!
-
-        if journey_plan.save
-
-          logger.debug("Successfully back a step - state now [#{journey_plan.state}]")
-
-          format.html do
-            redirect_to(datashift_journey.journey_plan_state_path(journey_plan.state, journey_plan)) && return
-          end
-
-        else
-          format.html { render :edit }
-        end
-      end
+      move_next(@reform.journey_plan)
     end
 
     def edit
@@ -74,7 +51,7 @@ module DatashiftJourney
       #   render :edit, locals: { journey_plan: journey_plan, form: form }
       # end
 
-      form_fields_to_data_nodes
+      @reform.save(params)
 
       logger.debug("UPDATED Plan [#{journey_plan.inspect}] - Move to Next")
       puts journey_plan.inspect
@@ -82,26 +59,22 @@ module DatashiftJourney
       move_next(journey_plan) && return
     end # UPDATE
 
-    def form_fields_to_data_nodes
-      form_params = params.fetch(@reform.params_key, {})
-
-      data_nodes = form_params["data_nodes"] # =>{"form_field"=>{"0"=>"name", "1"=>"namespace"}, "field_value"=>{"0"=>"dfsdf", "1"=>"ghfghf"}}}
+    def back_a_state
+      respond_to do |format|
+        logger.debug("BACK Requested - current [#{journey_plan.state}] - previous [#{journey_plan.previous_state_name}]")
 
-      if data_nodes.present?
+        journey_plan.back!
 
-        fields = data_nodes["form_field"]
-        values = data_nodes["field_value"]
+        if journey_plan.save
 
-        fields.each do |idx, name|
-          ff = Collector::FormField.where(name: name, form_definition: @reform.definition).first
-          next unless ff
+          logger.debug("Successfully back a step - state now [#{journey_plan.state}]")
 
-          # Ensure when user goes back and changes a value we reflect the changed value
-          Collector::DataNode.find_or_initialize_by(plan: journey_plan, form_field: ff).tap do |node|
-            node.field_value = values[idx]
-            node.save
+          format.html do
+            redirect_to(datashift_journey.journey_plan_state_path(journey_plan.state, journey_plan)) && return
           end
 
+        else
+          format.html { render :edit }
         end
       end
     end
@@ -114,13 +87,13 @@ module DatashiftJourney
       redirect_to(@reform.redirection_url) && return if @reform.redirect?
 
       if journey_plan.next_state_name.blank?
-        logger.error("JOURNEY ENDED - no next transition - rendering 'journey_end'")
+        logger.info("JOURNEY ENDED - no skip_fwd transition - rendering 'journey_end'")
         redirect_to(datashift_journey.journey_end_path(journey_plan)) && return
       end
 
-      # if there is no next event, state_machine dynamic helper can_next? not available
+      # if there is no skip_fwd event, state_machine dynamic helper skip_fwd? not available
       unless journey_plan.respond_to?('can_skip_fwd?') && journey_plan.can_skip_fwd?
-        logger.error("JOURNEY Cannot proceed - no next transition - rendering 'journey_end'")
+        logger.info("JOURNEY ENDED - no skip_fwd transition to - rendering 'journey_end'")
         redirect_to(datashift_journey.journey_end_path(journey_plan)) && return
       end
 

data/app/controllers/datashift_journey/reviews_controller.rb

@@ -7,7 +7,7 @@ module DatashiftJourney
     # We want this to run BEFORE other filters to ensure the current
     # journey_plan object has been selected from the DB
 
-    prepend_before_filter :set_journey_plan, only: [:edit]
+    prepend_before_action :set_journey_plan, only: [:edit]
 
     def edit
       logger.info("Sent from REVIEW [#{params.inspect}]")

data/app/forms/datashift_journey/collector/base_collector_form.rb

@@ -1,5 +1,3 @@
-require_relative '../concerns/form_mixin'
-
 module DatashiftJourney
   module Collector
 
@@ -16,7 +14,7 @@ module DatashiftJourney
     #
     class BaseCollectorForm < Reform::Form
 
-      include DatashiftJourney::FormMixin
+      include ::DatashiftJourney::FormMixin
 
       feature Reform::Form::Dry # override the default.
 
@@ -45,6 +43,33 @@ module DatashiftJourney
 
       end
 
+      def save(params)
+        form_params = params.fetch(params_key, {})
+
+        data_nodes = form_params["data_nodes"] # =>{"form_field"=>{"0"=>"name", "1"=>"namespace"}, "field_value"=>{"0"=>"dfsdf", "1"=>"ghfghf"}}}
+
+        if data_nodes.present?
+
+          fields = data_nodes["form_field"]
+          values = data_nodes["field_value"]
+
+          fields.each do |idx, name|
+            ff = Collector::FormField.where(name: name, form_definition: definition).first
+            next unless ff
+
+            # Ensure when user goes back and changes a value we reflect the changed value
+
+            pp journey_plan
+
+            Collector::DataNode.find_or_initialize_by(plan: journey_plan, form_field: ff).tap do |node|
+              node.field_value = values[idx]
+              node.save
+            end
+
+          end
+        end
+      end
+
       # Over ride in your form if your view forms have non standard key field.
       #
       # The default naming format for form elements in the view is : "#{params_key}[data_nodes][field_value][#{i}]"

data/app/views/datashift_journey/errors/401.html.erb

@@ -1,5 +1,3 @@
-<% content_for :page_title, create_title('global.401_unauthorized.heading') + " (#{response.status})" %>
-
 <%= yield :error_header %>
 
 <header>

data/app/views/datashift_journey/errors/403.html.erb

@@ -1,5 +1,3 @@
-<% content_for :page_title, create_title('global.403_forbidden.heading') + " (#{response.status})" %>
-
 <%= yield :error_header %>
 
 <header>

data/app/views/datashift_journey/errors/404.html.erb

@@ -1,5 +1,3 @@
-<% content_for :page_title, create_title('global.404_notfound.heading') + " (#{response.status})" %>
-
 <%= yield :error_header %>
 
 <header>

data/app/views/datashift_journey/errors/422.html.erb

@@ -1,5 +1,3 @@
-<% content_for :page_title, create_title('global.422_unprocessable_entity.heading') + " (#{response.status})" %>
-
 <%= yield :error_header %>
 
 <header>

data/app/views/datashift_journey/errors/500.html.erb

@@ -1,5 +1,3 @@
-<% content_for :page_title, create_title('global.500_internal_server_error.heading') + " (#{response.status})" %>
-
 <%= yield :error_header %>
 
 <header>

data/app/views/datashift_journey/errors/503.html.erb

@@ -1,5 +1,3 @@
-<% content_for :page_title, create_title('global.503_bad_gateway.heading') + " (#{response.status})" %>
-
 <%= yield :error_header %>
 
 <header>

data/app/views/datashift_journey/errors/invalid_authenticity_token.html.erb

@@ -1,5 +1,3 @@
-<% content_for :page_title, create_title('global.invalid_authenticity_token.heading') %>
-
 <%= yield :error_header %>
 
 <header>

data/app/views/datashift_journey/journey_plans/_render_fields.html.erb

@@ -16,7 +16,7 @@
       <% elsif data_node.form_field.number? %>
         <%= number_field_tag "#{key}[data_nodes][field_value][#{i}]", data_node.field_value,  { class: 'form-control', required: true } %>
       <% else %>
-        <%= text_field_tag "#{key}[data_nodes][field_value][#{i}]", data_node.field_value, size: "64", class: "form-control", required: true %>
+        <%= text_field_tag "#{key}[data_nodes][field_value][#{i}]", data_node.field_value, { size: "64", class: "form-control", required: true } %>
       <% end %>
 
     </div>

data/lib/datashift_journey/engine.rb

@@ -2,6 +2,7 @@ begin
   require_relative 'exceptions'
   require_relative 'configuration'
   require_relative 'journey/machine_builder'
+  require_relative 'form_mixin'
 
   require_relative 'reference_generator'
   require_relative 'helpers/back_link'

data/{app/forms/datashift_journey/concerns → lib/datashift_journey}/form_mixin.rb

@@ -27,7 +27,12 @@ module DatashiftJourney
 
       def form_definition
         # In this situation self is the class of the including form eg PaymentForm, AddressFrom
-        @form_definition ||= DatashiftJourney::Collector::FormDefinition.find_or_create_by!(klass: self.name)
+        begin
+          @form_definition ||= DatashiftJourney::Collector::FormDefinition.find_or_create_by(klass: self.name)
+        rescue
+          Rails.logger.error "Could not find or create FormDefinition [#{x}]"
+          nil
+        end
       end
 
       # Form helper to add fields inside a class definition
@@ -42,7 +47,12 @@ module DatashiftJourney
       #   journey_plan_form_field name: :memory,    category: :number
       #
       def journey_plan_form_field(name:, category:)
+        begin
         DatashiftJourney::Collector::FormField.find_or_create_by!(form_definition: form_definition, name: name,  category: category)
+        rescue => x
+          Rails.logger.error "Could not find or create FormField [#{x}]"
+          nil
+        end
       end
     end
 

data/lib/datashift_journey/prepare_data_for_review.rb

@@ -1,219 +1,215 @@
 module DatashiftJourney
 
-  #   module PrepareDataForReview
-  #
-  #     extend ActiveSupport::Concern
-  #
-  #     def self.included(base)
-  #       base.send :include, InstanceMethods
-  #     end
-  #
-  #     module InstanceMethods
-  #
-  #       # You can build your review page within a YAML config file (locale file)
-  #       # It supports a simple DSL in below format.
-  #       #
-  #       # SYNTAX :
-  #       #     Indentation, usually 2 spaces, or a 2 space TAB, is very important
-  #       #     <> are used to illustrate the elements that accept free text
-  #       #
-  #       # ROW :
-  #       #
-  #       # Each ReviewDataRow has upto 3 elements
-  #       #
-  #       #   :title:      The string for Column 1, the row header
-  #       #
-  #       #   :method: The actual database data for Column2, method to call on the model, or the association object
-  #       #
-  #       #   :link_state: The state the change me links, jumps back to.
-  #       #                Optional, if unspecified,  uses the section block (state)
-  #       #
-  #       # FULL DSL :
-  #       #
-  #       # <key>:
-  #       #   sections:
-  #       #     <section_block - usually a state>:          # The Link target defaults to this, if no explicit state set
-  #       #       section_heading: "Farming data"           # The section title - that spans the 3 columns
-  #       #       direct:                                   # Non association data i.e directly on the parent model
-  #       #         -  :title: "Activity is on a farm"      # Column title. The - indicates a list, each mini block is a row
-  #       #            :method: on_a_farm                   # Method called on association to get real (DB) data to display
-  #       #         -  :title: "Registrant is a farmer"     # Next mini block - Each section can have multiple rows
-  #       #            :method: is_a_farmer
-  #       #     <next section_block - choosing_site_address>:
-  #       #       section_heading: Waste Activity Location
-  #       #       associations:
-  #       #         <association>                     # As well as direct, supports Rails associations, on supplied model
-  #       #           -  :title: "1st Column"
-  #       #              :method: full_name           # Ruby method called on association, returns real (DB) data to display
-  #       #              :link_state: state           # The link target - i.e state to JUMP to, in order to EDIT the data
-  #       #          site_address:                    # Again, section can contain multiple rows, from multiple associations
-  #       #            -  :title: "Address"
-  #       #               :method:                    # No method supplied, data will be WHOLE associated object
-  #       #
-  #       # EXAMPLE:
-  #       #
-  #       # journey_plan_review:
-  #       #   sections:
-  #       #     choosing_farming_data:
-  #       #       section_heading: "Farming data"
-  #       #       direct:
-  #       #         -  :title: "Activity is on a farm"
-  #       #            :method: on_a_farm
-  #       #         -  :title: "Registrant is a farmer"
-  #       #            :method: is_a_farmer
-  #       #     choosing_site_address:
-  #       #       section_heading: Waste Activity Location
-  #       #       associations:
-  #       #          site_address:
-  #       #            -  :title: "Address"
-  #       #               :method:                    # No state cos Partial can render WHOLE Address object
-  #       #            -  :title: "Grid reference"
-  #       #               :method: grid_reference
-  #       #     choosing_exemption:
-  #       #       section_heading: Waste Exemption Codes
-  #       #       associations:
-  #       #         exemption:
-  #       #           -  :title: "Waste Exemptions"
-  #       #              :method: code
-  #       #
-  #       # NOTES
-  #       #
-  #       # Method can be left blank, in this case the data is the association object, so this must be display-able
-  #       #
-  #       # For example, this will cause @journey_plan.site_address to be sent to the review partial, which we know has
-  #       # special use case for Address, which renders a display address partial
-  #       #
-  #       #          site_address:
-  #       #            -  :title: "Address"
-  #       #               :method:
-  #       #
-  #       attr_reader :review_data
-  #
-  #       # rubocop:disable Metrics/MethodLength
-  #
-  #       def prepare_from_locale(model, locale_key = '.journey_plan_review')
-  #         sections = I18n.t("#{locale_key}.sections", default: {})
-  #
-  #         Rails.logger.debug("Review Sections: #{sections.inspect}")
-  #
-  #         unless sections.is_a?(Hash)
-  #           Rails.logger.error("Bad syntax in your review YAML - Expect a 'sections' Hash element")
-  #           raise "Bad syntax in your review YAML - Expect a 'sections' Hash element"
-  #         end
-  #
-  #         @model_object = model
-  #
-  #         # Return a collection of Sections (ReviewData), each section has multiple rows
-  #
-  #         sections.collect do |section, data|
-  #           next unless data[:section_heading]
-  #
-  #           @current_section = section
-  #
-  #           @review_data = ReviewDataSection.new(data[:section_heading])
-  #
-  #           # Possible Enhancement required :
-  #           # As it stands this will NOT preserve the Order as defined exactly in the YAML as it's a HASH
-  #           # with keys - for direct & association sections - which are unordered.
-  #           # So currently had to make arbitrary decision to process direct first, then associations
-  #
-  #           # Direct data on parent Model, where key is - direct:
-  #           key = "#{locale_key}.sections.#{section}.direct"
-  #
-  #           I18n.t(key).each { |column| row_to_review_data(model_object, column) } if I18n.exists?(key)
-  #
-  #           # Associated data - children of parent
-  #           key = "#{locale_key}.sections.#{current_section}.associations"
-  #
-  #           if I18n.exists?(key)
-  #
-  #             association_list = I18n.t("#{locale_key}.sections.#{current_section}.associations", default: [])
-  #
-  #             association_list.each do |association_data|
-  #               unless association_data.size == 2
-  #                 Rails.logger.error('Bad syntax in your review YAML - expect each association to have name and fields')
-  #                 next
-  #               end
-  #
-  #               # Each association should have a row defined as a list i.e Array
-  #               #  -  :title: Business trading name
-  #               #     :name: full_name
-  #               #
-  #               unless association_data[1].respond_to?(:each)
-  #                 Rails.logger.error('Bad syntax in review YAML - each row needs a title, method and optional link')
-  #                 next
-  #               end
-  #
-  #               # The first element is the association name or chain,
-  #               # i.e method(s) to call on the parent model to reach child with the actual data
-  #               association_method = association_data[0].to_s
-  #
-  #               review_object = begin
-  #                 find_association(association_method)
-  #               rescue => e
-  #                 Rails.logger.error(e.message)
-  #                 Rails.logger.error("Bad syntax in review YAML - Could not load associated object #{association_method}")
-  #                 next
-  #               end
-  #
-  #               unless review_object
-  #                 Rails.logger.error("Nil association for #{association_method} on #{model} - no review data available")
-  #                 next
-  #               end
-  #
-  #               # The second element is a list of rows, made up of title, method to call on association and the state link
-  #               association_data[1].each { |column| row_to_review_data(review_object, column) }
-  #             end
-  #           end
-  #
-  #           review_data
-  #         end
-  #       end
-  #
-  #       private
-  #
-  #       attr_accessor :current_section, :current_review_object, :review_data
-  #
-  #       attr_accessor :model_object
-  #
-  #       def row_to_review_data(review_object, row)
-  #         # The section name, can be used as the state, for linking whole section, rather than at field level
-  #         link_state = row[:link_state] || current_section
-  #         link_title = row[:link_title]
-  #
-  #         @current_review_object = review_object
-  #
-  #         # The review partial can support whole objects, or low level data from method call defined in the DSL
-  #         if row[:method].blank?
-  #           review_data.add(row[:title], review_object, link_state.to_s, link_title)
-  #         else
-  #           # rubocop:disable Style/IfInsideElse
-  #           if review_object.respond_to?(:each)
-  #             review_object.each do |o|
-  #               @current_review_object = o
-  #               review_data.add(row[:title], send_chain(row[:method]), link_state.to_s, link_title)
-  #             end
-  #           else
-  #             review_data.add(row[:title], send_chain(row[:method]), link_state.to_s, link_title)
-  #           end
-  #
-  #         end
-  #       end
-  #
-  #       def find_association(method_chain)
-  #         method_chain.to_s.split('.').inject(model_object) { |a, e| a.send(e) }
-  #       end
-  #
-  #       def send_chain(method_chain)
-  #         arr = method_chain.to_s.split('.')
-  #         begin
-  #           arr.inject(current_review_object) { |a, e| a.send(e) }
-  #         rescue => e
-  #           Rails.logger.error("Failed to process method chain #{method_chain} : #{e.message}")
-  #           return I18n.t('.journey_plan_review.missing_data')
-  #         end
-  #       end
-  #
-  #     end
-  #   end
+  module PrepareDataForReview
+    extend ActiveSupport::Concern
+
+
+    #     module InstanceMethods
+    #
+    #       # You can build your review page within a YAML config file (locale file)
+    #       # It supports a simple DSL in below format.
+    #       #
+    #       # SYNTAX :
+    #       #     Indentation, usually 2 spaces, or a 2 space TAB, is very important
+    #       #     <> are used to illustrate the elements that accept free text
+    #       #
+    #       # ROW :
+    #       #
+    #       # Each ReviewDataRow has upto 3 elements
+    #       #
+    #       #   :title:      The string for Column 1, the row header
+    #       #
+    #       #   :method: The actual database data for Column2, method to call on the model, or the association object
+    #       #
+    #       #   :link_state: The state the change me links, jumps back to.
+    #       #                Optional, if unspecified,  uses the section block (state)
+    #       #
+    #       # FULL DSL :
+    #       #
+    #       # <key>:
+    #       #   sections:
+    #       #     <section_block - usually a state>:          # The Link target defaults to this, if no explicit state set
+    #       #       section_heading: "Farming data"           # The section title - that spans the 3 columns
+    #       #       direct:                                   # Non association data i.e directly on the parent model
+    #       #         -  :title: "Activity is on a farm"      # Column title. The - indicates a list, each mini block is a row
+    #       #            :method: on_a_farm                   # Method called on association to get real (DB) data to display
+    #       #         -  :title: "Registrant is a farmer"     # Next mini block - Each section can have multiple rows
+    #       #            :method: is_a_farmer
+    #       #     <next section_block - choosing_site_address>:
+    #       #       section_heading: Waste Activity Location
+    #       #       associations:
+    #       #         <association>                     # As well as direct, supports Rails associations, on supplied model
+    #       #           -  :title: "1st Column"
+    #       #              :method: full_name           # Ruby method called on association, returns real (DB) data to display
+    #       #              :link_state: state           # The link target - i.e state to JUMP to, in order to EDIT the data
+    #       #          site_address:                    # Again, section can contain multiple rows, from multiple associations
+    #       #            -  :title: "Address"
+    #       #               :method:                    # No method supplied, data will be WHOLE associated object
+    #       #
+    #       # EXAMPLE:
+    #       #
+    #       # journey_plan_review:
+    #       #   sections:
+    #       #     choosing_farming_data:
+    #       #       section_heading: "Farming data"
+    #       #       direct:
+    #       #         -  :title: "Activity is on a farm"
+    #       #            :method: on_a_farm
+    #       #         -  :title: "Registrant is a farmer"
+    #       #            :method: is_a_farmer
+    #       #     choosing_site_address:
+    #       #       section_heading: Waste Activity Location
+    #       #       associations:
+    #       #          site_address:
+    #       #            -  :title: "Address"
+    #       #               :method:                    # No state cos Partial can render WHOLE Address object
+    #       #            -  :title: "Grid reference"
+    #       #               :method: grid_reference
+    #       #     choosing_exemption:
+    #       #       section_heading: Waste Exemption Codes
+    #       #       associations:
+    #       #         exemption:
+    #       #           -  :title: "Waste Exemptions"
+    #       #              :method: code
+    #       #
+    #       # NOTES
+    #       #
+    #       # Method can be left blank, in this case the data is the association object, so this must be display-able
+    #       #
+    #       # For example, this will cause @journey_plan.site_address to be sent to the review partial, which we know has
+    #       # special use case for Address, which renders a display address partial
+    #       #
+    #       #          site_address:
+    #       #            -  :title: "Address"
+    #       #               :method:
+    #       #
+    #       attr_reader :review_data
+    #
+    #       # rubocop:disable Metrics/MethodLength
+    #
+    #       def prepare_from_locale(model, locale_key = '.journey_plan_review')
+    #         sections = I18n.t("#{locale_key}.sections", default: {})
+    #
+    #         Rails.logger.debug("Review Sections: #{sections.inspect}")
+    #
+    #         unless sections.is_a?(Hash)
+    #           Rails.logger.error("Bad syntax in your review YAML - Expect a 'sections' Hash element")
+    #           raise "Bad syntax in your review YAML - Expect a 'sections' Hash element"
+    #         end
+    #
+    #         @model_object = model
+    #
+    #         # Return a collection of Sections (ReviewData), each section has multiple rows
+    #
+    #         sections.collect do |section, data|
+    #           next unless data[:section_heading]
+    #
+    #           @current_section = section
+    #
+    #           @review_data = ReviewDataSection.new(data[:section_heading])
+    #
+    #           # Possible Enhancement required :
+    #           # As it stands this will NOT preserve the Order as defined exactly in the YAML as it's a HASH
+    #           # with keys - for direct & association sections - which are unordered.
+    #           # So currently had to make arbitrary decision to process direct first, then associations
+    #
+    #           # Direct data on parent Model, where key is - direct:
+    #           key = "#{locale_key}.sections.#{section}.direct"
+    #
+    #           I18n.t(key).each { |column| row_to_review_data(model_object, column) } if I18n.exists?(key)
+    #
+    #           # Associated data - children of parent
+    #           key = "#{locale_key}.sections.#{current_section}.associations"
+    #
+    #           if I18n.exists?(key)
+    #
+    #             association_list = I18n.t("#{locale_key}.sections.#{current_section}.associations", default: [])
+    #
+    #             association_list.each do |association_data|
+    #               unless association_data.size == 2
+    #                 Rails.logger.error('Bad syntax in your review YAML - expect each association to have name and fields')
+    #                 next
+    #               end
+    #
+    #               # Each association should have a row defined as a list i.e Array
+    #               #  -  :title: Business trading name
+    #               #     :name: full_name
+    #               #
+    #               unless association_data[1].respond_to?(:each)
+    #                 Rails.logger.error('Bad syntax in review YAML - each row needs a title, method and optional link')
+    #                 next
+    #               end
+    #
+    #               # The first element is the association name or chain,
+    #               # i.e method(s) to call on the parent model to reach child with the actual data
+    #               association_method = association_data[0].to_s
+    #
+    #               review_object = begin
+    #                 find_association(association_method)
+    #               rescue => e
+    #                 Rails.logger.error(e.message)
+    #                 Rails.logger.error("Bad syntax in review YAML - Could not load associated object #{association_method}")
+    #                 next
+    #               end
+    #
+    #               unless review_object
+    #                 Rails.logger.error("Nil association for #{association_method} on #{model} - no review data available")
+    #                 next
+    #               end
+    #
+    #               # The second element is a list of rows, made up of title, method to call on association and the state link
+    #               association_data[1].each { |column| row_to_review_data(review_object, column) }
+    #             end
+    #           end
+    #
+    #           review_data
+    #         end
+    #       end
+    #
+    #       private
+    #
+    #       attr_accessor :current_section, :current_review_object, :review_data
+    #
+    #       attr_accessor :model_object
+    #
+    #       def row_to_review_data(review_object, row)
+    #         # The section name, can be used as the state, for linking whole section, rather than at field level
+    #         link_state = row[:link_state] || current_section
+    #         link_title = row[:link_title]
+    #
+    #         @current_review_object = review_object
+    #
+    #         # The review partial can support whole objects, or low level data from method call defined in the DSL
+    #         if row[:method].blank?
+    #           review_data.add(row[:title], review_object, link_state.to_s, link_title)
+    #         else
+    #           # rubocop:disable Style/IfInsideElse
+    #           if review_object.respond_to?(:each)
+    #             review_object.each do |o|
+    #               @current_review_object = o
+    #               review_data.add(row[:title], send_chain(row[:method]), link_state.to_s, link_title)
+    #             end
+    #           else
+    #             review_data.add(row[:title], send_chain(row[:method]), link_state.to_s, link_title)
+    #           end
+    #
+    #         end
+    #       end
+    #
+    #       def find_association(method_chain)
+    #         method_chain.to_s.split('.').inject(model_object) { |a, e| a.send(e) }
+    #       end
+    #
+    #       def send_chain(method_chain)
+    #         arr = method_chain.to_s.split('.')
+    #         begin
+    #           arr.inject(current_review_object) { |a, e| a.send(e) }
+    #         rescue => e
+    #           Rails.logger.error("Failed to process method chain #{method_chain} : #{e.message}")
+    #           return I18n.t('.journey_plan_review.missing_data')
+    #         end
+    #       end
+    #
+    #     end
+  end
 end

data/lib/datashift_journey/version.rb

@@ -1,3 +1,3 @@
 module DatashiftJourney
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/generators/datashift_journey/collector/templates/collector_migration.rb.tt

@@ -14,10 +14,12 @@ class DatashiftJourneyCreateCollector < ActiveRecord::Migration[<%= @migration_v
       t.references :form_definition, index: true, null: false
       t.string     :name, index: true,  null: false, limit: 100
       t.integer    :category, index: true, null: false
-      t.text       :presentation
+      t.jsonb      :options, null: false, default: {}
       t.timestamps null: false
     end
 
+    add_index :dsj_form_fields, :options, using: :gin   # see GIN vs GiST
+
     # The plan is an instance of a JourneyPlan class
     create_table :dsj_data_nodes do |t|
       t.references  :plan,  null: false, polymorphic: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datashift_journey
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - tom statter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2020-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -168,19 +168,16 @@ files:
 - app/controllers/concerns/datashift_journey/review_renderer.rb
 - app/controllers/concerns/datashift_journey/token_based_access.rb
 - app/controllers/concerns/datashift_journey/validate_state.rb
-- app/controllers/datashift_journey/abandon_enrollments_controller.rb
 - app/controllers/datashift_journey/abandonments_controller.rb
 - app/controllers/datashift_journey/api/v1/states_controller.rb
 - app/controllers/datashift_journey/application_controller.rb
 - app/controllers/datashift_journey/errors_controller.rb
 - app/controllers/datashift_journey/journey_ends_controller.rb
 - app/controllers/datashift_journey/journey_plans_controller.rb
-- app/controllers/datashift_journey/page_states_controller.rb
 - app/controllers/datashift_journey/reviews_controller.rb
 - app/controllers/datashift_journey/state_jumper_controller.rb
 - app/factories/datashift_journey/form_object_factory.rb
 - app/forms/datashift_journey/collector/base_collector_form.rb
-- app/forms/datashift_journey/concerns/form_mixin.rb
 - app/forms/datashift_journey/null_form.rb
 - app/helpers/datashift_journey/application_helper.rb
 - app/helpers/datashift_journey/back_link_helper.rb
@@ -189,8 +186,6 @@ files:
 - app/models/datashift_journey/collector/form_field.rb
 - app/models/datashift_journey/journey_review.rb
 - app/models/datashift_journey/review_data_section.rb
-- app/serializers/datashift_journey/collector/page_state_serializer.rb
-- app/serializers/state_machines/state/state_serializer.rb
 - app/views/datashift_journey/collector/_generic_form.html.erb
 - app/views/datashift_journey/errors/401.html.erb
 - app/views/datashift_journey/errors/403.html.erb
@@ -224,6 +219,7 @@ files:
 - lib/datashift_journey/configuration.rb
 - lib/datashift_journey/engine.rb
 - lib/datashift_journey/exceptions.rb
+- lib/datashift_journey/form_mixin.rb
 - lib/datashift_journey/helpers/back_link.rb
 - lib/datashift_journey/journey/machine_builder.rb
 - lib/datashift_journey/prepare_data_for_review.rb

data/app/controllers/datashift_journey/abandon_enrollments_controller.rb

@@ -1,14 +0,0 @@
-module DatashiftJourney
-  class AbandonEnrollmentsController < DatashiftJourney::AbandonmentsController
-    # journey_plan object should been selected from the DB
-    prepend_before_filter :set_journey_plan, only: [:show]
-
-    def show
-      logger.info("User has abandoned #{params}")
-
-      # high voltage expects  id => name of page
-      params[:id] = params['page']
-      super
-    end
-  end
-end

data/app/controllers/datashift_journey/page_states_controller.rb

@@ -1,49 +0,0 @@
-module DatashiftJourney
-  class FormsController < ActionController::API
-
-    include DatashiftJourney::ErrorRenderer
-
-    before_action :set_user, only: [:show, :update, :destroy]
-
-    # PageState contains details for rendering and storing a Page related to a single State
-    #
-    def index
-      @collector_forms = Collector::FormDefinition.all
-
-      render json: @collector_forms, status: :ok
-    end
-
-    def create
-      @collector_form = Collector::FormDefinition.new(page_state_params)
-
-      if @collector_form.save
-        render json: @collector_form, status: :created
-      else
-        render_error(@collector_form, :unprocessable_entity) and return
-        #render json: { errors: @collector_form.errors }, status: :unprocessable_entity
-      end
-    end
-
-    def show
-      render json: @collector_form
-    end
-
-    private
-
-    # Only allow a trusted parameter "white list" through.
-    def page_state_params
-      params.fetch(:page_state, {}).permit(:form_name)
-    end
-
-    def set_user
-      begin
-        @collector_form = Collector::FormDefinition.find params[:id]
-      rescue ActiveRecord::RecordNotFound
-        collector_form = Collector::FormDefinition.new
-        collector_form.errors.add(:id, "Wrong ID provided")
-        render_error(collector_form, 404) and return
-      end
-    end
-
-  end
-end

data/app/serializers/datashift_journey/collector/page_state_serializer.rb

@@ -1,9 +0,0 @@
-module DatashiftJourney
-  module Collector
-    class PageStateSerializer < ActiveModel::Serializer
-      attributes :id, :form_name, :created_at
-
-      link(:self) {page_state_url(object) }
-    end
-  end
-end

data/app/serializers/state_machines/state/state_serializer.rb

@@ -1,5 +0,0 @@
-module StateMachines
-    class StateSerializer < ActiveModel::Serializer
-      attributes :name, :value, :initial
-    end
-end