sinclair 1.6.6 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c38de6f509924f2b5b98eff6492718504c2f83111360e4985c67e421a2cebc5
-  data.tar.gz: 9210a66214f8fa11a6c42496b00f1045bf2268adde7c049b1481d47b21aba6cd
+  metadata.gz: 0c06e4b7038a22a311b6ee13f1b8fd2df24211d8953982035df626dba8fb66c5
+  data.tar.gz: b19227562faa97bca59e76d997998917068ccb2d230a0b90dfa76140f2032209
 SHA512:
-  metadata.gz: 7536c4b9bc1198fd23777b4bd73d20479d0c94d6ef03444e48e4c05687623d0c4f2cdcdb8ad6bfef4a20832307f04021d14bdd628bd3ff2cbf6e1c611c5be7ad
-  data.tar.gz: f0c246aa85bd9989337240ded4aa36634b80dcf1042f8776663b05ebea81220dd13b60f45f8c12ee4aa95064be096094c68d9fe6619d517fa36a879ffe897011
+  metadata.gz: 87daf64f9e084ef37bb47efee4fb6ff174e70cfdf5005e506acdff45647fd4ad502b348b23c6a3bbb1cce09676c14d7be52cc816b493fdbb4c92d23b94b33ecf
+  data.tar.gz: 3d02e09271942cd50dc21eb9e9578b63db0374196e084b3ce9b54e3d816206731a88f8cb470581d791ecaf5a0f7a5435d2489ecf7465fa446b56d8f8c8b6dd24

data/.circleci/config.yml

@@ -18,7 +18,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.5.3
+      - image: darthjee/circleci_ruby_270:1.1.0
         environment:
           PROJECT: sinclair
     steps:
@@ -52,7 +52,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.5.3
+      - image: darthjee/circleci_ruby_270:1.1.0
         environment:
           PROJECT: sinclair
     steps:

data/Dockerfile

@@ -1,6 +1,6 @@
-FROM darthjee/scripts:0.1.8 as scripts
+FROM darthjee/scripts:0.3.1 as scripts
 
-FROM darthjee/ruby_gems:0.5.3 as base
+FROM darthjee/ruby_270:1.1.0 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.6](https://www.rubydoc.info/gems/sinclair/1.6.6)
+[https://www.rubydoc.info/gems/sinclair/1.8.0](https://www.rubydoc.info/gems/sinclair/1.8.0)
 
 Installation
 ---------------
@@ -369,6 +369,12 @@ hash
   MyConfigurable.config.host # returns 'interstella.art'
   MyConfigurable.config.port # returns 5555
 
+  # Configurable enables options that can be passed
+  MyConfigurable.as_options.host # returns 'interstella.art'
+
+  # Configurable enables options that can be passed with custom values
+  MyConfigurable.as_options(host: 'other').host # returns 'other'
+
   MyConfigurable.reset_config
 
   MyConfigurable.config.host # returns nil
@@ -553,3 +559,4 @@ Projects Using
 
 -   [Arstotzka](https://github.com/darthjee/arstotzka)
 -   [Azeroth](https://github.com/darthjee/azeroth)
+-   [Magicka](https://github.com/darthjee/magicka)

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:
@@ -28,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:
@@ -36,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/config.rb

@@ -37,5 +37,51 @@ class Sinclair
         hash[attribute.to_s] = public_send(attribute)
       end
     end
+
+    # Returns options with configurated values
+    #
+    # The returned options will use the values defined in
+    # the config merged with the extra attributes
+    #
+    # @param options_hash [Hash] optional values for the options
+    #
+    # @return [Sinclair::Option]
+    #
+    # @example returning default options
+    #   class LoginConfig < Sinclair::Config
+    #     add_configs :password, username: 'bob'
+    #   end
+    #
+    #   class LoginConfigurable
+    #     extend Sinclair::Configurable
+    #
+    #     configurable_by LoginConfig
+    #   end
+    #
+    #   LoginConfigurable.configure do |conf|
+    #     conf.username :some_username
+    #     conf.password :some_password
+    #   end
+    #
+    #   options = LoginConfigurable.config.as_options
+    #
+    #   config.as_options.username # returns :some_username
+    #   config.as_options.password # returns :some_password
+    #
+    # @example returning custom options
+    #   LoginConfigurable.configure do |conf|
+    #     conf.username :some_username
+    #     conf.password :some_password
+    #   end
+    #
+    #   options = LoginConfigurable.config.as_options(
+    #     password: :correct_password
+    #   )
+    #
+    #   config.as_options.username # returns :some_username
+    #   config.as_options.password # returns :correct_password
+    def as_options(options_hash = {})
+      self.class.options_class.new(to_hash.merge(options_hash))
+    end
   end
 end

data/lib/sinclair/config_class.rb

@@ -89,8 +89,23 @@ class Sinclair
       Config::MethodsBuilder.new(self, *args).tap do |builder|
         builder.build
 
+        Sinclair::InputHash.input_hash(*args).each do |name, value|
+          options_class.with_options(name => value)
+        end
+
         config_attributes(*builder.config_names)
       end
     end
+
+    # @api private
+    # Returns the options class exclusive to this configurable
+    #
+    # The returned class is configured in parallel with the
+    # configurable itself
+    #
+    # @return [Class<Sinclair::Options>]
+    def options_class
+      @options_class ||= Class.new(superclass.try(:options_class) || Options)
+    end
   end
 end

data/lib/sinclair/configurable.rb

@@ -9,8 +9,8 @@ class Sinclair
   # By extending Configurable, class receives the methods public
   # {ConfigFactory#config .config}, {ConfigFactory#reset_config .reset_config}
   # and {ConfigFactory#configure .configure}
-  # and the private methods {#configurable_with .configurable_with}
-  # and {#configurable_by .configurable_by}
+  # and the private methods {#configurable_with .configurable_with},
+  # {#configurable_by .configurable_by} and {#as_options .as_options}
   #
   # @see ConfigFactory
   # @see ConfigBuilder
@@ -78,6 +78,14 @@ class Sinclair
     # @see ConfigFactory#configure
     delegate :config, :reset_config, :configure, to: :config_factory
 
+    # @method as_options(options_hash = {})
+    # @api public
+    #
+    # @param (see Sinclair::Config#as_options)
+    # @return (see Sinclair::Config#as_options)
+    # @example (see Sinclair::Config#as_options)
+    delegate :as_options, to: :config
+
     protected
 
     # @api private

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

data/lib/sinclair/matchers/add_method.rb

@@ -3,43 +3,52 @@
 class Sinclair
   module Matchers
     # @api private
-    # @author darthjee
-    # @abstract
     #
-    # Base class for add_method matcher
-    class AddMethod < RSpec::Matchers::BuiltIn::BaseMatcher
-      # @param method [String,Symbol] the method, to be checked, name
-      def initialize(method)
-        @method = method.to_sym
-      end
-
-      # definition needed for block matchers
+    # Commone methods for matchers
+    module AddMethod
+      # @api public
       #
-      # @return [Boolean]
-      def supports_block_expectations?
-        true
-      end
-
-      # Checkes if another instnce is equal self
+      # Builds final matcher
       #
-      # @return [Boolean]
-      def equal?(other)
-        return unless other.class == self.class
-
-        other.method == method
+      # The matcher checks if a method was added
+      # to a class or instance
+      #
+      # @param [target] target where the method will be added
+      #
+      # @return [Sinclair::Matchers::Base]
+      #
+      # @example
+      #  RSpec.configure do |config|
+      #    config.include Sinclair::Matchers
+      #  end
+      #
+      #  class MyModel
+      #  end
+      #
+      #  RSpec.describe 'my test' do
+      #    let(:klass)   { Class.new(MyModel) }
+      #    let(:builder) { Sinclair.new(klass) }
+      #
+      #    before do
+      #      builder.add_method(:class_name, 'self.class.name')
+      #    end
+      #
+      #    it do
+      #      expect { builder.build }.to add_method(:class_name).to(klass)
+      #    end
+      #  end
+      def to(target = nil)
+        add_method_to_class.new(target, method_name)
       end
 
-      alias == equal?
-
-      protected
-
-      # @method method
-      # @private
+      # @abstract
       #
-      # The method, to be checked, name
+      # Raise a warning on the usage as this is only a builder
       #
-      # @return [Symbol]
-      attr_reader :method
+      # @raise SyntaxError
+      def matches?(_actual)
+        raise SyntaxError, matcher_error
+      end
     end
   end
 end

data/lib/sinclair/matchers/add_method_to.rb

@@ -7,49 +7,8 @@ class Sinclair
     # @abstract
     #
     # Base class for add_method_to matcher
-    class AddMethodTo < RSpec::Matchers::BuiltIn::BaseMatcher
-      # @param method [SYmbol,String] method name
-      def initialize(method)
-        @method = method
-      end
-
-      # Checks if expectation is true or not
-      #
-      # @return [Boolean] expectation check
-      def matches?(event_proc)
-        return false unless event_proc.is_a?(Proc)
-
-        raise_block_syntax_error if block_given?
-        perform_change(event_proc)
-        added?
-      end
-
-      # definition needed for block matchers
-      def supports_block_expectations?
-        true
-      end
-
-      # Checkes if another instnce is equal self
-      #
-      # @return [Boolean]
-      def equal?(other)
-        return unless other.class == self.class
-
-        other.method == method &&
-          other.klass == klass
-      end
-
-      alias == equal?
-
-      protected
-
-      # @method method
-      # @private
-      #
-      # The method, to be checked, name
-      #
-      # @return [Symbol]
-      attr_reader :method
+    class AddMethodTo < Base
+      include MethodTo
 
       private
 
@@ -58,19 +17,8 @@ class Sinclair
       # Checks if a method was added (didn't exist before)
       #
       # @return Boolean
-      def added?
-        !@initial_state && @final_state
-      end
-
-      # @private
-      #
-      # Call block to check if it aded a method or not
-      #
-      # @return [Boolan]
-      def perform_change(event_proc)
-        @initial_state = method_defined?
-        event_proc.call
-        @final_state = method_defined?
+      def check
+        !initial_state && final_state
       end
     end
   end

data/lib/sinclair/matchers/base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @abstract
+    # @api private
+    #
+    # Base class for all matchers
+    class Base < RSpec::Matchers::BuiltIn::BaseMatcher
+      # @param method_name [String,Symbol] the method, to be checked, name
+      def initialize(method_name)
+        @method_name = method_name.to_sym
+      end
+
+      # definition needed for block matchers
+      #
+      # @return [Boolean]
+      def supports_block_expectations?
+        true
+      end
+
+      # Checkes if another instnce is equal self
+      #
+      # @return [Boolean]
+      def equal?(other)
+        return unless other.class == self.class
+
+        other.method_name == method_name &&
+          other.try(:klass) == try(:klass)
+      end
+
+      alias == equal?
+
+      protected
+
+      # @method method_name
+      # @private
+      #
+      # The method, to be checked, name
+      #
+      # @return [Symbol]
+      attr_reader :method_name
+    end
+  end
+end