yopt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da7d8098ce8b1dcc66d5e8f6ba3baf208daf805d
-  data.tar.gz: 6ae68982bb5ff8a3dc09cba07961c04e51b46fa3
+  metadata.gz: b2b1eaa4ca004e729d902f06b93fca46dd526175
+  data.tar.gz: 920c701a92b2f4a74698b376e81035d049d9bc74
 SHA512:
-  metadata.gz: 57fa46f4d6f766ac6fcd87a4b261fd049e8e3757c5578efa2851235b096f1086eb5cb1c801d0ca2dfa0266d6f5d593564677f4a170be22636cbcf3708517ddd9
-  data.tar.gz: 577ab29f9bdb5283d93941f24995c5d8b4cb02a7847faa2ff66e5018b8c7308f582adac0439ea1ff5c1dd7039fa68d32f8defed983b61dfd34122ddd0f043b0f
+  metadata.gz: 1fe9eed7ba9150bef20625b851109cfa872ed1b961ef3e9552126c200f841e45faf978b6d9f2539e516b236ef9a42ae224ccd260363430f75be15a63ae2f3d73
+  data.tar.gz: caff9b6961f3217f9d1894bda7bf30227026d86ff28fe043a20da52c05955c9837b93b9ce058a70d1e73583ba5b0294b9e18e1773190c898b73d49d7795f624d

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /vendor
 /yopt-0.1.0.gem
+/_site/

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 2.2.0
 before_install: gem install bundler -v 1.10.6

data/README.md

@@ -48,8 +48,16 @@ none.each {|value| puts value} # does not print anything
 We can safely retrieve the optional value by passing a default value to `Option#get_or_else`
 
 ```ruby
-some.get_or_else 0 # returns 42
-none.get_or_else 0 # returns 0
+some.get_or_else {0} # returns 42
+none.get_or_else {0} # returns 0
+```
+
+Notice how we are passing a block rather than an argument. This makes the evaluation of the default value lazy. In other words the block will only be evaluated if the caller in None.
+
+This gives us the possibility to react in a special way to a None value without breaking the API fluency, e.g.
+
+```ruby
+opt.each {|v| do_something_with(v)}.get_or_else {log_failure}
 ```
 
 We can also filter the optional value depending on how it evaluates against a block via `Option#select`
@@ -60,7 +68,7 @@ none.select {|value| value < 0} # returns None
 some.select {|value| value > 0} # returns Some(42)
 ```
 
-We can easily turn any object into an Option by means of `Option.call` - aliased to `Option.[]` for convenience.
+We can easily turn any object into an Option by means of `Option.call` - aliased to `Option[]` for convenience.
 For instance, this is useful when dealing with functions that might return `nil` to express the absence of a result.
 
 ```ruby
@@ -87,7 +95,7 @@ returns `c` if `opt` is `None`, and `f.(c, opt)` otherwise.
 
 This is a shortcut to
 ```
-opt.map{|v| f.(c,v)}.get_or_else(c)`
+opt.map{|v| f.(c,v)}.get_or_else {c}`
 ```
 
 
@@ -137,15 +145,15 @@ email_opt.zip(captcha_opt).each{|(email,_)| send_pass_recovery(email)}
 
 `Option#zip` returns `None` if any of the arguments is `None` or if the caller is `None`
 ```ruby
-Yopt::None.zip Option.[42] # None
-Option.[42].zip Yopt::None # None
-Option.[42].zip Option.[0], Yopt::None, Option.[-1] # None
+Yopt::None.zip Option[42] # None
+Option[42].zip Yopt::None # None
+Option[42].zip Option[0], Yopt::None, Option[-1] # None
 ```
 
 When both the caller and all the arguments are defined then `zip` collects all the values in an Array wrapped in a `Yopt::Some`
 
 ```ruby
-Option.[42].zip Option.[0], Option.["str"] # Some([42, 0, "str"])
+Option[42].zip Option[0], Option["str"] # Some([42, 0, "str"])
 ```
 
 
@@ -177,11 +185,11 @@ opt.filter(&is_positive).map {|v| Math.log(v)}
 
 Some (None?) might enjoy a comparison with Haskell's [Maybe](https://hackage.haskell.org/package/base/docs/Data-Maybe.html). Here is how the Data.Maybe API translate to Yopt.
 ```ruby
-maybe default f opt     -> opt.map(&f).get_or_else(default)
+maybe default f opt     -> opt.map(&f).get_or_else {default}
 isJust opt              -> not opt.empty?
 isNothing opt           -> opt.empty?
 fromJust opt            -> opt.get
-fromMaybe default opt   -> opt.get_or_else default
+fromMaybe default opt   -> opt.get_or_else {default}
 listToMaybe list        -> Option.ary_to_type list
 maybeToList opt         -> opt.to_a
 catMaybes listOfOptions -> listOfOptions.flatten

data/docs/README.template.md

@@ -48,8 +48,16 @@ none.each {|value| puts value} # does not print anything
 We can safely retrieve the optional value by passing a default value to `Option#get_or_else`
 
 ```ruby
-some.get_or_else 0 # returns 42
-none.get_or_else 0 # returns 0
+some.get_or_else {0} # returns 42
+none.get_or_else {0} # returns 0
+```
+
+Notice how we are passing a block rather than an argument. This makes the evaluation of the default value lazy. In other words the block will only be evaluated if the caller in None.
+
+This gives us the possibility to react in a special way to a None value without breaking the API fluency, e.g.
+
+```ruby
+opt.each {|v| do_something_with(v)}.get_or_else {log_failure}
 ```
 
 We can also filter the optional value depending on how it evaluates against a block via `Option#select`
@@ -60,7 +68,7 @@ none.select {|value| value < 0} # returns None
 some.select {|value| value > 0} # returns Some(42)
 ```
 
-We can easily turn any object into an Option by means of `Option.call` - aliased to `Option.[]` for convenience.
+We can easily turn any object into an Option by means of `Option.call` - aliased to `Option[]` for convenience.
 For instance, this is useful when dealing with functions that might return `nil` to express the absence of a result.
 
 ```ruby
@@ -87,7 +95,7 @@ returns `c` if `opt` is `None`, and `f.(c, opt)` otherwise.
 
 This is a shortcut to
 ```
-opt.map{|v| f.(c,v)}.get_or_else(c)`
+opt.map{|v| f.(c,v)}.get_or_else {c}`
 ```
 
 
@@ -137,15 +145,15 @@ email_opt.zip(captcha_opt).each{|(email,_)| send_pass_recovery(email)}
 
 `Option#zip` returns `None` if any of the arguments is `None` or if the caller is `None`
 ```ruby
-Yopt::None.zip Option.[42] # None
-Option.[42].zip Yopt::None # None
-Option.[42].zip Option.[0], Yopt::None, Option.[-1] # None
+Yopt::None.zip Option[42] # None
+Option[42].zip Yopt::None # None
+Option[42].zip Option[0], Yopt::None, Option[-1] # None
 ```
 
 When both the caller and all the arguments are defined then `zip` collects all the values in an Array wrapped in a `Yopt::Some`
 
 ```ruby
-Option.[42].zip Option.[0], Option.["str"] # Some([42, 0, "str"])
+Option[42].zip Option[0], Option["str"] # Some([42, 0, "str"])
 ```
 
 
@@ -177,11 +185,11 @@ opt.filter(&is_positive).map {|v| Math.log(v)}
 
 Some (None?) might enjoy a comparison with Haskell's [Maybe](https://hackage.haskell.org/package/base/docs/Data-Maybe.html). Here is how the Data.Maybe API translate to Yopt.
 ```ruby
-maybe default f opt     -> opt.map(&f).get_or_else(default)
+maybe default f opt     -> opt.map(&f).get_or_else {default}
 isJust opt              -> not opt.empty?
 isNothing opt           -> opt.empty?
 fromJust opt            -> opt.get
-fromMaybe default opt   -> opt.get_or_else default
+fromMaybe default opt   -> opt.get_or_else {default}
 listToMaybe list        -> Option.ary_to_type list
 maybeToList opt         -> opt.to_a
 catMaybes listOfOptions -> listOfOptions.flatten

data/lib/yopt.rb

@@ -47,11 +47,13 @@ module Yopt
       raise Option.invalid_argument('an Option', other) unless other.is_a? Option
       if empty? then other else self end
     end
-    def get_or_else default
-      if empty? then default else self.get end
+    def get_or_else
+      raise ArgumentError, 'missing block' unless block_given?
+      return self.get unless empty?
+      yield
     end
     def or_nil
-      get_or_else nil
+      get_or_else {nil}
     end
     def inspect() to_s end
     private

data/lib/yopt/version.rb

@@ -1,3 +1,3 @@
 module Yopt
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/yopt.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Yopt::VERSION
   spec.authors       = ["lorenzo.barasti"]
 
-  spec.summary       = %q{Scala-inspired Options for the idiomatic Rubyist.}
-  spec.description   = %q{This gem makes it possible to adopt the Option pattern in Ruby. It's meant to make conditional flow in our software clearer and more linear.}
-  spec.homepage      = "https://github.com/lbarasti/yopt"
+  spec.summary       = %q{Scala-inspired Options for the idiomatic Rubyist}
+  spec.description   = %q{The Option type models the possible absence of a value. It lets us deal with the uncertainty related to such a value being there without having to resort to errors or conditional blocks.}
+  spec.homepage      = "http://lbarasti.github.io/yopt"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -18,7 +18,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0'
+
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest", "~> 5.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yopt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - lorenzo.barasti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-23 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,18 +42,19 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: This gem makes it possible to adopt the Option pattern in Ruby. It's
-  meant to make conditional flow in our software clearer and more linear.
+        version: '5.8'
+description: The Option type models the possible absence of a value. It lets us deal
+  with the uncertainty related to such a value being there without having to resort
+  to errors or conditional blocks.
 email: 
 executables: []
 extensions: []
@@ -79,7 +80,7 @@ files:
 - lib/yopt.rb
 - lib/yopt/version.rb
 - yopt.gemspec
-homepage: https://github.com/lbarasti/yopt
+homepage: http://lbarasti.github.io/yopt
 licenses:
 - MIT
 metadata: {}
@@ -91,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -102,6 +103,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Scala-inspired Options for the idiomatic Rubyist.
+summary: Scala-inspired Options for the idiomatic Rubyist
 test_files: []
 has_rdoc: