undercarriage 0.1.0 → 0.4.1

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

@@ -0,0 +1,74 @@
+# 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
+      end
+    end
+  end
+end

data/lib/undercarriage/controllers/restful_concern.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  # :nodoc:
+  module Controllers
+    ##
+    # Restful actions
+    #
+    # Usage
+    #   class ExamplesController < ApplicationController
+    #     include Undercarriage::Controllers::RestfulConcern
+    #   end
+    #
+    module RestfulConcern
+      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
+        include Undercarriage::Controllers::Restful::UtilityConcern
+        include Undercarriage::Controllers::Restful::Actions::BaseConcern
+        include Undercarriage::Controllers::Restful::Actions::IndexConcern
+        include Undercarriage::Controllers::Restful::Actions::ShowConcern
+        include Undercarriage::Controllers::Restful::Actions::NewConcern
+        include Undercarriage::Controllers::Restful::Actions::CreateConcern
+        include Undercarriage::Controllers::Restful::Actions::EditConcern
+        include Undercarriage::Controllers::Restful::Actions::UpdateConcern
+        include Undercarriage::Controllers::Restful::Actions::DestroyConcern
+      end
+    end
+  end
+end

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.1.0'
+  ##
+  # Undercarriage version
+  #
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undercarriage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - David Freerksen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -35,12 +35,25 @@ 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/controllers/restful/actions/base_concern.rb
+- lib/undercarriage/controllers/restful/actions/create_concern.rb
+- lib/undercarriage/controllers/restful/actions/destroy_concern.rb
+- lib/undercarriage/controllers/restful/actions/edit_concern.rb
+- lib/undercarriage/controllers/restful/actions/index_concern.rb
+- 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/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