statusable 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25c9dd86e72394b2b8e82391af2c925c3b2ab2bab6db1fc2c6620c2d8d51f502
+  data.tar.gz: f04aa28c9f999d8594f632d5892bb1ed8aa11c7db6dfb89f064930dcca17ba93
+SHA512:
+  metadata.gz: 5a45c11415d8f4122f3a11da376c2ec68b8f502d255386efe96b957fbb1535e52bdc4a16a199c548c0ee8145969894b3be1712094d564742f6897b653e65e004
+  data.tar.gz: 516c253ee89fd0251e3b4cf9ccb4af45c2447ffbebf97abc4b5beddf58d0fe6066301360172c18f822e889445556dea0def970a70eb24d39df5e8aee082aa24c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Paul DobbinSchmaltz
+
+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,49 @@
+# Statusable
+
+Statusable adds a `has_statuses` macro for defining common status-related methods for use with ActiveRecord objects / Relations.
+
+## Usage
+
+```ruby
+class MyModel < ApplicationRecord
+  has_statuses(%w[
+      Pending
+      Running
+      Completed
+    ])
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "statusable"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install statusable
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/statusable.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Or, run `rake` to run the tests plus linters as well as `yard` (to confirm proper YARD documentation practices). You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb` and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/statusable/has_statuses.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+# Statusable::HasStatuses adds a `has_statuses` macro for defining common
+# status-related methods around the passed in list of status names for the given
+# {#col_name}.
+#
+# Optional validations exist as well. By default, inclusion is required, but
+# presence is not.
+module Statusable::HasStatuses
+  extend ActiveSupport::Concern
+
+  class_methods do # rubocop:disable Metrics/BlockLength
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Naming/PredicateName
+    def has_statuses(
+          *args,
+          col_name: "status",
+          arel_column: nil,
+          validate_inclusion: true,
+          validate_presence: false)
+      statuses = args.flatten.freeze
+
+      arel_column ||= arel_table[col_name]
+      pluralized_column_name = col_name.to_s.pluralize
+
+      humanized_statuses_list =
+        statuses.to_sentence(
+          two_words_connector: " or ",
+          last_word_connector: ", or ").
+          freeze
+
+      if validate_inclusion
+        validates col_name,
+                  inclusion: {
+                    in: statuses,
+                    allow_blank: true,
+                    message: "must be one of #{humanized_statuses_list}",
+                  }
+      end
+
+      if validate_presence
+        validates col_name,
+                  presence: true
+      end
+
+      # .for_status(<status>)
+      scope "for_#{col_name}",
+            ->(status) {
+              where(
+                if status.is_a?(Array)
+                  arel_column.in(status)
+                else
+                  arel_column.eq(status)
+                end)
+            }
+
+      # .not_for_status(<status>)
+      scope "not_for_#{col_name}",
+            ->(status) {
+              where(
+                if status.is_a?(Array)
+                  arel_column.not_in(status)
+                else
+                  arel_column.not_eq(status)
+                end)
+            }
+
+      # .by_status_asc
+      scope "by_#{col_name}_asc",
+            -> { order(arel_column) }
+
+      # .by_status_desc
+      scope "by_#{col_name}_desc",
+            -> { order(arel_column.desc) }
+
+      # .group_by_status
+      scope "group_by_#{col_name}",
+            -> { group(arel_column) }
+
+      # Class method to get a humanized list of statuses.
+      # .humanized_statuses_list
+      define_singleton_method(:"humanized_#{pluralized_column_name}_list") do
+        humanized_statuses_list
+      end
+
+      # Instance method to get a humanized list of statuses.
+      # #humanized_statuses_list
+      define_method(:"humanized_#{pluralized_column_name}_list") do
+        humanized_statuses_list
+      end
+
+      # Class method to get all options for <col_name>.
+      # .status_options
+      define_singleton_method(:"#{col_name}_options") do
+        statuses
+      end
+
+      # Instance method to get all options for <col_name>.
+      # #status_options
+      define_method(:"#{col_name}_options") do
+        statuses
+      end
+
+      statuses.each do |status| # rubocop:disable Metrics/BlockLength
+        status_name = status.parameterize.underscore
+
+        # .for_status_ready
+        scope "for_#{col_name}_#{status_name}",
+              -> { where(arel_column.eq(status)) }
+
+        # .not_for_status_ready
+        scope "not_for_#{col_name}_#{status_name}",
+              -> { where(arel_column.not_eq(status)) }
+
+        # Class method to get <status_name> value. Obviates the need for
+        # defining a constant.
+        # .status_ready  # => "Ready"
+        define_singleton_method(:"#{col_name}_#{status_name}") do
+          status
+        end
+
+        # Instance method to get <status_name> value. Obviates the need for
+        # defining a constant.
+        # #status_ready  # => "Ready"
+        define_method(:"#{col_name}_#{status_name}") do
+          status
+        end
+
+        # @return [self]
+        # #set_status_ready
+        define_method(:"set_#{col_name}_#{status_name}") do
+          public_send(:"#{col_name}=", status)
+
+          self
+        end
+
+        # #set_status_ready!
+        # @return [self]
+        define_method(:"set_#{col_name}_#{status_name}!") do
+          public_send(:"set_#{col_name}_#{status_name}")
+          save!
+
+          self
+        end
+
+        # #status_ready?
+        define_method(:"#{col_name}_#{status_name}?") do
+          public_send(col_name) == status
+        end
+
+        # #not_status_ready?
+        define_method(:"not_#{col_name}_#{status_name}?") do
+          public_send(col_name) != status
+        end
+
+        # #status?(<a_status>)
+        define_method(:"#{col_name}?") do |a_status|
+          public_send(col_name) == a_status
+        end
+      end
+    end
+    # rubocop:enable Naming/PredicateName
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/statusable/railtie.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Statusable::Railtie < Rails::Railtie
+end

data/lib/statusable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Statusable
+  VERSION = "0.1.0.pre"
+end

data/lib/statusable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Statusable is the base namespace for all modules/classes related to the
+# statusable gem.
+module Statusable
+end
+
+require "statusable/version"
+require "statusable/railtie"
+
+require "statusable/has_statuses"

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: statusable
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Paul DobbinSchmaltz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: gemwork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Statusable adds a `has_statuses` macro for defining common status-related
+  methods for use with ActiveRecord objects / Relations.
+email:
+- p.dobbinschmaltz@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/statusable.rb
+- lib/statusable/has_statuses.rb
+- lib/statusable/railtie.rb
+- lib/statusable/version.rb
+homepage: https://github.com/pdobb/statusable
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/pdobb/statusable/issues
+  changelog_uri: https://github.com/pdobb/statusable/releases
+  source_code_uri: https://github.com/pdobb/statusable
+  homepage_uri: https://github.com/pdobb/statusable
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: Adds a `has_statuses` macro for defining common status-related ActiveRecord
+  / Relation methods.
+test_files: []