reform 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b6b3c1dbb48304ae8b36f5fbc12d9f7149edc61b40757017472b3eb01cf04f
-  data.tar.gz: 689811ffa73a062d4e598d8a36b6258571350d1ce4c5c87c85db9707313dde04
+  metadata.gz: 9a0dc23a8d6a5ba78556fdd827acdfdd596e45dc8354ed5e82acfdfaf5cf5dcf
+  data.tar.gz: 21216fc1a7d500ca8ecd7b59349166629e8ef8514d34d321d23eb5a857d378dd
 SHA512:
-  metadata.gz: a797c79e164c4c1791661a97163d4e89b1b2e49ae4992e1c0a59eb427d98ddfdbdae96292f455f843acacc869b5053916afa7131018843c66f4d886e6872c372
-  data.tar.gz: 82fe647e1ab34dcc24e85250d5876b88b84ea3a991cdfb163bf0dd616be701105ab1ca87065285bc0e32abe9f67ccdb3cda103c7f70143e49d0a8c3024baa75e
+  metadata.gz: f5a8aeaa19e8a90c4d0276fba8fe6d85fb5574607e838e9c9298d556292182231ed7d2e29b24835f3265cabb9b37db93f6602388052889e6fcd759e5478ca6ef
+  data.tar.gz: c69fadd4887bfb63538d69a501ddf0e958bd9594ceb9ff97a4181c5017d1eec0a2bbc88fc9cb9ba417257be6f01ac655301b0e822c6babf36ca45d7b7c3fd4e3

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.4, 2.5, 2.6, 2.7, '3.0', head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 2.6.0
+
+* Support ruby-3 by using `Representable::Option` to handle `keyword_arguments` forwarding :tada:
+* Upgrade `representable` and `disposable` dependencies which uses `trailblazer-option` over `declarative-option`.
+* Deprecate populator's callable signature which accepts `form` as a separate positional argument. Make all callable (proc, method, `Uber::Callable`) signatures identical.
+
 ## 2.5.0
 *  fix memory leak with Dry validation (#525)
 

data/lib/reform/form/dry.rb

@@ -28,7 +28,7 @@ module Reform::Form::Dry
     class Group
       include InputHash
 
-      def initialize(**options)
+      def initialize(options)
         @validator = options.fetch(:contract, Contract)
         @schema_inject_params = options.fetch(:with, {})
       end
@@ -46,7 +46,7 @@ module Reform::Form::Dry
 
         dynamic_options = { form: form }
         inject_options = schema_inject_params.merge(dynamic_options)
-        contract.new(inject_options).call(input_hash(form))
+        contract.new(**inject_options).call(input_hash(form))
       end
 
       def contract

data/lib/reform/form/populator.rb

@@ -7,7 +7,7 @@
 class Reform::Form::Populator
   def initialize(user_proc)
     @user_proc = user_proc # the actual `populator: ->{}` block from the user, via ::property.
-    @value     = Declarative::Option(user_proc, instance_exec: true, callable: Object) # we can now process Callable, procs, :symbol.
+    @value     = ::Representable::Option(user_proc) # we can now process Callable, procs, :symbol.
   end
 
   def call(input, options)
@@ -30,7 +30,17 @@ class Reform::Form::Populator
 
   def call!(options)
     form = options[:represented]
-    @value.(form, options) # Declarative::Option call.
+    evaluate_option(form, options)
+  end
+
+  def evaluate_option(form, options)
+    if @user_proc.is_a?(Uber::Callable) && @user_proc.method(:call).arity == 2 # def call(form, options)
+      warn %{[Reform] Accepting `form` as a positional argument in `:populator` will be deprecated. Please use `def call(form:, **options)` signature instead.}
+
+      return @value.(form, exec_context: form, keyword_arguments: options)
+    end
+
+    @value.(exec_context: form, keyword_arguments: options.merge(form: form)) # Representable::Option call
   end
 
   def handle_fail(twin, options)
@@ -66,7 +76,7 @@ class Reform::Form::Populator
       return @user_proc.new if @user_proc.is_a?(Class) # handle populate_if_empty: Class. this excludes using Callables, though.
 
       deprecate_positional_args(form, @user_proc, options) do
-        @value.(form, options)
+        evaluate_option(form, options)
       end
     end
 

data/lib/reform/form/prepopulate.rb

@@ -13,7 +13,7 @@ module Reform::Form::Prepopulate
   def prepopulate_local!(options)
     schema.each do |dfn|
       next unless block = dfn[:prepopulator]
-      Declarative::Option(block, instance_exec: true).(self, options)
+      ::Representable::Option(block).(exec_context: self, keyword_arguments: options)
     end
   end
 

data/lib/reform/form/validate.rb

@@ -4,15 +4,15 @@ module Reform::Form::Validate
     class AllBlank
       include Uber::Callable
 
-      def call(form, options)
+      def call(input:, binding:, **)
         # TODO: Schema should provide property names as plain list.
         # ensure param keys are strings.
-        params = options[:input].each_with_object({}) { |(k, v), hash|
+        params = input.each_with_object({}) { |(k, v), hash|
           hash[k.to_s] = v
         }
 
         # return false if any property inputs are populated.
-        options[:binding][:nested].definitions.each do |definition|
+        binding[:nested].definitions.each do |definition|
           value = params[definition.name.to_s]
           return false if (!value.nil? && value != '')
         end

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "2.5.0".freeze
+  VERSION = "2.6.0".freeze
 end

data/reform.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency             "disposable",     ">= 0.4.2", "< 0.5.0"
-  spec.add_dependency             "representable",  ">= 2.4.0", "< 3.1.0"
+  spec.add_dependency             "disposable",     "~> 0.5.0"
+  spec.add_dependency             "representable",  ">= 3.1.1", "< 3.2.0"
   spec.add_dependency             "uber",           "< 0.2.0"
 
   spec.add_development_dependency "bundler"

data/test/populate_test.rb

@@ -127,6 +127,14 @@ class PopulateWithCallableTest < Minitest::Spec
   class TitlePopulator
     include Uber::Callable
 
+    def call(form:, **options)
+      form.title = options[:fragment].reverse
+    end
+  end
+
+  class TitlePopulatorWithOldSignature
+    include Uber::Callable
+
     def call(form, options)
       form.title = options[:fragment].reverse
     end
@@ -136,6 +144,10 @@ class PopulateWithCallableTest < Minitest::Spec
     property :title, populator: TitlePopulator.new
   end
 
+  class AlbumFormWithOldPopulator < TestForm
+    property :title, populator: TitlePopulatorWithOldSignature.new
+  end
+
   let(:form) { AlbumForm.new(Album.new) }
 
   it "runs populator method" do
@@ -143,6 +155,18 @@ class PopulateWithCallableTest < Minitest::Spec
 
     assert_equal form.title, "!em edirrevo"
   end
+
+  it "gives warning when `form` is accepted as a positional argument" do
+    _, warnings = capture_io do
+      form = AlbumFormWithOldPopulator.new(Album.new)
+      form.validate("title" => "override me!")
+
+      assert_equal form.title, "!em edirrevo"
+    end
+
+    assert_equal warnings, %{[Reform] Accepting `form` as a positional argument in `:populator` will be deprecated. Please use `def call(form:, **options)` signature instead.
+}
+  end
 end
 
 class PopulateWithProcTest < Minitest::Spec

data/test/prepopulator_test.rb

@@ -51,7 +51,7 @@ class PrepopulatorTest < MiniTest::Spec
 
   # add to existing collection.
   it do
-    form = AlbumForm.new(OpenStruct.new(songs: [Song.new])).prepopulate!
+    form = AlbumForm.new(OpenStruct.new(songs: [Song.new])).prepopulate!(title: "Potemkin City Limits")
 
     assert_equal form.songs.size, 2
     assert_equal form.songs[0].model, Song.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reform
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Nick Sutterer
@@ -9,26 +9,20 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disposable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
@@ -37,20 +31,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 3.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 3.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: uber
   requirement: !ruby/object:Gem::Requirement
@@ -157,8 +151,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGES.md
 - CONTRIBUTING.md
 - Gemfile
@@ -243,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Form object decoupled from models with validation, population and presentation.

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-cache: bundler
-bundler_args: --without benchmarks tools
-rvm:
-  - ruby-head
-  - 2.7
-  - 2.6
-  - 2.5
-  - 2.4
-matrix:
-  fast_finish: true
-  allow_failures:
-    - rvm: ruby-head