undercarriage 0.1.0 → 0.4.1

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      # :nodoc:
+      module Actions
+        ##
+        # Destroy restful action
+        #
+        # Usage
+        #   class ExamplesController < ApplicationController
+        #     include Undercarriage::Controllers::RestfulConcern
+        #   end
+        #
+        module DestroyConcern
+          extend ActiveSupport::Concern
+
+          included do
+            before_action :destroy_resource, only: %i[destroy]
+          end
+
+          ##
+          # Destroy 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 `@destroy_resource` or `@example`
+          #     #
+          #     # def destroy
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def destroy
+            @destroy_resource.destroy
+
+            flash[flash_status_type] = flash_destroyed_message
+
+            redirect_to location_after_destroy
+          end
+
+          protected
+
+          ##
+          # Destroy 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 destroy_resource_content
+          #     #   ...
+          #     # end
+          #
+          #     ##
+          #     # To add authorization through something like Pundit, the following could be used
+          #     #
+          #     # def destroy_resource_content
+          #     #   super
+          #     #
+          #     #   authorize @example
+          #     # end
+          #
+          #     ##
+          #     # The `resource_content` method can also be overwritten. Be careful with this because the `show`,
+          #     # `edit` and `update` actions will also use this method
+          #     #
+          #     # def resource_content
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def destroy_resource_content
+            resource_content
+          end
+
+          private
+
+          def destroy_resource
+            @destroy_resource ||= destroy_resource_content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      # :nodoc:
+      module Actions
+        ##
+        # Edit restful action
+        #
+        # Usage
+        #   class ExamplesController < ApplicationController
+        #     include Undercarriage::Controllers::RestfulConcern
+        #   end
+        #
+        module EditConcern
+          extend ActiveSupport::Concern
+
+          included do
+            before_action :edit_resource, only: %i[edit]
+          end
+
+          ##
+          # Edit 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 `@edit_resource` or `@example`
+          #     #
+          #     # def edit
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def edit
+            nested_resource_pre_build
+            nested_resource_build
+          end
+
+          protected
+
+          ##
+          # Edit 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 edit_resource_content
+          #     #   ...
+          #     # end
+          #
+          #     ##
+          #     # To add authorization through something like Pundit, the following could be used
+          #     #
+          #     # def edit_resource_content
+          #     #   super
+          #     #
+          #     #   authorize @example
+          #     # end
+          #
+          #     ##
+          #     # The `resource_content` method can also be overwritten. Be careful with this because the `show`,
+          #     # `update` and `destroy` actions will also use this method
+          #     #
+          #     # def resource_content
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def edit_resource_content
+            resource_content
+          end
+
+          private
+
+          def edit_resource
+            @edit_resource ||= edit_resource_content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      # :nodoc:
+      module Actions
+        ##
+        # Index restful action
+        #
+        # Usage
+        #   class ExamplesController < ApplicationController
+        #     include Undercarriage::Controllers::RestfulConcern
+        #   end
+        #
+        module IndexConcern
+          extend ActiveSupport::Concern
+
+          included do
+            before_action :index_resources, only: %i[index]
+          end
+
+          ##
+          # Index 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 `@index_resources` or `@examples`
+          #     #
+          #     # def index
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def index; end
+
+          protected
+
+          ##
+          # Index 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 `@examples`
+          #     #
+          #     # def resources_content
+          #     #   ...
+          #     # end
+          #
+          #     ##
+          #     # To add authorization through something like Pundit, the following could be used
+          #     #
+          #     # def resources_content
+          #     #   super
+          #     #
+          #     #   authorize @examples
+          #     # end
+          #   end
+          #
+          def resources_content
+            resources_query = model_class.all
+
+            instance_variable_set("@#{instances_name}", resources_query)
+          end
+
+          private
+
+          def index_resources
+            @index_resources ||= resources_content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      # :nodoc:
+      module Actions
+        ##
+        # New restful action
+        #
+        # Usage
+        #   class ExamplesController < ApplicationController
+        #     include Undercarriage::Controllers::RestfulConcern
+        #   end
+        #
+        module NewConcern
+          extend ActiveSupport::Concern
+
+          included do
+            before_action :new_resource, only: %i[new]
+          end
+
+          ##
+          # New 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 `@new_resource` or `@example`
+          #     #
+          #     # def new
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def new
+            nested_resource_pre_build
+            nested_resource_build
+          end
+
+          protected
+
+          ##
+          # New 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 new_resource_content
+          #     #   ...
+          #     # end
+          #
+          #     ##
+          #     # To add authorization through something like Pundit, the following could be used
+          #     #
+          #     # def new_resource_content
+          #     #   super
+          #     #
+          #     #   authorize @example
+          #     # end
+          #
+          #     ##
+          #     # The `resource_new_content` method can also be overwritten. This method is meant to share content with
+          #     # the `create` action
+          #     #
+          #     # def resource_new_content
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def new_resource_content
+            resource_query = model_class.new
+
+            instance_variable_set("@#{instance_name}", resource_query)
+          end
+
+          private
+
+          def new_resource
+            @new_resource ||= resource_new_content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      # :nodoc:
+      module Actions
+        ##
+        # Show restful action
+        #
+        # Usage
+        #   class ExamplesController < ApplicationController
+        #     include Undercarriage::Controllers::RestfulConcern
+        #   end
+        #
+        module ShowConcern
+          extend ActiveSupport::Concern
+
+          included do
+            before_action :show_resource, only: %i[show]
+          end
+
+          ##
+          # Show 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 `@show_resource` or `@example`
+          #     #
+          #     # def show
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def show; end
+
+          protected
+
+          ##
+          # Show 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 show_resource_content
+          #     #   ...
+          #     # end
+          #
+          #     ##
+          #     # To add authorization through something like Pundit, the following could be used
+          #     #
+          #     # def show_resource_content
+          #     #   super
+          #     #
+          #     #   authorize @example
+          #     # end
+          #
+          #     ##
+          #     # The `resource_content` method can also be overwritten. Be careful with this because the `edit`,
+          #     # `update`, and `destroy` actions will also use this method
+          #     #
+          #     # def resource_content
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def show_resource_content
+            resource_content
+          end
+
+          private
+
+          def show_resource
+            @show_resource ||= show_resource_content
+          end
+        end
+      end
+    end
+  end
+end