undercarriage 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ec3241ab6e053eb78aa66e3aed56473b299ebef9c48c08c415a7f9c04b0eb70
-  data.tar.gz: c0e0393b7f2d1c383eadb22af21ac440fe5651eea335f71241289918f754b547
+  metadata.gz: b12f7949572ff816f2b669ca0a6d94bfe8bce39ba6a744092b16ceedfda4cdac
+  data.tar.gz: 651b54c29ed119c043ca0542dccadfc7e6f60ffd471d86cbe1988c7f377d7c90
 SHA512:
-  metadata.gz: 423946c74cd8e1f5d313627933fd3f6a27d663e0e580d78ae5d56f202117d8348d56eb42315498e32878e0bdb39e30f7e48c021e4207b2221197c0d0edf7c73b
-  data.tar.gz: 5613f293beb7bac032d58f7aed7f686f67e6c8219ba52708690e591e874246e4fd86a60c91dc98c04a518a739b2e883dc7fc8f1ed1e47f8955bef20e955cc270
+  metadata.gz: de197de22b4c1cada28489687edeea986d628a7dc3245932e0b33565e9a4061c74dea37b7f5981e24e4348262d22d8df1df026b204edb008c86665299098b8fc
+  data.tar.gz: da32a07d87b9eccfc756de524410800fc36fa1b63814bb1ea5defa95bf870f854824c98ccae3fc3f8dbbd0192bb97f56e9a3f7921e5448a9a90746dd06ef7e81

data/README.md

@@ -2,6 +2,10 @@
 
 **\*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
@@ -13,13 +17,13 @@ Undercarriage is a set of concerns to add to your application to trim some of th
 
 Add to your application's Gemfile
 
-```ruby
-gem 'undercarriage', '~> 0.1'
+```
+gem 'undercarriage', '~> 0.4'
 ```
 
 Run the bundle command
 
-```bash
+```
 $ bundle install
 ```
 
@@ -31,9 +35,43 @@ 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
+
+```
+$ bin/test
+$ bundle exec rspec spec
+```
+
 ## 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

@@ -3,8 +3,21 @@
 require 'undercarriage/controllers/action_concern'
 require 'undercarriage/controllers/kaminari_concern'
 require 'undercarriage/controllers/locale_concern'
-
-require 'undercarriage/railtie'
+require 'undercarriage/controllers/restful_concern'
+require 'undercarriage/controllers/restful/actions/base_concern'
+require 'undercarriage/controllers/restful/actions/index_concern'
+require 'undercarriage/controllers/restful/actions/show_concern'
+require 'undercarriage/controllers/restful/actions/new_concern'
+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/models/published_concern'
 
 ##
 # Undercarriage
@@ -12,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

@@ -0,0 +1,120 @@
+# 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::Restful::Actions::BaseConcern
+        #   end
+        #
+        module BaseConcern
+          extend ActiveSupport::Concern
+
+          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)
+
+            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
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    # :nodoc:
+    module Restful
+      # :nodoc:
+      module Actions
+        ##
+        # Create restful action
+        #
+        # Usage
+        #   class ExamplesController < ApplicationController
+        #     include Undercarriage::Controllers::RestfulConcern
+        #   end
+        #
+        module CreateConcern
+          extend ActiveSupport::Concern
+
+          included do
+            before_action :create_resource, only: %i[create]
+          end
+
+          ##
+          # Create 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 `@create_resource` or `@example`
+          #     #
+          #     # def create
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def create
+            nested_resource_pre_build
+
+            if @create_resource.save
+              after_create_action
+
+              flash[flash_status_type] = flash_created_message
+
+              redirect_to location_after_create
+            else
+              nested_resource_build
+
+              render :new, status: :unprocessable_entity
+            end
+          end
+
+          protected
+
+          ##
+          # Create 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 create_resource_content
+          #     #   ...
+          #     # end
+          #
+          #     ##
+          #     # To add authorization through something like Pundit, the following could be used
+          #     #
+          #     # def create_resource_content
+          #     #   super
+          #     #
+          #     #   authorize @example
+          #     # end
+          #
+          #     ##
+          #     # The `resource_new_content` method can also be overwritten. This method is meant to share content with
+          #     # the `new` action
+          #     #
+          #     # def resource_new_content
+          #     #   ...
+          #     # end
+          #   end
+          #
+          def create_resource_content
+            resource_query = model_class.new(create_resource_params)
+
+            instance_variable_set("@#{instance_name}", resource_query)
+          end
+
+          private
+
+          def create_resource
+            @create_resource ||= resource_new_content
+          end
+        end
+      end
+    end
+  end
+end