undercarriage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ec3241ab6e053eb78aa66e3aed56473b299ebef9c48c08c415a7f9c04b0eb70
+  data.tar.gz: c0e0393b7f2d1c383eadb22af21ac440fe5651eea335f71241289918f754b547
+SHA512:
+  metadata.gz: 423946c74cd8e1f5d313627933fd3f6a27d663e0e580d78ae5d56f202117d8348d56eb42315498e32878e0bdb39e30f7e48c021e4207b2221197c0d0edf7c73b
+  data.tar.gz: 5613f293beb7bac032d58f7aed7f686f67e6c8219ba52708690e591e874246e4fd86a60c91dc98c04a518a739b2e883dc7fc8f1ed1e47f8955bef20e955cc270

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 David Freerksen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Undercarriage
+
+**\*Undercarriage is currently under development. It is not ready for production use.\***
+
+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
+
+## Installation
+
+Add to your application's Gemfile
+
+```ruby
+gem 'undercarriage', '~> 0.1'
+```
+
+Run the bundle command
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+TODO
+
+## TODO
+
+* [ ] Allow a way to set locale instead of relying on browser preferred language in `Undercarriage::Controllers::LocaleConcern`
+
+## Code Analysis
+
+TODO
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contributing
+
+1. Fork it ([https://github.com/dfreerksen/undercarriage/fork](https://github.com/dfreerksen/undercarriage/fork))
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Undercarriage'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/tasks/undercarriage_tasks.rake

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

data/lib/undercarriage.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'undercarriage/controllers/action_concern'
+require 'undercarriage/controllers/kaminari_concern'
+require 'undercarriage/controllers/locale_concern'
+
+require 'undercarriage/railtie'
+
+##
+# Undercarriage
+#
+# 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

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  module Controllers
+    ##
+    # Action helpers
+    #
+    # Helpers for the controller or view to help identify the action
+    #
+    # Usage
+    #   class ExamplesController < ApplicationController
+    #     include Undercarriage::Controllers::ActionConcern
+    #   end
+    #
+    module ActionConcern
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :action?,
+                      :collection_action?,
+                      :create_action?,
+                      :create_actions?,
+                      :edit_action?,
+                      :edit_actions?,
+                      :index_action?,
+                      :member_action?,
+                      :new_action?,
+                      :new_actions?,
+                      :show_action?,
+                      :update_action?,
+                      :update_actions?
+      end
+
+      ##
+      # Check action
+      #
+      # Check if action is a certain action type
+      #
+      # Usage
+      #   action?(:show) # true
+      #   action?('show') # true
+      #   action?(:index) # false
+      #
+      # @param action_method [String, Symbol] the action to test
+      # @return [Boolean] if action matches
+      #
+      def action?(action_method)
+        action == action_method.to_sym
+      end
+
+      ##
+      # Check if index
+      #
+      # Check if action is the index action type. The check will pass if it is an `index` action
+      #
+      # Usage
+      #   index_action? # true
+      #   index_action? # false
+      #
+      # @return [Boolean] if action is action type
+      #
+      def index_action?
+        action?('index')
+      end
+
+      ##
+      # Check if show
+      #
+      # Check if action is the show action type. The check will pass if it is a `show` action
+      #
+      # Usage
+      #   show_action? # true
+      #   show_action? # false
+      #
+      # @return [Boolean] if action is action type
+      #
+      def show_action?
+        action?('show')
+      end
+
+      ##
+      # Check if new
+      #
+      # Check if action is the new action type. The check will pass if it is a `new` action
+      #
+      # Usage
+      #   new_action? # true
+      #   new_action? # false
+      #
+      # @return [Boolean] if action is action type
+      #
+      def new_action?
+        action?('new')
+      end
+
+      ##
+      # Check if create
+      #
+      # Check if action is the create action type. The check will pass if it is a `create` action
+      #
+      # Usage
+      #   create_action? # true
+      #   create_action? # false
+      #
+      # @return [Boolean] if action is action type
+      #
+      def create_action?
+        action?('create')
+      end
+
+      ##
+      # Check if edit
+      #
+      # Check if action is the edit action type. The check will pass if it is an `edit` action
+      #
+      # Usage
+      #   edit_action? # true
+      #   edit_action? # false
+      #
+      # @return [Boolean] if action is action type
+      #
+      def edit_action?
+        action?('edit')
+      end
+
+      ##
+      # Check if update
+      #
+      # Check if action is the update action type. The check will pass if it is an `update` action
+      #
+      # Usage
+      #   update_action? # true
+      #   update_action? # false
+      #
+      # @return [Boolean] if action is action type
+      #
+      def update_action?
+        action?('update')
+      end
+
+      ##
+      # Check if collection
+      #
+      # Check if action is a collection action type. An action is a collection type if it is the `index` action
+      #
+      # Usage
+      #   collection_action? # true
+      #   collection_action? # false
+      #
+      # @return [Boolean] if action is collection type
+      #
+      def collection_action?
+        collection_actions.include?(action)
+      end
+
+      ##
+      # Check if create or new
+      #
+      # Check if action is a create or new action type. The check will pass if it is a `create` or `new` action
+      #
+      # Usage
+      #   create_actions? # true
+      #   create_actions? # false
+      #
+      #   new_actions? # true
+      #   new_actions? # false
+      #
+      # @return [Boolean] if action is actions type
+      #
+      def create_actions?
+        create_actions.include?(action)
+      end
+      alias new_actions? create_actions?
+
+      ##
+      # Check if member
+      #
+      # Check if action is a member action type. An action is a member type if it is the `edit`, `show`, or `update`
+      # action
+      #
+      # Usage
+      #   member_action? # true
+      #   member_action? # false
+      #
+      # @return [Boolean] if action is member type
+      #
+      def member_action?
+        member_actions.include?(action)
+      end
+
+      ##
+      # Check if edit or update
+      #
+      # Check if action is an edit or update action type. The check will pass if it is an `edit` or `update` action
+      #
+      # Usage
+      #   update_actions? # true
+      #   update_actions? # false
+      #
+      #   edit_actions? # true
+      #   edit_actions? # false
+      #
+      # @return [Boolean] if action is actions type
+      #
+      def update_actions?
+        update_actions.include?(action)
+      end
+      alias edit_actions? update_actions?
+
+      protected
+
+      def action
+        action_name.to_sym
+      end
+
+      def collection_actions
+        %i[index]
+      end
+
+      def member_actions
+        %i[edit show update]
+      end
+
+      def create_actions
+        %i[create new]
+      end
+
+      def update_actions
+        %i[edit update]
+      end
+    end
+  end
+end

data/lib/undercarriage/controllers/kaminari_concern.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  module Controllers
+    ##
+    # Kaminari pagination
+    #
+    # Helpers for Kaminari style pagination. Note that the Kaminari gem is not loaded with dependency. It must be added
+    # to your own Gemfile
+    #
+    # Usage
+    #   class ExamplesController < ApplicationController
+    #     include Undercarriage::Controllers::KaminariConcern
+    #
+    #     def index
+    #       @examples = Examples.page(page_num).per(per_page)
+    #     end
+    #   end
+    #
+    module KaminariConcern
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :page_num, :per_page
+      end
+
+      ##
+      # Items per page
+      #
+      # The number of items to return in pagination. Will use the Kaminari config `default_per_page` (typically `25`)
+      # for the count and will look for `per` in the URL paramaters to override.
+      #
+      # This is asseccible from the View as `per_page`
+      #
+      # Usage
+      #   /examples?per=100 # Return 100 items per page
+      #   /examples?per=10&page=3 # Return page 3 of items with 10 items per page
+      #
+      # @return [Integer] the number of items per page
+      #
+      def per_page
+        params.fetch(per_page_key, per_page_default).to_i
+      end
+
+      ##
+      # Page number
+      #
+      # Will look for the Kaminari config `param_name` (typically `page`) in the URL paramaters.
+      #
+      # This is asseccible from the View as `page_num`
+      #
+      # Usage
+      #   /examples?page=5 # Return page 5 of items
+      #   /examples?per=10&page=3 Return page 3 of items with 10 items per page
+      #
+      # @return [Integer] the page number
+      #
+      def page_num
+        params.fetch(page_num_key, page_num_default).to_i
+      end
+
+      protected
+
+      def per_page_key
+        :per
+      end
+
+      def page_num_key
+        Kaminari.config.param_name
+      end
+
+      private
+
+      def per_page_default
+        Kaminari.config.default_per_page
+      end
+
+      def page_num_default
+        1
+      end
+    end
+  end
+end

data/lib/undercarriage/controllers/locale_concern.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  module Controllers
+    ##
+    # Identify locale for translations
+    #
+    # Identify locale based on `HTTP_ACCEPT_LANGUAGE`. Browser preferred language is passed with the request as
+    # `en-US, en;q=0.9` where `en-US` (English with US dialect) is the preferred language with `en` (generic English) as
+    # an acceptable language.
+    #
+    # When preferred language cannot be identified or no translation is available, fall back to `I18n.default_locale`
+    # (typically `en`).
+    #
+    # Usage
+    #   class ExamplesController < ApplicationController
+    #     include Undercarriage::Controllers::LocaleConcern
+    #   end
+    #
+    module LocaleConcern
+      extend ActiveSupport::Concern
+
+      included do
+        around_action :identify_locale
+
+        helper_method :html_lang, :html_dir
+      end
+
+      ##
+      # Lang
+      #
+      # Helper for Views to return the identified language.
+      #
+      # Usage
+      #   <html lang="<%= html_lang %>"> #=> '<html lang="de">'
+      #   <html lang="<%= html_lang %>"> #=> '<html lang="de-at">'
+      #
+      def html_lang
+        I18n.locale.to_s
+      end
+
+      ##
+      # Text direction
+      #
+      # Helper for Views to return text direction based on locale. Display text left-to-right for all languages but a
+      # few languages which should display as right-to-left. Returns `rtl` for the following languages:
+      #
+      # * Arabic
+      # * Aramaic
+      # * Azeri
+      # * Divehi
+      # * Hebrew
+      # * Persian/Farsi
+      # * Urdu
+      #
+      # Usage
+      #   <html dir="<%= html_dir %>"> #=> <html dir="ltr">
+      #   <html dir="<%= html_dir %>"> #=> <html dir="rtl">
+      #
+      def html_dir
+        rtl_languages = %w[am ar az dv fa he ur]
+
+        html_lang.start_with?(*rtl_languages) ? 'rtl' : 'ltr'
+      end
+
+      protected
+
+      def identify_locale(&action)
+        I18n.with_locale(first_available_locale, &action)
+      end
+
+      private
+
+      def first_available_locale
+        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
+      end
+
+      def accepted_languages_header
+        accepted_languages = request.env['HTTP_ACCEPT_LANGUAGE'] || ''
+
+        accepted_languages.gsub(/\s+/, '').split(',').map do |lang|
+          lang.split(';q=').first
+        end
+      end
+    end
+  end
+end

data/lib/undercarriage/railtie.rb

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

data/lib/undercarriage/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: undercarriage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Freerksen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+description: Undercarriage is a set of concerns to add to your application to trim
+  some of the fat from controllers and models.
+email:
+- dfreerksen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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
+- lib/undercarriage/controllers/locale_concern.rb
+- lib/undercarriage/railtie.rb
+- lib/undercarriage/version.rb
+homepage: https://github.com/dfreerksen/undercarriage
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/dfreerksen/undercarriage/issues
+  documentation_uri: https://www.rubydoc.info/github/dfreerksen/undercarriage/master
+  homepage_uri: https://github.com/dfreerksen/undercarriage
+  source_code_uri: https://github.com/dfreerksen/undercarriage
+  wiki_uri: https://github.com/dfreerksen/undercarriage/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Controller and model concerns for Ruby on Rails.
+test_files: []