effective_resources 1.6.4 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bb7652d9f80993d8147a2256189201111268282d81f881172df757474113e39
-  data.tar.gz: 101536d12175828d0ae1008e2d6dbf226e3f594a93c55f7566f89a17d3bcd1c8
+  metadata.gz: a3a189848d1642d5a68d1bbae816eddf3bd4d51513d28bd369a02aa1843b5b9a
+  data.tar.gz: ab0af0abaefa639595858f4eee2356d2ba2b96434c3d493d6a1e1cdd49877bf1
 SHA512:
-  metadata.gz: 360ae9e38369c840302b06696686e3e3f64ed4375fdc651571f29208c437281248c02ab8aed272063e3f3e0fd6ab999e891bbe368e60f93ff05cbc27521abffa
-  data.tar.gz: 5cfa3f62f33ec8f0d2b1c2ea11806634964af86f9b19c2088ea184c1cf528bcabf3d7c4c0c873125ab90d60eb8a794ca376c91d78a05cd57f43137d6f827567f
+  metadata.gz: 660470293ca5400697b468ea97a95458a46b323ba6399ce35dea43dc2f535afdf86cae6c7f341cfea69a8ca13f54cbd156bc80fcb0d9fe11ec3c97e5c1aafbc7
+  data.tar.gz: 7e479eef9412d2195465f1cf4194f594dba7bcb5ec47179730098042cda8d151cc855fe52d09972ef9fad0e70a104ec982af49f13ea5e9e7b6d3c9f77bc35e02

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/crud_controller.rb

@@ -11,13 +11,14 @@ module Effective
 
     included do
       define_actions_from_routes
-      define_permitted_params_from_model
       define_callbacks :resource_render, :resource_before_save, :resource_after_save, :resource_after_commit, :resource_error
     end
 
     module ClassMethods
       include Effective::CrudController::Dsl
 
+      # This is used to define_actions_from_routes and for the buttons/submits/ons
+      # It doesn't really work with the resource_scope correctly but the routes are important here
       def effective_resource
         @_effective_resource ||= Effective::Resource.new(controller_path)
       end
@@ -32,17 +33,6 @@ module Effective
           define_method(action) { collection_action(action) }
         end
       end
-
-      def define_permitted_params_from_model
-        if effective_resource.model.present?
-          define_method(:effective_resource_permitted_params) { resource_permitted_params } # save.rb
-        end
-
-        if effective_resource.active_model?
-          define_method(:effective_resource_permitted_params) { resource_active_model_permitted_params } # save.rb
-        end
-      end
-
     end
 
     def resource # @thing
@@ -62,11 +52,29 @@ module Effective
     end
 
     def effective_resource
-      self.class.effective_resource
+      @_effective_resource ||= begin
+        relation = instance_exec(&resource_scope_relation) if respond_to?(:resource_scope_relation)
+
+        if respond_to?(:resource_scope_relation) && !relation.kind_of?(ActiveRecord::Relation)
+          raise('resource_scope must return an ActiveRecord::Relation')
+        end
+
+        resource = Effective::Resource.new(controller_path, relation: relation)
+
+        unless resource.relation.kind_of?(ActiveRecord::Relation) || resource.active_model?
+          raise("unable to build resource_scope for #{resource.klass || 'unknown klass'}. Please name your controller to match an existing model, or manually define a resource_scope.")
+        end
+
+        resource
+      end
     end
 
     private
 
+    def resource_scope
+      effective_resource.relation
+    end
+
     def resource_name # 'thing'
       effective_resource.name
     end
@@ -83,30 +91,6 @@ module Effective
       effective_resource.plural_name
     end
 
-    # Returns an ActiveRecord relation based on the computed value of `resource_scope` dsl method
-    def resource_scope # Thing
-      @_effective_resource_relation ||= (
-        relation = case @_effective_resource_scope  # If this was initialized by the resource_scope before_action
-        when ActiveRecord::Relation
-          @_effective_resource_scope
-        when Hash
-          effective_resource.klass.where(@_effective_resource_scope)
-        when Symbol
-          effective_resource.klass.send(@_effective_resource_scope)
-        when nil
-          effective_resource.klass.respond_to?(:all) ? effective_resource.klass.all : effective_resource.klass
-        else
-          raise "expected resource_scope method to return an ActiveRecord::Relation or Hash"
-        end
-
-        unless relation.kind_of?(ActiveRecord::Relation) || effective_resource.active_model?
-          raise("unable to build resource_scope for #{effective_resource.klass || 'unknown klass'}. Please name your controller to match an existing model, or manually define a resource_scope.")
-        end
-
-        relation
-      )
-    end
-
     def resource_datatable_attributes
       resource_scope.where_values_hash.symbolize_keys
     end
@@ -128,7 +112,16 @@ module Effective
     end
 
     def resource_params_method_name
-      ["#{resource_name}_params", "#{resource_plural_name}_params", 'permitted_params', 'effective_resource_permitted_params', ('resource_permitted_params' if effective_resource.model.present?)].compact.find { |name| respond_to?(name, true) } || 'params'
+      ['permitted_params', "#{resource_name}_params", "#{resource_plural_name}_params"].each do |name|
+        return name if respond_to?(name, true)
+      end
+
+      # Built in ones
+      return 'resource_permitted_params' if effective_resource.model.present?
+      return 'resource_active_model_permitted_params' if effective_resource.active_model?
+
+      # Fallback
+      'params'
     end
 
   end

data/app/controllers/concerns/effective/crud_controller/dsl.rb

@@ -79,9 +79,12 @@ module Effective
       def resource_scope(obj = nil, opts = {}, &block)
         raise 'expected a proc or block' unless (obj.respond_to?(:call) || block_given?)
 
-        instance_exec do
-          before_action(opts) { @_effective_resource_scope ||= instance_exec(&(block_given? ? block : obj)) }
+        if block_given?
+          define_method(:resource_scope_relation) { return block }
+        else
+          define_method(:resource_scope_relation) { return obj }
         end
+
       end
 
     end

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

@@ -2,18 +2,17 @@ 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
     include Effective::WizardController::BeforeActions
     include Effective::WizardController::Save
+    include Effective::WizardController::WickedOverrides
 
     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
 
@@ -56,9 +55,11 @@ module Effective
       effective_resource.klass.const_get(:WIZARD_STEPS).keys
     end
 
+    # It could be :new, :start
+    # Or resource, step
     def resource_wizard_path(resource, step)
-      path_helper = effective_resource.action_path_helper(:show).to_s.sub('_path', '_build_path')
-      public_send(path_helper, resource, step)
+      param = (resource.respond_to?(:to_param) ? resource.to_param : resource)
+      wizard_path(step, resource_name_id => param)
     end
 
   end

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

@@ -21,6 +21,7 @@ module Effective
         Rails.logger.info 'Processed by Effective::WizardController#update'
 
         resource.assign_attributes(send(resource_params_method_name))
+        assign_current_step
 
         save_wizard_resource(resource)
       end

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

@@ -42,14 +42,19 @@ module Effective
         return if resource.can_visit_step?(step)
 
         next_step = wizard_steps.reverse.find { |step| resource.can_visit_step?(step) }
-        raise('There is no wizard step to visit') unless next_step
+        raise('There is no wizard step to visit. Make sure can_visit_step?(step) returns true for at least one step') unless next_step
 
-        flash[:danger] = "You have been redirected to the #{resource_wizard_step_title(next_step)} step."
+        if Rails.env.development?
+          Rails.logger.info "  \e[31m\e[1mFAILED\e[0m\e[22m" # bold red
+          Rails.logger.info "  Unable to visit step :#{step}. Last can_visit_step? is :#{next_step}. Change the acts_as_wizard model's can_visit_step?(step) function to change this."
+        end
+
+        flash[:success] = "You have been redirected to the #{resource_wizard_step_title(next_step)} step."
         redirect_to wizard_path(next_step)
       end
 
       # before_action :assign_current_step, only: [:show, :update]
-      # Assign the urrent step to resource
+      # Assign the current step to resource
       def assign_current_step
         if respond_to?(:current_user) && resource.respond_to?(:current_user=)
           resource.current_user = current_user

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

@@ -0,0 +1,23 @@
+module Effective
+  module WizardController
+    module WickedOverrides
+
+      # Changes made here to work inside an effective rails engine
+      #
+      # https://github.com/zombocom/wicked/blob/main/lib/wicked/controller/concerns/path.rb
+      # https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/routing/url_for.rb#L180
+      def wizard_path(goto_step = nil, options = {})
+        options = options.respond_to?(:to_h) ? options.to_h : options
+        options = { :controller => wicked_controller,
+                    :action     => 'show',
+                    :id         => goto_step || params[:id],
+                    :only_path  => true
+                   }.merge(options)
+
+        merged_url_options = options.reverse_merge!(url_options)
+        effective_resource.url_helpers.url_for(merged_url_options)
+      end
+
+    end
+  end
+end

data/app/models/concerns/acts_as_wizard.rb

@@ -68,6 +68,10 @@ module ActsAsWizard
       wizard_steps[step].present?
     end
 
+    def next_step
+      required_steps.reverse.find { |step| can_visit_step?(step) } || required_steps.first
+    end
+
     def previous_step(step)
       index = required_steps.index(step)
       required_steps[index-1] unless index == 0 || index.nil?

data/app/models/effective/resource.rb

@@ -15,8 +15,8 @@ module Effective
     include Effective::Resources::Sql
 
     # post, Post, Admin::Post, admin::Post, admin/posts, admin/post, admin/effective::post
-    def initialize(input, namespace: nil, &block)
-      _initialize_input(input, namespace: namespace)
+    def initialize(input, namespace: nil, relation: nil, &block)
+      _initialize_input(input, namespace: namespace, relation: relation)
       _initialize_model(&block) if block_given?
       self
     end

data/app/models/effective/resources/actions.rb

@@ -12,8 +12,8 @@ module Effective
       def routes
         @routes ||= (
           matches = [
-            [namespace, plural_name].compact.join('/'),
-            [namespace, name].compact.join('/')
+            [namespace, route_name.pluralize].compact.join('/'),
+            [namespace, route_name].compact.join('/'),
           ]
 
           # Check main Rails app
@@ -21,9 +21,25 @@ module Effective
             (matches & [route.defaults[:controller]]).present? && !route.name.to_s.end_with?('root')
           end
 
+          if routes.blank?
+            matches = [
+              [namespace, plural_name].compact.join('/'),
+              [namespace, name].compact.join('/')
+            ]
+
+            # Check main Rails app
+            routes = Rails.application.routes.routes.select do |route|
+              (matches & [route.defaults[:controller]]).present? && !route.name.to_s.end_with?('root')
+            end
+          end
+
           # Check engine routes
           if routes.blank?
             matches = [
+              [namespace, route_name.pluralize].compact.join('/'),
+              [namespace, route_name].compact.join('/'),
+              ['effective', namespace, route_name.pluralize].compact.join('/'),
+              ['effective', namespace, route_name].compact.join('/'),
               [namespace, plural_name].compact.join('/'),
               [namespace, name].compact.join('/'),
               ['effective', namespace, plural_name].compact.join('/'),
@@ -35,7 +51,11 @@ module Effective
                 (matches & [route.defaults[:controller]]).present? && !route.name.to_s.end_with?('root')
               end
 
-              break if routes.present?
+              if routes.present?
+                @routes_app = engine
+                break
+              end
+
             end
           end
 
@@ -43,6 +63,14 @@ module Effective
         )
       end
 
+      def routes_app
+        @routes_app if routes.present?
+      end
+
+      def url_helpers
+        (routes_app || Rails.application).routes.url_helpers
+      end
+
       # Effective::Resource.new('admin/posts').action_path_helper(:edit) => 'edit_admin_posts_path'
       # This will return empty for create, update and destroy
       def action_path_helper(action)

data/app/models/effective/resources/init.rb

@@ -4,9 +4,9 @@ module Effective
 
       private
 
-      def _initialize_input(input, namespace: nil)
+      def _initialize_input(input, namespace: nil, relation: nil)
         @initialized_name = input
-        @model_klass = _klass_by_input(input)
+        @model_klass = (relation ? _klass_by_input(relation) : _klass_by_input(input))
 
         # Consider namespaces
         if namespace
@@ -18,20 +18,24 @@ module Effective
         end
 
         # Consider relation
+        if relation.kind_of?(ActiveRecord::Relation)
+          @relation ||= relation
+        end
+
         if input.kind_of?(ActiveRecord::Relation)
           @relation ||= input
         end
 
         if input.kind_of?(ActiveRecord::Reflection::MacroReflection) && input.scope
-          @relation ||= klass.where(nil).merge(input.scope)
+          @relation ||= @model_klass.where(nil).merge(input.scope)
         end
 
         # Consider instance
-        if klass && input.instance_of?(klass)
+        if @model_klass && input.instance_of?(@model_klass)
           @instance ||= input
         end
 
-        if klass && input.kind_of?(Array) && input.last.instance_of?(klass)
+        if @model_klass && input.kind_of?(Array) && input.last.instance_of?(@model_klass)
           @instance ||= input.last
         end
       end

data/app/models/effective/resources/naming.rb

@@ -19,6 +19,10 @@ module Effective
         @initialized_name
       end
 
+      def route_name # 'post' initialized from the controller_path/initialized_name and not the class
+        @route_name ||= (initialized_name.to_s.split(SPLIT).last || '').singularize.underscore
+      end
+
       def class_name # 'Effective::Post'
         @model_klass ? @model_klass.name : name.classify
       end
@@ -44,11 +48,11 @@ module Effective
       end
 
       def human_name
-        class_name.gsub('::', ' ').underscore.gsub('_', ' ')
+        name.gsub('::', ' ').underscore.gsub('_', ' ')
       end
 
       def human_plural_name
-        class_name.pluralize.gsub('::', ' ').underscore.gsub('_', ' ')
+        name.pluralize.gsub('::', ' ').underscore.gsub('_', ' ')
       end
 
     end

data/app/models/effective/resources/relation.rb

@@ -4,8 +4,10 @@ module Effective
       TARGET_LIST_LIMIT = 1500
       TARGET_KEYS_LIMIT = 30000
 
+      # This could be active_model? in which we just return the klass itself here
+      # This value ends up being crud_controller resource_scope()
       def relation
-        @relation ||= klass.where(nil)
+        @relation ||= (klass.respond_to?(:where) ? klass.where(nil) : klass)
       end
 
       # When Effective::Resource is initialized with an ActiveRecord relation, the following

data/lib/effective_resources/engine.rb

@@ -51,9 +51,11 @@ module EffectiveResources
     # Register the acts_as_archived routes concern
     # resources :things, concerns: :acts_as_archived
     initializer 'effective_resources.routes_concern' do |app|
-      ActiveSupport.on_load :action_controller_base do
-        ActionDispatch::Routing::Mapper.include(ActsAsArchived::RoutesConcern)
-      end
+      ActionDispatch::Routing::Mapper.include(ActsAsArchived::RoutesConcern)
+
+      # Doesn't seem to work with the on_load in rails 6.0
+      #ActiveSupport.on_load :action_controller_base do
+      #end
     end
 
     # Register the flash_messages concern so that it can be called in ActionController

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '1.6.4'.freeze
+  VERSION = '1.7.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -132,6 +132,7 @@ files:
 - app/controllers/concerns/effective/wizard_controller/actions.rb
 - app/controllers/concerns/effective/wizard_controller/before_actions.rb
 - app/controllers/concerns/effective/wizard_controller/save.rb
+- app/controllers/concerns/effective/wizard_controller/wicked_overrides.rb
 - app/helpers/effective_resources_helper.rb
 - app/helpers/effective_resources_private_helper.rb
 - app/helpers/effective_resources_wizard_helper.rb