hexx 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb67d554082720fe92957b12996f0a313b3b3ae8
-  data.tar.gz: 197971ca631d755c770543cf8393d173bff65ff3
+  metadata.gz: c3e5d03628aadfc3fbfda454f834e2f573658bf6
+  data.tar.gz: 0ddf399a8ff32c8d78e3aa2a245e4e4f2434fc73
 SHA512:
-  metadata.gz: 2616e0e816e014aba36151690e5d5546ace6adcd2e1ec08bef86191526bf594576359ed0b3eace7ce4380eb629c00d675cd0bb1aef3e1ab5eb6918a6b8e018ef
-  data.tar.gz: b811fd9b51612ea91d71c75b0c87fedfe2146a10f78b4327953390fc7cd430dec07f9475e5d72b7aa5f00660b1309b81a859805fd37c7b8ead676f666e11c3f8
+  metadata.gz: 9c686b91c627deacdadd1102ea9742d4dea28a5842bec1536a58ffe448939c9d0bd3876a54e59dd9bb27c2cf7324140e20f060c3f63507980c6d1c8bade31367
+  data.tar.gz: 95cadea3c85273d9a0d5431508d7c3c1d98f2dfcd17b563fe06e22560f248f1f35b066d6f81eb55507d800aa9f7a4bf994197dee358adae25438b5daa7daf21e

data/lib/hexx/null.rb

@@ -0,0 +1,210 @@
+# encoding: utf-8
+
+module Hexx
+
+  # The Null object class.
+  # @see http://robots.thoughtbot.com/rails-refactoring-example-introduce-null-object
+  #   The intro to null object pattern from Dan Croak.
+  # @see http://devblog.avdi.org/2011/05/30/null-objects-and-falsiness/
+  #   The post of Avdi Grimm on null object falsiness problem.
+  # 
+  # Except for some special cases (see examples below) calling any method
+  # returns the +Null+ itself.
+  #
+  # @note (see Hexx::Null.!)
+  # @example (see Hexx::Null.method_missing)
+  # @example (see Hexx::Null.new)
+  # @example (see Hexx::Null.nil?)
+  # @example (see Hexx::Null.eq?)
+  # @example (see Hexx::Null.<=>)
+  # @example (see Hexx::Null.false?)
+  # @example (see Hexx::Null.true?)
+  # @example (see Hexx::Null.!)
+  # @example (see Hexx::Null.to_a)
+  # @example (see Hexx::Null.to_h)
+  # @example (see Hexx::Null.to_s)
+  # @example (see Hexx::Null.to_i)
+  # @example (see Hexx::Null.to_f)
+  # @example (see Hexx::Null.to_c)
+  # @example (see Hexx::Null.to_r)
+  # @example (see Hexx::Null.to_nil)
+  class Null
+    class << self
+      include Comparable
+
+      # The constructor constructs itself.
+      #
+      # @example The +Null+ object constructs itself.
+      #   Null.new
+      #   # => Null
+      #
+      # @return [Class] +Null+.
+      def new
+        self
+      end
+
+      # Checks if +Null+ is equal to other object.
+      #
+      # @example The +Null+ is equal to +nil+.
+      #   Null.eq? nil  # => true
+      #   Null.eq? Null # => true
+      #
+      # @example The +Null+ differs from non-nil
+      #   Null.eq? 0     # => false
+      #   Null.eq? false # => false
+      #
+      # @param [Object] other The other object to compare to Null.
+      # @return [Boolean] The result of comparison.
+      def eq?(other)
+        other.nil?
+      end
+
+      # Compares the +Null+ to other object.
+      #
+      # @example The +Null+ is less than non-nil object:
+      #   Null < 0     # => true
+      #   Null < ""    # => true
+      #   Null < false # => true
+      #
+      # @param [Object] other The other object to compare to Null.
+      # @return [-1, 0] The result of comparison.
+      def <=>(other)
+        other.nil? ? 0 : -1
+      end
+
+      # Checks if the +Null+ is nil.
+      #
+      # @example The +Null+ is nil.
+      #   Null.nil? # => true
+      #
+      # @return [Boolean] +true+.
+      def nil?
+        true
+      end
+
+      # Checks if the +Null+ is falseу.
+      #
+      # @example The +Null+ is falseу.
+      #   Null.false?  # => true
+      #
+      # @example The +Null+ isn't false in logical operations
+      #   false || Null # => Null
+      #
+      # @return [Boolean] +true+.
+      def false?
+        true
+      end
+
+      # Converts nil to true.
+      #
+      # @note In Ruby the only objects that are +false+ are +nil+ and +false+.
+      #   Use the double bang before any object that may be the +Null+.
+      #
+      # @example The +Null+ is convertible to +true+.
+      #   !Null  # => true
+      #
+      # @example Use a double bang before objects that may be the +Null+.
+      #   Null && true   # => true
+      #   !!Null && true # => false
+      #
+      # @return [Boolean] +true+.
+      def !
+        true
+      end
+
+      # Checks if the +Null+ is truthy.
+      #
+      # @example The +Null+ isn't truthy.
+      #   Null.true?  # => false
+      #
+      # @example The +Null+ is truthy in logical operations.
+      #   true && Null # => Null
+      #
+      # @return [Boolean] +false+.
+      def true?
+        false
+      end
+
+      # Converts the +Null+ to the empty string.
+      #
+      # @example The +Null+ is convertible to the empty string.
+      #   Null.to_s # => ""
+      #
+      # @return [String] The empty string.
+      def to_s
+        ""
+      end
+
+      # Converts the +Null+ to +nil+.
+      #
+      # @example The +Null+ is convertible to +nil+.
+      #   Null.to_nil # => nil
+      #
+      # @return [NilClass] +nil+.
+      def to_nil
+        nil
+      end
+
+      # @!method to_a
+      # Converts the +Null+ to the empty array.
+      # @example The +Null+ is convertible to the empty array.
+      #   Null.to_a # => []
+      # @return [Array] the empty array.
+
+      # @!method to_i
+      # Converts the +Null+ to zero as an integer.
+      # @example The +Null+ is convertible to zero as an integer.
+      #   Null.to_i # => 0
+      # @return [Integer] zero.
+
+      # @!method to_f
+      # Converts the +Null+ to zero as a float.
+      # @example The +Null+ is convertible to zero as a float.
+      #   Null.to_f # => 0.0
+      # @return [Float] zero.
+
+      # @!method to_c
+      # Converts the +Null+ to zero as a complex.
+      # @example The +Null+ is convertible to zero as a complex.
+      #   Null.to_c # => (0+0i)
+      # @return [Complex] zero.
+
+      # @!method to_r
+      # Converts the +Null+ to zero as a rational.
+      # @example The +Null+ is convertible to zero as a rational.
+      #   Null.to_c # => (0/1)
+      # @return [Rational] zero.
+
+      # Checks if a method defined.
+      #
+      # @example The +Null+ responds to any object.
+      #   Null.respond_to? arbitrary_method
+      #   # => true
+      #
+      # @return [Boolean] +true+.
+      def respond_to?(*)
+        true
+      end
+
+      private
+
+      # @api hide
+      # @example An arbitrary method returns the +Null+ itself.
+      #   Null.is_an_eagle_owl?  # => Null
+      #   Null.is_an_elk?        # => Null
+      #   Null.fly               # => Null
+      #   # ... etc.
+      #
+      # @example An arbitrary method called with a block yields the block.
+      #   Null.when_fishing { p "I've got it!" }
+      #   # => "I've got it!"
+      #   # => Null
+      #
+      def method_missing(name, *args, &block)
+        return nil.send(name, *args, &block) if nil.respond_to?(name)
+        block.call if block_given?
+        self
+      end
+    end
+  end
+end

data/lib/hexx/version.rb

@@ -2,5 +2,5 @@
 module Hexx
 
   # Current release.
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/spec/hexx/null_spec.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+require "spec_helper"
+
+module Hexx
+  describe Null do
+
+    subject { Null }
+
+    describe ".new" do
+
+      it "constructs itself" do
+        expect(Null.new).to eq Null
+      end
+    end
+
+    describe "arbitrary method" do
+
+      it "is defined" do
+        expect(Null).to respond_to :drag_and_drop
+      end
+
+      it "yields a block" do
+        test = double :test, check: nil
+        expect(test).to receive :check
+        Null.when_fishing { test.check }
+      end
+
+      it "returns itself" do
+        expect(Null.is_an_eagle_owl?).to eq Null
+      end
+    end
+
+    it "equals nil" do
+      expect(Null).to eq nil
+      expect(Null).to be_nil
+    end
+
+    it "equals Null" do
+      expect(Null.eq? Null).to be_truthy
+    end
+
+    it "is less than any other object" do
+      expect(Null).to be < -1
+      expect(Null).to be < false
+      expect(Null).to be < true
+      expect(Null).to be < ""
+    end
+
+    it "is falsey" do
+      expect(Null).to be_falsey
+      expect(Null).not_to be_truthy
+      expect(!Null).to eq true
+    end
+
+    describe "#to_a" do
+
+      it "returns the empty array" do
+        expect(Null.to_a).to eq []
+      end
+    end
+
+    describe "#to_h" do
+
+      it "returns the empty hash" do
+        expect(Null.to_h).to eq({})
+      end
+    end
+
+    describe "#to_s" do
+
+      it "returns the empty string" do
+        expect(Null.to_s).to eq ""
+      end
+    end
+
+    describe "#to_i" do
+
+      it "returns zero as an integer" do
+        expect(Null.to_i).to eq 0
+      end
+    end
+
+    describe "#to_f" do
+
+      it "returns zero as a float" do
+        expect(Null.to_f).to eq 0.0
+      end
+    end
+
+    describe "#to_c" do
+
+      it "returns zero as a complex" do
+        expect(Null.to_c).to eq 0.to_c
+      end
+    end
+
+    describe "#to_r" do
+
+      it "returns zero as a rational" do
+        expect(Null.to_r).to eq 0.to_r
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2014-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -151,6 +151,7 @@ files:
 - lib/hexx.rb
 - lib/hexx/models.rb
 - lib/hexx/models/base_coercer.rb
+- lib/hexx/null.rb
 - lib/hexx/service.rb
 - lib/hexx/service/invalid.rb
 - lib/hexx/service/message.rb
@@ -158,6 +159,7 @@ files:
 - lib/hexx/service/with_callbacks.rb
 - lib/hexx/version.rb
 - spec/hexx/models_spec.rb
+- spec/hexx/null_spec.rb
 - spec/hexx/service/invalid_spec.rb
 - spec/hexx/service/message_spec.rb
 - spec/hexx/service_spec.rb
@@ -194,6 +196,7 @@ summary: Service objects for Rails.
 test_files:
 - spec/spec_helper.rb
 - spec/hexx/service_spec.rb
+- spec/hexx/null_spec.rb
 - spec/hexx/service/message_spec.rb
 - spec/hexx/service/invalid_spec.rb
 - spec/hexx/models_spec.rb