argspec 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78bed1162720f96bec34e01c4b6f0dd1fd7d7a75
-  data.tar.gz: 204b8dc5273e335cf2da9f5bd6e30c86a43adc95
+  metadata.gz: 6f6a9d2738f76290fa9b362e0b324eb6e60c3318
+  data.tar.gz: 5c70bae7e6ddd2d018ba54d42aaa81ba46f57414
 SHA512:
-  metadata.gz: 4cbdb4f44be0effc0cefa45d89e51273af695b169d8c41e3b868e4fc6502fe4ef5d87b7fb01fa327b9d3f487d6855fc28ef68c5b7c635d7b56a2c1e6c0819d4a
-  data.tar.gz: c2fa42bb7e822850b1f2aafb03497888947e1f37904edff56dcf52a972e6e8e8d7c711ed75947f45ce2b87e76449d7c33b049ee3b8d0ab79df54da0fc01f59f6
+  metadata.gz: b49f0e5af1ee8057b7fe1bf820155b24b6242b3e7cf47f19c99f42d0916b63c14f33631b1deb9ad360b165467a26263a93ae473991aaa766926bc78ed54f4836
+  data.tar.gz: 7d260f1446eb41e61b7d54ca30d170c745f40e1a5d946fa8db8969e038370684d55a0553b1ba17c20d2c9e1603ac4e4f3d7300adf6c744139ac35840cca31ed6

data/README.md

@@ -61,13 +61,13 @@ class Person
   attr_reader :name, :gender, :birthdate
 
   def initialize(name, gender, birthdate)
-    argument(name).should(:be_a, String)
-    argument(gender).should(:be_a, Symbol)
-    argument(birthdate).should(:be_a, Date)
+    argument(name) do
+      should be_a(String)
+      should_not be_empty
+    end
 
-    argument(name).should_not(:be, nil)
-    argument(gender).should_not(:be, nil)
-    argument(birthdate).should_not(:be, nil)
+    argument(gender) { should be_a(Symbol) }
+    argument(birthdate) { should be_a(Date) }
 
     @name = name
     @gender = gender
@@ -78,6 +78,26 @@ end
 
 That's better. It's now really clear what validations you're performing.
 
+Method chaining is also supported:
+
+```ruby
+class Person
+  include ArgumentSpecification::DSL
+
+  attr_reader :name, :gender, :birthdate
+
+  def initialize(name, gender, birthdate)
+    argument(name) { should(be_a(Symbol)).and_not(be_empty) }
+    argument(gender) { should be_a(Symbol) }
+    argument(birthdate) { should be_a(Date) }
+
+    @name = name
+    @gender = gender
+    @birthdate = birthdate
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/argspec/argument.rb

@@ -1,19 +1,26 @@
 module ArgumentSpecification
   class Argument
+    include ArgumentSpecification::DSL::Matchers
+
     attr_reader :actual
 
     # Create a new argument
     #
     # Arguments:
     #   actual: (Object)
+    #   block: (Block)
     #
     # Example:
     #   >> test = :test
-    #   >> ArgumentSpecification::Argument.new(test)
+    #   >> ArgumentSpecification::Argument.new(test) do
+    #   >>   should_not be_nil
+    #   >> end
     #   => #<Argument:0x00000000000000 @actual=:test>
     #
-    def initialize(actual)
+    def initialize(actual, &block)
       @actual = actual
+
+      instance_eval(&block)
     end
 
     # Ensure the argument matches
@@ -22,18 +29,18 @@ module ArgumentSpecification
     #   matcher: (Matchers::BaseMatcher)
     #
     # Example:
-    #   >> argument.should be_a(Symbol)
-    #   => nil
+    #   >> should be_a(Symbol)
+    #   => #<Argument:0x00000000000000 @actual=:test>
     #
     # Raises:
     #   ArgumentError: When the argument does not match
     #
     def should(matcher)
-      return nil unless matcher.is_a?(Matchers::BaseMatcher)
+      return self unless matcher.is_a?(Matchers::BaseMatcher)
 
       matcher.send(:actual=, @actual)
 
-      return nil if matcher.matches?
+      return self if matcher.matches?
 
       raise ArgumentError, matcher.failure_message
     end
@@ -44,20 +51,40 @@ module ArgumentSpecification
     #   matcher: (Matchers::BaseMatcher)
     #
     # Example:
-    #   >> argument.should_not be_a(Symbol)
-    #   => nil
+    #   >> should_not be_a(Symbol)
+    #   => #<Argument:0x00000000000000 @actual=:test>
     #
     # Raises:
     #   ArgumentError: When the argument matches
     #
     def should_not(matcher)
-      return nil unless matcher.is_a?(Matchers::BaseMatcher)
+      return self unless matcher.is_a?(Matchers::BaseMatcher)
 
       matcher.send(:actual=, @actual)
 
-      return nil unless matcher.matches?
+      return self unless matcher.matches?
 
       raise ArgumentError, matcher.failure_message_when_negated
     end
+
+    # Alias for should
+    #
+    # Example:
+    #   >> and be_a(Symbol)
+    #   => #<Argument:0x00000000000000 @actual=:test>
+    #
+    def and(*args)
+      should(*args)
+    end
+
+    # Alias for should_not
+    #
+    # Example:
+    #   >> and_not be_a(Symbol)
+    #   => #<Argument:0x00000000000000 @actual=:test>
+    #
+    def and_not(*args)
+      should_not(*args)
+    end
   end
 end

data/lib/argspec/constants.rb

@@ -1,3 +1,3 @@
 module ArgumentSpecification
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/argspec/dsl/matchers.rb

@@ -0,0 +1,30 @@
+module ArgumentSpecification
+  module DSL
+    module Matchers
+      class << self
+        # Register a matcher
+        #
+        # Arguments:
+        #   klass: (ArgumentSpecification::Matchers::BaseMatcher)
+        #   name: (Symbol)
+        #
+        # Example:
+        #   >> Matchers.register(TestMatcher, :test_matcher)
+        #   => true
+        #
+        def register(klass, name)
+          return unless klass.ancestors.include?(ArgumentSpecification::Matchers::BaseMatcher)
+          return unless name.is_a?(Symbol)
+
+          module_eval <<-EOS
+            def #{name}(*args, &block)
+              instance = #{klass}.new(*args, &block)
+              instance.send(:setup, '#{name}'.to_sym, args)
+              instance
+            end
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/argspec/dsl.rb

@@ -1,42 +1,20 @@
 module ArgumentSpecification
   module DSL
-    class << self
-      # Register a matcher
-      #
-      # Arguments:
-      #   klass: (Matchers::BaseMatcher)
-      #   name: (Symbol)
-      #
-      # Example:
-      #   >> register_matcher(TestMatcher, :test_matcher)
-      #   => true
-      #
-      def register_matcher(klass, name)
-        return unless klass.ancestors.include?(Matchers::BaseMatcher)
-        return unless name.is_a?(Symbol)
-
-        module_eval <<-EOS
-          def #{name}(*args, &block)
-            instance = #{klass}.new(*args, &block)
-            instance.send(:setup, '#{name}'.to_sym, args)
-            instance
-          end
-        EOS
-      end
-    end
-
     # Get an argument object
     #
     # Arguments:
     #   object: (Object)
+    #   block: (Block)
     #
     # Example:
     #   >> test = :test
-    #   >> argument(test)
-    #   => #<Argument:0x00000000000000 @object=:test>
+    #   >> argument(test) { should_not be_nil }
+    #   => nil
     #
-    def argument(object)
-      ArgumentSpecification::Argument.new(object)
+    def argument(object, &block)
+      ArgumentSpecification::Argument.new(object, &block)
+
+      nil
 		end
   end
 end

data/lib/argspec/matchers/base_matcher.rb

@@ -17,7 +17,7 @@ module ArgumentSpecification
           names.each do |name|
             next unless name.is_a?(Symbol)
 
-            DSL.register_matcher(self, name)
+            DSL::Matchers.register(self, name)
           end
         end
       end

data/lib/argspec/matchers/be.rb

@@ -3,19 +3,11 @@ module ArgumentSpecification
     class Be < BaseMatcher
       matcher_name :be
 
-      OPERATORS = {
-        :==  => :equal,
-        :=== => :case_equal,
-        :=~  => :match,
-        :<   => :be_less_than,
-        :>   => :be_greater_than,
-        :<=  => :be_less_than_or_equal_to,
-        :>=  => :be_greater_than_or_equal_to
-      }
-
-      OPERATORS.keys.each do |operator|
+      [:==, :===, :=~, :<, :>, :<=, :>=].each do |operator|
         define_method(operator) do |expected|
-          send(OPERATORS[operator], expected)
+          instance = BeComparedTo.new(operator, expected)
+          instance.send(:setup, operator, [operator, expected])
+          instance
         end
       end
 

data/lib/argspec/matchers/be_compared_to.rb

@@ -0,0 +1,89 @@
+module ArgumentSpecification
+  module Matchers
+    class BeComparedTo < BaseMatcher
+      attr_reader :operator, :expected
+
+      # Create a new matcher instance
+      #
+      # Arguments:
+      #   operator: (Symbol)
+      #   expected: (Object)
+      #
+      # Example:
+      #   >> ArgumentSpecification::Matchers::BeComparedTo.new(:==, 10)
+      #   => #<ArgumentSpecification::Matchers::BeComparedTo:0x00000000000000 @operator=:==, @expected=10>
+      #
+      def initialize(operator, expected)
+        @operator = operator
+        @expected = expected
+      end
+
+      # The failure message when using 'should'
+      #
+      # Example:
+      #   >> matcher.failure_message
+      #   => "':foo' should be equal to ':test'"
+      #
+      def failure_message
+        actual = prettify_args(@actual)
+
+        "'#{actual}' should #{pretty_matcher} '#{@expected}'"
+      end
+
+      # The failure message when using 'should not'
+      #
+      # Example:
+      #   >> matcher.failure_message_when_negated
+      #   => "':test' should not be equal to ':test'"
+      #
+      def failure_message_when_negated
+        actual = prettify_args(@actual)
+
+        "'#{actual}' should not #{pretty_matcher} '#{@expected}'"
+      end
+
+      # Check if the actual object matches
+      #
+      # Example:
+      #   >> matcher.matches?
+      #   => true
+      #
+      def matches?
+        begin
+          @actual.send(@operator, @expected)
+        rescue ArgumentError
+          false
+        end
+      end
+
+      private
+      # Get the pretty matcher name
+      #
+      # Example:
+      #   >> matcher = BeComparedTo.new(:==, 1)
+      #   >> matcher.pretty_matcher
+      #   => "equal"
+      #
+      def pretty_matcher
+        case @operator
+        when :==
+          "equal"
+        when :===
+          "case equal"
+        when :=~
+          "match"
+        when :<
+          "be less than"
+        when :>
+          "be greater than"
+        when :<=
+          "be less than or equal to"
+        when :>=
+          "be greater than or equal to"
+        else
+          "pass comparison #{@operator} to"
+        end
+      end
+    end
+  end
+end

data/lib/argspec/matchers/be_nil.rb

@@ -10,7 +10,11 @@ module ArgumentSpecification
       #   => true
       #
       def matches?
-        @actual.nil?
+        begin
+          @actual.nil?
+        rescue NoMethodError
+          false
+        end
       end
     end
   end

data/lib/argspec/matchers/be_one_of.rb

@@ -0,0 +1,36 @@
+module ArgumentSpecification
+  module Matchers
+    class BeOneOf < BaseMatcher
+      matcher_name :be_one_of
+
+      attr_reader :values
+
+      # Create a new matcher instance
+      #
+      # Arguments:
+      #   values: (Splat|Range)
+      #
+      # Example:
+      #   >> ArgumentSpecification::Matchers::BeOneOf.new(1, 2)
+      #   => #<ArgumentSpecification::Matchers::BeOneOf:0x00000000000000 @values=[1, 2]>
+      #
+      def initialize(*values)
+        if values && values.first.is_a?(Range)
+          @values = values.first.to_a
+        else
+          @values = values
+        end
+      end
+
+      # Check if the actual object matches
+      #
+      # Example:
+      #   >> matcher.matches?
+      #   => true
+      #
+      def matches?
+        @values.include?(@actual)
+      end
+    end
+  end
+end

data/lib/argspec.rb

@@ -9,6 +9,7 @@ module ArgumentSpecification
     def require!
       require 'argspec/constants'
       require 'argspec/dsl'
+      require 'argspec/dsl/matchers'
       require 'argspec/matchers'
       require 'argspec/argument'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: argspec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nialto Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,18 +72,17 @@ files:
 - lib/argspec/argument.rb
 - lib/argspec/constants.rb
 - lib/argspec/dsl.rb
+- lib/argspec/dsl/matchers.rb
 - lib/argspec/matchers.rb
 - lib/argspec/matchers/all.rb
 - lib/argspec/matchers/base_matcher.rb
 - lib/argspec/matchers/be.rb
 - lib/argspec/matchers/be_a.rb
+- lib/argspec/matchers/be_compared_to.rb
 - lib/argspec/matchers/be_empty.rb
 - lib/argspec/matchers/be_falsey.rb
-- lib/argspec/matchers/be_greater_than.rb
-- lib/argspec/matchers/be_greater_than_or_equal_to.rb
-- lib/argspec/matchers/be_less_than.rb
-- lib/argspec/matchers/be_less_than_or_equal_to.rb
 - lib/argspec/matchers/be_nil.rb
+- lib/argspec/matchers/be_one_of.rb
 - lib/argspec/matchers/be_truthy.rb
 - lib/argspec/matchers/be_within_range.rb
 - lib/argspec/matchers/case_equal.rb

data/lib/argspec/matchers/be_greater_than.rb

@@ -1,32 +0,0 @@
-module ArgumentSpecification
-  module Matchers
-    class BeGreaterThan < BaseMatcher
-      matcher_name :be_greater_than
-
-      attr_reader :expected
-
-      # Create a new matcher instance
-      #
-      # Arguments:
-      #   expected: (Object)
-      #
-      # Example:
-      #   >> ArgumentSpecification::Matchers::BeGreaterThan.new(10)
-      #   => #<ArgumentSpecification::Matchers::BeGreaterThan:0x00000000000000 @expected=10>
-      #
-      def initialize(expected)
-        @expected = expected
-      end
-
-      # Check if the actual object matches
-      #
-      # Example:
-      #   >> matcher.matches?
-      #   => true
-      #
-      def matches?
-        @actual > @expected
-      end
-    end
-  end
-end

data/lib/argspec/matchers/be_greater_than_or_equal_to.rb

@@ -1,32 +0,0 @@
-module ArgumentSpecification
-  module Matchers
-    class BeGreaterThanOrEqualTo < BaseMatcher
-      matcher_name :be_greater_than_or_equal_to
-
-      attr_reader :expected
-
-      # Create a new matcher instance
-      #
-      # Arguments:
-      #   expected: (Object)
-      #
-      # Example:
-      #   >> ArgumentSpecification::Matchers::BeGreaterThanOrEqualTo.new(10)
-      #   => #<ArgumentSpecification::Matchers::BeGreaterThanOrEqualTo:0x00000000000000 @expected=10>
-      #
-      def initialize(expected)
-        @expected = expected
-      end
-
-      # Check if the actual object matches
-      #
-      # Example:
-      #   >> matcher.matches?
-      #   => true
-      #
-      def matches?
-        @actual >= @expected
-      end
-    end
-  end
-end

data/lib/argspec/matchers/be_less_than.rb

@@ -1,32 +0,0 @@
-module ArgumentSpecification
-  module Matchers
-    class BeLessThan < BaseMatcher
-      matcher_name :be_less_than
-
-      attr_reader :expected
-
-      # Create a new matcher instance
-      #
-      # Arguments:
-      #   expected: (Object)
-      #
-      # Example:
-      #   >> ArgumentSpecification::Matchers::BeLessThan.new(10)
-      #   => #<ArgumentSpecification::Matchers::BeLessThan:0x00000000000000 @expected=10>
-      #
-      def initialize(expected)
-        @expected = expected
-      end
-
-      # Check if the actual object matches
-      #
-      # Example:
-      #   >> matcher.matches?
-      #   => true
-      #
-      def matches?
-        @actual < @expected
-      end
-    end
-  end
-end

data/lib/argspec/matchers/be_less_than_or_equal_to.rb

@@ -1,32 +0,0 @@
-module ArgumentSpecification
-  module Matchers
-    class BeLessThanOrEqualTo < BaseMatcher
-      matcher_name :be_less_than_or_equal_to
-
-      attr_reader :expected
-
-      # Create a new matcher instance
-      #
-      # Arguments:
-      #   expected: (Object)
-      #
-      # Example:
-      #   >> ArgumentSpecification::Matchers::BeLessThanOrEqualTo.new(10)
-      #   => #<ArgumentSpecification::Matchers::BeLessThanOrEqualTo:0x00000000000000 @expected=10>
-      #
-      def initialize(expected)
-        @expected = expected
-      end
-
-      # Check if the actual object matches
-      #
-      # Example:
-      #   >> matcher.matches?
-      #   => true
-      #
-      def matches?
-        @actual <= @expected
-      end
-    end
-  end
-end