much-result 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4805f13dbc5498186070c28c422564440a511d0b9e4af9f695802b969e3f7da
-  data.tar.gz: 811cb65cfb9bb197329e06b44ce7511daab25adc9bbdbcd1610d307c2f1b4cb3
+  metadata.gz: 50f359b93392a57fb5a5706b9b127b6683b4d9bbff35414d6dd2f88e13c3fe92
+  data.tar.gz: 85bd060061eb19a84d5fbb44e64ff4512f1d0cafece8049880ffa76933314fd8
 SHA512:
-  metadata.gz: 2e3a53796159c10e8b8e05ab1afd862cdbc77bc0eb729d3874808f731ae8f82a69f71479fb3664dffc3cb69c0bc4a815a9e29f1c1ed5c4ba1f71b584bdd29377
-  data.tar.gz: 77b2ac454e76ba063bc3ff2812a063caafe776d42e0875f111fa17868d58a1716f0ced1e423bb045f723250e5f6e72f11f3bc5acd2cd3db89cff3b4e77e704ba
+  metadata.gz: 704dc5d29a3d8000ec35fe54b92055e2e2e491b0c30169bc1218476fac0a8c7e5ba5e9d308f9afa06b3be72b636333250726c379340db241d59fe5e795c25987
+  data.tar.gz: afd00a2cd6dd19af02af0c05d280434057440b6a5c4f5de713936fcc3d185abb11d22407d3ee68afcd4a97a43ab381a97e0eafc77730ec005a6479a50dab45c4

data/README.md

@@ -210,6 +210,18 @@ result.get_for_all_failure_results(:description)
 
 Note: MuchResult::Transactions are designed to delegate to their MuchResult. You can interact with a MuchResult::Transaction as if it were a MuchResult.
 
+You can configure a default transaction receiver (e.g. `ActiveRecord::Base`) in an initializer. Doing so means if no receiver is passed to `MuchResult.transaction`, the default receiver will be used:
+
+```ruby
+# In an initializer or configuration script:
+MuchResult.default_transaction_receiver = ActiveRecord::Base
+
+# Since no receiver is passed, ActiveRecord::Base will be used:
+MuchResult.transaction do |transaction|
+  # ...
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/much-result.rb

@@ -35,8 +35,28 @@ class MuchResult
     }
   end
 
-  def self.transaction(receiver, backtrace: caller, **kargs, &block)
-    MuchResult::Transaction.call(receiver, backtrace: backtrace, **kargs, &block)
+  def self.transaction(receiver = nil, backtrace: caller, **kargs, &block)
+    if (transaction_receiver = receiver || default_transaction_receiver).nil?
+      raise(
+        ArgumentError,
+        "no receiver given and no default_transaction_receiver configured."
+      )
+    end
+
+    MuchResult::Transaction.(
+      receiver || default_transaction_receiver,
+      backtrace: backtrace,
+      **kargs,
+      &block
+    )
+  end
+
+  def self.default_transaction_receiver
+    @default_transaction_receiver
+  end
+
+  def self.default_transaction_receiver=(receiver)
+    @default_transaction_receiver = receiver
   end
 
   attr_reader :sub_results, :description, :backtrace

data/lib/much-result/transaction.rb

@@ -11,6 +11,8 @@ class MuchResult::Transaction
   end
 
   def initialize(receiver, **result_kargs)
+    raise(ArgumentError, "`receiver` can't be nil.") if receiver.nil?
+
     @receiver = receiver
     @result_kargs = result_kargs
 

data/lib/much-result/version.rb

@@ -1,3 +1,3 @@
 class MuchResult
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/unit/much-result_tests.rb

@@ -14,6 +14,7 @@ class MuchResult
     let(:value1) { Factory.value }
 
     should have_imeths :success, :failure, :for, :tap, :transaction
+    should have_accessors :default_transaction_receiver
 
     should "build success instances" do
       result = subject.success
@@ -113,6 +114,35 @@ class MuchResult
 
       assert_that(result.sub_results.size).equals(1)
     end
+
+    should "configure default transaction receivers" do
+      MuchStub.on_call(MuchResult::Transaction, :call) { |call|
+        @transaction_call = call
+      }
+
+      receiver1 = Factory.transaction_receiver
+      kargs1 = {
+        backtrace: Factory.backtrace,
+        value: value1
+      }
+      block1 = -> {}
+
+      assert_that(subject.default_transaction_receiver).is_nil
+      assert_that(-> {
+        subject.transaction(**kargs1, &block1)
+      }).raises(ArgumentError)
+
+      subject.default_transaction_receiver = receiver1
+      subject.transaction(**kargs1, &block1)
+
+      assert_that(subject.default_transaction_receiver).equals(receiver1)
+      assert_that(@transaction_call.pargs).equals([receiver1])
+      assert_that(@transaction_call.kargs).equals(kargs1)
+      assert_that(@transaction_call.block).equals(block1)
+
+      subject.default_transaction_receiver = nil
+      assert_that(subject.default_transaction_receiver).is_nil
+    end
   end
 
   class InitTests < UnitTests

data/test/unit/transaction_tests.rb

@@ -45,6 +45,12 @@ class MuchResult::Transaction
 
     should have_imeths :result, :call, :rollback, :halt
 
+    should "complain if given a nil receiver" do
+      assert_that(-> {
+        unit_class.new(nil, **kargs1)
+      }).raises(ArgumentError)
+    end
+
     should "know its result" do
       assert_that(subject.result).is_instance_of(MuchResult)
       assert_that(subject.result.value).equals(value1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: much-result
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kelly Redding
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: assert