sinclair 1.6.2 → 1.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15c8c49649134851cc9f1fb6a92d4ea19ff82cc2e68ce2d09339987b2623a5d4
-  data.tar.gz: def1468dbdf88b1f700edc6fd172cc6dc06d56b9aba07171cb6d7c3a7bcdc32e
+  metadata.gz: ecab9b7d077c8641fa413a2e8e8b673e2412a900f5a9322b81dff53e47a7c51d
+  data.tar.gz: 816d60a81f193492df1fa44cc5ae405e8521c4dca914ff862171e3381e9e4c7f
 SHA512:
-  metadata.gz: fcaf42f0c6ee8b2cdb4986e003b487f1f53184d9486c9479477fcfe4fb38550ff9deecc4b3029da563812179152ecee68c379b5673f60eedfb7df9a4f945b30c
-  data.tar.gz: 622f77edaeb7d9b247a15c071ecb80981e82d915124dbeb57851c86153c1790bd301ea7be067b9020281dc9aeecd6cec54ec4403a74972bf7f8d9d89cf444020
+  metadata.gz: 75b74e8881fe963bccff4b154727e354eeb9189d73774f86cbc53bbcea345d89cb34cc09fcd38db5136e9aad819f90179707ff7e6016e749c4fd336ef680169d
+  data.tar.gz: 195d742d548b6d9cfe218dc23ba8ae8194882abf0203b5cda7c90f4f06f122e1768da71d7f51e05ca3f32563ef5335046ab0f5d5e9513fcaf1dd36eec50059cf

data/.circleci/config.yml

@@ -1,8 +1,24 @@
 version: 2
+workflows:
+  version: 2
+  test-and-build:
+    jobs:
+      - test:
+          filters:
+            tags:
+              only: /.*/
+      - build-and-release:
+          requires: [test]
+          filters:
+            tags:
+              only: /\d+\.\d+\.\d+/
+            branches:
+              only:
+                - master
 jobs:
-  build:
+  test:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.5.0
+      - image: darthjee/circleci_ruby_gems:0.5.3
         environment:
           PROJECT: sinclair
     steps:
@@ -34,3 +50,22 @@ jobs:
       - run:
           name: Check unit tests
           command: check_specs
+  build-and-release:
+    docker:
+      - image: darthjee/circleci_ruby_gems:0.5.3
+        environment:
+          PROJECT: sinclair
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Signin
+          command: build_gem.sh signin
+      - run:
+          name: Build Gem
+          command: build_gem.sh build
+      - run:
+          name: Push Gem
+          command: build_gem.sh push

data/Dockerfile

@@ -1,6 +1,6 @@
-FROM darthjee/scripts:0.1.7 as scripts
+FROM darthjee/scripts:0.1.8 as scripts
 
-FROM darthjee/ruby_gems:0.5.0 as base
+FROM darthjee/ruby_gems:0.5.3 as base
 
 COPY --chown=app:app ./ /home/app/app/
 

data/README.md

@@ -15,7 +15,7 @@ methods
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.6.2](https://www.rubydoc.info/gems/sinclair/1.6.2)
+[https://www.rubydoc.info/gems/sinclair/1.6.7](https://www.rubydoc.info/gems/sinclair/1.6.7)
 
 Installation
 ---------------
@@ -409,7 +409,7 @@ Configurations can also be done through custom classes
   Client.config.url # returns 'http://interstella.com:8080'
 ```
 
-### Sinclair::Settable
+### Sinclair::EnvSettable
 
 Settable allows classes to extract configuration from environments through
 a simple meta-programable way
@@ -452,6 +452,8 @@ Options allows projects to have an easy to configure option object
 ```ruby
   class ConnectionOptions < Sinclair::Options
     with_options :timeout, :retries, port: 443, protocol: 'https'
+
+    # skip_validation if you dont want to validate intialization arguments
   end
 
  options = ConnectionOptions.new(
@@ -463,6 +465,8 @@ Options allows projects to have an easy to configure option object
  options.retries  # returns nil
  options.protocol # returns 'http'
  options.port     # returns 443
+
+ ConnectionOptions.new(invalid: 10) # raises Sinclair::Exception::InvalidOptions
 ```
 
 RSspec matcher

data/config/check_specs.yml

@@ -4,3 +4,6 @@ ignore:
   - lib/sinclair/version.rb
   - lib/sinclair/method_builder/base.rb
   - lib/sinclair/exception.rb
+  - lib/sinclair/matchers/method_to.rb
+  - lib/sinclair/matchers/base.rb
+  - lib/sinclair/matchers/change_method_on.rb

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 100
+threshold: 99.8
 require_exact_threshold: false
 rules:
   ApiTag::Presence:
@@ -19,6 +19,7 @@ rules:
       - Sinclair::Configurable#config
       - Sinclair::Configurable#reset_config
       - Sinclair::Configurable#configure
+      - Sinclair::Options#==
       - Sinclair::OptionsParser#options
       - Sinclair::OptionsParser#options_object
   ReturnTag:
@@ -27,6 +28,8 @@ rules:
       - Sinclair::Matchers::AddClassMethodTo#raise_block_syntax_error
       - Sinclair::Matchers::AddInstanceMethodTo#raise_block_syntax_error
       - Sinclair::MethodBuilder#build_from_definition
+      - Sinclair::Matchers::ChangeClassMethodOn#raise_block_syntax_error
+      - Sinclair::Matchers::ChangeInstanceMethodOn#raise_block_syntax_error
   Summary::Presence:
     enabled: true
     exclude:
@@ -35,10 +38,14 @@ rules:
       - Sinclair::EnvSettable::Builder#initialize
       - Sinclair::Exception::InvalidOptions#initialize
       - Sinclair::InputHash#initialize
+      - Sinclair::Matchers::AddInstanceMethodTo#initialize
       - Sinclair::Matchers::AddClassMethodTo#initialize
       - Sinclair::Matchers::AddInstanceMethodTo#instance
       - Sinclair::Matchers::AddMethod#initialize
       - Sinclair::Matchers::AddMethodTo#initialize
+      - Sinclair::Matchers::Base#initialize
+      - Sinclair::Matchers::ChangeClassMethodOn#initialize
+      - Sinclair::Matchers::ChangeInstanceMethodOn#initialize
       - Sinclair::MethodBuilder
       - Sinclair::MethodBuilder::Base#initialize
       - Sinclair::MethodDefinition#initialize

data/lib/sinclair/matchers.rb

@@ -28,12 +28,19 @@ class Sinclair
   #    end
   #  end
   module Matchers
-    autoload :AddMethod,           'sinclair/matchers/add_method'
-    autoload :AddInstanceMethod,   'sinclair/matchers/add_instance_method'
-    autoload :AddClassMethod,      'sinclair/matchers/add_class_method'
-    autoload :AddMethodTo,         'sinclair/matchers/add_method_to'
-    autoload :AddInstanceMethodTo, 'sinclair/matchers/add_instance_method_to'
-    autoload :AddClassMethodTo,    'sinclair/matchers/add_class_method_to'
+    autoload :Base,                   'sinclair/matchers/base'
+    autoload :AddInstanceMethod,      'sinclair/matchers/add_instance_method'
+    autoload :AddClassMethod,         'sinclair/matchers/add_class_method'
+    autoload :AddMethod,              'sinclair/matchers/add_method'
+    autoload :AddMethodTo,            'sinclair/matchers/add_method_to'
+    autoload :AddInstanceMethodTo,    'sinclair/matchers/add_instance_method_to'
+    autoload :AddClassMethodTo,       'sinclair/matchers/add_class_method_to'
+    autoload :ChangeClassMethod,      'sinclair/matchers/change_class_method'
+    autoload :ChangeInstanceMethod,   'sinclair/matchers/change_instance_method'
+    autoload :ChangeMethodOn,         'sinclair/matchers/change_method_on'
+    autoload :ChangeClassMethodOn,    'sinclair/matchers/change_class_method_on'
+    autoload :ChangeInstanceMethodOn, 'sinclair/matchers/change_instance_method_on'
+    autoload :MethodTo,               'sinclair/matchers/method_to'
 
     # DSL to AddInstanceMethod
     #
@@ -41,8 +48,8 @@ class Sinclair
     # @example (see Sinclair::Matchers::AddInstanceMethod#to)
     #
     # @return [AddInstanceMethod] RSpec Matcher
-    def add_method(method)
-      Sinclair::Matchers::AddInstanceMethod.new(method)
+    def add_method(method_name)
+      Sinclair::Matchers::AddInstanceMethod.new(method_name)
     end
 
     # DSL to AddClassMethod
@@ -51,8 +58,28 @@ class Sinclair
     # @example (see Sinclair::Matchers::AddClassMethod#to)
     #
     # @return [AddClassMethod] RSpec Matcher
-    def add_class_method(method)
-      Sinclair::Matchers::AddClassMethod.new(method)
+    def add_class_method(method_name)
+      Sinclair::Matchers::AddClassMethod.new(method_name)
+    end
+
+    # DSL to ChangeInstanceMethod
+    #
+    # @example (see Sinclair::Matchers)
+    # @example (see Sinclair::Matchers::ChangeInstanceMethod#to)
+    #
+    # @return [ChangeInstanceMethod] RSpec Matcher
+    def change_method(method_name)
+      Sinclair::Matchers::ChangeInstanceMethod.new(method_name)
+    end
+
+    # DSL to ChangeClassMethod
+    #
+    # @example (see Sinclair::Matchers)
+    # @example (see Sinclair::Matchers::ChangeClassMethod#to)
+    #
+    # @return [ChangeClassMethod] RSpec Matcher
+    def change_class_method(method_name)
+      Sinclair::Matchers::ChangeClassMethod.new(method_name)
     end
   end
 end

data/lib/sinclair/matchers/add_class_method.rb

@@ -31,25 +31,28 @@ class Sinclair
     #
     #   # outputs
     #   # should add method class_method 'new_method' to #<Class:0x000055b4d0a25c80>
-    class AddClassMethod < AddMethod
-      # @abstract
+    class AddClassMethod < Base
+      include AddMethod
+
+      private
+
+      # @private
       #
-      # Raise a warning on the usage as this is only a builder for AddClassMethodTo
+      # Error description on wrong usage
       #
-      # @raise SyntaxError
-      def matches?(_actual)
-        raise SyntaxError, 'You should specify which class the method is being added to' \
-          "add_class_method(:#{method}).to(klass)"
+      # @return String
+      def matcher_error
+        'You should specify which class the method is being added to' \
+          "add_class_method(:#{method_name}).to(klass)"
       end
 
-      # Creates a matcher {AddClassMethodTo}
+      # @private
       #
-      # @param target [Class]
-      #   class where the method should be added to
+      # Class of the real matcher
       #
-      # @return [AddClassMethodTo] the correct matcher
-      def to(target = nil)
-        AddClassMethodTo.new(target, method)
+      # @return [Class<Sinclair::Matchers::Base>]
+      def add_method_to_class
+        AddClassMethodTo
       end
     end
   end

data/lib/sinclair/matchers/add_class_method_to.rb

@@ -36,55 +36,41 @@ class Sinclair
       # @param [Class] klass
       #   Class where the class method should be added to
       #
-      # @param method [SYmbol,String] method name
-      def initialize(klass, method)
+      # @param method_name [SYmbol,String] method name
+      def initialize(klass, method_name)
         @klass = klass
-        super(method)
+        super(method_name)
       end
 
       # Return expectaton description
       #
       # @return [String]
       def description
-        "add method class_method '#{method}' to #{klass}"
+        "add class method '#{method_name}' to #{klass}"
       end
 
       # Returns message on expectation failure
       #
       # @return [String]
       def failure_message_for_should
-        "expected class_method '#{method}' to be added to #{klass} but " \
-          "#{@initial_state ? 'it already existed' : "it didn't"}"
+        "expected class method '#{method_name}' to be added to #{klass} but " \
+          "#{initial_state ? 'it already existed' : "it didn't"}"
       end
 
       # Returns message on expectation failure for negative expectation
       #
       # @return [String]
       def failure_message_for_should_not
-        "expected class_method '#{method}' not to be added to #{klass} but it was"
+        "expected class method '#{method_name}' not to be added to #{klass} but it was"
       end
 
-      alias failure_message failure_message_for_should
-      alias failure_message_when_negated failure_message_for_should_not
-
-      protected
-
-      # @method klass
-      # @private
-      # @api private
-      #
-      # Class where class method should be added to
-      #
-      # @return [Class]
-      attr_reader :klass
-
       private
 
       # Checks if class has instance method defined
       #
       # @return [Boolean]
-      def method_defined?
-        klass.methods(false).include?(method.to_sym)
+      def state
+        klass.methods(false).include?(method_name.to_sym)
       end
 
       # Raises when block was not given

data/lib/sinclair/matchers/add_instance_method.rb

@@ -55,30 +55,28 @@ class Sinclair
     #
     #   # Outputs
     #   # 'should add method 'the_method' to #<Class:0x000056441bf46608> instances'
-    class AddInstanceMethod < AddMethod
-      # @abstract
+    class AddInstanceMethod < Base
+      include AddMethod
+
+      private
+
+      # @private
       #
-      # Raise a warning on the usage as this is only a builder for {AddInstanceMethodTo}
+      # Error description on wrong usage
       #
-      # @raise SyntaxError
-      def matches?(_actual)
-        raise SyntaxError, 'You should specify which instance the method is being added to' \
-          "add_method(:#{method}).to(instance)"
+      # @return String
+      def matcher_error
+        'You should specify which instance the method is being added to' \
+          "add_method(:#{method_name}).to(instance)"
       end
 
-      # Creates a matcher AddInstanceMethodTo
-      #
-      # @overload to(klass)
-      #   @param [Class] klass
-      #     class where the method should be added to
+      # @private
       #
-      # @overload to(instance)
-      #   @param [Object] instance
-      #     instance of the class where the method should be added to
+      # Class of the real matcher
       #
-      # @return [AddInstanceMethodTo] the correct matcher
-      def to(target = nil)
-        AddInstanceMethodTo.new(target, method)
+      # @return [Class<Sinclair::Matchers::Base>]
+      def add_method_to_class
+        AddInstanceMethodTo
       end
     end
   end

data/lib/sinclair/matchers/add_instance_method_to.rb

@@ -30,54 +30,50 @@ class Sinclair
     #     end
     #   end
     class AddInstanceMethodTo < AddMethodTo
-      # Returns a new instance of AddInstanceMethodTo
-      #
-      # @overload initialize(klass, method)
+      # @overload initialize(klass, method_name)
       #   @param [Class] klass
       #     class where the method should be added to
       #
-      # @overload initialize(instance, method)
+      # @overload initialize(instance, method_name)
       #   @param [Object] instance
       #     instance of the class where the method should be added to
       #
-      # @param method [Symbol,String] method name
-      def initialize(target, method)
+      # @param method_name [Symbol,String] method name
+      def initialize(target, method_name)
         if target.is_a?(Class)
           @klass = target
         else
           @instance = target
         end
-        super(method)
+        super(method_name)
       end
 
       # Returnst expectaton description
       #
       # @return [String]
       def description
-        "add method '#{method}' to #{klass} instances"
+        "add method '#{method_name}' to #{klass} instances"
       end
 
       # Returns message on expectation failure
       #
       # @return [String]
       def failure_message_for_should
-        "expected '#{method}' to be added to #{klass} but " \
-          "#{@initial_state ? 'it already existed' : "it didn't"}"
+        "expected '#{method_name}' to be added to #{klass} but " \
+          "#{initial_state ? 'it already existed' : "it didn't"}"
       end
 
       # Returns message on expectation failure for negative expectation
       #
       # @return [String]
       def failure_message_for_should_not
-        "expected '#{method}' not to be added to #{klass} but it was"
+        "expected '#{method_name}' not to be added to #{klass} but it was"
       end
 
-      alias failure_message failure_message_for_should
-      alias failure_message_when_negated failure_message_for_should_not
-
       protected
 
       # @method instance
+      # @api private
       # @private
       #
       # Instance of the class where the method should be added
@@ -101,8 +97,8 @@ class Sinclair
       # Checks if class has instance method defined
       #
       # @return [Boolean]
-      def method_defined?
-        klass.method_defined?(method)
+      def state
+        klass.method_defined?(method_name)
       end
 
       # @private