unexceptional 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 843955cd99c06a932f0594cc96ffa64488cd596a
+  data.tar.gz: 38523fd3cd5282fa9bcd44ad8dd6048ed4f94089
+SHA512:
+  metadata.gz: 4188134219b235eba0f0dc541adc67b360ac723f31d8be8e945202cb1afa9d4f088f3e2a760272da71be0b624fae767a7704995d580dc578441feb6865e085b1
+  data.tar.gz: fd32c477e1a02bb7317fb51e87d1b9cc00cf956ab4cc3479bac8a93689968d07bf7ab75c351d65033e86a4534ab37b1eea97973276eff4d773eed19b69ac8c8c

data/lib/unexceptional.rb

@@ -0,0 +1,201 @@
+module Unexceptional
+  class Result
+    # Pass true or false and an error value. If the first argument is true, returns an ok
+    # Result. If the first argument is false, returns an err Result wrapping the error
+    # value.
+    def self.check(condition, error)
+      condition ? ok : err(error)
+    end
+  
+    # Returns a new Result respresenting failure. Optionally pass a wrapped result value.
+    def self.err(err)
+      new false, nil, err
+    end
+  
+    # Pass a block and a collection. The block must accept a member of the collection and
+    # return a Result.
+    # 
+    # If all members succeed, returns a Result wrapping all the mapped members:
+    #
+    #     Result.map([1, 2]) do |i|
+    #       Result.ok i * 2
+    #     end
+    #     # => Result.ok([1, 2])
+    # 
+    # Aborts on the first failure:
+    #
+    #     Result.map([1, 2, 3]) do |i|
+    #       if i == 2
+    #         Result.err '2 is invalid'
+    #       elsif i == 3
+    #         raise 'This is never executed because Result.map aborts on the previous element.'
+    #       else
+    #         Result.ok i * 2
+    #       end
+    #     end
+    #     # => Result.err('2 is invalid')
+    def self.map_while(collection)
+      Result.ok(
+        collection.map do |member|
+          result = yield member
+          if result.err?
+            return result
+          else
+            result.unwrap
+          end
+        end
+      )
+    end
+    
+    # Returns a new Result respresenting success. Optionally pass a wrapped result value.
+    def self.ok(val = nil)
+      new true, val, nil
+    end
+  
+    # Given a block, runs an ActiveRecord transaction. The block must return a Result. If
+    # the Result is an error, rolls back the transaction. Either way, returns the Result.
+    # You must call `require 'active_record` before you call this method.
+    def self.transaction
+      unless defined?(ActiveRecord)
+        raise 'ActiveRecord is not defined'
+      end
+      result = nil
+      ActiveRecord::Base.transaction do
+        result = yield
+        if result.err?
+          raise ActiveRecord::Rollback
+        end
+      end
+      result
+    end
+    
+    # Tries to run a list of procs, aborting on the first failure, if any. Each proc must
+    # return a Result--either ok or err. Aborts on the first err, if any, returning the
+    # failed Result. If all procs return ok, returns the last Result.
+    # 
+    #    Result.try(
+    #      ->    { Result.ok 2 },
+    #      ->(i) { Result.ok 3 * i }
+    #    )
+    #    # => Result.ok(6)
+    #    
+    #    Result.try(
+    #      ->    { Result.ok 2 },
+    #      ->(_) { Result.err :uh_oh },
+    #      ->(i) { Result.ok 3 * i }
+    #    )
+    #    # => Result.err(:uh_oh)
+    # 
+    # You can also pass tuples through and pattern-match:
+    # 
+    #    Result.try(
+    #      ->         { Result.ok [1, 2] },
+    #      ->((a, b)) { Result.ok a + b }
+    #    )
+    #    # => Result.ok(3)
+    def self.try(*procs)
+      if procs.empty?
+        raise 'Must past at least one proc to Result.try'
+      end
+      procs.inject(nil) do |last_result, proc|
+        if last_result.nil?
+          proc.call
+        elsif last_result.ok?
+          if proc.parameters.length == 0
+            proc.call
+          else
+            proc.call last_result.unwrap
+          end
+        else
+          last_result
+        end
+      end
+    end
+    
+    # If this Result is an err, returns self:
+    #
+    #     Result
+    #       .err(:uh_oh)
+    #       .and_then { 'This block never executes' }
+    #     # => Result.err(:uh_oh)
+    # 
+    # If this Result is ok, then the behavior depends on what you passed to `and_then`:
+    # 
+    #     # Passing a single argument:
+    #     Result
+    #       .ok('This value gets dropped')
+    #       .and_then(Result.ok('This is the final value'))
+    #     # => Result.ok('This is the final value')
+    #     
+    #     # Passing a block:
+    #     Result
+    #       .ok(3)
+    #       .and_then { |v| v * 2 }
+    #     # => Result.ok(6)
+    #     
+    #     # Passing nothing:
+    #     Result
+    #       .ok('This value gets dropped')
+    #       .and_then
+    #     # => Result.ok
+    def and_then(next_result = nil)
+      if @ok
+        if block_given?
+          yield
+        elsif next_result
+          next_result
+        else
+          Result.ok
+        end
+      else
+        self
+      end
+    end
+    
+    # Yields this Result if this Result is an err.
+    def if_err
+      yield self.err if !@ok
+      self
+    end
+    
+    # Yields this Result if this Result is ok.
+    def if_ok
+      yield self.val if @ok
+      self
+    end
+    
+    # Returns the wrapped err value. Raises if this Result is ok.
+    def err
+      if !@ok
+        @err
+      else
+        raise "Called #err, but Result was ok."
+      end
+    end
+  
+    # Returns true if this Result is an err, false if this Result is ok.
+    def err?
+      !@ok
+    end
+    
+    def initialize(ok, val, err) # :nodoc:
+      @ok = ok
+      @val = val
+      @err = err
+    end
+  
+    # Returns true if this Result is ok, false if this Result is an err.
+    def ok?
+      @ok
+    end
+    
+    # Returns the wrapped success value. Raises if this Result is an err.
+    def unwrap
+      if @ok
+        @val
+      else
+        raise "Called #unwrap on error: #{@err.inspect}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: unexceptional
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Jarrett Colby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Provides a Result class for more elegant, exception-free error handling.
+  Especially useful for processing input that could be invalid for many different
+  reasons.
+email: jarrett@madebyhq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/unexceptional.rb
+homepage: https://github.com/jarrett/unexceptional
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Unexceptional
+test_files: []