sinclair 1.4.1 → 1.4.2

data/lib/sinclair/method_definition/instance_block_definition.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodDefinition
+    # @api private
+    # @author darthjee
+    #
+    # Define a method from block
+    class InstanceBlockDefinition < BlockDefinition
+      private
+
+      # @private
+      #
+      # Method used to define an instance method
+      #
+      # @return [Symbol] Always :define_method
+      def method_definer
+        :define_method
+      end
+    end
+  end
+end

data/lib/sinclair/method_definition/instance_method_definition.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodDefinition
+    # @api private
+    # @author darthjee
+    #
+    # Module responsible for building instance method definitions
+    module InstanceMethodDefinition
+      # Returns an instance method definition
+      #
+      # When block is given returns an instance of
+      # {InstanceBlockDefinition}, and when not, returns
+      # {InstanceStringDefinition}
+      #
+      # @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 method with cache
+      #
+      # @example
+      #   klass = Class.new
+      #
+      #   method_definition = Sinclair::MethodDefinition::InstanceMethodDefinition.from(
+      #     :sequence, '@x = @x.to_i ** 2 + 1'
+      #   )
+      #
+      #   method_definition.build(klass)
+      #
+      #   instance = klass.new
+      #
+      #   instance.sequence # returns 1
+      #   instance.sequence # returns 2
+      #   instance.sequence # returns 5
+      #
+      # @return MethodDefinition
+      def self.from(name, code = nil, **options, &block)
+        if block
+          InstanceBlockDefinition.new(name, **options, &block)
+        else
+          InstanceStringDefinition.new(name, code, **options)
+        end
+      end
+    end
+  end
+end

data/lib/sinclair/method_definition/instance_string_definition.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodDefinition
+    # @api private
+    # @author darthjee
+    #
+    # Define an instance method from string
+    class InstanceStringDefinition < StringDefinition
+      private
+
+      # @private
+      #
+      # String used when defining method
+      #
+      # Instance definition always returns +name+
+      #
+      # @return [String]
+      def method_name
+        name
+      end
+    end
+  end
+end

data/lib/sinclair/method_definition/string_definition.rb

@@ -2,7 +2,12 @@
 
 class Sinclair
   class MethodDefinition
-    # Define a method from string
+    # @api private
+    # @author darthjee
+    #
+    # @abstract
+    #
+    # Define an instance method from string
     class StringDefinition < MethodDefinition
       # @param name    [String,Symbol] name of the method
       # @param code    [String] code to be evaluated as method
@@ -22,17 +27,17 @@ class Sinclair
       #
       # @return [Symbol] name of the created method
       #
-      # @example With no options
+      # @example Using instance string method with no options
       #   class MyModel
       #   end
       #
       #   instance = MyModel.new
       #
-      #   method_definition = Sinclair::MethodDefinition.from(
+      #   method_definition = Sinclair::MethodDefinition::InstanceStringDefinition.new(
       #     :sequence, '@x = @x.to_i ** 2 + 1'
       #   )
       #
-      #   method_definition.build(klass)      # adds instance_method :sequence to
+      #   method_definition.build(MyModel)    # adds instance_method :sequence to
       #                                       # MyModel instances
       #
       #   instance.instance_variable_get(:@x) # returns nil
@@ -43,12 +48,41 @@ class Sinclair
       #
       #   instance.instance_variable_get(:@x) # returns 5
       #
+      # @example Using class string method with cache options
+      #   class MyModel
+      #   end
+      #
+      #   method_definition = Sinclair::MethodDefinition::ClassStringDefinition.new(
+      #     :sequence,
+      #     '@x = @x.to_i ** 2 + 1',
+      #     cached: true
+      #   )
+      #
+      #   method_definition.build(MyModel) # adds instance_method :sequence to
+      #                                    # MyModel instances
+      #
+      #   MyModel.instance_variable_get(:@sequence) # returns nil
+      #   MyModel.instance_variable_get(:@x)        # returns nil
+      #
+      #   MyModel.sequence               # returns 1
+      #   MyModel.sequence               # returns 1 (cached value)
+      #
+      #   MyModel.instance_variable_get(:@sequence) # returns 1
+      #   MyModel.instance_variable_get(:@x)        # returns 1
       def build(klass)
         klass.module_eval(code_definition, __FILE__, __LINE__ + 1)
       end
 
       private
 
+      # @method code
+      # @private
+      #
+      # Code to be evaluated as method
+      #
+      # @return [String]
+      attr_reader :code
+
       # @private
       #
       # Builds full code of method
@@ -58,7 +92,7 @@ class Sinclair
         code_line = cached? ? code_with_cache : code
 
         <<-CODE
-          def #{name}
+          def #{method_name}
             #{code_line}
           end
         CODE

data/lib/sinclair/method_definitions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Sinclair
+  # @api private
+  # @author darthjee
+  #
+  # Enumerator holding all method definitions
+  class MethodDefinitions < Array
+    # Builds and adds new definition
+    #
+    # @param definition_class [Class] class used to define method definition
+    # @param name [String,Symbol] method name
+    # @param options [Hash] Options of construction
+    # @option options cached [Boolean] Flag telling to create
+    #   a method with cache
+    #
+    # @overload add(definition_class, name, code = nil, **options)
+    #   @param code [String] code to be evaluated when the method is ran
+    #
+    # @overload add(definition_class, name, **options, &block)
+    #   @param block [Proc]  block to be ran as method
+    #
+    # @return MethodDefinitions
+    def add(definition_class, name, code = nil, **options, &block)
+      self << definition_class.from(name, code, **options, &block)
+    end
+  end
+end

data/lib/sinclair/options_parser.rb

@@ -33,9 +33,14 @@ class Sinclair
     private
 
     # @!visibility public
+    #
+    # Options hash
+    #
+    # @return [Hash]
     attr_reader :options
 
     # @!visibility public
+    # @api public
     #
     # Builds an openstruct of the Hash
     #

data/lib/sinclair/version.rb

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

data/sinclair.gemspec

@@ -21,14 +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-nav',       '~> 0.2.4'
-  gem.add_development_dependency 'rake',          '>= 12.3.1'
-  gem.add_development_dependency 'rspec',         '>= 3.8'
-  gem.add_development_dependency 'rubocop',       '0.58.1'
-  gem.add_development_dependency 'rubocop-rspec', '1.30.0'
-  gem.add_development_dependency 'rubycritic',    '>= 4.0.2'
-  gem.add_development_dependency 'simplecov',     '~> 0.16.x'
-  gem.add_development_dependency 'yard',          '>= 0.9.18'
-  gem.add_development_dependency 'yardstick',     '>= 0.9.9'
+  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 'rake',               '12.3.3'
+  gem.add_development_dependency 'reek',               '5.4.0'
+  gem.add_development_dependency 'rspec',              '3.8.0'
+  gem.add_development_dependency 'rspec-core',         '3.8.0'
+  gem.add_development_dependency 'rspec-expectations', '3.8.3'
+  gem.add_development_dependency 'rspec-mocks',        '3.8.0'
+  gem.add_development_dependency 'rspec-support',      '3.8.0'
+  gem.add_development_dependency 'rubocop',            '0.73.0'
+  gem.add_development_dependency 'rubocop-rspec',      '1.33.0'
+  gem.add_development_dependency 'rubycritic',         '4.1.0'
+  gem.add_development_dependency 'simplecov',          '0.17.0'
+  gem.add_development_dependency 'yard',               '0.9.19'
+  gem.add_development_dependency 'yardstick',          '0.9.9'
 end

data/spec/integration/yard/sinclair/matchers/add_class_method_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Sinclair::Matchers::AddClassMethod do
+  describe 'yard' do
+    describe '#to' do
+      context 'when checking against Class' do
+        let(:clazz) { Class.new(MyModel) }
+
+        let(:block) do
+          proc do
+            clazz.define_singleton_method(:new_method) { 2 }
+          end
+        end
+
+        it do
+          expect(&block).to add_class_method(:new_method).to(clazz)
+        end
+      end
+    end
+  end
+end

data/spec/integration/yard/sinclair/matchers/add_class_method_to_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Matchers::AddClassMethodTo do
+  describe 'yard' do
+    let(:klass)   { Class.new(MyModel) }
+
+    let(:block) do
+      proc do
+        klass.define_singleton_method(:parent_name) { superclass.name }
+      end
+    end
+
+    it do
+      expect(&block).to add_class_method(:parent_name).to(klass)
+    end
+  end
+end

data/spec/integration/yard/sinclair/matchers/{add_method_spec.rb → add_instance_method_spec.rb}

@@ -2,11 +2,11 @@
 
 require 'spec_helper'
 
-RSpec.describe Sinclair::Matchers::AddMethod do
+RSpec.describe Sinclair::Matchers::AddInstanceMethod do
   describe 'yard' do
     describe '#to' do
       context 'when checking against Class' do
-        let(:clazz)   { Class.new }
+        let(:clazz)   { Class.new(MyModel) }
         let(:builder) { Sinclair.new(clazz) }
 
         before do
@@ -19,7 +19,7 @@ RSpec.describe Sinclair::Matchers::AddMethod do
       end
 
       context 'when checking against instance' do
-        let(:clazz)    { Class.new }
+        let(:clazz)    { Class.new(MyModel) }
         let(:builder)  { Sinclair.new(clazz) }
         let(:instance) { clazz.new }
 

data/spec/integration/yard/sinclair/matchers/{add_method_to_spec.rb → add_instance_method_to_spec.rb}

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Sinclair::Matchers::AddMethodTo do
+describe Sinclair::Matchers::AddInstanceMethodTo do
   describe 'yard' do
     let(:klass)   { Class.new(MyModel) }
     let(:builder) { Sinclair.new(klass) }

data/spec/integration/yard/sinclair/method_definition/class_block_definition_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::MethodDefinition::ClassBlockDefinition do
+  describe 'yard' do
+    describe '#build' do
+      subject(:method_definition) do
+        described_class.new(name) do
+          @x = @x.to_i**2 + 1
+        end
+      end
+
+      let(:klass)    { Class.new }
+      let(:name)     { :sequence }
+
+      it 'adds a dynamic method' do
+        expect { method_definition.build(klass) }.to add_class_method(name).to(klass)
+        expect { klass.sequence }
+          .to change { klass.instance_variable_get(:@x) }.from(nil).to 1
+        expect(klass.sequence).to eq(2)
+        expect(klass.sequence).to eq(5)
+      end
+
+      it 'changes instance variable' do
+        method_definition.build(klass)
+
+        expect { klass.sequence }
+          .to change { klass.instance_variable_get(:@x) }
+          .from(nil).to 1
+      end
+    end
+  end
+end

data/spec/integration/yard/sinclair/method_definition/class_method_definition_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::MethodDefinition::ClassMethodDefinition do
+  describe 'yard' do
+    describe '#build' do
+      describe 'using block with cache option' do
+        subject(:method_definition) do
+          described_class.from(name, cached: true) do
+            @x = @x.to_i**2 + 1
+          end
+        end
+
+        let(:klass)    { Class.new }
+        let(:name)     { :sequence }
+
+        it 'adds a dynamic method' do
+          expect { method_definition.build(klass) }.to add_class_method(name).to(klass)
+          expect { klass.sequence }
+            .to change { klass.instance_variable_get(:@x) }.from(nil).to 1
+          expect { klass.sequence }.not_to change(klass, :sequence)
+          expect(klass.instance_variable_get(:@sequence)).to eq(1)
+        end
+      end
+    end
+  end
+end

data/spec/integration/yard/sinclair/method_definition/class_string_definition_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+describe Sinclair::MethodDefinition::ClassStringDefinition do
+  describe 'yard' do
+    describe '#build' do
+      subject(:method_definition) do
+        described_class.new(name, code, cached: true)
+      end
+
+      let(:klass)    { Class.new }
+      let(:code)     { '@x = @x.to_i ** 2 + 1' }
+      let(:name)     { :sequence }
+
+      it 'adds a dynamic method' do
+        expect { method_definition.build(klass) }.to add_class_method(name).to(klass)
+        expect { klass.sequence }
+          .to change { klass.instance_variable_get(:@x) }.from(nil).to(1)
+        expect { klass.sequence }.not_to change(klass, :sequence)
+        expect(klass.instance_variable_get(:@sequence)).to eq(1)
+      end
+    end
+  end
+end

data/spec/integration/yard/sinclair/method_definition/{block_definition_spec.rb → instance_block_definition_spec.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-describe Sinclair::MethodDefinition::BlockDefinition do
+describe Sinclair::MethodDefinition::InstanceBlockDefinition do
   describe 'yard' do
     describe '#build' do
       subject(:method_definition) do
-        described_class.from(name, cached: true) do
+        described_class.new(name, cached: true) do
           @x = @x.to_i**2 + 1
         end
       end