sinclair 1.6.5 → 1.7.0

data/lib/sinclair/matchers/change_class_method_on.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # Checks if a class method was changed
+    # by the call of a block
+    #
+    #  This is used with a RSpec DSL method
+    #  change_class_method(method_name).on(class_object)
+    class ChangeClassMethodOn < ChangeMethodOn
+      # @param [Class] klass
+      #   Class where the class method should be added to
+      #
+      # @param method_name [SYmbol,String] method name
+      def initialize(target, method_name)
+        @klass = target
+        super(method_name)
+      end
+
+      # Return expectaton description
+      #
+      # @return [String]
+      def description
+        "change class method '#{method_name}' on #{klass}"
+      end
+
+      # Returns message on expectation failure
+      #
+      # @return [String]
+      def failure_message_for_should
+        "expected class method '#{method_name}' to be changed on #{klass} but " \
+          "#{initial_state ? "it didn't" : "it didn't exist"}"
+      end
+
+      # Returns message on expectation failure for negative expectation
+      #
+      # @return [String]
+      def failure_message_for_should_not
+        "expected class method '#{method_name}' not to be changed on #{klass} but it was"
+      end
+
+      private
+
+      # Checks if class has instance method defined
+      #
+      # @return [Boolean]
+      def state
+        klass.methods(false).include?(method_name.to_sym) \
+          && klass.method(method_name)
+      end
+
+      # Raises when block was not given
+      #
+      # @raise SyntaxError
+      def raise_block_syntax_error
+        raise SyntaxError, 'Block not received by the `change_class_method_on` matcher. ' \
+          'Perhaps you want to use `{ ... }` instead of do/end?'
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/change_instance_method.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # AddInstanceMethod is able to build an instance of
+    # {Sinclair::Matchers::ChangeInstanceMethodOn}
+    class ChangeInstanceMethod < Base
+      include AddMethod
+
+      # @api public
+      #
+      # Builds final matcher
+      #
+      # @return [Sinclair::Matchers::ChangeInstanceMethodOn]
+      alias on to
+
+      private
+
+      # @private
+      #
+      # Error description on wrong usage
+      #
+      # @return String
+      def matcher_error
+        'You should specify which instance the method is being changed on' \
+          "change_method(:#{method_name}).on(instance)"
+      end
+
+      # @private
+      #
+      # Class of the real matcher
+      #
+      # @return [Class<Sinclair::Matchers::Base>]
+      def add_method_to_class
+        ChangeInstanceMethodOn
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/change_instance_method_on.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # Checks if a method was changed
+    # by the call of a block
+    #
+    #  This is used with a RSpec DSL method
+    #  change_method(method_name).on(class_object)
+    class ChangeInstanceMethodOn < ChangeMethodOn
+      # @overload initialize(klass, method_name)
+      #   @param [Class] klass
+      #     class where the method should be added to
+      #
+      # @overload initialize(instance, method_name)
+      #   @param [Object] instance
+      #     instance of the class where the method should be added to
+      #
+      # @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_name)
+      end
+
+      # Returnst expectaton description
+      #
+      # @return [String]
+      def description
+        "change method '#{method_name}' on #{klass} instances"
+      end
+
+      # Returns message on expectation failure
+      #
+      # @return [String]
+      def failure_message_for_should
+        "expected '#{method_name}' to be changed on #{klass} but " \
+          "#{initial_state ? "it didn't" : "it didn't exist"}"
+      end
+
+      # Returns message on expectation failure for negative expectation
+      #
+      # @return [String]
+      def failure_message_for_should_not
+        "expected '#{method_name}' not to be changed on #{klass} but it was"
+      end
+
+      protected
+
+      # @method instance
+      # @api private
+      # @private
+      #
+      # Instance of the class where the method should be added
+      #
+      # @return [Object]
+      attr_reader :instance
+
+      # @private
+      #
+      # Class to be analised
+      #
+      # @return [Class]
+      def klass
+        @klass ||= instance.class
+      end
+
+      private
+
+      # @private
+      #
+      # Checks if class has instance method defined
+      #
+      # @return [Boolean]
+      def state
+        klass.method_defined?(method_name) &&
+          klass.instance_method(method_name)
+      end
+
+      # @private
+      #
+      # Raises when block was not given
+      #
+      # @raise SyntaxError
+      def raise_block_syntax_error
+        raise SyntaxError, 'Block not received by the `change_instance_method_on` matcher. ' \
+          'Perhaps you want to use `{ ... }` instead of do/end?'
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/change_method_on.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    # @abstract
+    #
+    # Base class for change_method_on matcher
+    class ChangeMethodOn < Base
+      include MethodTo
+
+      private
+
+      # @private
+      #
+      # Checks if a method was changed
+      #
+      # @return Boolean
+      def check
+        initial_state && initial_state != final_state
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/method_to.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    #
+    # Common methods on final matchers
+    module MethodTo
+      # Used for other versions of rspec
+      #
+      # Some versions call failure_message, others
+      # call failure_message_for_should
+      #
+      # @return [String]
+      def failure_message
+        failure_message_for_should
+      end
+
+      # Used for other versions of rspec
+      #
+      # Some versions call failure_message_when_negated, others
+      # call failure_message_for_should_not
+      #
+      # @return [String]
+      def failure_message_when_negated
+        failure_message_for_should_not
+      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)
+        check
+      end
+
+      protected
+
+      # @method klass
+      # @api private
+      # @private
+      #
+      # Class where class method should be added to
+      #
+      # @return [Class]
+      attr_reader :klass
+
+      private
+
+      # @method initial_state
+      # @api private
+      # @private
+      #
+      # State before running the block
+      #
+      # @return [Object]
+
+      # @method final_state
+      # @api private
+      # @private
+      #
+      # State after running the block
+      #
+      # @return [Object]
+      attr_reader :initial_state, :final_state
+
+      # @private
+      #
+      # Call block to check if it aded a method or not
+      #
+      # @return [Boolan]
+      def perform_change(event_proc)
+        @initial_state = state
+        event_proc.call
+        @final_state = state
+      end
+    end
+  end
+end

data/lib/sinclair/matchers.rb

@@ -7,33 +7,21 @@ class Sinclair
   # Matchers module will have the DSL to be included in RSpec in order to have
   # access to the matchers
   #
-  # @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
+  # @example (see Sinclair::Matchers::AddMethod#to)
   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 +29,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 +39,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/options/class_methods.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'set'
+
+class Sinclair
+  class Options
+    # Class Methods for {Sinclai::Options}
+    module ClassMethods
+      # @api private
+      #
+      # returns invalid options
+      #
+      # @return [Array<Symbol>]
+      def invalid_options_in(names)
+        names.map(&:to_sym) - allowed_options.to_a
+      end
+
+      # @api private
+      #
+      # Allow new option
+      #
+      # This does not create the method
+      #
+      # @param name [String,Symbol] options to be allowed
+      #
+      # @return [Set<Symbol>]
+      def allow(name)
+        allowed_options << name.to_sym
+      end
+
+      # @api private
+      # @private
+      #
+      # Options allowed when initializing options
+      #
+      # @return [Set<Symbol>]
+      def allowed_options
+        @allowed_options ||= superclass.try(:allowed_options).dup || Set.new
+      end
+
+      # @api private
+      #
+      # checks if class skips initialization validation
+      #
+      # @return [TrueClass,FalseClass]
+      def skip_validation?
+        @skip_validation ||= superclass.try(:skip_validation?) || false
+      end
+
+      # @api public
+      #
+      # Add available options
+      #
+      # @example (see Options)
+      #
+      # @return (see Sinclair#build)
+      #
+      # @overload with_options(*options)
+      #   @param options [Array<Symbol>] list of accepted
+      #     options
+      # @overload with_options(*options, **defaults)
+      #   @param options [Array<Symbol>] list of accepted
+      #     options
+      #   @param defaults [Hash<Symbol,Object>] default options
+      #     hash
+      def with_options(*options)
+        Builder.new(self, *options).build
+      end
+
+      # @api public
+      #
+      # Changes class to skip attributes validation
+      #
+      # when initializing options, options
+      # will accept any arguments when validation
+      # is skipped
+      #
+      # @return [TrueClass]
+      #
+      # @example
+      #   class BuilderOptions < Sinclair::Options
+      #     with_options :name
+      #
+      #     skip_validation
+      #   end
+      #   options = BuilderOptions.new(name: 'Joe', age: 10)
+      #
+      #   options.name      # returns 'Joe'
+      #   options.try(:age) # returns nil
+      def skip_validation
+        @skip_validation = true
+      end
+    end
+  end
+end

data/lib/sinclair/options.rb

@@ -20,64 +20,10 @@ class Sinclair
   #   options.port     # returns 8080
   #   options.protocol # returns 'https'
   class Options
-    autoload :Builder, 'sinclair/options/builder'
+    autoload :Builder,      'sinclair/options/builder'
+    autoload :ClassMethods, 'sinclair/options/class_methods'
 
-    class << self
-      # @api private
-      #
-      # returns invalid options
-      #
-      # @return [Array<Symbol>]
-      def invalid_options_in(names)
-        names.map(&:to_sym) - allowed_options.to_a
-      end
-
-      # @api private
-      #
-      # Allow new option
-      #
-      # This does not create the method
-      #
-      # @param name [String,Symbol] options to be allowed
-      #
-      # @return [Set<Symbol>]
-      def allow(name)
-        allowed_options << name.to_sym
-      end
-
-      # @api private
-      # @private
-      #
-      # Options allowed when initializing options
-      #
-      # @return [Set<Symbol>]
-      def allowed_options
-        @allowed_options ||= superclass.try(:allowed_options).dup || Set.new
-      end
-
-      private
-
-      # @api public
-      # @!visibility public
-      #
-      # Add available options
-      #
-      # @example (see Options)
-      #
-      # @return (see Sinclair#build)
-      #
-      # @overload with_options(*options)
-      #   @param options [Array<Symbol>] list of accepted
-      #     options
-      # @overload with_options(*options, **defaults)
-      #   @param options [Array<Symbol>] list of accepted
-      #     options
-      #   @param defaults [Hash<Symbol,Object>] default options
-      #     hash
-      def with_options(*options)
-        Builder.new(self, *options).build
-      end
-    end
+    extend ClassMethods
 
     # @param options [Hash] hash with options (see {.options}, {.with_options})
     # @example (see Options)
@@ -108,7 +54,7 @@ class Sinclair
     #                #   protocol: 'https'
     #                # }
     def to_h
-      self.class.allowed_options.inject({}) do |hash, option|
+      allowed_options.inject({}) do |hash, option|
         hash.merge(option => public_send(option))
       end
     end
@@ -121,13 +67,15 @@ class Sinclair
     def ==(other)
       return false unless self.class == other.class
 
-      self.class.allowed_options.all? do |name|
+      allowed_options.all? do |name|
         public_send(name) == other.public_send(name)
       end
     end
 
     private
 
+    delegate :allowed_options, :skip_validation?, :invalid_options_in, to: :class
+
     # @private
     # @api private
     #
@@ -137,7 +85,9 @@ class Sinclair
     #
     # @return [NilClass]
     def check_options(options)
-      invalid_keys = self.class.invalid_options_in(options.keys)
+      return if skip_validation?
+
+      invalid_keys = invalid_options_in(options.keys)
 
       return if invalid_keys.empty?
 

data/lib/sinclair/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Sinclair
-  VERSION = '1.6.5'
+  VERSION = '1.7.0'
 end

data/sinclair.gemspec

@@ -21,20 +21,20 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport', '~> 5.2.0'
 
-  gem.add_development_dependency 'bundler',            '1.16.1'
-  gem.add_development_dependency 'pry',                '0.12.2'
-  gem.add_development_dependency 'pry-nav',            '0.3.0'
+  gem.add_development_dependency 'bundler',            '2.3.20'
+  gem.add_development_dependency 'pry',                '0.14.1'
+  gem.add_development_dependency 'pry-nav',            '1.0.0'
   gem.add_development_dependency 'rake',               '13.0.1'
-  gem.add_development_dependency 'reek',               '5.6.0'
-  gem.add_development_dependency 'rspec',              '3.9.0'
-  gem.add_development_dependency 'rspec-core',         '3.9.1'
-  gem.add_development_dependency 'rspec-expectations', '3.9.1'
-  gem.add_development_dependency 'rspec-mocks',        '3.9.1'
-  gem.add_development_dependency 'rspec-support',      '3.9.2'
+  gem.add_development_dependency 'reek',               '6.0.3'
+  gem.add_development_dependency 'rspec',              '3.11.0'
+  gem.add_development_dependency 'rspec-core',         '3.11.0'
+  gem.add_development_dependency 'rspec-expectations', '3.11.0'
+  gem.add_development_dependency 'rspec-mocks',        '3.11.1'
+  gem.add_development_dependency 'rspec-support',      '3.11.0'
   gem.add_development_dependency 'rubocop',            '0.80.1'
   gem.add_development_dependency 'rubocop-rspec',      '1.38.1'
-  gem.add_development_dependency 'rubycritic',         '4.4.1'
-  gem.add_development_dependency 'simplecov',          '0.17.1'
-  gem.add_development_dependency 'yard',               '0.9.24'
+  gem.add_development_dependency 'rubycritic',         '4.7.0'
+  gem.add_development_dependency 'simplecov',          '0.21.2'
+  gem.add_development_dependency 'yard',               '0.9.27'
   gem.add_development_dependency 'yardstick',          '0.9.9'
 end

data/spec/integration/readme/my_class_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe MyClass do
-  subject(:model) { klass.new(attributes) }
+  subject(:model) { klass.new(**attributes) }
 
   let(:klass) { described_class }
   let(:name)  { 'name' }

data/spec/integration/yard/sinclair/config_spec.rb

@@ -24,5 +24,32 @@ describe Sinclair::Config do
           .to eq('{"password":null,"username":"bob"}')
       end
     end
+
+    describe '#options' do
+      subject(:config) { configurable.config }
+
+      let(:configurable) { LoginConfigurable }
+
+      before do
+        LoginConfigurable.configure do |conf|
+          conf.username :some_username
+          conf.password :some_password
+        end
+      end
+
+      it 'returns options with correct values' do
+        expect(config.options.username).to eq(:some_username)
+        expect(config.options.password).to eq(:some_password)
+      end
+
+      context 'when merging with given attributes' do
+        subject(:options) { config.options(password: :correct_password) }
+
+        it 'returns options with custom values' do
+          expect(options.username).to eq(:some_username)
+          expect(options.password).to eq(:correct_password)
+        end
+      end
+    end
   end
 end