undercarriage 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fccd3ba65ccfd908ef199e41930f736cd2f9022ca3113ee90186a96230a7cf8c
-  data.tar.gz: a92a0518846b2d4996ba806f55e1a4f00df34ad6dcdd0501a3e4cd7292915bf5
+  metadata.gz: 2a9348f83d9d2e3924e13edfcb27bcea2a7602479195298e5f9e95ce646e8cb2
+  data.tar.gz: 2f6fe5126d7b6d4db2429118dc9343f30c76609766d313937cf26790cf5ad7e8
 SHA512:
-  metadata.gz: 45773941e2a9fd2775e2e75c736083072e2193f90b49e92711638e2776d9d2058f18649050ce97ad663e2eb0d7b82d929d0db23de859fd7ff96912c886f228fd
-  data.tar.gz: 3d5cf0b390504b5cf2d342d8e92ecce6738798466579af5562f145d0c11866a924950d955e506e699c4af4d8c25c30ca8d4d186391482ce39dd23f469b3bd5a6
+  metadata.gz: e10bb005e424d5e25984ccbb92d3bf44b53ce0d4d48d220ef3f71ddc7d884f6bd97a803732c69583ea10dc15704a3d7c5dfd8ebb2548a1ade20c013344d3b8e3
+  data.tar.gz: deb15ab41c1b0c027017c363028a4beabed9a0b92741efb418ec3d8592eb2289ac871f70c947140a7afa2e93c38175d84eae17a98c89466d902510a04501b0d6

data/README.md

@@ -2,24 +2,28 @@
 
 **\*Undercarriage is currently under development. It is not ready for production use.\***
 
+[![CircleCI](https://circleci.com/gh/dfreerksen/undercarriage.svg?style=shield)](https://circleci.com/gh/dfreerksen/undercarriage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d15980a534f8db936469/maintainability)](https://codeclimate.com/github/dfreerksen/undercarriage/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d15980a534f8db936469/test_coverage)](https://codeclimate.com/github/dfreerksen/undercarriage/test_coverage)
+
 Undercarriage is a set of concerns to add to your application to trim some of the fat from controllers and models.
 
 ## Requirements
 
 * Ruby >= 2.5
-* Rails >= 6.0.3
+* Rails >= 6.0
 
 ## Installation
 
 Add to your application's Gemfile
 
-```ruby
-gem 'undercarriage', '~> 0.2'
+```
+gem 'undercarriage', '~> 0.5'
 ```
 
 Run the bundle command
 
-```bash
+```
 $ bundle install
 ```
 
@@ -31,9 +35,59 @@ TODO
 
 * [ ] Allow a way to set locale instead of relying on browser preferred language in `Undercarriage::Controllers::LocaleConcern`
 
+## Testing
+
+Run tests with one of the following
+
+```
+$ bundle exec rspec
+$ bundle exec rspec spec
+```
+
+### Appraisal
+
+Undercarriage uses [Appraisal](https://github.com/thoughtbot/appraisal) to ensure various dependency versions work as expected
+
+When dependencies change, run
+
+```
+$ bundle exec appraisal install
+```
+
+To run tests with Appraisal, run
+
+```
+$ bundle exec appraisal rspec
+```
+
 ## Code Analysis
 
-TODO
+Various tools are used to ensure code is linted and formatted correctly.
+
+### RuboCop
+
+[RuboCop](https://github.com/bbatsov/rubocop) is a Ruby static code analyzer.
+
+```
+$ rubocop
+```
+
+## Documentation
+
+[Yard](https://github.com/lsegal/yard) is used to generate documentation. [Online documentation is available](http://www.rubydoc.info/github/dfreerksen/undercarriage/master)
+
+Build the documentation with one of the following
+
+```
+$ yard
+$ yard doc
+```
+
+Build the documentation and list all undocumented objects
+
+```
+$ yard stats --list-undoc
+```
 
 ## License
 

data/lib/undercarriage.rb

@@ -12,12 +12,12 @@ require 'undercarriage/controllers/restful/actions/create_concern'
 require 'undercarriage/controllers/restful/actions/edit_concern'
 require 'undercarriage/controllers/restful/actions/update_concern'
 require 'undercarriage/controllers/restful/actions/destroy_concern'
+require 'undercarriage/controllers/restful/flash_concern'
 require 'undercarriage/controllers/restful/location_after_concern'
 require 'undercarriage/controllers/restful/namespace_concern'
 require 'undercarriage/controllers/restful/permitted_attributes_concern'
 require 'undercarriage/controllers/restful/utility_concern'
-
-require 'undercarriage/railtie'
+require 'undercarriage/models/published_concern'
 
 ##
 # Undercarriage
@@ -25,5 +25,4 @@ require 'undercarriage/railtie'
 # Undercarriage is a set of concerns to add to your application to trim some of the fat from controllers and models.
 #
 module Undercarriage
-  # Your code goes here...
 end

data/lib/undercarriage/controllers/action_concern.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
     ##
     # Action helpers
@@ -209,22 +210,39 @@ module Undercarriage
 
       protected
 
+      ##
+      # Action symbol
+      #
+      # Take `action_name` (string) and turn it into a symbol
+      #
       def action
         action_name.to_sym
       end
 
+      ##
+      # Collection actions
+      #
       def collection_actions
         %i[index]
       end
 
+      ##
+      # Member actions
+      #
       def member_actions
         %i[edit show update]
       end
 
+      ##
+      # Create actions
+      #
       def create_actions
         %i[create new]
       end
 
+      ##
+      # Update actions
+      #
       def update_actions
         %i[edit update]
       end

data/lib/undercarriage/controllers/kaminari_concern.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
     ##
     # Kaminari pagination
@@ -61,10 +62,20 @@ module Undercarriage
 
       protected
 
+      ##
+      # Items per page key
+      #
+      # Query param to be used to identify count to be returned
+      #
       def per_page_key
         :per
       end
 
+      ##
+      # Page numberkey
+      #
+      # Query param to be used to identify page offset
+      #
       def page_num_key
         Kaminari.config.param_name
       end

data/lib/undercarriage/controllers/locale_concern.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
     ##
     # Identify locale for translations
@@ -65,6 +66,11 @@ module Undercarriage
 
       protected
 
+      ##
+      # Set I18n locale
+      #
+      # Set I18n locale for the request
+      #
       def identify_locale(&action)
         I18n.with_locale(first_available_locale, &action)
       end
@@ -75,7 +81,7 @@ module Undercarriage
         preferred_locales = (accepted_languages_header << I18n.default_locale.to_s).uniq
         available_locales = I18n.available_locales.map(&:to_s)
 
-        preferred_locales.intersection(available_locales).first
+        (preferred_locales & available_locales).first
       end
 
       def accepted_languages_header

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

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
+    # :nodoc:
     module Restful
+      # :nodoc:
       module Actions
         ##
         # Base restful action
         #
         # Usage
         #   class ExamplesController < ApplicationController
-        #     include Undercarriage::Controllers::RestfulConcern
+        #     include Undercarriage::Controllers::Restful::Actions::BaseConcern
         #   end
         #
         module BaseConcern
@@ -17,10 +20,42 @@ module Undercarriage
 
           protected
 
+          ##
+          # New content action
+          #
+          # Decide what content to load based on action name
+          #
           def resource_new_content
             action_name == 'new' ? new_resource_content : create_resource_content
           end
 
+          ##
+          # Resource action
+          #
+          # Used for `show`, `edit`, `update` and `destroy` actions unless overwritten
+          #
+          # 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 resource_content
+          #     #   ...
+          #     # end
+          #
+          #     ##
+          #     # To add authorization through something like Pundit, the following could be used
+          #     #
+          #     # def resource_content
+          #     #   super
+          #     #
+          #     #   authorize @example
+          #     # end
+          #   end
+          #
           def resource_content
             resource_id = params.fetch(:id)
             resource_query = model_class.find(resource_id)
@@ -28,12 +63,55 @@ module Undercarriage
             instance_variable_set("@#{instance_name}", resource_query)
           end
 
+          ##
+          # Build nested association before action
+          #
+          # Called first thing from `new`, `create`, `edit` and `update` actions. Meant to build a basic resource before
+          # the action is evaluated
+          #
+          # Usage
+          #   nested_resource_pre_build
+          #     @example.build_image if @example.image.blank?
+          #   end
+          #
           def nested_resource_pre_build; end
 
+          ##
+          # Build nested association for action
+          #
+          # Similar to `nested_resource_pre_build` but called in different places. For the `new` and `edit` actions, it
+          # is called right after `nested_resource_pre_build`. For the `create` and `update` actions, it is only called
+          # after validation has failed and before the view is rendered.
+          #
+          # Usage
+          #   nested_resource_build
+          #     @example.build_image if @example.image.blank?
+          #   end
+          #
           def nested_resource_build; end
 
+          ##
+          # After create callback
+          #
+          # Callback after `create` action has created the record.
+          #
+          # Usage
+          #   after_create_action
+          #     ExampleJob.perform_later(@example.id)
+          #   end
+          #
           def after_create_action; end
 
+          ##
+          # After update callback
+          #
+          # Callback after `update` action has updated the record.
+          #
+          # Usage
+          #   after_update_action
+          #     ExampleJob.perform_later(@example.id)
+          #   end
+          #
           def after_update_action; end
         end
       end

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
+    # :nodoc:
     module Restful
+      # :nodoc:
       module Actions
         ##
         # Create restful action
@@ -38,17 +41,21 @@ module Undercarriage
           def create
             nested_resource_pre_build
 
-            if @create_resource.save
-              after_create_action
+            respond_to do |format|
+              if @create_resource.save
+                after_create_action
 
-              respond_with(@create_resource) do |format|
-                format.html { redirect_to location_after_create }
-              end
-            else
-              nested_resource_build
+                format.html do
+                  flash[flash_status_type] = flash_created_message
+
+                  redirect_to location_after_create
+                end
+                format.json { render :show, status: :created, location: location_after_create }
+              else
+                nested_resource_build
 
-              respond_with(@create_resource) do |format|
-                format.html { render action: :new }
+                format.html { render :new, status: :unprocessable_entity }
+                format.json { render json: @create_resource.errors, status: :unprocessable_entity }
               end
             end
           end

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
+    # :nodoc:
     module Restful
+      # :nodoc:
       module Actions
         ##
         # Destroy restful action
@@ -38,8 +41,13 @@ module Undercarriage
           def destroy
             @destroy_resource.destroy
 
-            respond_with(@destroy_resource) do |format|
-              format.html { redirect_to location_after_destroy }
+            respond_to do |format|
+              format.html do
+                flash[flash_status_type] = flash_destroyed_message
+
+                redirect_to location_after_destroy
+              end
+              format.json { head :no_content }
             end
           end
 

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
+    # :nodoc:
     module Restful
+      # :nodoc:
       module Actions
         ##
         # Edit restful action
@@ -38,10 +41,6 @@ module Undercarriage
           def edit
             nested_resource_pre_build
             nested_resource_build
-
-            respond_with(@edit_resource) do |format|
-              format.html { render layout: !request.xhr? }
-            end
           end
 
           protected

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
+    # :nodoc:
     module Restful
+      # :nodoc:
       module Actions
         ##
         # Index restful action
@@ -35,12 +38,7 @@ module Undercarriage
           #     # end
           #   end
           #
-          def index
-            respond_with(@index_resources) do |format|
-              format.html { render layout: !request.xhr? }
-              format.json { render layout: false }
-            end
-          end
+          def index; end
 
           protected
 

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
+    # :nodoc:
     module Restful
+      # :nodoc:
       module Actions
         ##
         # New restful action
@@ -38,10 +41,6 @@ module Undercarriage
           def new
             nested_resource_pre_build
             nested_resource_build
-
-            respond_with(@new_resource) do |format|
-              format.html { render layout: !request.xhr? }
-            end
           end
 
           protected

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
+    # :nodoc:
     module Restful
+      # :nodoc:
       module Actions
         ##
         # Show restful action
@@ -35,12 +38,7 @@ module Undercarriage
           #     # end
           #   end
           #
-          def show
-            respond_with(@show_resource) do |format|
-              format.html { render layout: !request.xhr? }
-              format.json { render layout: false }
-            end
-          end
+          def show; end
 
           protected
 

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
+    # :nodoc:
     module Restful
+      # :nodoc:
       module Actions
         ##
         # Update restful action
@@ -38,17 +41,21 @@ module Undercarriage
           def update
             nested_resource_pre_build
 
-            if @update_resource.update(update_resource_params)
-              after_update_action
+            respond_to do |format|
+              if @update_resource.update(update_resource_params)
+                after_update_action
 
-              respond_with(@update_resource) do |format|
-                format.html { redirect_to location_after_update }
-              end
-            else
-              nested_resource_build
+                format.html do
+                  flash[flash_status_type] = flash_updated_message
+
+                  redirect_to location_after_update
+                end
+                format.json { render :show, status: :ok, location: location_after_update }
+              else
+                nested_resource_build
 
-              respond_with(@update_resource) do |format|
-                format.html { render action: :edit }
+                format.html { render :edit }
+                format.json { render json: @post.errors, status: :unprocessable_entity }
               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

@@ -1,29 +1,61 @@
 # 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

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

@@ -1,8 +1,18 @@
 # 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
 

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

@@ -1,31 +1,95 @@
 # 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
 
@@ -35,8 +99,7 @@ module Undercarriage
         private
 
         def permitted_attributes_fallback
-          with_method = self.class.instance_methods(false)
-                            .include?(:permitted_attributes)
+          with_method = self.class.instance_methods(false).include?(:permitted_attributes)
 
           with_method ? permitted_attributes : []
         end

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

@@ -1,33 +1,70 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
+    # :nodoc:
     module Restful
+      ##
+      # Utility
+      #
+      # Utility helper methods
+      #
+      # Usage
+      #   class ExamplesController < ApplicationController
+      #     include Undercarriage::Controllers::Restful::UtilityConcern
+      #   end
+      #
       module UtilityConcern
         extend ActiveSupport::Concern
 
         protected
 
+        ##
+        # Singular controller name
+        #
         def controller_name_singular
           controller_name.to_s.singularize
         end
 
+        ##
+        # Singular human name
+        #
+        def controller_name_singular_human
+          controller_name_singular.humanize
+        end
+
+        ##
+        # Model name
+        #
         def model_name
           controller_name_singular
         end
 
+        ##
+        # Model class
+        #
         def model_class
           model_name.classify.constantize
         end
 
+        ##
+        # Instances name
+        #
         def instances_name
           controller_name.to_s
         end
 
+        ##
+        # Instance name
+        #
         def instance_name
           model_name
         end
 
+        ##
+        # Resource scope
+        #
         def resource_scope
           model_name.to_sym
         end

data/lib/undercarriage/controllers/restful_concern.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Undercarriage
+  # :nodoc:
   module Controllers
     ##
     # Restful actions
@@ -14,6 +15,7 @@ module Undercarriage
       extend ActiveSupport::Concern
 
       included do
+        include Undercarriage::Controllers::Restful::FlashConcern
         include Undercarriage::Controllers::Restful::LocationAfterConcern
         include Undercarriage::Controllers::Restful::NamespaceConcern
         include Undercarriage::Controllers::Restful::PermittedAttributesConcern

data/lib/undercarriage/models/published_concern.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Models
+    ##
+    # Published
+    #
+    # Based on the presence of a datetime in the `published_at` column (configurable) in the database. If there is a
+    # datetime in the column, it is considered published. You need to do your own validation to ensure the value is a
+    # datetime value
+    #
+    # Usage
+    #   # Model
+    #   class Example < ApplicationRecord
+    #     include Undercarriage::Models::PublishedConcern
+    #
+    #     ##
+    #     # The name of the column is expected to be `published_at`. If that is not the case for you, uncomment the
+    #     # following to change the column name
+    #     #
+    #     # self.published_column = :ready_at
+    #
+    #     ##
+    #     # The following are useful helpers for the model. They are not part of the concern
+    #     #
+    #     scope :available, -> { published.where("#{published_column} <= ?", Time.current) }
+    #
+    #     def available?
+    #       published? && self[published_column] <= Time.current
+    #     end
+    #
+    #     scope :scheduled, -> { published.where("#{published_column} > ?", , Time.current) }
+    #
+    #     def scheduled?
+    #       published? && self[published_column] > Time.current
+    #     end
+    #   end
+    #
+    #   # Controller
+    #   class PagesController < AdminController
+    #     def index
+    #       @examples = Example.published
+    #     end
+    #   end
+    #
+    #   # View
+    #   <% @examples.each do |example| %>
+    #     Published?: <%= example.published? %>
+    #   <% end %>
+    #
+    module PublishedConcern
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :published_column
+        self.published_column = :published_at
+
+        ##
+        # Published scope
+        #
+        # Retrieve only published resources
+        #
+        # Usage
+        #   class PagesController < AdminController
+        #     def index
+        #       @examples = Example.published
+        #     end
+        #   end
+        #
+        scope :published, -> { where.not(published_column => nil) }
+
+        ##
+        # Unpublished scope
+        #
+        # Retrieve only unpublished resources
+        #
+        # Usage
+        #   class PagesController < AdminController
+        #     def index
+        #       @examples = Example.unpublished
+        #     end
+        #   end
+        #
+        scope :unpublished, -> { where(published_column => nil) }
+      end
+
+      ##
+      # Published check
+      #
+      # Check if an item is published based on the presence of a value in the published column. This does not take into
+      # account whether the item is not currently available (scheduled). See module documentation for more information
+      #
+      # Usage
+      #   @example.published? => true
+      #   @example.published? => false
+      #
+      # @return [Boolean] if resource is published
+      #
+      def published?
+        self[self.class.published_column].present?
+      end
+
+      ##
+      # Unpublished check
+      #
+      # Check if an item is unpublished based on the lack of presence of a value in the published column
+      #
+      # Usage
+      #   @example.unpublished? => true
+      #   @example.unpublished? => false
+      #
+      # @return [Boolean] if resource is unpublished
+      #
+      def unpublished?
+        !published?
+      end
+    end
+  end
+end

data/lib/undercarriage/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
 module Undercarriage
-  VERSION = '0.2.0'
+  ##
+  # Undercarriage version
+  #
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undercarriage
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - David Freerksen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: '6.0'
 description: Undercarriage is a set of concerns to add to your application to trim
   some of the fat from controllers and models.
 email:
@@ -35,7 +35,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- lib/tasks/undercarriage_tasks.rake
 - lib/undercarriage.rb
 - lib/undercarriage/controllers/action_concern.rb
 - lib/undercarriage/controllers/kaminari_concern.rb
@@ -48,12 +47,13 @@ files:
 - lib/undercarriage/controllers/restful/actions/new_concern.rb
 - lib/undercarriage/controllers/restful/actions/show_concern.rb
 - lib/undercarriage/controllers/restful/actions/update_concern.rb
+- lib/undercarriage/controllers/restful/flash_concern.rb
 - lib/undercarriage/controllers/restful/location_after_concern.rb
 - lib/undercarriage/controllers/restful/namespace_concern.rb
 - lib/undercarriage/controllers/restful/permitted_attributes_concern.rb
 - lib/undercarriage/controllers/restful/utility_concern.rb
 - lib/undercarriage/controllers/restful_concern.rb
-- lib/undercarriage/railtie.rb
+- lib/undercarriage/models/published_concern.rb
 - lib/undercarriage/version.rb
 homepage: https://github.com/dfreerksen/undercarriage
 licenses:

data/lib/tasks/undercarriage_tasks.rake

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-# desc "Explaining what the task does"
-# task :undercarriage do
-#   # Task goes here
-# end

data/lib/undercarriage/railtie.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module Undercarriage
-  class Railtie < ::Rails::Railtie
-  end
-end