undercarriage 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fccd3ba65ccfd908ef199e41930f736cd2f9022ca3113ee90186a96230a7cf8c
-  data.tar.gz: a92a0518846b2d4996ba806f55e1a4f00df34ad6dcdd0501a3e4cd7292915bf5
+  metadata.gz: 559e80f965a59b18fcbf8a6e73794ec46271d0e42bee153bcc215d393343216e
+  data.tar.gz: b4d88ead8c3576c47cb52be8ac23c9e44f65add36e499e8072649f215302442d
 SHA512:
-  metadata.gz: 45773941e2a9fd2775e2e75c736083072e2193f90b49e92711638e2776d9d2058f18649050ce97ad663e2eb0d7b82d929d0db23de859fd7ff96912c886f228fd
-  data.tar.gz: 3d5cf0b390504b5cf2d342d8e92ecce6738798466579af5562f145d0c11866a924950d955e506e699c4af4d8c25c30ca8d4d186391482ce39dd23f469b3bd5a6
+  metadata.gz: 51e19014eb0a462810268058435a775dd25d02b69ba815ccbdce46e0a5a364b9e3553c246bb8a056f082cdb486410d8eb281a5abaddeca7fe2b9ab5afb8ed89b
+  data.tar.gz: 66caf3c904f4263eca9b6146c3e577a0712148179c478bfb1e1405de6ea496a0bcb4c6d44f8c04f2dc2480634e6e850d6b1714709d332c3bc61425ba8e4d0428

data/README.md

@@ -14,7 +14,7 @@ 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.2'
+gem 'undercarriage', '~> 0.3'
 ```
 
 Run the bundle command

data/lib/undercarriage.rb

@@ -16,6 +16,7 @@ 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'
 
 require 'undercarriage/railtie'
 

data/lib/undercarriage/models/published_concern.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Undercarriage
+  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,5 @@
 # frozen_string_literal: true
 
 module Undercarriage
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: undercarriage
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David Freerksen
@@ -53,6 +53,7 @@ files:
 - 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/railtie.rb
 - lib/undercarriage/version.rb
 homepage: https://github.com/dfreerksen/undercarriage