activemodel-with_conditions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b87e3feb3afd222ced22ffd2c5ffb9dc027bba52afe73404e2517fb7f037378f
+  data.tar.gz: d934a506e31218f30a2b702bc729ee81ffeb78130640360d6856136df6148fc3
+SHA512:
+  metadata.gz: 637afd30d18d47428c7c29023ceea2d50f1102f2ff6c6a01243012f0122f81c7aa4a2c914f7f59d321b0e3bba4ca1125115bb3b5e2203d789b05d487d5879b79
+  data.tar.gz: 15a68276fd2e44b78a5a68495c77c028b220bdde08e29ba8635ededbba4e34d9398944105c38830ea7837ca6921f652ba656e8dea7d21063dafcba64e3cb4fe0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.0.0] - 2024-12-22
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+
+group :test do
+  gem "activemodel"
+  gem "activesupport"
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    activemodel-with_conditions (1.0.0)
+      activemodel
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (8.0.1)
+      activesupport (= 8.0.1)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    logger (1.6.4)
+    minitest (5.25.4)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    securerandom (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (1.0.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  activemodel
+  activemodel-with_conditions!
+  activesupport
+  rake
+  rspec
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Henrik Nyh
+
+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,59 @@
+# ActiveModel::WithConditions
+
+Adds `with_conditions` to Rails apps, or other projects using Active Model or Active Record.
+
+`with_conditions` is like Active Support's [`with_options`](https://guides.rubyonrails.org/active_support_core_extensions.html#with-options), but only supports `:if` and `:unless`, and it merges these.
+
+So you can do:
+
+``` ruby
+with_conditions(if: :feature_x_is_on?) do
+  validate :free_plans_must_have_x, if: :free_plan?
+end
+```
+
+It supports all forms of `:if` and `:unless` – symbols, lambdas (with or without a block argument), and arrays of the same.
+
+## Compared to `with_options`
+
+This improves on Active Support's `with_options`, where the inner `:if` would overwrite the outer one, and you'd need to work around it with something like:
+
+``` ruby
+with_options(unless: -> { !feature_x_is_on? }) do
+  validate :free_plans_must_have_x, if: :free_plan?
+end
+```
+
+You can still use `with_options` for other things (though this gem's author ever only uses it for validations and callback conditions). You could even combine them:
+
+``` ruby
+with_conditions(if: :feature_x_is_on?) do
+  with_options(presence: true) do
+    validates :x
+  end
+end
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add activemodel-with_conditions
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install activemodel-with_conditions
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome at <https://github.com/henrik/activemodel-with_conditions>.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/activemodel-with_conditions.rb

@@ -0,0 +1 @@
+require_relative "with_conditions"

data/lib/with_conditions/options_merger.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module WithConditions
+  class OptionMerger < BasicObject
+    def initialize(context, if:, unless:)
+      @context = context
+      @if_conds = Array(::Kernel.binding.local_variable_get(:if))
+      @unless_conds = Array(::Kernel.binding.local_variable_get(:unless))
+    end
+
+    private
+
+    def method_missing(method, *, **kwargs, &)
+      kwargs[:if] = @if_conds + Array(kwargs[:if])
+      kwargs[:unless] = @unless_conds + Array(kwargs[:unless])
+      @context.__send__(method, *, **kwargs, &)
+    end
+
+    def respond_to_missing?(...) = @context.respond_to?(...)
+    def Array(...) = ::Kernel.Array(...)
+  end
+end

data/lib/with_conditions/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WithConditions
+  VERSION = "1.0.0"
+end

data/lib/with_conditions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "active_model"
+require_relative "with_conditions/options_merger"
+require_relative "with_conditions/version"
+
+module WithConditions
+  def with_conditions(if: nil, unless: nil, &block)
+    option_merger = WithConditions::OptionMerger.new(self, if:, unless:)
+
+    if block
+      block.arity.zero? ? option_merger.instance_eval(&block) : block.call(option_merger)
+    else
+      option_merger
+    end
+  end
+end
+
+module ActiveModel
+  module API
+    singleton_class.prepend(Module.new do
+      def included(klass)
+        super
+        klass.extend WithConditions
+      end
+    end)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: activemodel-with_conditions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Henrik Nyh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Like with_options but merges :if and :unless conditions. Convenient for
+  Active Model or Active Record validations and callbacks.
+email:
+- henrik@nyh.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/activemodel-with_conditions.rb
+- lib/with_conditions.rb
+- lib/with_conditions/options_merger.rb
+- lib/with_conditions/version.rb
+homepage: https://github.com/henrik/activemodel-with_conditions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/henrik/activemodel-with_conditions
+  source_code_uri: https://github.com/henrik/activemodel-with_conditions
+  changelog_uri: https://github.com/henrik/activemodel-with_conditions/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Like with_options but merges :if and :unless conditions.
+test_files: []