errgonomic 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a07fce97adead2a0d6b77c83f0c80c06d6ecb6633193f61454d961bea1a4acf2
-  data.tar.gz: c6c66f5a03d8bea908b6b68cbe76c69f724012313348c3563bade4932946acc8
+  metadata.gz: 4dc41a36e372dc0af60cb4282d28c3fd92575c1b6999a41222e4be9623ead934
+  data.tar.gz: 6d5b368f9eabb77bfc1b3e459d18e29b6767681c08e83a77faf69df0bee7dcc0
 SHA512:
-  metadata.gz: 8d6d7dbac95eeea0d1fcb1bade820a2c7ba83e464dda0d79052a7beee9f9a67bc4c53c1b87b38256189ffd8f8d6bf0e8f40dc2055db1395f2bc227c30a2075bf
-  data.tar.gz: 522f8e75d45b543d1d8762be130d6a625dac1b8ac47a7b3eae5729649afedd8d0e493ecbb885b1aef42a887fc6a4a8ab4461ab0fd615d40d413b91da93da6ebf
+  metadata.gz: e9e9b29acfc45cbfee45957b864c2ca0498765bd37a2066cd516a012a2397c6b6962695f5ff8844d63aeeaf177014cb16235559153d0d107557f0e4c4e35f26d
+  data.tar.gz: 1484855cc2d7b22649679924958d34694e9e7726969d179147877ebaf31a34089e83c55881b330f3b63bfa8edf1a52f0598da5cc2439b3bf7795a9e96e97580d

data/README.md

@@ -55,7 +55,21 @@ TODO: Write usage instructions here
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+This project encourages **red, green, refactor** when making changes. First, add or change a test that captures the desired behavior; next, run the tests to observe the failure message, confirming the test is useful; next, make the smallest code change(s) to make the test pass. Once tests pass, review your diff and look for opportunities to simplify or improve abstractions; make changes and iterate, running tests on each change to guard against regressions.
+
+Run the doctest suite with:
+
+```bash
+nix develop -c yard doctest
+```
+
+Run all tests with:
+
+```
+nix develop -c rake
+```
 
 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).
 

data/Rakefile

@@ -2,8 +2,11 @@
 
 require 'bundler/gem_tasks'
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end
 
 require 'yard/doctest/rake'
 YARD::Doctest::RakeTask.new do |task|
@@ -11,4 +14,4 @@ YARD::Doctest::RakeTask.new do |task|
   task.pattern = 'lib/**/*.rb'
 end
 
-task default: %i[spec yard:doctest]
+task default: %i[test yard:doctest]

data/gemset.nix

@@ -269,7 +269,7 @@
       path = ./.;
       type = "path";
     };
-    version = "0.5.0";
+    version = "0.6.0";
   };
   erubi = {
     groups = ["default" "development"];

data/lib/errgonomic/option.rb

@@ -257,7 +257,7 @@ module Errgonomic
         return self if some?
 
         val = block.call
-        if !val.is_a?(Errgonomic::Option::Any) && Errgonomic.give_me_ambiguous_downstream_errors?
+        if !val.is_a?(Errgonomic::Option::Any) && !Errgonomic.give_me_ambiguous_downstream_errors?
           raise Errgonomic::ArgumentError.new, "block must return an Option, was #{val.class.name}"
         end
 
@@ -275,16 +275,17 @@ module Errgonomic
         other
       end
 
-      # If self is Some, call the given block and return its value. Block most return an Option.
+      # If self is Some, call the given block with the inner value and return
+      # its result. Block must return an Option.
       #
       # @example
-      #   None().and_then { Some(1) } # => None()
-      #   Some(2).and_then { Some(3) } # => Some(3)
+      #   None().and_then { |x| Some(x + 1) } # => None()
+      #   Some(2).and_then { |x| Some(x + 1) } # => Some(3)
       def and_then(&block)
         return self if none?
 
-        val = block.call
-        if Errgonomic.give_me_ambiguous_downstream_errors? && !val.is_a?(Errgonomic::Option::Any)
+        val = block.call(value)
+        if !Errgonomic.give_me_ambiguous_downstream_errors? && !val.is_a?(Errgonomic::Option::Any)
           raise Errgonomic::ArgumentError.new, "block must return an Option, was #{val.class.name}"
         end
 

data/lib/errgonomic/rails.rb

@@ -15,12 +15,9 @@ module Errgonomic
       ActiveRecord::Base.include(Errgonomic::Rails::ActiveRecordDelegateOptional)
     end
 
-    # Wrapping optional associations requires that we include the module after
-    # the class is first evaluated, so that it can define its associations for
-    # later reflection.
-    def self.setup_after
-      # todo
-    end
+    # Models opt in to ActiveRecordOptional individually via
+    # `include Errgonomic::Rails::ActiveRecordOptional`.
+    def self.setup_after; end
   end
 
   # Hook into Rails with a Railtie

data/lib/errgonomic/result.rb

@@ -142,7 +142,7 @@ module Errgonomic
         return self if err?
 
         res = block.call(value)
-        if !res.is_a?(Errgonomic::Result::Any) && Errgonomic.give_me_ambiguous_downstream_errors?
+        if !res.is_a?(Errgonomic::Result::Any) && !Errgonomic.give_me_ambiguous_downstream_errors?
           raise Errgonomic::ArgumentError, 'and_then block must return a Result'
         end
 
@@ -173,20 +173,18 @@ module Errgonomic
       # Sorry about that, hopefully it helps your tests. Better than ambiguous
       # downstream "undefined method" errors, probably.
       #
-      # TODO yield the Err
-      #
       # @param block [Proc]
       #
       # @example
-      #   Ok(1).or_else { Ok(2) } # => Ok(1)
-      #   Err(:o).or_else { Ok(1) } # => Ok(1)
-      #   Err(:q).or_else { Err(:r) } # => Err(:r)
-      #   Err(:s).or_else { "oops" } # => raise Errgonomic::ArgumentError, "or_else block must return a Result"
+      #   Ok(1).or_else { |e| Ok(2) } # => Ok(1)
+      #   Err(:o).or_else { |e| Ok(1) } # => Ok(1)
+      #   Err(:q).or_else { |e| Err(:r) } # => Err(:r)
+      #   Err(:s).or_else { |e| "oops" } # => raise Errgonomic::ArgumentError, "or_else block must return a Result"
       def or_else(&block)
         return self if ok?
 
-        res = block.call(self)
-        if !res.is_a?(Errgonomic::Result::Any) && Errgonomic.give_me_ambiguous_downstream_errors?
+        res = block.call(value)
+        if !res.is_a?(Errgonomic::Result::Any) && !Errgonomic.give_me_ambiguous_downstream_errors?
           raise Errgonomic::ArgumentError, 'or_else block must return a Result'
         end
 
@@ -249,8 +247,7 @@ module Errgonomic
       def map(&block)
         return self if err?
 
-        @value = block.call(value)
-        self
+        Ok(block.call(value))
       end
 
       # Refuse to serialize an unwrapped Result as a String. Results must be

data/lib/errgonomic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Errgonomic
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/errgonomic.rb

@@ -27,10 +27,12 @@ module Errgonomic
 
   class NotPresentError < Error; end
 
-  class TypeMismatchError < TypeError; end
+  class TypeMismatchError < Error; end
 
   class UnwrapError < Error
-    def initialize(msg, value)
+    attr_reader :value
+
+    def initialize(msg, value = nil)
       super(msg)
       @value = value
     end
@@ -47,8 +49,9 @@ module Errgonomic
   class SerializeError < TypeError; end
 
   # A little bit of control over how pedantic we are in our runtime type checks.
+  # Default is false: we are pedantic and raise errors on type mismatches.
   def self.give_me_ambiguous_downstream_errors?
-    @give_me_ambiguous_downstream_errors || true
+    !!@give_me_ambiguous_downstream_errors
   end
 
   # You can opt out of the pedantic runtime checks for lazy block evaluation,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errgonomic
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nick Zadrozny