ok_nok 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9710785601667b0220dd5d1d211af18f6006a228
-  data.tar.gz: 8b31d1c24fc43e1b66f694fe10a7ac83dba18a8c
+SHA256:
+  metadata.gz: 2d85d1c1ea684abde0dba07ad461742fd98c434ed2de2132589949921b7b788f
+  data.tar.gz: 229a500ba0cd3bc06d632fb3b1e7f676b10f020a33ab0809bbe595a8b617302f
 SHA512:
-  metadata.gz: a112205b4b1b45ab0cf912e5d08da6df6f384cb5895ddae2ceff5d796c6de9de8a845eac3b2f55ee99d21dcff8c530f3af02817f8d707f3911daf0d1aa1573db
-  data.tar.gz: 40f3f6b11423464712d9471233bf9a4a4c875117c128b7917f6723b286b1ce5ab4d06181591837858f6882335323db0dac1ce29c65cf3778618de547fd35e86c
+  metadata.gz: a7666aaee0f0542c6116f0e49d7f0f984497ee5ddfa24fb9ac7cca9f9292e8685ef8be4f6c114bcc357608bec049fed8e84f50447632a2f50c7521acc7306971
+  data.tar.gz: 718eac86750e033b83e3753926f1156f22bfe0782da971e55fde72aca3338cf91a0c1511e68883024ef0e978b9ed03f9e54c60a5e0aa37e3ecee434551c4fe3a

data/.gitignore

@@ -1,37 +1,37 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-.project
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.project

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ok_nok (0.0.1)
+    ok_nok (0.0.2)
 
 GEM
   remote: http://rubygems.org/
@@ -23,7 +23,11 @@ GEM
 
 PLATFORMS
   x86-mingw32
+  x86_64-darwin-21
 
 DEPENDENCIES
   ok_nok!
-  rspec
+  rspec (~> 3.0, >= 3.0.0)
+
+BUNDLED WITH
+   2.4.8

data/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 patrick-gleeson
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2015 patrick-gleeson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,73 +1,72 @@
-# ok_nok
-A utility for adding a variant of functional-style Either return values to Ruby code.
-
-[![Codeship Status for patrick-gleeson/ok_nok](https://www.codeship.io/projects/e971b5a0-e9b3-0132-e2ca-4602e60b2e9f/status?branch=master)](https://www.codeship.io/projects/82985)
-
-##Rationale
-Functional programming includes the concept of the Either, a return value that has a Left or a Right. Traditionally a populated Left value represents failure, and can contain information about the failure and a populated Right represents success.
-That's nicely generic, but it's also hard to read and unintuitive unless you're used to the syntax.
-
-It's very common in MVC apps in particular to want to return either a successful result or nothing - e.g. when retrieving a Model object by ID from a database. 
-The Option type, which returns either a Some instance or a None object, is designed to handle this, but it lacks the any way of indicating what went wrong in a None situation.
-
-So what we're looking for is a neat way of either returning a value if an operation completed successfully, or returning an error explanation if it didn't. And we want it to be impossible to mistake the error explanation for a valid returned result.
-
-Either classes are too generic, as are Scala-style tuples. Option classes are too limited. Raising Exceptions is a bit heavy-handed. Presenting, then, ok_nok.
-
-##Installation
-(Coming soon)
-As per any gem, add `gem 'ok_nok'` to your gemfile and `bundle` yourself, or just run `gem install ok_nok`
-
-##Usage
-An ok_nok function always returns an instance of OkNok, whose status is set to either `ok` or `nok` (not ok). `ok` and `nok` methods monkey-patched into the Object class make this easy, e.g.:
-
-    def multiple_foos(multiplier)
-      if (intified = Integer(multiplier) rescue false)
-        ok("foo" * intified)
-      else
-        nok("'#{multiplier}' can't be converted to an Integer so can't be used to multiply foo")
-      end
-    end
-    
-At the most basic level you can then query the OkNok object about its status, like so:
-
-    result = multiple_foos(gets)
-    if result.ok?
-      puts result.value
-    else
-      puts "Uh-Oh! #{result.value}"
-    end
-    
-But OkNoks also enable other, slightly more convenient control structures, e.g.:
-
-    result = multiple_foos(gets).value_or_if_nok do |nok_value|
-      # The code here only gets executed if multiple_foos is not ok
-    end
-    
-    # result will be either the ok value, or the return value of the block
-    
-Also you can do:
-
-    multiple_foos(gets).ok {|ok_value| 
-      #This block gets called if multiple_foos is ok 
-    }.nok {|nok_value| 
-      #This block gets called if multiple_foos is not ok
-    }
-    
-You can wrap a block in an OkNok, if you specify what a nok result looks like:
-
-    result = OkNok.nok_if(nil, "No 'e' was found") do
-      gets.index("e")
-    end
-    
-Finally, you can wrap a block in an OkNok and have it return a nok only if an exception is raised
-
-    result = OkNok.nok_if_exception("Uh-oh, my block raised an exception") do
-      Integer(gets)
-    end
-
-Note that in the above examples the nok value has been a user-friendly error message string. Of course, this could be a L10n key, a symbol, a Proc, or any sort of object that helps you deal with not-ok scenarios.
-
-
-##Licence
-Licensed under the MIT licence.
+# ok_nok
+A utility for adding a variant of functional-style Either return values to Ruby code.
+
+[![Codeship Status for patrick-gleeson/ok_nok](https://www.codeship.io/projects/e971b5a0-e9b3-0132-e2ca-4602e60b2e9f/status?branch=master)](https://www.codeship.io/projects/82985)
+
+##Rationale
+Functional programming includes the concept of the Either, a return value that has a Left or a Right. Traditionally a populated Left value represents failure, and can contain information about the failure and a populated Right represents success.
+That's nicely generic, but it's also hard to read and unintuitive unless you're used to the syntax.
+
+It's very common in MVC apps in particular to want to return either a successful result or nothing - e.g. when retrieving a Model object by ID from a database. 
+The Option type, which returns either a Some instance or a None object, is designed to handle this, but it lacks the any way of indicating what went wrong in a None situation.
+
+So what we're looking for is a neat way of either returning a value if an operation completed successfully, or returning an error explanation if it didn't. And we want it to be impossible to mistake the error explanation for a valid returned result.
+
+Either classes are too generic, as are Scala-style tuples. Option classes are too limited. Raising Exceptions is a bit heavy-handed. Presenting, then, ok_nok.
+
+##Installation
+As per any gem published on RubyGems, add `gem 'ok_nok'` to your gemfile and do a command line `bundle`, or just run `gem install ok_nok`.
+
+##Usage
+An ok_nok function always returns an instance of OkNok, whose status is set to either `ok` or `nok` (not ok). `ok` and `nok` methods monkey-patched into the Object class make this easy, e.g.:
+
+    def multiple_foos(multiplier)
+      if (intified = Integer(multiplier) rescue false)
+        ok("foo" * intified)
+      else
+        nok("'#{multiplier}' can't be converted to an Integer so can't be used to multiply foo")
+      end
+    end
+    
+At the most basic level you can then query the OkNok object about its status, like so:
+
+    result = multiple_foos(gets)
+    if result.ok?
+      puts result.value
+    else
+      puts "Uh-Oh! #{result.value}"
+    end
+    
+But OkNoks also enable other, slightly more convenient control structures, e.g.:
+
+    result = multiple_foos(gets).value_or_if_nok do |nok_value|
+      # The code here only gets executed if multiple_foos is not ok
+    end
+    
+    # result will be either the ok value, or the return value of the block
+    
+Also you can do:
+
+    multiple_foos(gets).ok {|ok_value| 
+      #This block gets called if multiple_foos is ok 
+    }.nok {|nok_value| 
+      #This block gets called if multiple_foos is not ok
+    }
+    
+You can wrap a block in an OkNok, if you specify what a nok result looks like:
+
+    result = OkNok.nok_if(nil, "No 'e' was found") do
+      gets.index("e")
+    end
+    
+Finally, you can wrap a block in an OkNok and have it return a nok only if an exception is raised
+
+    result = OkNok.nok_if_exception("Uh-oh, my block raised an exception") do
+      Integer(gets)
+    end
+
+Note that in the above examples the nok value has been a user-friendly error message string. Of course, this could be a L10n key, a symbol, a Proc, or any sort of object that helps you deal with not-ok scenarios.
+
+
+##Licence
+Licensed under the MIT licence.

data/lib/ok_nok/object_extensions.rb

@@ -1,11 +1,11 @@
-module OkNok
-  module ObjectExtensions
-    def ok(value)
-      OkNok::Returnable.new(OkNok::OK, value)
-    end
-    
-    def nok(value)
-      OkNok::Returnable.new(OkNok::NOK, value)
-    end
-  end
-end
+module OkNok
+  module ObjectExtensions
+    def ok(value)
+      OkNok::Returnable.new(OkNok::OK, value)
+    end
+    
+    def nok(value)
+      OkNok::Returnable.new(OkNok::NOK, value)
+    end
+  end
+end

data/lib/ok_nok/returnable.rb

@@ -1,44 +1,44 @@
-module OkNok
-  class Returnable
-    attr_reader :status, :value
-    
-    def initialize(status, value)
-      raise ArgumentError, "Status must be OkNok::OK or OkNok::NOK" unless [OkNok::OK, OkNok::NOK].include? status
-      @status, @value = status, value
-    end
-    
-    def ok?
-      @status == OkNok::OK
-    end
-    
-    def nok?
-      @status == OkNok::NOK
-    end
-    
-    def value_or_if_nok
-      return value if ok?
-      return nil unless block_given?
-      yield value
-    end
-    
-    def value_or_if_ok
-      return value if nok?
-      return nil unless block_given?
-      yield value
-    end
-    
-    def ok
-      if ok?
-        yield value if block_given?
-      end
-      return self
-    end
-    
-    def nok
-      if nok?
-        yield value if block_given?
-      end
-      return self
-    end
-  end
-end
+module OkNok
+  class Returnable
+    attr_reader :status, :value
+    
+    def initialize(status, value)
+      raise ArgumentError, "Status must be OkNok::OK or OkNok::NOK" unless [OkNok::OK, OkNok::NOK].include? status
+      @status, @value = status, value
+    end
+    
+    def ok?
+      @status == OkNok::OK
+    end
+    
+    def nok?
+      @status == OkNok::NOK
+    end
+    
+    def value_or_if_nok
+      return value if ok?
+      return nil unless block_given?
+      yield value
+    end
+    
+    def value_or_if_ok
+      return value if nok?
+      return nil unless block_given?
+      yield value
+    end
+    
+    def ok
+      if ok?
+        yield value if block_given?
+      end
+      return self
+    end
+    
+    def nok
+      if nok?
+        yield value if block_given?
+      end
+      return self
+    end
+  end
+end

data/lib/ok_nok/statuses.rb

@@ -1,4 +1,4 @@
-module OkNok
-  OK = :ok
-  NOK = :nok
-end
+module OkNok
+  OK = :ok
+  NOK = :nok
+end

data/lib/ok_nok/version.rb

@@ -1,3 +1,3 @@
 module OkNok
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/ok_nok.rb

@@ -6,13 +6,13 @@ module OkNok
   def ok(value)
     OkNok::Returnable.new(OkNok::OK, value)
   end
-  
+
   def nok(value)
     OkNok::Returnable.new(OkNok::NOK, value)
   end
-  
+
   def self.nok_if(comparison_value, nok_value)
-    raise ArgumentError, "You must provide a block" unless block_given?
+    raise ArgumentError, "You must provide a block." unless block_given?
     block_result = yield
     if block_result == comparison_value
       nok nok_value
@@ -20,9 +20,9 @@ module OkNok
       ok block_result
     end
   end
-  
+
   def self.nok_if_exception(nok_value)
-    raise ArgumentError, "You must provide a block" unless block_given?
+    raise ArgumentError, "You must provide a block." unless block_given?
     begin
       ok yield
     rescue StandardError

data/ok_nok.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "ok_nok"
   s.version     = OkNok::VERSION
   s.authors     = ["Patrick Gleeson"]
-  s.email       = ["hello@patrickgleeson.com"]
-  s.homepage    = "https://github.com/patrick-gleeson"
+  s.email       = ["hello@tabletopgroupfinder.co.uk"]
+  s.homepage    = "https://tabletopgroupfinder.co.uk"
   s.summary     = %q{Success-failure utility}
   s.description = %q{A utility for adding a variant of functional-style Either return values to Ruby code.}
   s.license     = "MIT"

data/spec/ok_nok_spec.rb

@@ -1,147 +1,147 @@
-require 'spec_helper'
-
-include OkNok
-
-describe OkNok do
-  let(:value_passed_in) { "SomeValue" }
-  let(:provided_nok_value) { "Return me if nok" }
-  let(:ok_block_return_value) { "other value" }
-  
-  describe '#ok' do
-    subject { ok value_passed_in }
-    
-    specify do
-      expect(subject).to be_an(OkNok)
-    end
-    
-    it 'sets status to "ok"' do
-      expect(subject.status).to be OkNok::OK
-    end
-    
-    it 'keeps the value passed in' do
-      expect(subject.value).to be value_passed_in
-    end
-  end
-  
-  describe '#nok' do
-    subject { nok value_passed_in }
-    
-    specify do
-      expect(subject).to be_an(OkNok)
-    end
-    
-    it 'sets status to "nok"' do
-      expect(subject.status).to be OkNok::NOK
-    end
-    
-    it 'keeps the value passed in' do
-      expect(subject.value).to be value_passed_in
-    end
-  end 
-  
-  describe ".nok_if" do
-    let(:comparison_value) {"If you get me, return a nok"}
-    
-    specify do
-      expect{|block| OkNok.nok_if(comparison_value, provided_nok_value, &block)}.to yield_control
-    end
-    
-    context "when no block is provided" do
-      specify do
-        expect{OkNok.nok_if(comparison_value, provided_nok_value)}.to raise_error(ArgumentError)
-      end
-    end
-    
-    context "when the block return value equals the comparison value" do
-      subject do 
-        OkNok.nok_if comparison_value, provided_nok_value do 
-          comparison_value
-        end
-      end
-      
-      specify do
-        expect(subject).to be_an(OkNok)
-      end
-      
-      specify do
-        expect(subject).to be_nok
-      end
-      
-      it "assigns the provided value to the nok" do
-        expect(subject.value).to eq provided_nok_value
-      end
-    end
-    
-    context "when the block return value doesn't equal the comparison value" do      
-      subject do
-        OkNok.nok_if comparison_value, provided_nok_value do 
-          ok_block_return_value 
-         end
-      end
-      
-      specify do
-        expect(subject).to be_an(OkNok)
-      end
-      
-      specify do
-        expect(subject).to be_ok
-      end
-      
-      it "assigns the block return value to the ok" do
-        expect(subject.value).to eq ok_block_return_value
-      end
-    end    
-  end
-  
-  describe ".nok_if_exception" do
-    specify do
-      expect{|block| OkNok.nok_if_exception(provided_nok_value, &block)}.to yield_control
-    end
-    
-    context "when no block is provided" do
-      specify do
-        expect{OkNok.nok_if_exception}.to raise_error(ArgumentError)
-      end      
-    end
-    
-    context "when the block doesn't raise an exception" do
-      subject do
-        OkNok.nok_if_exception provided_nok_value do 
-          ok_block_return_value 
-         end
-      end
-      
-      specify do
-        expect(subject).to be_an(OkNok)
-      end
-      
-      specify do
-        expect(subject).to be_ok
-      end
-      
-      it "assigns the block return value to the ok" do
-        expect(subject.value).to eq ok_block_return_value
-      end
-    end
-    
-    context "when the block raises an exception" do
-      subject do
-        OkNok.nok_if_exception provided_nok_value do 
-           raise "This block has issues!"
-         end
-      end
-      specify do
-        expect(subject).to be_an(OkNok)
-      end
-      
-      specify do
-        expect(subject).to be_nok
-      end
-      
-      it "assigns the provided return value to the nok" do
-        expect(subject.value).to eq provided_nok_value
-      end
-    end
-  end    
-end
-
+require 'spec_helper'
+
+include OkNok
+
+describe OkNok do
+  let(:value_passed_in) { "SomeValue" }
+  let(:provided_nok_value) { "Return me if nok" }
+  let(:ok_block_return_value) { "other value" }
+  
+  describe '#ok' do
+    subject { ok value_passed_in }
+    
+    specify do
+      expect(subject).to be_an(OkNok)
+    end
+    
+    it 'sets status to "ok"' do
+      expect(subject.status).to be OkNok::OK
+    end
+    
+    it 'keeps the value passed in' do
+      expect(subject.value).to be value_passed_in
+    end
+  end
+  
+  describe '#nok' do
+    subject { nok value_passed_in }
+    
+    specify do
+      expect(subject).to be_an(OkNok)
+    end
+    
+    it 'sets status to "nok"' do
+      expect(subject.status).to be OkNok::NOK
+    end
+    
+    it 'keeps the value passed in' do
+      expect(subject.value).to be value_passed_in
+    end
+  end 
+  
+  describe ".nok_if" do
+    let(:comparison_value) {"If you get me, return a nok"}
+    
+    specify do
+      expect{|block| OkNok.nok_if(comparison_value, provided_nok_value, &block)}.to yield_control
+    end
+    
+    context "when no block is provided" do
+      specify do
+        expect{OkNok.nok_if(comparison_value, provided_nok_value)}.to raise_error(ArgumentError)
+      end
+    end
+    
+    context "when the block return value equals the comparison value" do
+      subject do 
+        OkNok.nok_if comparison_value, provided_nok_value do 
+          comparison_value
+        end
+      end
+      
+      specify do
+        expect(subject).to be_an(OkNok)
+      end
+      
+      specify do
+        expect(subject).to be_nok
+      end
+      
+      it "assigns the provided value to the nok" do
+        expect(subject.value).to eq provided_nok_value
+      end
+    end
+    
+    context "when the block return value doesn't equal the comparison value" do      
+      subject do
+        OkNok.nok_if comparison_value, provided_nok_value do 
+          ok_block_return_value 
+         end
+      end
+      
+      specify do
+        expect(subject).to be_an(OkNok)
+      end
+      
+      specify do
+        expect(subject).to be_ok
+      end
+      
+      it "assigns the block return value to the ok" do
+        expect(subject.value).to eq ok_block_return_value
+      end
+    end    
+  end
+  
+  describe ".nok_if_exception" do
+    specify do
+      expect{|block| OkNok.nok_if_exception(provided_nok_value, &block)}.to yield_control
+    end
+    
+    context "when no block is provided" do
+      specify do
+        expect{OkNok.nok_if_exception}.to raise_error(ArgumentError)
+      end      
+    end
+    
+    context "when the block doesn't raise an exception" do
+      subject do
+        OkNok.nok_if_exception provided_nok_value do 
+          ok_block_return_value 
+         end
+      end
+      
+      specify do
+        expect(subject).to be_an(OkNok)
+      end
+      
+      specify do
+        expect(subject).to be_ok
+      end
+      
+      it "assigns the block return value to the ok" do
+        expect(subject.value).to eq ok_block_return_value
+      end
+    end
+    
+    context "when the block raises an exception" do
+      subject do
+        OkNok.nok_if_exception provided_nok_value do 
+           raise "This block has issues!"
+         end
+      end
+      specify do
+        expect(subject).to be_an(OkNok)
+      end
+      
+      specify do
+        expect(subject).to be_nok
+      end
+      
+      it "assigns the provided return value to the nok" do
+        expect(subject.value).to eq provided_nok_value
+      end
+    end
+  end    
+end
+

data/spec/returnable_spec.rb

@@ -1,178 +1,178 @@
-require 'spec_helper'
-
-describe OkNok::Returnable do
-  let(:happy_value) { 'Hooray this worked' }
-  let(:sad_value) { 'Oh no this failed' }
-  let(:ok_object) {OkNok::Returnable.new(OkNok::OK, happy_value)}
-  let(:nok_object){OkNok::Returnable.new(OkNok::NOK, sad_value) }
-  
-  context 'when initialized as ok' do
-    describe '#value' do
-      it 'contains the value passed in' do
-        expect(ok_object.value).to eq happy_value
-      end
-    end
-    
-    describe '#status' do
-      it 'is ok' do
-        expect(ok_object.status).to eq OkNok::OK
-      end
-    end
-
-    describe '#ok?' do    
-      it 'is true' do
-        expect(ok_object.ok?).to eq true
-      end      
-    end
-
-    describe '#nok?' do    
-      it 'is false' do
-        expect(ok_object.nok?).to eq false
-      end      
-    end
-    
-    describe "#value_or_if_nok" do
-      it "doesn't execute a provided block" do
-        expect{|block| ok_object.value_or_if_nok(&block)}.not_to yield_control
-      end
-      
-      it "returns its value" do
-        expect(ok_object.value_or_if_nok {|nok_value| nil}).to eq ok_object.value
-      end
-    end
-    
-    describe "#value_or_if_ok" do
-      it "executes a provided block" do
-        expect{|block| ok_object.value_or_if_ok(&block)}.to yield_control
-      end
-      
-      it "returns nil if no block provided" do
-        expect(ok_object.value_or_if_ok).to be_nil
-      end
-      
-      it "returns the result of the block if a block is provided" do
-        expect(ok_object.value_or_if_ok {|nok_value| "Some result"}).to eq "Some result"
-      end
-      
-      it "provides its value as an argument to the block" do
-        ok_object.value_or_if_ok do |ok_value|
-          expect(ok_value).to eq ok_object.value
-        end
-      end
-    end
-    
-    describe "#ok" do
-      it "executes a provided block" do
-        expect{|block| ok_object.ok(&block)}.to yield_control
-      end
-      
-      it "returns itself" do
-        expect(ok_object.ok {|ok_value| nil}).to eq ok_object
-      end
-      
-      it "provides its value as an argument to the block" do
-        ok_object.ok do |ok_value|
-          expect(ok_value).to eq ok_object.value
-        end
-      end
-    end
-    
-    describe "#nok" do
-      it "doesn't execute a provided block" do
-        expect{|block| ok_object.nok(&block)}.not_to yield_control
-      end
-      
-      it "returns itself" do
-        expect(ok_object.nok {|nok_value| nil}).to eq ok_object
-      end
-    end
-  end
-  
-  context 'when initialized as nok' do
-    describe '#value' do
-      it 'contains the value passed in' do
-        expect(nok_object.value).to eq sad_value
-      end
-    end
-    
-    describe '#status' do
-      it 'is nok' do
-        expect(nok_object.status).to eq OkNok::NOK
-      end
-    end
-
-    describe '#ok?' do    
-      it 'is false' do
-        expect(nok_object.ok?).to eq false
-      end      
-    end
-
-    describe '#nok?' do    
-      it 'is true' do
-        expect(nok_object.nok?).to eq true
-      end      
-    end
-    
-    describe "#value_or_if_nok" do
-      it "executes a provided block" do
-        expect{|block| nok_object.value_or_if_nok(&block)}.to yield_control
-      end
-      
-      it "returns nil if no block provided" do
-        expect(nok_object.value_or_if_nok).to be_nil
-      end
-      
-      it "returns the result of the block if a block is provided" do
-        expect(nok_object.value_or_if_nok {|nok_value| "Some result"}).to eq "Some result"
-      end
-      
-      it "provides the nok value as an argument to the block" do
-        nok_object.value_or_if_nok do |nok_value|
-          expect(nok_value).to eq nok_object.value
-        end
-      end
-    end
-    
-    describe "#value_or_if_ok" do
-      it "doesn't execute a provided block" do
-        expect{|block| nok_object.value_or_if_ok(&block)}.not_to yield_control
-      end
-      
-      it "returns its value" do
-        expect(nok_object.value_or_if_ok {|ok_value| nil}).to eq nok_object.value
-      end
-    end
-    
-    describe "#ok" do
-      it "doesn't execute a provided block" do
-        expect{|block| nok_object.ok(&block)}.not_to yield_control
-      end
-      
-      it "returns itself" do
-        expect(nok_object.ok {|ok_value| nil}).to eq nok_object
-      end
-    end
-    
-    describe "#nok" do
-      it "executes a provided block" do
-        expect{|block| nok_object.nok(&block)}.to yield_control
-      end
-      
-      it "returns itself" do
-        expect(nok_object.nok {|nok_value| nil}).to eq nok_object
-      end
-      
-      it "provides its value as an argument to the block" do
-        nok_object.nok do |nok_value|
-          expect(nok_value).to eq nok_object.value
-        end
-      end
-    end
-  end
-  
-  context 'when initialized with non ok/nok status' do
-    it 'raises an ArgumentError' do
-      expect{OkNok::Returnable.new("not a status", "some value")}.to raise_error(ArgumentError)
-    end
-  end  
-end
+require 'spec_helper'
+
+describe OkNok::Returnable do
+  let(:happy_value) { 'Hooray this worked' }
+  let(:sad_value) { 'Oh no this failed' }
+  let(:ok_object) {OkNok::Returnable.new(OkNok::OK, happy_value)}
+  let(:nok_object){OkNok::Returnable.new(OkNok::NOK, sad_value) }
+  
+  context 'when initialized as ok' do
+    describe '#value' do
+      it 'contains the value passed in' do
+        expect(ok_object.value).to eq happy_value
+      end
+    end
+    
+    describe '#status' do
+      it 'is ok' do
+        expect(ok_object.status).to eq OkNok::OK
+      end
+    end
+
+    describe '#ok?' do    
+      it 'is true' do
+        expect(ok_object.ok?).to eq true
+      end      
+    end
+
+    describe '#nok?' do    
+      it 'is false' do
+        expect(ok_object.nok?).to eq false
+      end      
+    end
+    
+    describe "#value_or_if_nok" do
+      it "doesn't execute a provided block" do
+        expect{|block| ok_object.value_or_if_nok(&block)}.not_to yield_control
+      end
+      
+      it "returns its value" do
+        expect(ok_object.value_or_if_nok {|nok_value| nil}).to eq ok_object.value
+      end
+    end
+    
+    describe "#value_or_if_ok" do
+      it "executes a provided block" do
+        expect{|block| ok_object.value_or_if_ok(&block)}.to yield_control
+      end
+      
+      it "returns nil if no block provided" do
+        expect(ok_object.value_or_if_ok).to be_nil
+      end
+      
+      it "returns the result of the block if a block is provided" do
+        expect(ok_object.value_or_if_ok {|nok_value| "Some result"}).to eq "Some result"
+      end
+      
+      it "provides its value as an argument to the block" do
+        ok_object.value_or_if_ok do |ok_value|
+          expect(ok_value).to eq ok_object.value
+        end
+      end
+    end
+    
+    describe "#ok" do
+      it "executes a provided block" do
+        expect{|block| ok_object.ok(&block)}.to yield_control
+      end
+      
+      it "returns itself" do
+        expect(ok_object.ok {|ok_value| nil}).to eq ok_object
+      end
+      
+      it "provides its value as an argument to the block" do
+        ok_object.ok do |ok_value|
+          expect(ok_value).to eq ok_object.value
+        end
+      end
+    end
+    
+    describe "#nok" do
+      it "doesn't execute a provided block" do
+        expect{|block| ok_object.nok(&block)}.not_to yield_control
+      end
+      
+      it "returns itself" do
+        expect(ok_object.nok {|nok_value| nil}).to eq ok_object
+      end
+    end
+  end
+  
+  context 'when initialized as nok' do
+    describe '#value' do
+      it 'contains the value passed in' do
+        expect(nok_object.value).to eq sad_value
+      end
+    end
+    
+    describe '#status' do
+      it 'is nok' do
+        expect(nok_object.status).to eq OkNok::NOK
+      end
+    end
+
+    describe '#ok?' do    
+      it 'is false' do
+        expect(nok_object.ok?).to eq false
+      end      
+    end
+
+    describe '#nok?' do    
+      it 'is true' do
+        expect(nok_object.nok?).to eq true
+      end      
+    end
+    
+    describe "#value_or_if_nok" do
+      it "executes a provided block" do
+        expect{|block| nok_object.value_or_if_nok(&block)}.to yield_control
+      end
+      
+      it "returns nil if no block provided" do
+        expect(nok_object.value_or_if_nok).to be_nil
+      end
+      
+      it "returns the result of the block if a block is provided" do
+        expect(nok_object.value_or_if_nok {|nok_value| "Some result"}).to eq "Some result"
+      end
+      
+      it "provides the nok value as an argument to the block" do
+        nok_object.value_or_if_nok do |nok_value|
+          expect(nok_value).to eq nok_object.value
+        end
+      end
+    end
+    
+    describe "#value_or_if_ok" do
+      it "doesn't execute a provided block" do
+        expect{|block| nok_object.value_or_if_ok(&block)}.not_to yield_control
+      end
+      
+      it "returns its value" do
+        expect(nok_object.value_or_if_ok {|ok_value| nil}).to eq nok_object.value
+      end
+    end
+    
+    describe "#ok" do
+      it "doesn't execute a provided block" do
+        expect{|block| nok_object.ok(&block)}.not_to yield_control
+      end
+      
+      it "returns itself" do
+        expect(nok_object.ok {|ok_value| nil}).to eq nok_object
+      end
+    end
+    
+    describe "#nok" do
+      it "executes a provided block" do
+        expect{|block| nok_object.nok(&block)}.to yield_control
+      end
+      
+      it "returns itself" do
+        expect(nok_object.nok {|nok_value| nil}).to eq nok_object
+      end
+      
+      it "provides its value as an argument to the block" do
+        nok_object.nok do |nok_value|
+          expect(nok_value).to eq nok_object.value
+        end
+      end
+    end
+  end
+  
+  context 'when initialized with non ok/nok status' do
+    it 'raises an ArgumentError' do
+      expect{OkNok::Returnable.new("not a status", "some value")}.to raise_error(ArgumentError)
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -1 +1 @@
-require 'ok_nok'
+require 'ok_nok'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ok_nok
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Patrick Gleeson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-31 00:00:00.000000000 Z
+date: 2023-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -33,7 +33,7 @@ dependencies:
 description: A utility for adding a variant of functional-style Either return values
   to Ruby code.
 email:
-- hello@patrickgleeson.com
+- hello@tabletopgroupfinder.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -53,11 +53,11 @@ files:
 - spec/ok_nok_spec.rb
 - spec/returnable_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/patrick-gleeson
+homepage: https://tabletopgroupfinder.co.uk
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,9 +72,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ok_nok
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.4.8
+signing_key:
 specification_version: 4
 summary: Success-failure utility
-test_files: []
+test_files:
+- spec/ok_nok_spec.rb
+- spec/returnable_spec.rb
+- spec/spec_helper.rb