journea 0.1.0

data/lib/journea/step.rb

@@ -0,0 +1,32 @@
+require "simple_form_object"
+
+module Journea
+  class Step
+    attr_accessor :journey
+
+    include SimpleFormObject
+
+    @custom_name = ""
+    class << self
+      attr_accessor :custom_name
+    end
+
+    def self.permitted_params
+      attributes.map(&:name)
+    end
+
+    def self.step_name
+      custom_name.presence || model_name.to_s.underscore
+    end
+
+    def step_name
+      self.class.step_name
+    end
+
+    def pre_save(form_params) end
+
+    def persisted?
+      true
+    end
+  end
+end

data/lib/journea/version.rb

@@ -0,0 +1,3 @@
+module Journea
+  VERSION = "0.1.0".freeze
+end

data/lib/simple_form_object.rb

@@ -0,0 +1,146 @@
+# Originally from: https://github.com/reinteractive-open/simple_form_object
+# Copied here (along with specs) so we can add Rails 5 support and tweak as needed
+module SimpleFormObject
+  extend ActiveSupport::Concern
+  include ActiveModel::Model
+  include ActiveModel::Callbacks
+
+  # TODO: There are a number of self. calls that rubocop claims are redundant
+  # in this file that need to be investigated.
+  # rubocop:disable Style/RedundantSelf
+  module ClassMethods
+    def attribute(name, type = :string, options = {})
+      self.send(:attr_accessor, name)
+
+      _attributes << Attribute.new(name, options, type)
+    end
+
+    def delegate_all(options = {})
+      @_delegation_target = options.fetch(:to)
+    end
+
+    def _delegation_target
+      @_delegation_target
+    end
+
+    def _attributes
+      @_attributes ||= []
+    end
+
+    def attributes
+      @_attributes
+    end
+
+    def _attribute(attribute_name)
+      _attributes.select { |a| a.name == attribute_name }.first
+    end
+
+    def model_name
+      ActiveModel::Name.new(self, nil, self.to_s.gsub(/Step$/, ""))
+    end
+  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, *args, &block)
+    return super unless delegatable?(method)
+
+    # TODO: Figure out why self.class.delegate(method, to: self.class._delegation_target)
+    # doesn't work.
+
+    # TODO: At this time don't understand enough about the gem to understand how
+    # best to resolve this issue.
+    # rubocop:disable Lint/ShadowingOuterLocalVariable
+    self.class.send(:define_method, method) do |*args, &block|
+      _delegation_target.send(method, *args, &block)
+    end
+    # rubocop:enable Lint/ShadowingOuterLocalVariable
+
+    send(method, *args, &block)
+  end
+  # rubocop:enable Style/MethodMissing
+
+  def delegatable?(method)
+    if !_delegation_target.nil?
+      _delegation_target.respond_to?(method)
+    else
+      false
+    end
+  end
+
+  def _delegation_target
+    target = self.class._delegation_target
+
+    if target.is_a? Symbol
+      self.send(target)
+    else
+      target
+    end
+  end
+
+  def column_for_attribute(attribute)
+    self.class._attribute(attribute).fake_column
+  end
+
+  def attribute?(attribute_name)
+    self.class._attribute(attribute_name).present?
+  end
+
+  def initialize(attributes = {})
+    super
+    self.class._attributes.each do |attribute|
+      attribute.apply_default_to(self)
+    end
+  end
+
+  def attributes
+    attribs = {}
+    self.class._attributes.each do |a|
+      attribs[a.name] = self.send(a.name)
+    end
+    attribs
+  end
+
+  class Attribute
+    def initialize(name, options, type = nil)
+      @name = name
+      @type = type || :string
+      @options = options
+
+      extract_options
+    end
+
+    attr_accessor :name, :type, :options
+
+    def fake_column
+      self
+    end
+
+    def apply_default_to(form)
+      return unless form.send(@name).nil?
+
+      form.send("#{@name}=", default_value(form)) if @apply_default
+    end
+
+    private
+
+    def default_value(context)
+      if @default.respond_to?(:call)
+        context.instance_eval(&@default)
+      else
+        @default
+      end
+    end
+
+    def extract_options
+      @apply_default = true
+      @default = options.fetch(:default) do
+        @apply_default = false
+        nil
+      end
+      @skip_validations = options.fetch(:skip_validations, false)
+    end
+  end
+  # rubocop:enable Style/RedundantSelf
+end

data/lib/tasks/journea_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :journey do
+#   # Task goes here
+# end

data/lib/templates/erb/scaffold/_form.html.erb

@@ -0,0 +1,13 @@
+<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= f.error_notification %>
+
+  <div class="form-inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="form-actions">
+    <%%= f.button :submit %>
+  </div>
+<%% end %>

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link journey_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// 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_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/pages_controller.rb

@@ -0,0 +1,4 @@
+class PagesController < ApplicationController
+  def start
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/steps/address_step.rb

@@ -0,0 +1,4 @@
+class AddressStep < Journea::Step
+  attribute :address_line_1, :string
+  attribute :address_line_2, :string
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/app/views/pages/start.html.erb

@@ -0,0 +1 @@
+<%= link_to 'Start now', journea.journeys_path, method: :post %>

data/spec/dummy/app/views/steps/address.html.erb

@@ -0,0 +1,5 @@
+<h1>Address</h1>
+<p>Please enter your address:</p>
+<%= simple_form_for @step do |f| %>
+  <%= f.button :submit, 'Continue' %>
+<% end %>

data/spec/dummy/app/views/steps/name.html.erb

@@ -0,0 +1,5 @@
+<h1>Name</h1>
+<p>Please do not enter your name.</p>
+<%= simple_form_for @step do |f| %>
+  <%= f.button :submit, 'Continue' %>
+<% end %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end