confident_ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f02a5207d69e5ec3aeccccc3ef3984b474b62d51
-  data.tar.gz: 9c5e15fed060781bb3389a48828de782b5756ed6
+  metadata.gz: 5541c0988788cd2a99c4b02e4e085b316b051e01
+  data.tar.gz: 1d1f94e86a664e9527608d3947ef05b8ac0be7c2
 SHA512:
-  metadata.gz: a2d015875987eb01a9e87538b466714ff5917c9bc4d920ccc10d8e4141dfcdd48796fa64afbab1a03f5e6171be36d285058153ce9919857d066f9f80414435e3
-  data.tar.gz: c477da18f1db3a8d3ea3bb14af91fc37e846bc4ea5813a052e113678ab6c45c53a8bdc36bfcb0d44380157e1565228c56e41ec71029bc489e957b59c0ba10251
+  metadata.gz: 66a53a390ccfde96427c2cc79816f6bb13c21c8658dc777e6a74eabf00ff3ff60e2f214a28fb5291c082f062a05da8b475bc1d1c129f4d66b8d039399e0504e0
+  data.tar.gz: 36ad69c4fffca4ee6e231988610370c24271bfe60dd7ec8c65c2145fdac273849329f9689e94a601da848adccebf081cdbb62fc51b7d8fc2f64269d5c63fc945

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx
+
+script: bundle exec rspec
+bundler_args: --without development

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in confident.ruby.gemspec
 gemspec
+
+gem 'rspec'

data/README.md

@@ -22,8 +22,14 @@ Or install it yourself as:
 
 ## Usage
 
+```ruby
+require "confident"
+```
+
 ### Eliminating condition
 
+*Not implemented*
+
 Given this code:
 
 ```ruby
@@ -75,6 +81,8 @@ end
 
 ### Eliminating switch
 
+*Not implemented*
+
 Given this code:
 
 ```ruby
@@ -151,10 +159,46 @@ end
 
 Looks like we expanding our code and making it bigger at no time, but it is actually beneficial to us, because we don't need to duplicate knowledge on how to determine `kind` of product throughout a codebase, we just call `Product.lift(kind_string_value)`, and we are done with it. You can implement this stuff in raw ruby easily, but this library wants to cut of a boilerplate code involved in this usually.
 
+### Handling success/failure result
+
+Just use `Confident::Result`:
+
+```ruby
+def some_computation_that_may_fail
+  Confident::Result.ok(compute)
+rescue => e
+  Confident::Result.error(e.to_s)
+end
+
+puts some_computation_that_may_fail.on_error { |e| report_error(e) }.unwrap
+```
+
+If you have something that returns `true` in case of success and `false` in case of failure, you can use `Confident::Result.from_condition(boolean_value, failure_message=nil)`:
+
+```ruby
+Confident::Result.from_condition(some_weird_external_api, "Weird external API returned unexpected error")
+```
+
+### Pure null object
+
+Pure null object (`Confident::NullObject`) quacks to any method with itself.
+
+If you have an input value that could be `nil`, you can just wrap it in `Confident::AutoNullObject` to get either original value or pure null object if it is `nil`.
+Example usage with `AutoNullObject`:
+
+```ruby
+def do_something_with(possibly_nil_value)
+  AutoNullObject(some_possibly_nil_value).say("hello")
+end
+
+do_something_with(fetch_me_a_value)        # => "said: hello"
+do_something_with(fetch_me_a_nil_value)    # => #<Confident::NullObject:0x000001019f37f8>
+```
+
 ### TODO (to specify in this README)
 
 - lift & bind
-- null object
+- null object with ability to define your own custom null object
 - barricade
 
 ## Contributing

data/lib/confident.rb

@@ -1,4 +1,6 @@
 require "confident/version"
+require "confident/result"
+require "confident/null_object"
 
 module Confident
   # Your code goes here...

data/lib/confident/null_object.rb

@@ -0,0 +1,18 @@
+module Confident
+  class NullObject
+    def method_missing(*)
+      self
+    end
+  end
+
+  module AutoNullObject
+    class << self
+      def wrap(value)
+        return value unless NilClass === value
+        NullObject.new
+      end
+
+      alias_method :[], :wrap
+    end
+  end
+end

data/lib/confident/result.rb

@@ -0,0 +1,71 @@
+module Confident
+  class Result
+    DEFAULT_MISSING_ERROR_HANDLER_MESSAGE = "You haven't specified error handler for Confident::Result, use #on_error for that"
+    DEFAULT_FAILURE_MESSAGE = "Condition should be true" 
+
+    def initialize(value)
+      @value = value
+    end
+
+    def unwrap
+      unless error_handler
+        raise MissingErrorHandler, DEFAULT_MISSING_ERROR_HANDLER_MESSAGE
+      end
+    end
+
+    def on_error(&error_handler)
+      @error_handler = error_handler
+      self
+    end
+
+    private
+
+    attr_reader :value, :error_handler
+
+    class << self
+      def ok(value=nil)
+        Ok[value]
+      end
+
+      def error(value=nil)
+        Error[value]
+      end
+
+      def from_condition(condition_value, failure_message=DEFAULT_FAILURE_MESSAGE)
+        condition_value ? ok : error(failure_message)
+      end
+
+      def inherited(subclass)
+        class << subclass; public :new, :[] end
+      end
+
+      alias_method :[], :new
+
+      private :new, :[]
+    end
+
+    class Ok < self
+      def ok?
+        true
+      end
+
+      def unwrap
+        super
+        value
+      end
+    end
+
+    class Error < self
+      def ok?
+        false
+      end
+
+      def unwrap
+        super
+        error_handler.call(value)
+      end
+    end
+
+    class MissingErrorHandler < ArgumentError; end
+  end
+end

data/lib/confident/version.rb

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

data/spec/confident/null_object_spec.rb

@@ -0,0 +1,29 @@
+module Confident
+  RSpec.describe NullObject do
+    it "quacks with self" do
+      expect(subject.quack).to be(subject)
+    end
+  end
+
+  RSpec.describe AutoNullObject do
+    describe "#[]" do
+      subject { AutoNullObject[value] }
+
+      context "when value is not nil" do
+        let(:value) { double("A value") }
+
+        it "returns original value" do
+          is_expected.to be(value)
+        end
+      end
+
+      context "when value is nil" do
+        let(:value) { nil }
+
+        it "returns NullObject" do
+          is_expected.to be_a(NullObject)
+        end
+      end
+    end
+  end
+end

data/spec/confident/result_spec.rb

@@ -0,0 +1,114 @@
+module Confident
+  RSpec.describe Result do
+    let(:value) { double("Value") }
+    let(:error) { double("Error object") }
+
+    describe ".new" do
+      it "can't be called" do
+        expect { Result.new(value) }.to raise_error(NoMethodError)
+      end
+
+      it "can't be called in :[] form" do
+        expect { Result[value] }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe ".from_condition" do
+      subject { Result.from_condition(condition_value) }
+
+      context "when the condition is true" do
+        let(:condition_value) { true }
+
+        it "returns Result::Ok" do
+          expect(subject).to be_ok
+        end
+      end
+
+      context "when the condition is false" do
+        let(:condition_value) { false }
+
+        it "returns Result::Error" do
+          expect(subject.on_error { |e| [:report, e] }.unwrap).to eq([:report, Confident::Result::DEFAULT_FAILURE_MESSAGE])
+        end
+
+        context "when failure_message is provided" do
+          subject { Result.from_condition(condition_value, failure_message) }
+          let(:failure_message) { "Special failure message" }
+
+          it "return Result::Error with provided failure message" do
+            expect(subject.on_error { |e| [:report, e] }.unwrap).to eq([:report, failure_message])
+          end
+        end
+      end
+    end
+
+    describe ".ok" do
+      subject { Result.ok(value) }
+
+      it "returns instance of Result::Ok" do
+        is_expected.to be_a(Result::Ok)
+      end
+    end
+
+    describe ".error" do
+      subject { Result.error(error) }
+
+      it "returns instance of Result::Error" do
+        is_expected.to be_a(Result::Error)
+      end
+    end
+
+    describe Result::Ok do
+      subject { Result.ok(value) }
+
+      describe "#ok?" do
+        it "is true" do
+          expect(subject.ok?).to be_truthy
+        end
+      end
+
+      describe "#unwrap" do
+        context "when error callback was not provided" do
+          it "raises error" do
+            expect { subject.unwrap }.to raise_error(Result::MissingErrorHandler)
+          end
+        end
+
+        context "when error callback is provided" do
+          subject { super().on_error { |e| :do_nothing } }
+
+          it "returns a wrapped value" do
+            expect(subject.unwrap).to eq(value)
+          end
+        end
+      end
+    end
+
+    describe Result::Error do
+      subject { Result.error(error) }
+
+      describe "#ok?" do
+        it "is false" do
+          expect(subject.ok?).to be_falsey
+        end
+      end
+
+      describe "#unwrap" do
+        context "when error callback is not provided" do
+          it "raises error" do
+            expect { subject.unwrap }.to raise_error(Result::MissingErrorHandler)
+          end
+        end
+
+        context "when error callback is provided" do
+          subject { super().on_error { |e| [:report, e] } }
+
+          it "executes callback and returns its result" do
+            expect(subject.unwrap).to eq([:report, error])
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+require 'confident'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confident_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexey Fedorov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -48,13 +48,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - confident_ruby.gemspec
 - lib/confident.rb
+- lib/confident/null_object.rb
+- lib/confident/result.rb
 - lib/confident/version.rb
+- spec/confident/null_object_spec.rb
+- spec/confident/result_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/waterlink/confident.ruby
 licenses:
 - MIT
@@ -79,4 +86,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Be confident and narrative when writing code in ruby.
-test_files: []
+test_files:
+- spec/confident/null_object_spec.rb
+- spec/confident/result_spec.rb
+- spec/spec_helper.rb