incredible 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 136f74de4f0fb1f2ce9b7c034536e309a3cec7ae
+  data.tar.gz: 8144f9c6ace33e5a6b2442b8f7704ee0dbfb4a78
+SHA512:
+  metadata.gz: 856c927d05693349103b26fc1754e85415d58ba4f52e858d93f2c244a1c609e73fd4ac5a8e27af9ea0ac2a8f1587552db81f6fbde061bc2a566c115b592f58e2
+  data.tar.gz: 948ab2aeb444d19082b18cfc432a30e4b76e217d1d2961802d45431ab489f20cb524eb34770f7b18dff20ab63fb284b0bd404f832cacce4eab1adec302abcd17

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 pezholio
+
+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/README.md

@@ -0,0 +1,153 @@
+[![Build Status](http://img.shields.io/circleci/project/github/wearefuturegov/incredible.svg?style=flat-square)](https://circleci.com/gh/wearefuturegov/incredible)
+[![Coverage Status](http://img.shields.io/coveralls/wearefuturegov/incredible.svg?style=flat-square)](https://coveralls.io/r/wearefuturegov/incredible)
+[![Code Climate](http://img.shields.io/codeclimate/github/wearefuturegov/incredible.svg?style=flat-square)](https://codeclimate.com/github/wearefuturegov/incredible)
+[![Gem Version](http://img.shields.io/gem/v/Incredible.svg?style=flat-square)](https://rubygems.org/gems/Incredible)
+[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://wearefuturegov.mit-license.org)
+
+# Incredible
+
+Build multi-page forms like a [General](https://www.youtube.com/watch?v=mL2Bgj-za5k).
+
+Incredible uses the power of [Wicked](https://github.com/schneems/wicked) to allow you to build multi-page, ActiveRecord model-based, Rails forms using a simple YAML-based format.
+
+## Installation
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'incredible'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install incredible
+```
+
+## Usage
+
+*NOTE:* Incredible is still a work in progress and at an early stage, so these docs are subject to change (and definitely need improving!)
+
+First, create a YAML file in `config/forms` - for example `config/forms/my_awesome_form.yml`.
+
+Here's an example:
+
+```YAML
+form:
+  name: 'Test form'
+  steps:
+    step1:
+      template: foo
+      rules:
+        name:
+          'Mike': :step3
+      questions:
+        - name: :name
+          title: Your full name
+          widget: :input
+        - name: :postcode
+          title: Your postcode
+          widget: :input
+    step2:
+      template: bar
+      questions:
+        - name: :email
+          title: Email
+          widget: :email
+        - name: :phone_number
+          title: Phone Number
+          widget: :tel
+    step3:
+      template: :baz
+```
+
+Each step *must* have a template, and questions as a minimum.  
+
+Next create a model:
+
+```bash
+rails g model form name:string postcode:string email:string postcode:string
+rails db:migrate
+```
+
+Note how all the columns refer to a question in your YAML file.
+
+Then create a controller:
+
+```bash
+rails g controller forms/build
+````
+
+Add Routes into config/routes.rb:
+
+```Ruby
+resources :forms do
+  resources :build, controller: 'forms/build'
+end
+```
+
+Next include `Incredible::Wizard` in your controller
+
+```Ruby
+class Forms::BuildController < ApplicationController
+  include Incredible::Wizard
+
+  form 'my_awesome_form'
+end
+```
+
+(Where `my_awesome_form` is the name of the YAML file you created)
+
+Next add `show`, `create` and `new` methods to your controller
+
+```Ruby
+class Forms::BuildController < ApplicationController
+  include Incredible::Wizard
+  
+  form 'my_awesome_form'
+  
+  def show
+    render_wizard nil, template: "forms/#{template}"
+  end
+
+  def update
+    @form = Form.find(params[:id])
+    render_wizard @form
+  end
+  
+  def new
+    redirect_to wizard_path(steps.first, foster_check_id: foster_check.id)
+  end
+  
+end
+```
+
+Next, you'll need to have a controller that creates your model and redirects to the form. Run this:
+
+```bash
+rails g controller forms
+````
+
+Then edit your controller:
+
+```ruby
+class FormsController < ApplicationController
+  
+  def create
+    form = Form.create
+    redirect_to new_form_build_path(form_id: form.id)
+  end
+  
+end
+```
+
+More docs coming soon!
+
+## Contributing
+See [CONTRIBUTING.md](https://github.com/wearefuturegov/incredible/blob/master/CONTRIBUTING.md)
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+
+Coveralls::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+
+task default: [:spec, 'coveralls:push']

data/config/routes.rb

@@ -0,0 +1,2 @@
+Incredible::Engine.routes.draw do
+end

data/lib/incredible.rb

@@ -0,0 +1,12 @@
+require 'wicked'
+
+require 'incredible/engine'
+require 'incredible/loader'
+require 'incredible/form'
+require 'incredible/step'
+
+require 'incredible/wizard'
+
+module Incredible
+  # Your code goes here...
+end

data/lib/incredible/engine.rb

@@ -0,0 +1,9 @@
+module Incredible
+  class Engine < ::Rails::Engine
+    isolate_namespace Incredible
+    
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+    end
+  end
+end

data/lib/incredible/form.rb

@@ -0,0 +1,26 @@
+module Incredible
+  class Form
+    def initialize(name)
+      @data = Incredible::Loader.load(name)
+    end
+    
+    def step_names
+      raw_steps.keys
+    end
+    
+    def steps
+      @steps ||= raw_steps.map { |k, v| { k => Step.new(v) } }.reduce(:merge)
+    end
+    
+    def find_step(step_name)
+      steps[step_name]
+    end
+    
+    private
+
+    def raw_steps
+      @data['form']['steps']
+    end
+    
+  end
+end

data/lib/incredible/loader.rb

@@ -0,0 +1,24 @@
+module Incredible
+  class Loader
+    class FormNotFound < StandardError; end
+    class BadYAML < StandardError; end
+
+    def self.load(name)
+      filename = "#{name}.yml"
+      new(filename).data
+    end
+
+    def initialize(filename)
+      @path = Rails.root.join('config', 'forms', filename)
+    end
+
+    def data
+      YAML.safe_load File.open(@path), [Symbol]
+    rescue Errno::ENOENT => e
+      raise FormNotFound, e.message
+    rescue Psych::SyntaxError => e
+      raise BadYAML, e.message
+    end
+  
+  end
+end

data/lib/incredible/step.rb

@@ -0,0 +1,15 @@
+module Incredible
+  class Step
+    
+    def initialize(data)
+      @data = data.symbolize_keys
+      
+      %I[questions rules template].each do |k|
+        self.class.send :define_method, k.to_sym do
+          @data[k]
+        end
+      end
+    end
+    
+  end
+end

data/lib/incredible/version.rb

@@ -0,0 +1,3 @@
+module Incredible
+  VERSION = '0.0.1.pre'.freeze
+end

data/lib/incredible/wizard.rb

@@ -0,0 +1,42 @@
+module Incredible
+  module Wizard
+    extend ActiveSupport::Concern
+    include Wicked::Wizard
+    
+    attr_accessor :wizard_form, :step_data, :template, :rules, :questions
+
+    included do
+      before_action :load_step, only: %i[show update]
+      before_action :process_rules, only: :update
+      before_action :load_step_data, only: %i[show update]
+    end
+    
+    def load_step
+      self.step_data = wizard_form.find_step(params[:id])
+    end
+    
+    def load_step_data
+      self.template = step_data.template
+      self.questions = step_data.questions
+    end
+    
+    def process_rules
+      self.rules = step_data.rules || {}
+      next_step = permitted_params.to_h.map do |k, v|
+        rules.dig(k, v)
+      end&.first
+      jump_to next_step if next_step
+    end
+    
+    module ClassMethods
+      def form(form_name)
+        wizard_form = Incredible::Form.new(form_name)
+        steps(*wizard_form.step_names)
+        prepend_before_action do
+          self.wizard_form = wizard_form
+        end
+      end
+    end
+    
+  end
+end

data/spec/controllers/forms_controller_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe FormsController, type: :controller do
+  
+  context 'rendering templates' do
+    it 'renders step 1 template' do
+      expect(
+        (get :show, params: { id: :step1 })
+      ).to render_template('forms/foo')
+    end
+    
+    it 'renders step 2 template' do
+      expect(
+        (get :show, params: { id: :step2 })
+      ).to render_template('forms/bar')
+    end
+  end
+  
+  context 'rules' do
+    it 'follows a rule' do
+      expect(
+        (put :update, params: { id: :step1, model: { name: 'Mike' } })
+      ).to redirect_to('http://test.host/forms/step3')
+    end
+    
+    it 'goes to the next step by default' do
+      expect(
+        (put :update, params: { id: :step1, model: { name: 'Ian' } })
+      ).to redirect_to('http://test.host/forms/step2')
+    end
+  end
+  
+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/controllers/application_controller.rb

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

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

@@ -0,0 +1,21 @@
+class FormsController < ActionController::Base
+  include Incredible::Wizard
+  
+  form 'form'
+
+  def show
+    render_wizard nil, template: "forms/#{template}"
+  end
+
+  def update
+    @model = StubModel.new(permitted_params)
+    render_wizard @model
+  end
+  
+  private
+  
+  def permitted_params
+    params.require(:model).permit(:name, :postcode, :email, :phone_number)
+  end
+
+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/models/stub_model.rb

@@ -0,0 +1,9 @@
+class StubModel
+  include ActiveModel::Model
+  
+  attr_accessor :name, :postcode, :email, :phone_number
+  
+  def save
+    true
+  end
+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' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>