effective_resources 0.7.13 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 287350db2bd99d6ee44fb82d7a31ff7a138b13d6
-  data.tar.gz: b624b6db3fdb2ae627fc201a36c53ec615f10bf3
+  metadata.gz: 548398bd2a4c2d0b765dbe366a13792a40e2738b
+  data.tar.gz: 0c86f9d641ce9453397ae1f85b9601f0995f45d2
 SHA512:
-  metadata.gz: 8083ed649eee3b427b455487e21485ec01c8e46f242404eb6e551b470a165ed9d2793ec9f07ad1fa4b6eefbabf15d26583ea8559adcf60e2512ad78c08c0032c
-  data.tar.gz: fe26139eb7170c782064ab0c82d0dd0ad56114657f40972ef2e0bb33816a8b0111196983a1050483b01fb0da7638179d4345b6719c91ec08449aee712dc61f78
+  metadata.gz: 0d8512be42bc14efb7cbd3683ed59e5a0b8a9f5c8735c9b54c0b2864f6ea4a7932e150f861eac0371cb06e7a3c0b785b46bac565fc69349b23eb6ee11f38fded
+  data.tar.gz: 972f967e8097e08411b32f544bda79e8fdb35508a1cb48112066769a92a5084235c5d859ac2d3113b98c60820048d11c978b7abb34d3c44191227ad8b532d887

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

@@ -4,28 +4,29 @@ module Effective
 
     included do
       class << self
-        def member_actions
-          @_effective_member_actions ||= {}
+
+        def effective_resource
+          @_effective_resource ||= Effective::Resource.new(controller_path)
         end
 
-        def _default_member_actions
-          if defined?(EffectiveBootstrap)
-            { 'Save': { action: :save }, 'Continue': { action: :save }, 'Add New': { action: :save } }
-          else
-            {
-              'Save' => { action: :save, data: { disable_with: 'Saving...' }},
-              'Continue' => { action: :save, data: { disable_with: 'Saving...' }},
-              'Add New' => { action: :save, data: { disable_with: 'Saving...' }}
-            }
-          end
+        def submits
+          effective_resource.submits
         end
       end
 
+      define_actions_from_routes
       define_callbacks :resource_render, :resource_save, :resource_error
     end
 
     module ClassMethods
 
+      # Automatically respond to any action defined via the routes file
+      def define_actions_from_routes
+        resource = Effective::Resource.new(controller_path)
+        resource.member_actions.each { |action| member_action(action) }
+        resource.collection_actions.each { |action| collection_action(action) }
+      end
+
       # https://github.com/rails/rails/blob/v5.1.4/actionpack/lib/abstract_controller/callbacks.rb
       def before_render(*names, &blk)
         _insert_callbacks(names, blk) { |name, options| set_callback(:resource_render, :before, name, options) }
@@ -39,73 +40,44 @@ module Effective
         _insert_callbacks(names, blk) { |name, options| set_callback(:resource_error, :after, name, options) }
       end
 
-      # Add the following to your controller for a simple member action
-      # member_action :print
+      # This controls the form submit options of effective_submit
+      # It also controls the redirect path for any actions
       #
-      # Add to your permissions:  can :print, Thing
+      # Effective::Resource will populate this with all member_post_actions
+      # And you can control the details with this DSL:
       #
-      # If you want to POST and do an action based on this:
-      # Make sure your model responds to approve!
-      # member_action :approve
-      # If you want it to automatically show up in your forms
-      # member_action :approve, 'Save and Approve', if: -> { approved? }
-      # member_action :approve, 'Save and Approve', unless: -> { !approved? }, redirect: :show
-
-      def member_action(action, commit = nil, args = {})
-        if commit.present?
-          raise 'expected args to be a Hash or false' unless args.kind_of?(Hash) || args == false
-
-          if args == false
-            member_actions.delete(commit); return
-          end
-
-          if args.key?(:if) && args[:if].respond_to?(:call) == false
-            raise "expected if: to be callable. Try member_action :approve, 'Save and Approve', if: -> { submitted? }"
-          end
-
-          if args.key?(:unless) && args[:unless].respond_to?(:call) == false
-            raise "expected unless: to be callable. Try member_action :approve, 'Save and Approve', unless: -> { declined? }"
-          end
+      # submit :approve, 'Save and Approve', unless: -> { approved? }, redirect: :show
+      #
+      # submit :toggle, 'Blacklist', if: -> { sync? }, class: 'btn btn-primary'
+      # submit :toggle, 'Whitelist', if: -> { !sync? }, class: 'btn btn-primary'
 
-          redirect = args.delete(:redirect_to) || args.delete(:redirect) # Remove redirect_to keyword. use redirect.
+      def submit(action, commit = nil, args = {})
+        raise 'expected args to be a Hash or false' unless args.kind_of?(Hash) || args == false
 
-          member_actions[commit] = (args || {}).merge(action: action, redirect: redirect)
+        if commit == false
+          submits.delete_if { |commit, args| args[:action] == action }; return
         end
 
-        define_method(action) do
-          self.resource ||= resource_scope.find(params[:id])
-
-          EffectiveResources.authorize!(self, action, resource)
-
-          @page_title ||= "#{action.to_s.titleize} #{resource}"
-
-          member_post_action(action) unless request.get?
+        if args == false
+          submits.delete(commit); return
         end
-      end
 
-      def collection_action(action)
-        define_method(action) do
-          if params[:ids].present?
-            self.resources ||= resource_scope.where(id: params[:ids])
-          end
-
-          if effective_resource.scope?(action)
-            self.resources ||= resource_scope.public_send(action)
-          end
-
-          self.resources ||= resource_scope.all
-
-          EffectiveResources.authorize!(self, action, resource_klass)
+        if commit # Overwrite the default member action when given a custom commit
+          submits.delete_if { |commit, args| args[:default] && args[:action] == action }
+        end
 
-          @page_title ||= "#{action.to_s.titleize} #{resource_plural_name.titleize}"
+        if args.key?(:if) && args[:if].respond_to?(:call) == false
+          raise "expected if: to be callable. Try submit :approve, 'Save and Approve', if: -> { finished? }"
+        end
 
-          collection_post_action(action) unless request.get?
+        if args.key?(:unless) && args[:unless].respond_to?(:call) == false
+          raise "expected unless: to be callable. Try submit :approve, 'Save and Approve', unless: -> { declined? }"
         end
-      end
 
-      # Applies the default actions
-      def default_actions(args = {})
-        default_member_actions.each { |k, v| member_actions[k] = (args || {}).merge(v) }
+        redirect = args.delete(:redirect_to) || args.delete(:redirect) # Remove redirect_to keyword. use redirect.
+        args.merge!(action: action, redirect: redirect)
+
+        (submits[commit] ||= {}).merge!(args)
       end
 
       # page_title 'My Title', only: [:new]
@@ -138,6 +110,43 @@ module Effective
         end
       end
 
+      # Defines a function to handle a GET and POST request on this URL
+      # Just add a member action to your routes, you shouldn't need to call this directly
+      def member_action(action)
+        define_method(action) do
+          self.resource ||= resource_scope.find(params[:id])
+
+          EffectiveResources.authorize!(self, action, resource)
+
+          @page_title ||= "#{action.to_s.titleize} #{resource}"
+
+          member_post_action(action) unless request.get?
+        end
+      end
+
+      # Defines a function to handle a GET and POST request on this URL
+      # Handles bulk_ actions
+      # Just add a member action to your routes, you shouldn't need to call this directly
+      # You shouldn't need to call this directly
+      def collection_action(action)
+        define_method(action) do
+          if params[:ids].present?
+            self.resources ||= resource_scope.where(id: params[:ids])
+          end
+
+          if effective_resource.scope?(action)
+            self.resources ||= resource_scope.public_send(action)
+          end
+
+          self.resources ||= resource_scope.all
+
+          EffectiveResources.authorize!(self, action, resource_klass)
+
+          @page_title ||= "#{action.to_s.titleize} #{resource_plural_name.titleize}"
+
+          collection_post_action(action) unless request.get?
+        end
+      end
     end
 
     def index
@@ -299,31 +308,6 @@ module Effective
       render json: { status: 200, message: "Successfully #{action_verb(action)} #{successes} / #{resources.length} selected #{resource_plural_name}" }
     end
 
-    # Here we look at all available (class level) member actions, see which ones apply to the current resource
-    # This feeds into the helper simple_form_submit(f)
-    # Returns a Hash of {'Save': {data-disable-with: 'Saving...'}, 'Approve': {data-disable-with: 'Approve'}}
-    def member_actions_for(obj)
-      actions = (self.class.member_actions.presence || self.class._default_member_actions)
-
-      actions.select do |commit, args|
-        args[:class] = args[:class].to_s
-
-        (args.key?(:if) ? obj.instance_exec(&args[:if]) : true) &&
-        (args.key?(:unless) ? !obj.instance_exec(&args[:unless]) : true)
-      end.sort do |(commit_x, x), (commit_y, y)|
-        # Sort to front
-        primary = (y[:class].include?('primary') ? 1 : 0) - (x[:class].include?('primary') ? 1 : 0)
-        primary = nil if primary == 0
-
-        # Sort to back
-        danger = (x[:class].include?('danger') ? 1 : 0) - (y[:class].include?('danger') ? 1 : 0)
-        danger = nil if danger == 0
-
-        primary || danger || actions.keys.index(commit_x) <=> actions.keys.index(commit_y)
-      end.inject({}) do |h, (commit, args)|
-        h[commit] = args.except(:action, :if, :unless, :redirect); h
-      end
-    end
 
     protected
 
@@ -357,6 +341,7 @@ module Effective
         when :index ; resource_index_path
         when :edit  ; resource_edit_path
         when :show  ; resource_show_path
+        when :new   ; resource_new_path
         when :back  ; referer_redirect_path
         when nil    ; nil
         else        ; resource_member_action_path(commit_action[:action])
@@ -466,7 +451,7 @@ module Effective
     end
 
     def commit_action
-      self.class.member_actions[params[:commit].to_s] || { action: :save }
+      self.class.submits[params[:commit].to_s] || { action: :save }
     end
 
     # Returns an ActiveRecord relation based on the computed value of `resource_scope` dsl method

data/app/helpers/effective_resources_helper.rb

@@ -1,77 +1,23 @@
 module EffectiveResourcesHelper
 
   def effective_submit(form, options = {}, &block) # effective_bootstrap
-    resource = (@_effective_resource || Effective::Resource.new(controller_path))
-
-    # Apply btn-primary to the first item, only if the class isn't already present
-    actions = if controller.respond_to?(:member_actions_for)
-      controller.member_actions_for(form.object).transform_values.with_index do |opts, index|
-        opts[:class] = "btn #{index == 0 ? 'btn-primary' : 'btn-secondary'}" if opts[:class].blank?
-        opts
-      end
-    else
-      {}.tap do |actions|
-        actions['Save'] = { class: 'btn btn-primary' }
-
-        if resource.action_path(:index) && EffectiveResources.authorized?(controller, :index, resource.klass)
-          actions['Continue'] = { class: 'btn btn-secondary' }
-        end
-
-        if resource.action_path(:new) && EffectiveResources.authorized?(controller, :new, resource.klass)
-          actions['Add New'] = { class: 'btn btn-secondary' }
-        end
-      end
-    end
+    resource = (controller.class.respond_to?(:effective_resource) ? controller.class.effective_resource : Effective::Resource.new(controller_path))
+    actions = resource.submits_for(form.object, controller: controller)
 
     # Group by class and render
     buttons = actions.group_by { |_, opts| opts[:class] }.flat_map do |_, btns|
       btns.map { |name, opts| form.save(name, opts) }
     end.join.html_safe
 
-    effective_save(form) do
+    form.submit('', options) do
       (block_given? ? capture(&block) : ''.html_safe) + buttons
     end
-
-  end
-
-  def effective_save(form, label = 'Save', &block) # effective_bootstrap
-    wrapper = (form.layout == :horizontal) ? { class: 'form-group form-actions row' } : { class: 'form-group form-actions' }
-
-    content_tag(:div, wrapper) do
-      icon('spinner') + (block_given? ? capture(&block) : form.save(label, class: 'btn btn-primary'))
-    end
-  end
-
-  def effective_save_button(form, label = 'Save', &block)
-    content_tag(:div, class: 'form-actions') do
-      icon('spinner') + (block_given? ? capture(&block) : form.save(label, class: 'btn btn-primary'))
-    end
   end
 
   # effective_form_inputs
   def simple_form_submit(form, options = {}, &block)
-    resource = (@_effective_resource || Effective::Resource.new(controller_path))
-
-    # Apply btn-primary to the first item, only if the class isn't already present
-    actions = if controller.respond_to?(:member_actions_for)
-      controller.member_actions_for(form.object).transform_values.with_index do |opts, index|
-        opts[:class] = "btn #{index == 0 ? 'btn-primary' : 'btn-default'}" if opts[:class].blank?
-        opts
-      end
-    else
-      {}.tap do |actions|
-        actions['Save'] = { class: 'btn btn-primary', data: { disable_with: 'Saving...' }}
-
-        if resource.action_path(:index) && EffectiveResources.authorized?(controller, :index, resource.klass)
-          actions['Continue'] = { class: 'btn btn-default', data: { disable_with: 'Saving...' }}
-        end
-
-        if resource.action_path(:new) && EffectiveResources.authorized?(controller, :new, resource.klass)
-          actions['Add New'] = { class: 'btn btn-default', data: { disable_with: 'Saving...' }}
-        end
-
-      end
-    end
+    resource = (controller.class.respond_to?(:effective_resource) ? controller.class.effective_resource : Effective::Resource.new(controller_path))
+    actions = resource.submits_for(form.object, controller: controller)
 
     wrapper_options = { class: 'form-actions' }.merge(options.delete(:wrapper_html) || {})
 

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

@@ -54,17 +54,30 @@ module Effective
 
       # GET actions
       def collection_actions
-        routes.values.map { |route| route.defaults[:action].to_sym if is_get_route?(route) && !is_member_route?(route) }.compact - crud_actions
+        routes.values.map { |route| route.defaults[:action].to_sym if is_collection_route?(route) }.compact - crud_actions
       end
 
-      # GET actions
+      def collection_get_actions
+        routes.values.map { |route| route.defaults[:action].to_sym if is_collection_route?(route) && is_get_route?(route) }.compact - crud_actions
+      end
+
+      def collection_post_actions
+        routes.values.map { |route| route.defaults[:action].to_sym if is_collection_route?(route) && is_post_route?(route) }.compact - crud_actions
+      end
+
+      # All actions
       def member_actions
-        routes.values.map { |route| route.defaults[:action].to_sym if is_get_route?(route) && is_member_route?(route) }.compact - crud_actions
+        routes.values.map { |route| route.defaults[:action].to_sym if is_member_route?(route) }.compact - crud_actions
+      end
+
+      # GET actions
+      def member_get_actions
+        routes.values.map { |route| route.defaults[:action].to_sym if is_member_route?(route) && is_get_route?(route) }.compact - crud_actions
       end
 
       # POST/PUT/PATCH actions
       def member_post_actions
-        routes.values.map { |route| route.defaults[:action].to_sym if is_post_route?(route) && is_member_route?(route) }.compact - crud_actions
+        routes.values.map { |route| route.defaults[:action].to_sym if is_member_route?(route) && is_post_route?(route) }.compact - crud_actions
       end
 
       # Same as controller_path in the view
@@ -82,6 +95,10 @@ module Effective
         (route.path.required_names || []).include?('id')
       end
 
+      def is_collection_route?(route)
+        (route.path.required_names || []).include?('id') == false
+      end
+
       def is_get_route?(route)
         route.verb.to_s.include?('GET')
       end

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

@@ -2,6 +2,60 @@ module Effective
   module Resources
     module Forms
 
+      # Used by effective_form_submit
+      # The actions we would use to commit. For link_to
+      # { 'Save': { action: :save }, 'Continue': { action: :save }, 'Add New': { action: :save }, 'Approve': { action: :approve } }
+      # Saves a list of commit actions...
+      def submits
+        @submits ||= {}.tap do |submits|
+          if (actions.find { |a| a == :create } || actions.find { |a| a == :update })
+            submits['Save'] = { action: :save, class: 'btn btn-primary' }
+          end
+
+          member_post_actions.each do |action| # default true means it will be overwritten by dsl methods
+            submits[action.to_s.titleize] = { action: action, default: true, class: 'btn btn-primary' }
+          end
+
+          if actions.find { |a| a == :index }
+            submits['Continue'] = { action: :save, redirect: :index }
+          end
+
+          if actions.find { |a| a == :new }
+            submits['Add New'] = { action: :save, redirect: :new }
+          end
+        end
+      end
+
+      # Here we look at all available (class level) member actions, see which ones apply to the current resource
+      # This feeds into the helper simple_form_submit(f)
+      # Returns a Hash of {'Save': {data-disable-with: 'Saving...'}, 'Approve': {data-disable-with: 'Approve'}}
+      def submits_for(obj, controller:)
+        submits.select do |commit, args|
+          args[:class] = args[:class].to_s
+
+          action = (args[:action] == :save ? (obj.new_record? ? :create : :update) : args[:action])
+
+          (args.key?(:if) ? obj.instance_exec(&args[:if]) : true) &&
+          (args.key?(:unless) ? !obj.instance_exec(&args[:unless]) : true) &&
+          EffectiveResources.authorized?(controller, action, obj)
+        end.sort do |(commit_x, x), (commit_y, y)|
+          # Sort to front
+          primary = (y[:class].include?('primary') ? 1 : 0) - (x[:class].include?('primary') ? 1 : 0)
+          primary = nil if primary == 0
+
+          # Sort to back
+          danger = (x[:class].include?('danger') ? 1 : 0) - (y[:class].include?('danger') ? 1 : 0)
+          danger = nil if danger == 0
+
+          primary || danger || submits.keys.index(commit_x) <=> submits.keys.index(commit_y)
+        end.inject({}) do |h, (commit, args)|
+          h[commit] = args.except(:action, :default, :if, :unless, :redirect); h
+        end.transform_values.with_index do |opts, index|
+          opts[:class] = "btn #{index == 0 ? 'btn-primary' : 'btn-secondary'}" if opts[:class].blank?
+          opts
+        end
+      end
+
       # Used by datatables
       def search_form_field(name, type = nil)
         case (type || sql_type(name))

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '0.7.13'.freeze
+  VERSION = '0.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 0.7.13
+  version: 0.8.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2018-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails