fear 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79938c2515814ea5906a6ddba5c880b3ba7f8f57
-  data.tar.gz: 5393d7b3acf1714ccfa95db7dc2b3d947b49c7dc
+  metadata.gz: 6ed9cfc50bd85c7975607f880037044e5bba3aad
+  data.tar.gz: 908994c021e427c5ec6724581f7355a7cf754f39
 SHA512:
-  metadata.gz: 18f67b3306834c6d5fdbfc698eab233252855c3d0d0e1425f8eabe0e5489a25171c96584491f23d529b6d134cd829f6f4d6ffb0059d6a1f5a959772afecf90e5
-  data.tar.gz: 404f270b34607bd5ba35d1ced38c9a130a98c8aee0d0dd6d2e5a2118f434d3d00c24489e5b736851fc89fc91ecfff33cef9db31ad889db59443689c9e778746d
+  metadata.gz: e7d901c611b11fc3f90c9c6cd252cb1cb62a1e36bdd1ff825d4412fa5aecd7054de4c3c562bb56b8692130f436c85ab88e81b7247a7ec691895b656de27b4a24
+  data.tar.gz: 1d5b23551ce259c08834b62e1cc0956bf09c7fc31c4d5af56e80b625efe56f079f9f9311216b5c76d5d8cd1dfe64bdf87090c9d393f9e5097cf7a479713dd2a0

data/.rubocop.yml

@@ -9,3 +9,7 @@ Style/Documentation:
 
 Style/CaseEquality:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.6.0
+
+* Added `Either#or_else` and `Option#or_else`. `Try#or_else` may accept only block ([@bolshakov][])
+  
+[@bolshakov]: https://github.com/bolshakov

data/README.md

@@ -23,9 +23,9 @@ Or install it yourself as:
 
 ## Usage
 
-### Option
+### Option ([Documentation](http://www.rubydoc.info/github/bolshakov/fear/master/Fear/Option))
 
-Represents optional values. Instances of `Option` are either an instance of 
+Represents optional (nullable) values. Instances of `Option` are either an instance of 
 `Some` or the object `None`.
 
 The most idiomatic way to use an `Option` instance is to treat it
@@ -34,17 +34,22 @@ as a collection and use `map`, `flat_map`, `select`, or `each`:
 ```ruby
 include Fear::Option::Mixin
 
-name = Option(params[:name])
-upper = name.map(&:strip).select { |n| n.length != 0 }.map(&:upcase)
-puts upper.get_or_else('')
+def normalize_name(name)
+  Option(name)
+    .map(&:strip)
+    .select { |n| n.length != 0 }
+    .map(&:upcase)
+    .get_or_else('NONAME')
+end
+
+normalize_name('robert paulson ') #=> 'ROBERT PAULSON'
+normalize_name(nil) #=> 'NONAME' 
 ```
 
 This allows for sophisticated chaining of `Option` values without
 having to check for the existence of a value.
 
-See full documentation [Fear::Option](http://www.rubydoc.info/github/bolshakov/fear/master/Fear/Option)
-
-### Try
+### Try ([Documentation](http://www.rubydoc.info/github/bolshakov/fear/master/Fear/Try))
 
 The `Try` represents a computation that may either result in an exception, 
 or return a successfully computed value.  Instances of `Try`, are either 
@@ -60,19 +65,17 @@ include Fear::Try::Mixin
 dividend = Try { Integer(params[:dividend]) }
 divisor = Try { Integer(params[:divisor]) }
 
-problem = dividend.flat_map { |x| divisor.map { |y| x / y }
+result = dividend.flat_map { |x| divisor.map { |y| x / y } }
 
-if problem.success?
-  puts "Result of #{dividend.get} / #{divisor.get} is: #{problem.get}"
+if result.success?
+  puts "Result of #{dividend.get} / #{divisor.get} is: #{result.get}"
 else
   puts "You must've divided by zero or entered something wrong. Try again"
-  puts "Info from the exception: #{problem.exception.message}"
+  puts "Info from the exception: #{result.exception.message}"
 end
 ```
 
-See full documentation [Fear::Try](http://www.rubydoc.info/github/bolshakov/fear/master/Fear/Try)
-
-### Either
+### Either ([Documentation](http://www.rubydoc.info/github/bolshakov/fear/master/Fear/Either))
 
 Represents a value of one of two possible types (a disjoint union.)
 An instance of `Either` is either an instance of `Left` or `Right`.
@@ -102,9 +105,7 @@ puts(
     -> (x) { "You passed me the String: #{x}" }
   )
 )
-```
-  
-See full documentation [Fear::Either](http://www.rubydoc.info/github/bolshakov/fear/master/Fear/Either)
+``` 
   
 ### For composition
 
@@ -115,31 +116,36 @@ is supported by `For`.
 ```ruby
 include Fear::For::Mixin
 
-For(a: Some(2), b: Some(3)) do 
-  a * b 
-end #=> Some(6)
+def divide(dividend, divisor)
+  For(x: dividend, y: divisor) do 
+    x / y
+  end
+end
+
+dividend = Try { Integer(params[:dividend]) } #=> Try(4)
+divisor = Try { Integer(params[:divisor]) } #=> Try(2)
+
+divide(dividend, divisor) #=> Try(2)
 ```
 
 It would be translated to 
 
 ```ruby
-Some(2).flat_map do |a|
-  Some(3).map do |b|
-    a * b
+Success(4).flat_map do |x|
+  Success(2).map do |y|
+    x / y
   end
 end
 ```
 
-If one of operands is None, the result is None
+If one of operands is Failure, the result is Failure
 
 ```ruby
-For(a: Some(2), b: None()) do
-  a * b
-end  #=> None()
 
-For(a: None(), b: Some(2)) do 
-  a * b 
-end #=> None()
+dividend = Try { 42 }
+divisor = Try { Integer('ehuton') }
+
+divide(dividend, divisor) #=> Failure(<ArgumentError: invalid value for Integer(): "ehuton">)
 ```
 
 `For` works with arrays as well
@@ -194,9 +200,9 @@ provides a bunch of rspec matchers.
 
 ## Alternatives
 
-* [dry-monads](https://github.com/dry-rb/dry-monads)
 * [deterministic](https://github.com/pzol/deterministic)
-* [ruby-possibly](https://github.com/rap1ds/ruby-possibly)
+* [dry-monads](https://github.com/dry-rb/dry-monads)
 * [kleisli](https://github.com/txus/kleisli)
+* [maybe](https://github.com/bhb/maybe)
+* [ruby-possibly](https://github.com/rap1ds/ruby-possibly)
 * [rumonade](https://github.com/ms-ati/rumonade)
-

data/fear.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'spbtv_code_style'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop-rspec', '1.13.0'
+  spec.add_development_dependency 'rubocop', '0.47.1'
   spec.add_development_dependency 'simplecov'
 end

data/lib/fear/either.rb

@@ -45,6 +45,14 @@ module Fear
   #       Right(42).get_or_else(12)         #=> 42
   #       Left('undefined').get_or_else(12) #=> 12
   #
+  # @!method or_else(&alternative)
+  #   Returns this +Right+ or the given alternative if this is a +Left+.
+  #   @return [Either]
+  #   @example
+  #     Right(42).or_else { Right(21) }           #=> Right(42)
+  #     Left('unknown').or_else { Right(21) }     #=> Right(21)
+  #     Left('unknown').or_else { Left('empty') } #=> Left('empty')
+  #
   # @!method include?(other_value)
   #   Returns +true+ if +Right+ has an element that is equal
   #   (as determined by +==+) to +other_value+, +false+ otherwise.
@@ -206,7 +214,7 @@ module Fear
   #     Left("flower").join_right        #=> Left("flower")
   #     Left(Right("flower")).join_right #=> Left(Right("flower"))
   #
-  # # @!method join_right
+  # @!method join_right
   #   Joins an +Either+ through +Left+. This method requires
   #   that the left side of this +Either+ is itself an
   #   +Either+ type.

data/lib/fear/failure.rb

@@ -27,8 +27,8 @@ module Fear
     end
 
     # @return [Try] of calling block
-    def or_else
-      Success.new(yield)
+    def or_else(*args)
+      super
     rescue => error
       Failure.new(error)
     end

data/lib/fear/option.rb

@@ -42,6 +42,14 @@ module Fear
   #       Some(42).get_or_else(12)  #=> 42
   #       None().get_or_else(12)    #=> 12
   #
+  # @!method or_else(&alternative)
+  #   Returns this +Some+ or the given alternative if this is a +None+.
+  #   @return [Option]
+  #   @example
+  #     Some(42).or_else { Some(21) } #=> Some(42)
+  #     None().or_else { Some(21) }   #=> Some(21)
+  #     None().or_else { None() }     #=> None()
+  #
   # @!method include?(other_value)
   #   Returns +true+ if it has an element that is equal
   #   (as determined by +==+) to +other_value+, +false+ otherwise.

data/lib/fear/right_biased.rb

@@ -11,6 +11,15 @@ module Fear
         super
       end
 
+      # Returns this `RightBiased::Right` or the given alternative if
+      # this is a `RightBiased::Left`.
+      def or_else(*args, &block)
+        Utils.assert_arg_or_block!('or_else', *args, &block)
+        super.tap do |result|
+          Utils.assert_type!(result, left_class, right_class)
+        end
+      end
+
       def flat_map
         super.tap do |result|
           Utils.assert_type!(result, left_class, right_class)
@@ -43,6 +52,11 @@ module Fear
         value
       end
 
+      # @return [self]
+      def or_else
+        self
+      end
+
       # @param [any]
       # @return [Boolean]
       def include?(other_value)
@@ -112,6 +126,13 @@ module Fear
         args.fetch(0) { yield }
       end
 
+      # @!method get_or_else(&alternative)
+      #   @return [RightBiased] result of evaluating a block.
+      #
+      def or_else(*_args)
+        yield
+      end
+
       # @param [any]
       # @return [false]
       #

data/lib/fear/try.rb

@@ -13,7 +13,7 @@ module Fear
   #
   #   dividend = Try { Integer(params[:dividend]) }
   #   divisor = Try { Integer(params[:divisor]) }
-  #   problem = dividend.flat_map { |x| divisor.map { |y| x / y }
+  #   problem = dividend.flat_map { |x| divisor.map { |y| x / y } }
   #
   #   if problem.success?
   #     puts "Result of #{dividend.get} / #{divisor.get} is: #{problem.get}"
@@ -144,14 +144,13 @@ module Fear
   #     Success(42).get                 #=> 42
   #     Failure(ArgumentError.new).get  #=> ArgumentError: ArgumentError
   #
-  # @!method or_else(&default)
-  #   Returns this +Try+ if it's a +Success+ or the given default
-  #   argument if this is a +Failure+.
+  # @!method or_else(&alternative)
+  #   Returns this +Try+ if it's a +Success+ or the given alternative if this is a +Failure+.
   #   @return [Try]
   #   @example
-  #     Success(42).or_else { -1 }                 #=> Success(42)
-  #     Failure(ArgumentError.new).or_else { -1 }  #=> Success(-1)
-  #     Failure(ArgumentError.new).or_else { 1/0 } #=> Failure(ZeroDivisionError.new('divided by 0'))
+  #     Success(42).or_else { Success(-1) }                 #=> Success(42)
+  #     Failure(ArgumentError.new).or_else { Success(-1) }  #=> Success(-1)
+  #     Failure(ArgumentError.new).or_else { Try { 1/0 } }  #=> Failure(ZeroDivisionError.new('divided by 0'))
   #
   # @!method flatten
   #   Transforms a nested +Try+, ie, a +Success+ of +Success+,

data/lib/fear/version.rb

@@ -1,3 +1,3 @@
 module Fear
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/spec/fear/failure_spec.rb

@@ -28,7 +28,7 @@ RSpec.describe Fear::Failure do
 
   describe '#or_else' do
     context 'default does not fail' do
-      subject { failure.or_else { 'value' } }
+      subject { failure.or_else { Fear::Success.new('value') } }
       it { is_expected.to eq(Fear::Success.new('value')) }
     end
 

data/spec/fear/left_spec.rb

@@ -39,6 +39,15 @@ RSpec.describe Fear::Left do
     end
   end
 
+  describe '#or_else' do
+    subject { left.or_else { alternative } }
+    let(:alternative) { Left(42) }
+
+    it 'returns alternative' do
+      is_expected.to eq(alternative)
+    end
+  end
+
   describe '#select' do
     subject do
       left.select { |v| v == 'value' }
@@ -95,7 +104,7 @@ RSpec.describe Fear::Left do
       let(:either) { described_class.new(value) }
       let(:value) { Left('error') }
 
-      it 'it returns value' do
+      it 'returns value' do
         is_expected.to eq(Left('error'))
       end
     end

data/spec/fear/none_spec.rb

@@ -17,6 +17,15 @@ RSpec.describe Fear::None do
     it { is_expected.to eq(nil) }
   end
 
+  describe '#or_else' do
+    subject { none.or_else { alternative } }
+    let(:alternative) { Some(42) }
+
+    it 'returns alternative' do
+      is_expected.to eq(alternative)
+    end
+  end
+
   describe '#empty?' do
     subject { none.empty? }
     it { is_expected.to eq(true) }

data/spec/fear/right_biased/right.rb

@@ -41,6 +41,16 @@ RSpec.shared_examples Fear::RightBiased::Right do
     end
   end
 
+  describe '#or_else' do
+    it 'does not call block' do
+      expect { |probe| right.or_else(&probe) }.not_to yield_control
+    end
+
+    it 'returns the same object' do
+      expect(right.or_else { 42 }).to eql(right)
+    end
+  end
+
   describe '#map' do
     subject { right.map(&:length) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fear
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Tema Bolshakov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-25 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
@@ -84,16 +84,30 @@ dependencies:
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.47.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +134,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -172,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: "%q{Ruby port of some Scala's monads.}"