effective_resources 1.6.5 → 1.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 638c0fd7b0f6e8ad8cbcdfe19a1d10e3824a2767734371e7ee744687181eb773
-  data.tar.gz: 25bf07d2126c62e65092cbeb4113a8df0017188fd5f17108b425cf8aa4ff09b0
+  metadata.gz: 323b70f4a0eb470c2e96edf3651c83493763ad203659f03bb25832cf487812a1
+  data.tar.gz: f997c5dcd62f4de1d49065c5fb3d5d882ea3eca30c47fe518bb6642dbd43e65a
 SHA512:
-  metadata.gz: 86e11947ca25724dfb6255bd77129b92b87780f8199257634ebdd6841406165ba952d4ddad329608d15685102c5e216b9afeae6cffc51052c05b9564881ec749
-  data.tar.gz: 70608699672fe60a576f96987224accdddeffeef6248d775c2f6f4481ef1b69c42edddc14e20cb953025098e041d9e354fdb354dfa0a6b99a25a18218f9a5d81
+  metadata.gz: 4d78587039acac7fa236913c588946277481a5df90933141db13a7d447491233452f8dd6c3c96ebf7bff8dfd95ba217e56c65e826128d9674532331d6971422c
+  data.tar.gz: daff8c0e7009dd67297f2e62a90744b7dcc67008f107543b53c53b24476ca8534284202aae98b0579e394fddbdbb498925b0294f47c95e70f9bbf8b551cab4a3

data/README.md

@@ -256,6 +256,102 @@ end
 
 and include Effective::CrudController in your resource controller.
 
+### acts_as_wizard
+
+Build up an object through a wizard.
+
+Works with the [wicked](https://github.com/zombocom/wicked) gem to create wizard quickly.
+
+Create a model and define `acts_as_wizard`:
+
+```ruby
+class Thing < ApplicationRecord
+  acts_as_wizard(
+    start: 'Start',
+    select: 'Select',
+    finish: 'Finish'
+  )
+
+  effective_resource do
+    title       :string
+    wizard_steps  :text, permitted: false
+  end
+
+  validates :title, presence: true
+
+  def to_s
+    title.presence || 'New Thing'
+  end
+
+  # If you define a bang method matching the name of a step
+  # it will be called when that step is submitted.
+  # Otherwise save! is called.
+  def select!
+    ApplicationMailer.selected(self).deliver_later
+    save!
+  end
+
+  # An array of steps that the controller will use
+  # Default value is just all of them. But you can customize here
+  # def required_steps
+  #   steps = WIZARD_STEPS.keys
+  #   selectable? ? steps : steps - [:select]
+  # end
+
+  # Control whether the user has permission to visit this step
+  #
+  # This is the default, can go forward or back:
+  #
+  # def can_visit_step?(step)
+  #   can_revisit_completed_steps(step)
+  # end
+  #
+  # Easy change if you only want to go forward:
+  #
+  # def can_visit_step?(step)
+  #   cannot_revisit_completed_steps(step)
+  # end
+  #
+  # or custom algorithm:
+  #
+  # def can_visit_step?(step)
+  #   return false unless has_completed_previous_step?(step)
+  #   return false if has_completed_step?(:finish) && step != :finish
+  # end
+end
+```
+
+In your routes:
+
+```ruby
+resources :things, only: [:index, :show, :new, :destroy] do
+  resources :build, controller: :things, only: [:show, :update]
+end
+```
+
+Make a controller:
+
+```ruby
+class ThingsController < ApplicationController
+  include Effective::WizardController
+end
+```
+
+And then create one view per step.
+
+Here's `views/things/start.html.haml`:
+
+```haml
+= render_wizard_sidebar(resource) do
+  %h1= @page_title
+
+  = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+    = f.text_field :title
+    = f.submit 'Save and Continue'
+```
+
+You can also call `render_wizard_sidebar(resource)` without the block syntax.
+
 ## Testing
 
 Run tests by:

data/app/controllers/concerns/effective/wizard_controller.rb

@@ -2,11 +2,7 @@ module Effective
   module WizardController
     extend ActiveSupport::Concern
 
-    unless defined?(Wicked)
-      raise("please install gem 'wicked' to use Effective::WizardController")
-    end
-
-    include Wicked::Wizard
+    include Wicked::Wizard if defined?(Wicked)
     include Effective::CrudController
 
     include Effective::WizardController::Actions
@@ -14,6 +10,8 @@ module Effective
     include Effective::WizardController::Save
 
     included do
+      raise("please install gem 'wicked' to use Effective::WizardController") unless defined?(Wicked)
+
       with_options(only: [:show, :update]) do
         before_action :redirect_if_blank_step
 

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '1.6.5'.freeze
+  VERSION = '1.6.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.6.6
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails