undercarriage 0.1.0 → 0.4.1

data/lib/undercarriage/controllers/restful/actions/update_concern.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      # :nodoc:
+      module Actions
+        ##
+        # Update restful action
+        #
+        # Usage
+        #   class ExamplesController < ApplicationController
+        #     include Undercarriage::Controllers::RestfulConcern
+        #   end
+        #
+        module UpdateConcern
+          extend ActiveSupport::Concern
+
+          included do
+            before_action :update_resource, only: %i[update]
+          end
+
+          ##
+          # Update action
+          #
+          # Usage
+          #   class ExamplesController < ApplicationController
+          #     include Undercarriage::Controllers::RestfulConcern
+          #
+          #     ##
+          #     # This method is only needed if you want to override the action entirely. Otherwise, it is not needed.
+          #     # Database resources can be accessed as `@update_resource` or `@example`
+          #     #
+          #     # def update
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def update
+            nested_resource_pre_build
+
+            if @update_resource.update(update_resource_params)
+              after_update_action
+
+              flash[flash_status_type] = flash_updated_message
+
+              redirect_to location_after_update
+            else
+              nested_resource_build
+
+              render :edit, status: :unprocessable_entity
+            end
+          end
+
+          protected
+
+          ##
+          # Update restful action
+          #
+          # Usage
+          #   class ExamplesController < ApplicationController
+          #     include Undercarriage::Controllers::RestfulConcern
+          #
+          #     ##
+          #     # This method is only needed if you want to override the query entirely. Otherwise, it is not needed.
+          #     # Database resources can be accessed as `@example`
+          #     #
+          #     # def update_resource_content
+          #     #   ...
+          #     # end
+          #
+          #     ##
+          #     # To add authorization through something like Pundit, the following could be used
+          #     #
+          #     # def update_resource_content
+          #     #   super
+          #     #
+          #     #   authorize @example
+          #     # end
+          #
+          #     ##
+          #     # The `resource_content` method can also be overwritten. Be careful with this because the `show`,
+          #     # `edit` and `destroy` actions will also use this method
+          #     #
+          #     # def resource_content
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def update_resource_content
+            resource_content
+          end
+
+          private
+
+          def update_resource
+            @update_resource ||= update_resource_content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/undercarriage/controllers/restful/flash_concern.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      ##
+      # Flash
+      #
+      # Flash messages
+      #
+      # Usage
+      #   class ExamplesController < ApplicationController
+      #     include Undercarriage::Controllers::Restful::FlashConcern
+      #   end
+      #
+      #   # config/locales/flash.en.yml
+      #   flash:
+      #     actions:
+      #       create:
+      #         notice: "%{resource_name} was successfully created."
+      #       update:
+      #         notice: "%{resource_name} was successfully updated."
+      #       destroy:
+      #         notice: "%{resource_name} was successfully destroyed."
+      #     posts:
+      #       create:
+      #         notice: "Your %{downcase_resource_name} was created."
+      #       update:
+      #         notice_html: "<strong>Huzzah!</strong> Your %{downcase_resource_name} was updated."
+      #         notice: "Huzzah! Your %{downcase_resource_name} was updated." # Not used since `notice_html` is defined
+      #     things:
+      #       destroy:
+      #         notice: "Good riddance. That wasn't needed anyway."
+      #
+      module FlashConcern
+        extend ActiveSupport::Concern
+
+        included do
+          class_attribute :flash_status_type
+          self.flash_status_type = :success
+        end
+
+        protected
+
+        ##
+        # Flash message for `#create` action
+        #
+        # Translate create flash message
+        #
+        def flash_created_message
+          flash_message_builder(:create, flash_status_type, 'created')
+        end
+
+        ##
+        # Flash message for `#update` action
+        #
+        # Translate update flash message
+        #
+        def flash_updated_message
+          flash_message_builder(:update, flash_status_type, 'updated')
+        end
+
+        ##
+        # Flash message for `#destroy` action
+        #
+        # Translate destroy flash message
+        #
+        def flash_destroyed_message
+          flash_message_builder(:destroy, flash_status_type, 'destroyed')
+        end
+
+        private
+
+        def flash_message_builder(action, status, past_tense)
+          defaults = flash_message_defaults(controller_name_singular_human, action, status, past_tense)
+          message = defaults.shift
+
+          I18n.t(message, resource_name: controller_name_singular_human,
+                          downcase_resource_name: controller_name_singular,
+                          default: defaults)
+        end
+
+        ##
+        # Default flash messages
+        #
+        # List of default flash messages. The following is the list
+        #
+        #   flash.[NAMESPACE].[CONTROLLER].[ACTION].[STATUS]_html
+        #   flash.[NAMESPACE].[CONTROLLER].[ACTION].[STATUS]
+        #   flash.[CONTROLLER].[ACTION].[STATUS]_html
+        #   flash.[CONTROLLER].[ACTION].[STATUS]
+        #   flash.actions.[ACTION].[STATUS]
+        #   English default
+        #
+        def flash_message_defaults(resource_name, action, status, past_tense)
+          controller_with_namespace = [resource_namespace, controller_name].compact.join('.')
+
+          [
+            :"flash.#{controller_with_namespace}.#{action}.#{status}_html",
+            :"flash.#{controller_with_namespace}.#{action}.#{status}",
+            :"flash.#{controller_name}.#{action}.#{status}_html",
+            :"flash.#{controller_name}.#{action}.#{status}",
+            :"flash.actions.#{action}.#{status}",
+            "#{resource_name} was successfully #{past_tense}."
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/undercarriage/controllers/restful/location_after_concern.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      ##
+      # Location after
+      #
+      # Redirect locations after create, update or destroy
+      #
+      # Usage
+      #   class ExamplesController < ApplicationController
+      #     include Undercarriage::Controllers::Restful::LocationAfterConcern
+      #   end
+      #
+      module LocationAfterConcern
+        extend ActiveSupport::Concern
+
+        protected
+
+        ##
+        # Location after create
+        #
+        # The path of the created resource
+        #
+        def location_after_create
+          resource_id = @create_resource
+
+          resource_path(resource_id)
+        end
+
+        ##
+        # Location after update
+        #
+        # The path of the updated resource
+        #
+        def location_after_update
+          resource_id = @update_resource
+
+          resource_path(resource_id)
+        end
+
+        ##
+        # Location after destroy
+        #
+        # The path of the resources
+        #
+        def location_after_destroy
+          location_after_save
+        end
+
+        ##
+        # Location after save
+        #
+        # The path of the resources
+        #
+        def location_after_save
+          resources_path
+        end
+
+        private
+
+        def resource_path(resource, options = {})
+          location_path = [resource_namespace, controller_name_singular].compact
+
+          send("#{location_path.join('_')}_path", resource, options)
+        end
+
+        def resources_path(options = {})
+          location_path = [resource_namespace, controller_name].compact
+
+          polymorphic_path(location_path, options)
+        end
+      end
+    end
+  end
+end

data/lib/undercarriage/controllers/restful/namespace_concern.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      ##
+      # Namespace
+      #
+      # Usage
+      #   class ExamplesController < ApplicationController
+      #     include Undercarriage::Controllers::Restful::NamespaceConcern
+      #   end
+      #
+      module NamespaceConcern
+        extend ActiveSupport::Concern
+
+        protected
+
+        ##
+        # Resource namespace
+        #
+        # Best guess for namespace. Take `controller_path` and if there is more than one segment, assume the first is
+        # the namespace. When there is one segment, the namespace is `nil`
+        #
+        # Example
+        #   # Override method that builds namespace
+        #   def resource_namespace
+        #     :admin
+        #   end
+        #
+        def resource_namespace
+          segments = controller_path.split('/')
+
+          segments.length > 1 ? segments.first : nil
+        end
+      end
+    end
+  end
+end

data/lib/undercarriage/controllers/restful/permitted_attributes_concern.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      ##
+      # Permitted attributes
+      #
+      # Usage
+      #   class ExamplesController < ApplicationController
+      #     include Undercarriage::Controllers::Restful::PermittedAttributesConcern
+      #   end
+      #
+      module PermittedAttributesConcern
+        extend ActiveSupport::Concern
+
+        protected
+
+        ##
+        # Permitted attributes for `create` action
+        #
+        # Permitted attributes for the `create` action. If `create` and `update` do not need to be different, you can
+        # still override the `permitted_attributes` method which would be applied to both `create` and `update`.
+        #
+        # Example
+        #   def permitted_create_attributes
+        #     %i[thingy dilly whatsit]
+        #   end
+        #
+        #   # Use this method is `create` and `update` do not need different permitted attributes
+        #   def permitted_attributes
+        #     [
+        #       :thingy, :dilly, :whatsit,
+        #       { whosits_attributes: %i[id _destroy name] }
+        #     ]
+        #   end
+        #
+        def permitted_create_attributes
+          permitted_attributes_fallback
+        end
+
+        ##
+        # Permitted attributes for `update` action
+        #
+        # Permitted attributes for the `update` action. If `create` and `update` do not need to be different, you can
+        # still override the `permitted_attributes` method which would be applied to both `create` and `update`.
+        #
+        # Example
+        #   def permitted_update_attributes
+        #     %i[thingy dilly whatsit]
+        #   end
+        #
+        #   # Use this method is `create` and `update` do not need different permitted attributes
+        #   def permitted_attributes
+        #     [
+        #       :thingy, :dilly, :whatsit,
+        #       { whosits_attributes: %i[id _destroy name] }
+        #     ]
+        #   end
+        #
+        def permitted_update_attributes
+          permitted_attributes_fallback
+        end
+
+        ##
+        # New resource decider
+        #
+        # For the `new` action, resource params are `nil`. For the `create` action, resource params are the posted
+        # params from `create_resource_params` method
+        #
+        def resource_new_params
+          action_name == 'new' ? nil : create_resource_params
+        end
+
+        ##
+        # Permitted params for `create` action
+        #
+        # Permitted params for the `create` action scoped to the resource.
+        #
+        def create_resource_params
+          permitted = permitted_create_attributes
+
+          params.require(resource_scope).permit(permitted)
+        end
+
+        ##
+        # Permitted params for `update` action
+        #
+        # Permitted params for the `update` action scoped to the resource.
+        #
+        def update_resource_params
+          permitted = permitted_update_attributes
+
+          params.require(resource_scope).permit(permitted)
+        end
+
+        private
+
+        def permitted_attributes_fallback
+          with_method = self.class.instance_methods(false).include?(:permitted_attributes)
+
+          with_method ? permitted_attributes : []
+        end
+      end
+    end
+  end
+end