sinclair 1.8.0 → 1.10.0

data/lib/sinclair/matchers/add_method.rb

@@ -4,41 +4,39 @@ class Sinclair
   module Matchers
     # @api private
     #
-    # Commone methods for matchers
-    module AddMethod
-      # @api public
-      #
-      # Builds final matcher
-      #
-      # 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)
+    # Common methods for matchers
+    class AddMethod < Base
+      class << self
+        private
+
+        # @api private
+        # @private
+        #
+        # Add a method to generate the final matcher
+        #
+        # @param name [String,Symbol] the name of the method
+        # @param matcher_class [Class<AddMethodTo>] The matcher class to be returned
+        #
+        # @return (see Sinclair#build)
+        #
+        # @!macro with_final_matcher
+        #   @!method $1(target = nil)
+        #   @api public
+        #
+        #   Builds final matcher
+        #
+        #   The matcher checks if a method was added
+        #   to a class or instance
+        #
+        #   @param [Class,Object] target where the method will be added
+        #
+        #   @return [$2]
+        def with_final_matcher(name, matcher_class)
+          matcher = matcher_class
+          Sinclair.new(self).tap do |builder|
+            builder.add_method(name) { |target| matcher.new(target, method_name) }
+          end.build
+        end
       end
 
       # @abstract

data/lib/sinclair/matchers/change_class_method.rb

@@ -7,15 +7,30 @@ class Sinclair
     #
     # AddInstanceMethod is able to build an instance of
     # {Sinclair::Matchers::ChangeClassMethodOn}
-    class ChangeClassMethod < Base
-      include AddMethod
-
-      # @api public
+    class ChangeClassMethod < AddMethod
+      # @example Checking if a class method has changed
+      #  RSpec.configure do |config|
+      #    config.include Sinclair::Matchers
+      #  end
+      #
+      #  class MyModel
+      #  end
       #
-      # Builds final matcher
+      #  RSpec.describe 'my test' do
+      #    let(:builder) { Sinclair.new(klass) }
+      #    let(:klass)   { Class.new(MyModel) }
       #
-      # @return [Sinclair::Matchers::ChangeClassMethodOn]
-      alias on to
+      #    before do
+      #      builder.add_class_method(:the_method) { 10 }
+      #      builder.build
+      #      builder.add_class_method(:the_method) { 20 }
+      #    end
+      #
+      #    it do
+      #      expect{ builder.build }.to change_class_method(:the_method).on(klass)
+      #    end
+      #  end
+      with_final_matcher :on, ChangeClassMethodOn
 
       private
 
@@ -28,15 +43,6 @@ class Sinclair
         'You should specify which class the method is being changed on' \
           "change_class_method(:#{method_name}).on(klass)"
       end
-
-      # @private
-      #
-      # Class of the real matcher
-      #
-      # @return [Class<ChangeClassMethodOn>]
-      def add_method_to_class
-        ChangeClassMethodOn
-      end
     end
   end
 end

data/lib/sinclair/matchers/change_instance_method.rb

@@ -7,15 +7,54 @@ class Sinclair
     #
     # AddInstanceMethod is able to build an instance of
     # {Sinclair::Matchers::ChangeInstanceMethodOn}
-    class ChangeInstanceMethod < Base
-      include AddMethod
-
-      # @api public
+    class ChangeInstanceMethod < AddMethod
+      # @example Checking if an instance method has changed
+      #  RSpec.configure do |config|
+      #    config.include Sinclair::Matchers
+      #  end
+      #
+      #  class MyModel
+      #  end
+      #
+      #  RSpec.describe 'my test' do
+      #    let(:builder) { Sinclair.new(klass) }
+      #    let(:klass)   { Class.new(MyModel) }
+      #
+      #    before do
+      #      builder.add_method(:the_method) { 10 }
+      #      builder.build
+      #      builder.add_method(:the_method) { 20 }
+      #    end
+      #
+      #    it do
+      #      expect{ builder.build }.to change_method(:the_method).on(klass)
+      #    end
+      #  end
+      #
+      # @example Checking if an instance method has changed on an instance
+      #  RSpec.configure do |config|
+      #    config.include Sinclair::Matchers
+      #  end
+      #
+      #  class MyModel
+      #  end
       #
-      # Builds final matcher
+      #  RSpec.describe 'my test' do
+      #    let(:builder)  { Sinclair.new(klass) }
+      #    let(:instance) { klass.new }
+      #    let(:klass)    { Class.new(MyModel) }
       #
-      # @return [Sinclair::Matchers::ChangeInstanceMethodOn]
-      alias on to
+      #    before do
+      #      builder.add_method(:the_method) { 10 }
+      #      builder.build
+      #      builder.add_method(:the_method) { 20 }
+      #    end
+      #
+      #    it do
+      #      expect{ builder.build }.to change_method(:the_method).on(instance)
+      #    end
+      #  end
+      with_final_matcher :on, ChangeInstanceMethodOn
 
       private
 
@@ -28,15 +67,6 @@ class Sinclair
         '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.rb

@@ -6,8 +6,6 @@ class Sinclair
   #
   # Matchers module will have the DSL to be included in RSpec in order to have
   # access to the matchers
-  #
-  # @example (see Sinclair::Matchers::AddMethod#to)
   module Matchers
     autoload :Base,                   'sinclair/matchers/base'
     autoload :AddInstanceMethod,      'sinclair/matchers/add_instance_method'
@@ -25,7 +23,6 @@ class Sinclair
 
     # DSL to AddInstanceMethod
     #
-    # @example (see Sinclair::Matchers)
     # @example (see Sinclair::Matchers::AddInstanceMethod#to)
     #
     # @return [AddInstanceMethod] RSpec Matcher
@@ -35,7 +32,6 @@ class Sinclair
 
     # DSL to AddClassMethod
     #
-    # @example (see Sinclair::Matchers)
     # @example (see Sinclair::Matchers::AddClassMethod#to)
     #
     # @return [AddClassMethod] RSpec Matcher
@@ -45,8 +41,7 @@ class Sinclair
 
     # DSL to ChangeInstanceMethod
     #
-    # @example (see Sinclair::Matchers)
-    # @example (see Sinclair::Matchers::ChangeInstanceMethod#to)
+    # @example (see Sinclair::Matchers::ChangeInstanceMethod#on)
     #
     # @return [ChangeInstanceMethod] RSpec Matcher
     def change_method(method_name)
@@ -55,8 +50,7 @@ class Sinclair
 
     # DSL to ChangeClassMethod
     #
-    # @example (see Sinclair::Matchers)
-    # @example (see Sinclair::Matchers::ChangeClassMethod#to)
+    # @example (see Sinclair::Matchers::ChangeClassMethod#on)
     #
     # @return [ChangeClassMethod] RSpec Matcher
     def change_class_method(method_name)

data/lib/sinclair/method_builder/call_method_builder.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodBuilder
+    # @api private
+    # @author darthjee
+    #
+    # Build a method based on a {MethodDefinition::CallDefinition}
+    class CallMethodBuilder < Base
+      # Builds the method
+      #
+      # @return [NilClass]
+      def build
+        klass.module_eval(code_line, __FILE__, __LINE__ + 1)
+      end
+
+      private
+
+      # @api private
+      # @private
+      #
+      # String to be evaluated when building the method
+      #
+      # This can be {code_string} or {class_code_string}
+      # @return (see MethodDefinition::CallDefinition#code_string)
+      def code_line
+        instance? ? code_string : class_code_string
+      end
+
+      delegate :code_string, :class_code_string, to: :definition
+
+      # @method code_string
+      # @private
+      # @api private
+      #
+      # Delegated from {MethodDefinition::CallDefinition}
+      #
+      # @see MethodDefinition::CallDefinition#code_string
+      # @return [String]
+
+      # @method class_code_string
+      # @private
+      # @api private
+      #
+      # @see MethodDefinition::CallDefinition#class_code_string
+      # @return [String]
+    end
+  end
+end

data/lib/sinclair/method_builder.rb

@@ -9,6 +9,7 @@ class Sinclair
     autoload :Base,                'sinclair/method_builder/base'
     autoload :StringMethodBuilder, 'sinclair/method_builder/string_method_builder'
     autoload :BlockMethodBuilder,  'sinclair/method_builder/block_method_builder'
+    autoload :CallMethodBuilder,   'sinclair/method_builder/call_method_builder'
 
     CLASS_METHOD = :class
     INSTANCE_METHOD = :instance
@@ -53,8 +54,10 @@ class Sinclair
     def build_from_definition(definition, type)
       if definition.string?
         StringMethodBuilder.new(klass, definition, type: type).build
-      else
+      elsif definition.block?
         BlockMethodBuilder.new(klass, definition, type: type).build
+      else
+        CallMethodBuilder.new(klass, definition, type: type).build
       end
     end
   end

data/lib/sinclair/method_definition/call_definition.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodDefinition
+    # @api private
+    # @author darthjee
+    #
+    # Define a call of method to e done within the class
+    class CallDefinition < MethodDefinition
+      # @param method_name [Symbol] method to be called
+      # @param arguments [Array<Symbol,String>] parameters to be passed as
+      #   arguments to the call
+      def initialize(method_name, *arguments)
+        @arguments = arguments
+        super(method_name)
+      end
+
+      default_value :block?, false
+      default_value :string?, false
+
+      # String to be executed within the class
+      # @return [String]
+      def code_string
+        "#{name} :#{arguments.join(', :')}"
+      end
+
+      # String to be executed within the class running code to change the class itself
+      #
+      # @see code_string
+      # @return [String]
+      def class_code_string
+        <<-CODE
+          class << self
+            #{code_string}
+          end
+        CODE
+      end
+
+      private
+
+      attr_reader :arguments
+
+      # @method arguments
+      # @api private
+      # @private
+      #
+      # parameters to be passed as arguments to the call
+      #
+      # @return [Array<Symbol,String>]
+    end
+  end
+end

data/lib/sinclair/method_definition/string_definition.rb

@@ -5,8 +5,6 @@ class Sinclair
     # @api private
     # @author darthjee
     #
-    # @abstract
-    #
     # Define an instance method from string
     class StringDefinition < MethodDefinition
       # @param name    [String,Symbol] name of the method

data/lib/sinclair/method_definition.rb

@@ -11,6 +11,7 @@ class Sinclair
     autoload :BlockHelper,      'sinclair/method_definition/block_helper'
     autoload :BlockDefinition,  'sinclair/method_definition/block_definition'
     autoload :StringDefinition, 'sinclair/method_definition/string_definition'
+    autoload :CallDefinition,   'sinclair/method_definition/call_definition'
 
     # @method name
     #
@@ -24,31 +25,46 @@ class Sinclair
       cached: false
     }.freeze
 
-    # Builds a method that will return the same value always
-    #
-    # @return [Symbol]
-    def self.default_value(method_name, value)
-      define_method(method_name) { value }
-    end
+    class << self
+      # Builds a method that will return the same value always
+      #
+      # @return [Symbol]
+      def default_value(method_name, value)
+        define_method(method_name) { value }
+      end
 
-    # @param name    [String,Symbol] name of the method
-    # @param code    [String] code to be evaluated as method
-    # @param block   [Proc] block with code to be added as method
-    # @param options [Hash] Options of construction
-    # @option options cached [Boolean] Flag telling to create a block
-    #   with cache
-    #
-    # builds a method definition based on arguments
-    #
-    # when block is given, returns a {BlockDefinition} and
-    # returns a {StringDefinition} otherwise
-    #
-    # @return [Base]
-    def self.from(name, code = nil, **options, &block)
-      if block
-        BlockDefinition.new(name, **options, &block)
-      else
-        StringDefinition.new(name, code, **options)
+      # @param name    [String,Symbol] name of the method
+      # @param code    [String] code to be evaluated as method
+      # @param block   [Proc] block with code to be added as method
+      # @param options [Hash] Options of construction
+      # @option options cached [Boolean] Flag telling to create a block
+      #   with cache
+      #
+      # builds a method definition based on arguments
+      #
+      # when block is given, returns a {BlockDefinition} and
+      # returns a {StringDefinition} otherwise
+      #
+      # @return [Base]
+      def from(name, code = nil, **options, &block)
+        if block
+          BlockDefinition.new(name, **options, &block)
+        else
+          StringDefinition.new(name, code, **options)
+        end
+      end
+
+      # creates a definition
+      #
+      # The creation is based on type which will be used to infer
+      # which subclass of {Sinclair::MethodDefinition} to be used
+      #
+      # @param type [Symbol] the method definition type
+      #
+      # @return [Sinclair::MethodDefinition] an instance of a subclass
+      def for(type, *args, **options, &block)
+        klass = const_get("#{type}_definition".camelize)
+        klass.new(*args, **options, &block)
       end
     end
 

data/lib/sinclair/method_definitions.rb

@@ -10,6 +10,8 @@ class Sinclair
 
     # Builds and adds new definition
     #
+    # The type is decided based in the arguments
+    #
     # @param name [String,Symbol] method name
     # @param options [Hash] Options of construction
     # @option options cached [Boolean] Flag telling to create
@@ -21,11 +23,29 @@ class Sinclair
     # @overload add(definition_class, name, **options, &block)
     #   @param block [Proc]  block to be ran as method
     #
-    # @return MethodDefinitions
+    # @return [Array<MethodDefinition>]
     def add(name, code = nil, **options, &block)
       definitions << MethodDefinition.from(name, code, **options, &block)
     end
 
+    # Builds and adds new definition
+    #
+    # The type is decided based on the argument +type+
+    #
+    # @param type [Symbol] type of definition
+    #   - :string -> {MethodDefinition::StringDefinition}
+    #   - :block -> {MethodDefinition::BlockDefinition}
+    #   - :call -> {MethodDefinition::CallDefinition}
+    # @param options [Hash] Options of construction
+    # @option options cached [Boolean] Flag telling to create
+    #   a method with cache
+    # @param block [Proc]  block to be ran as method
+    #
+    # @return [Array<MethodDefinition>]
+    def add_definition(type, *args, **options, &block)
+      definitions << MethodDefinition.for(type, *args, **options, &block)
+    end
+
     private
 
     # @private

data/lib/sinclair/options/builder.rb

@@ -36,6 +36,7 @@ class Sinclair
       # @return (see Sinclair#build)
       def build
         add_all_methods
+        add_filds_to_equals
 
         super
       end
@@ -60,6 +61,13 @@ class Sinclair
           klass.allow(option)
         end
       end
+
+      # Add the fields to equals comparation
+      #
+      # @return (see Sinclair::EqualsChecker#add)
+      def add_filds_to_equals
+        klass.comparable_by(*attributes.keys)
+      end
     end
   end
 end

data/lib/sinclair/options.rb

@@ -24,6 +24,7 @@ class Sinclair
     autoload :ClassMethods, 'sinclair/options/class_methods'
 
     extend ClassMethods
+    include Comparable
 
     # @param options [Hash] hash with options (see {.options}, {.with_options})
     # @example (see Options)
@@ -59,19 +60,6 @@ class Sinclair
       end
     end
 
-    # returns if other equals to self
-    #
-    # @param other [Object] object to be compared
-    #
-    # @return [TrueClass,FalseClass]
-    def ==(other)
-      return false unless self.class == other.class
-
-      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

data/lib/sinclair/version.rb

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

data/lib/sinclair.rb

@@ -88,8 +88,10 @@ class Sinclair
   autoload :ConfigClass,       'sinclair/config_class'
   autoload :ConfigFactory,     'sinclair/config_factory'
   autoload :Configurable,      'sinclair/configurable'
+  autoload :Comparable,        'sinclair/comparable'
   autoload :EnvSettable,       'sinclair/env_settable'
   autoload :Exception,         'sinclair/exception'
+  autoload :EqualsChecker,     'sinclair/equals_checker'
   autoload :InputHash,         'sinclair/input_hash'
   autoload :MethodBuilder,     'sinclair/method_builder'
   autoload :MethodDefinition,  'sinclair/method_definition'

data/sinclair.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport', '~> 5.2.0'
 
-  gem.add_development_dependency 'bundler',            '2.3.20'
+  gem.add_development_dependency 'bundler',            '2.3.25'
   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'

data/spec/integration/readme/sinclair/comparable_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Comparable do
+  describe '#readme' do
+    describe '.comparable_by?' do
+      let(:model_class) do
+        Class.new(SampleModel) do
+          include Sinclair::Comparable
+
+          comparable_by :name
+        end
+      end
+
+      it 'regular usage' do
+        model1 = model_class.new(name: 'jack', age: 21)
+        model2 = model_class.new(name: 'jack', age: 23)
+
+        expect(model1 == model2).to be_truthy
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Comparable do
+  describe '#yard' do
+    describe '.comparable_by?' do
+      let(:model_class) do
+        Class.new(SampleModel) do
+          include Sinclair::Comparable
+
+          comparable_by :name
+        end
+      end
+
+      it 'regular usage' do
+        model1 = model_class.new(name: 'jack', age: 21)
+        model2 = model_class.new(name: 'jack', age: 23)
+
+        expect(model1 == model2).to be_truthy
+      end
+    end
+  end
+end