mandate 1.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d56daf22931d4b43f0c73217175ee9ff4c100d59086f5d4ecafbca2caa26bb8
-  data.tar.gz: 6a3b61893705efd5b9f9bf650d53a7d147ac146fe0165b2ef41378b186ca7e20
+  metadata.gz: 12d7d983ad9f280460b90e764a105b84b0d25d311852f71a511ea6a9ddd69d06
+  data.tar.gz: 2b37f6c50d8165472db2d2c65da490a01a0047862460594a1e95c3d1cb780db6
 SHA512:
-  metadata.gz: 8db9b3480d63328cae72171280e98584f13eb8af7c2778dacfd30cdf50002751cd415c29a431a0f97f6bb0ce2b0e8d5e98d8f27647ecaae9760587d45eaf9f35
-  data.tar.gz: aca17005769c5c735c127e6f6f852be7eaed2d6288765858fcfa6ac48c88758a22fafbbf55adf65fad101735db267b2e1663d07a2e7e689da01e6796583f9993
+  metadata.gz: 53038261b0697c3ad94eb0240b0d031f5face943123a07493e369068922c8463ef1a95483eb2cec77e44ccd5636d5c35730a89ec32afeb712826d8249dd948ff
+  data.tar.gz: be465cc6fc64837235ec99ab7b1c071da90978611497138a3ed481eec07d3d987eae5da31b9973b65f99122bf8e44530f2db41cd00a639f9e5669c4253dfd879

data/.github/workflows/rubocop.yml

@@ -14,9 +14,9 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@42817531497ae2ef0168458f709e451109306bd5
+        uses: ruby/setup-ruby@4726835508d9debb3220096c92d7bf6388485faa
         with:
-          ruby-version: 2.6.6
+          ruby-version: '3.1.0'
 
       - name: Install gems
         run: |

data/.github/workflows/tests.yml

@@ -15,13 +15,13 @@ jobs:
       matrix:
         os:
           - ubuntu-20.04
-        ruby-version: [2.6, 2.7, 3.0]
+        ruby-version: ['3.0', '3.1']
 
     steps:
       - uses: actions/checkout@v2
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@42817531497ae2ef0168458f709e451109306bd5
+        uses: ruby/setup-ruby@4726835508d9debb3220096c92d7bf6388485faa
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true

data/.rubocop.yml

@@ -3,6 +3,7 @@ require:
   - rubocop-performance
 
 AllCops:
+  TargetRubyVersion: 3.0.0
   NewCops: disable
   Exclude:
     - "bin/**/*"

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.1.0

data/CHANGELOG.md

@@ -1,5 +1,16 @@
+# 2.1.0 / 2022-04-23
+
+- [FEATURE] Change initialize_with to take a block which is run after variables are set.
+- [FEATURE] Add optional kwarg specified by using Mandate::NO_DEFAULT.
+
+# 2.0.0 / 2022-04-19
+
+- [FEATURE] Simplify codebase for Ruby 3 (thanks to @erikschierboom)
+
 # 0.3.0 / 2019-09-06
-* [FEATURE] Add success/failure callbacks
+
+- [FEATURE] Add success/failure callbacks
 
 # 0.2.0 / 2018-08-11
-* [FEATURE] Add initialize_with
+
+- [FEATURE] Add initialize_with

data/README.md

@@ -4,6 +4,8 @@
 
 A simple command-pattern helper gem for Ruby.
 
+**Note: As of 2.0.0, Mandate only supports Ruby 3.x. For Ruby 2.x, please use the 1.0.0 release.**
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,7 +28,7 @@ Or install it yourself as:
 class Multiplies
   include Mandate
 
-  initialize_with :number_1, :number_2
+  initialize_with :number_1, number_2: 0
 
   def call
     do_the_maths
@@ -48,17 +50,40 @@ Multiplies.(20, 3)
 ### `initialize_with`
 
 The `initialize_with` method creates an initializer and private attr_readers for the specified variables.
+Keyword arguments can be expressed normally, but arguments without default values must be specified with the value `Mandate::NO_DEFAULT`.
+You may also use the `Mandate::KWARGS` param to capture any params that aren't explicitely set.
+The call also takes a block, which is run after the variables are set.
 
-For example `initialize_with :foo, :bar` is the equivalent of:
+For example, this...
 
 ```ruby
-def initialize(foo, bar)
-  @foo = foo
-  @bar = bar
+MODELS = ...
+
+class Car
+  initialize_with :model, color: "blue", owner: Mandate::NO_DEFAULT, params: Mandate::KWARGS do
+    raise unless MODELS[model].colors.include?(color)
+  end
 end
+```
+
+...is the equivalent of...
 
-private
-attr_reader :foo, :bar
+```ruby
+MODELS = ...
+
+class Foobar
+  def initialize(model, color: "blue", owner:, params = {})
+    @model = model
+    @color = color
+    @owner = owner
+    @params = params
+
+    raise unless MODELS[model].colors.include?(color)
+  end
+
+  private
+  attr_reader :model, :color, :owner
+end
 ```
 
 ### Using on_success/on_failure callbacks

data/lib/mandate/call_injector.rb

@@ -6,16 +6,8 @@ module Mandate
       # which internally calls:
       #   Foobar.new(some, args).call()
       class << base
-        def call(*args)
-          # If the last argument is a hash and the last param is a keyword params (signified by
-          # its type being :key, the we should pass the hash in in using the **kwords syntax.
-          # This fixes a deprecation issue in Ruby 2.7.
-          if args.last.is_a?(Hash) &&
-             instance_method(:initialize).parameters.last&.first == :key
-            new(*args[0..-2], **args[-1]).()
-          else
-            new(*args).()
-          end
+        def call(...)
+          new(...).()
         end
       end
     end

data/lib/mandate/initializer_injector.rb

@@ -1,34 +1,43 @@
+require 'securerandom'
+
 module Mandate
+  NO_DEFAULT = SecureRandom.uuid
+  KWARGS = SecureRandom.uuid
+
   module InitializerInjector
     def self.extended(base)
       class << base
-        def initialize_with(*attrs, **kwattrs)
-          if kwattrs.empty?
-            define_method :initialize do |*args|
-              unless args.length == attrs.length
-                raise ArgumentError, "wrong number of arguments (given #{args.length}, expected #{attrs.length})"
-              end
+        def initialize_with(*attrs, **kwattrs, &block)
+          kwarg_capture_key = (kwattrs.find(-> { [] }) { |_name, value| value == KWARGS }).first
 
-              attrs.zip(args).each do |attr, arg|
-                instance_variable_set("@#{attr}", arg)
-              end
+          define_method :initialize do |*args, **kwargs|
+            unless args.length == attrs.length
+              raise ArgumentError, "wrong number of arguments (given #{args.length}, expected #{attrs.length})"
             end
-          else
-            define_method :initialize do |*args, **kwargs|
-              unless args.length == attrs.length
-                raise ArgumentError, "wrong number of arguments (given #{args.length}, expected #{attrs.length})"
-              end
-
-              attrs.zip(args).each do |attr, arg|
-                instance_variable_set("@#{attr}", arg)
-              end
 
-              kwargs.each do |name, value|
-                raise ArgumentError, "unknown keyword: #{name}" unless kwattrs.key?(name)
+            attrs.zip(args).each do |attr, arg|
+              instance_variable_set("@#{attr}", arg)
+            end
 
+            instance_variable_set("@#{kwarg_capture_key}", {}) if kwarg_capture_key
+            kwargs.each do |name, value|
+              if kwattrs.key?(name)
                 instance_variable_set("@#{name}", value)
+              elsif kwarg_capture_key
+                instance_variable_get("@#{kwarg_capture_key}")[name] = value
+              else
+                raise ArgumentError, "unknown keyword: #{name}"
               end
             end
+
+            kwattrs.each do |key, value|
+              next unless value == NO_DEFAULT
+              next if kwargs.key?(key)
+
+              raise ArgumentError, "Keyword argument was not specified: #{key}"
+            end
+
+            instance_eval(&block) if block
           end
 
           attrs.each do |attr|

data/lib/mandate/version.rb

@@ -1,3 +1,3 @@
 module Mandate
-  VERSION = "1.0.0".freeze
+  VERSION = "2.2.0".freeze
 end

data/mandate.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "mandate/version"
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 3.0.0'
   spec.name          = "mandate"
   spec.version       = Mandate::VERSION
   spec.authors       = ["Jeremy Walker"]
@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'mocha'
   spec.add_development_dependency "rake", "~> 12.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jeremy Walker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,14 +109,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A simple command-pattern helper gem for Ruby