form_journey 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5d63c4a9037f39e322a214c36318874c03ea65e
+  data.tar.gz: f99720d342be944bad852614907162ccea6e39b4
+SHA512:
+  metadata.gz: 404e37955b49b888895130eb3dbf7535480fac454289004a9db923b63d449f786bd287c5600fb9d8d8a3538c77a065d1904b45cc96a5d52a0912114f5e453f92
+  data.tar.gz: 91ef6436d06ddb5ab21e180e5102489752bf7f48d33090390d1a32676c3b29f9d742550d8a297f2697724dae5c5ccfed1044747bdb5e910e3e3f8c98dff1ecff

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,17 @@
+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    = 'FormJourney'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/form_journey.rb

@@ -0,0 +1,7 @@
+module FormJourney
+end
+
+require_relative './form_journey/routes'
+require_relative './form_journey/controller'
+require_relative './form_journey/parameters'
+require_relative './form_journey/uses_single_model'

data/lib/form_journey/controller.rb

@@ -0,0 +1,131 @@
+module FormJourney
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_steps
+      self._steps = []
+
+      before_action :before_step_action
+      helper_method :step_path
+      helper_method :current_step_path
+      helper_method :next_step_path
+      helper_method :previous_step_path
+      helper_method :current_step_number
+      helper_method :total_steps_number
+
+      [:current_step, :previous_step, :next_step].each do |key|
+        class_eval do
+          define_method "#{key}_path".to_sym do
+            step_path(self.send(key))
+          end
+        end
+      end
+    end
+
+    def default_step
+      redirect_to steps.any? ? step_path(steps.first) : '/'
+    end
+
+    def steps
+      instance_steps
+    end
+
+    def instance_steps
+      @instance_steps ||= self.class._steps.dup
+    end
+
+    def update_steps(*new_steps)
+      @instance_steps = new_steps
+    end
+
+    def add_step(new_step, before: nil)
+      if before
+        index = instance_steps.index(before)
+        return nil unless index
+        instance_steps.insert(index, new_step)
+      else
+        instance_steps << new_step
+      end
+    end
+
+    def remove_step(step_name)
+      instance_steps.delete(step_name)
+    end
+
+    def step_path(step)
+      url_for(controller: params[:controller], action: step)
+    end
+
+    def current_step
+      steps.include?(params[:action].to_sym) and params[:action].to_sym or steps.first
+    end
+
+    def next_step
+      steps[current_step_index + 1] || steps.last
+    end
+
+    def previous_step
+      steps[current_step_index - 1] || steps.first
+    end
+
+    def current_step_number
+      current_step_index + 1
+    end
+
+    def total_steps_number
+      steps.count
+    end
+
+    def when_post
+      return yield if request.post?
+    end
+
+    def when_patch
+      return yield if request.patch?
+    end
+
+    def when_post_or_patch
+      return yield if request.patch? || request.post?
+    end
+
+    def when_delete
+      return yield if request.delete?
+    end
+
+    def when_get
+      return yield if request.get?
+    end
+
+    def journey_params
+      @journey_params ||= FormJourney::Parameters.new(params, journey_session)
+    end
+
+    private
+
+    def previous_steps
+      Array(steps.clone).tap do |steps|
+        steps.slice!(current_step_index + 1, steps.length)
+      end
+    end
+
+    def current_step_index
+      steps.index(current_step)
+    end
+
+    def before_step_action
+      method = "before_#{current_step}"
+      return self.send(method) if self.respond_to?(method, true)
+    end
+
+    def journey_session
+      (session["#{params[:controller]}_journey_session".to_sym] ||= {})
+    end
+
+    module ClassMethods
+      def steps(*steps)
+        self._steps.concat(steps)
+      end
+    end
+  end
+end

data/lib/form_journey/parameters.rb

@@ -0,0 +1,80 @@
+module FormJourney
+  class Parameters < HashWithIndifferentAccess
+    def initialize(attributes = nil, session)
+      @session = (session || {})
+      @session.deep_merge!(attributes.deep_symbolize_keys) if attributes
+      super(@session)
+    end
+
+    def clear!
+      replace({})
+      @session.clear
+    end
+
+    def []=(key, value)
+      super
+      update_session
+    end
+
+    def get(*keys)
+      params = to_hash
+      while !keys.empty?
+        return nil if params.nil?
+        params = params[keys.shift.to_s]
+      end
+      params
+    end
+
+    def del(*keys)
+      parent_param = self
+      while !keys.empty?
+        return nil if parent_param.nil?
+
+        if keys.length == 1
+          del_param = parent_param.try(:delete, keys.shift)
+          update_session
+          return del_param
+        end
+        parent_param = parent_param[keys.shift]
+      end
+    end
+
+    def set(*keys, value:)
+      parent_param = self
+      while !keys.empty?
+        return nil if parent_param.nil?
+
+        if keys.length == 1
+          parent_param[keys.shift] = value
+          update_session
+          return self
+        end
+        parent_param = parent_param[keys.shift]
+      end
+    end
+
+    def add_to_array(*path, value:, unique: false)
+      array = Array(get(*path))
+      array << value
+      array.uniq! if unique
+      set(*path, value: array)
+    end
+
+    def remove_from_array(*path, value:)
+      array = Array(get(*path))
+      array.select! { |v| v != value }
+      set(*path, value: array)
+    end
+
+    def require(key)
+      ActionController::Parameters.new(to_hash).require(key)
+    end
+
+    private
+
+    def update_session
+      @session.clear
+      @session.merge!(deep_symbolize_keys)
+    end
+  end
+end

data/lib/form_journey/routes.rb

@@ -0,0 +1,14 @@
+require 'action_dispatch'
+
+module ActionDispatch::Routing
+  class Mapper
+    def mount_journey(path, controller)
+      resource "#{path}", only: [] do
+        get "/", controller: controller, action: :default_step
+        get "/:id/edit", controller: controller, action: 'edit', as: 'edit'
+        yield if block_given?
+        match "/:action", controller: controller, action: /[a-z0-9_]+/, via: [:get, :post, :patch, :delete], as: 'step'
+      end
+    end
+  end
+end

data/lib/form_journey/uses_single_model.rb

@@ -0,0 +1,89 @@
+module FormJourney
+  module UsesSingleModel
+    extend ActiveSupport::Concern
+    included do
+      class_attribute :_model_class
+      class_attribute :_model_scope
+      class_attribute :_params_method
+    end
+
+    def edit
+      journey_params.clear!
+      journey_params.set(:_model_object_id, value: params[:id])
+      redirect_to step_path(steps.first)
+    end
+
+    def editing?
+      model_object_id.present?
+    end
+
+    def model_object_id
+      journey_params.get(:_model_object_id)
+    end
+
+    private
+
+    def model_object
+      @model_object ||= begin
+        if editing?
+          scoped_class.find(model_object_id).tap do |obj|
+            obj.assign_attributes(model_params)
+          end
+        else
+          scoped_class.new(model_params)
+        end
+      end
+    end
+
+    def scoped_class
+      model_class = self.class._model_class
+      scope = self.class._model_scope
+      return model_class unless scope
+      if scope.respond_to?(:call)
+        instance_exec(model_class, &scope)
+      else
+        messages = Array(scope)
+        messages.reduce(model_class) do |chained_scope, message|
+          chained_scope.send(message.to_sym)
+        end
+      end
+    end
+
+    def model_params
+      if self.class._params_method.respond_to?(:call)
+        self.class._params_method.call
+      else
+        self.send(self.class._params_method.to_sym)
+      end
+    end
+
+    module ClassMethods
+      def params_method(params_method)
+        self._params_method = params_method
+      end
+
+      def model_scope(*scope)
+        if scope.size == 1
+          self._model_scope = scope.first
+        else
+          self._model_scope = scope
+        end
+      end
+
+      def model_class(clasz)
+        clasz = clasz.is_a?(String) ? self.const_get(clasz) : clasz
+        self._model_class = clasz
+        hyphenated_class_name = clasz.to_s.gsub(/::/, '')
+          .gsub(/(?<=[^\b])([A-Z])/, '_\1')
+          .downcase
+        class_eval do
+          define_method(hyphenated_class_name.to_sym) do
+            model_object
+          end
+        end
+        self.send(:helper_method, hyphenated_class_name.to_sym)
+      end
+    end
+  end
+end
+

data/lib/form_journey/version.rb

@@ -0,0 +1,3 @@
+module FormJourney
+  VERSION = "0.3.0"
+end

data/lib/tasks/form_journey_tasks.rake

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

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: form_journey
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Driftrock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  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: pry
+  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: Create multi page form using Rails
+email:
+- dev@driftrock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/form_journey.rb
+- lib/form_journey/controller.rb
+- lib/form_journey/parameters.rb
+- lib/form_journey/routes.rb
+- lib/form_journey/uses_single_model.rb
+- lib/form_journey/version.rb
+- lib/tasks/form_journey_tasks.rake
+homepage: http://www.driftrock.com
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rails form journey
+test_files: []