action_state 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66bc5c3dbb72d3061e32ebd722563bf5f1ea6d00714604c27c6720b7e49d8d72
+  data.tar.gz: bd61f346df26a1ca17c8c29b39ae9e57544a0082026a948788819fbff74499e6
+SHA512:
+  metadata.gz: 45d45ce7c60a9353c05f7b0a727aadc817d60513511ba7018b7e76383737bc294ceda47c9b4dcbce8213fdc1a3d386320f93031103f42290ea0885368206ac6d
+  data.tar.gz: 7d1149caa26980a04fd2c7059f54675ab0afcc806aaed3aeb8273a11b9c8a81b8eb8104f4e8e30db8dda4a291f7699282b6e56b7e16ac42a39a7e939eb42af07

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Joel Drapper
+
+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,122 @@
+# action_state
+
+ActionState provides a simple DSL for defining model states and allows you to query the state as an ActiveRecord scope on the class and a predicate on the instance.
+
+For example, the following state definition defines a class scope `Article.published` and an instance predicate `article.published?`.
+
+```ruby
+class Article < ApplicationRecord
+  state(:published) { where(published_at: ..Time.current) }
+  ...
+end
+```
+
+## Usage
+
+ActionState supports a small subset of ActiveRecord queries for the predicate definition, and delegates the scope definition to ActiveRecord.
+
+It's not meant to comprehensively support every possible ActiveRecord query; rather it supports a few features that tend to lend themselves well to predicate definitions.
+
+### `where`
+
+The `where` method checks for inclusion in an Enumerable, coverage by a Range, and equality with other types of value.
+
+#### Inclusion in an Enumerable
+
+```ruby
+state(:crafter) { where(role: ["designer", "developer"]) }
+```
+
+#### Covered by a Range
+
+```ruby
+state(:negative) { where(stars: 1..4 }
+state(:indifferent) { where(stars: 5..6) }
+state(:positive) { where(stars: 7..9) }
+
+state(:recently_published) { where(published_at: 1.week.ago..) }
+```
+
+#### Equality
+
+```ruby
+state(:featured) { where(featured: true) }
+```
+
+### `where.not`
+
+The counterpart to `where` is `where.not` which checks for exclusion from an Enumerable or Range, and inequality with other types of value.
+
+```ruby
+state(:deleted) { where.not(deleted_at: nil) }
+```
+
+### `excluding`
+
+The `excluding` method excludes specific instances of a model.
+
+```ruby
+state(:normal) { excluding(special_post) }
+```
+
+### Passing arguments
+
+States can also be defined to accept arguments.
+
+```ruby
+state(:before) { |whenever| where(created_at: ..whenever) }
+state(:after) { |whenever| where(created_at: whenever..) }
+```
+
+### Composing states
+
+You can chain query methods together to form more complex queries.
+
+```ruby
+state(:can_edit) { where(role: "admin").where.not(disabled: true) }
+```
+
+You can also compose multiple states together.
+
+```ruby
+state(:published) { where(published: true) }
+state(:featured) { published.where(featured: true) }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "action_state"
+```
+
+And then execute:
+
+```other
+$ bundle
+```
+
+Or install it yourself as:
+
+```other
+$ gem install action_state
+```
+
+Finally, include `ActionState` in your model class or `ApplicationRecord`:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include ActionState
+  ...
+end
+```
+
+## Contributing
+
+Contributions are welcome. Please feel free top open a PR / issue / discussion.
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/action_state/predicate.rb

@@ -0,0 +1,63 @@
+module ActionState
+  class Predicate
+    attr_reader :result
+
+    def initialize(record)
+      @record = record
+      @result = true
+    end
+
+    def excluding(*records)
+      return self unless result
+
+      @result = false if records.include?(@record)
+
+      self
+    end
+
+    def where(**kwargs)
+      return self unless @result
+
+      @result = false if kwargs.any? do |k, v|
+        case v
+        when ::Range
+          !v.cover? @record.send(k)
+        when ::Enumerable
+          !v.include? @record.send(k)
+        else
+          v != @record.send(k)
+        end
+      end
+
+      self
+    end
+
+    def not(**kwargs)
+      return self unless @result
+
+      @result = false if kwargs.any? do |k, v|
+        attribute = @record.send(k)
+        next true if attribute.nil? && !v.nil?
+
+        case v
+        when ::Range
+          v.cover? attribute
+        when ::Enumerable
+          v.include? attribute
+        else
+          v == attribute
+        end
+      end
+
+      self
+    end
+
+    def method_missing(method_name, *args, **kwargs, &block)
+      return self unless @result
+
+      @result = false unless @record.send("#{method_name}?", *args, **kwargs, &block)
+
+      self
+    end
+  end
+end

data/lib/action_state/railtie.rb

@@ -0,0 +1,4 @@
+module ActionState
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/action_state/version.rb

@@ -0,0 +1,3 @@
+module ActionState
+  VERSION = "1.0.0"
+end

data/lib/action_state.rb

@@ -0,0 +1,17 @@
+require "action_state/version"
+require "action_state/railtie"
+require "action_state/predicate"
+
+module ActionState
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def state(name, &block)
+      scope(name, Proc.new(&block))
+
+      define_method("#{name}?") do |*args, **kwargs|
+        Predicate.new(self).instance_exec(*args, **kwargs, &block).result
+      end
+    end
+  end
+end

data/lib/tasks/action_state_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :action_state do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: action_state
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joel Drapper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Quickly define model state predicates and scopes at the same time.
+email:
+- joel@drapper.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/action_state.rb
+- lib/action_state/predicate.rb
+- lib/action_state/railtie.rb
+- lib/action_state/version.rb
+- lib/tasks/action_state_tasks.rake
+homepage: https://github.com/joeldrapper/action_state
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joeldrapper/action_state
+  source_code_uri: https://github.com/joeldrapper/action_state
+  changelog_uri: https://github.com/joeldrapper/action_state
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Small DSL for defining model states.
+test_files: []