sinclair 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c859413d4a0550d19e5578915d18a1a9e2c1fd3759af5445de6599eb604e56ab
-  data.tar.gz: 495fe0c0dc55e043647887fb1637a3149647deef58293ef18d1df30b4fd05196
+  metadata.gz: 4e368ae3e5bd4a4fdea678f56442dd2d88fb29c1b59ef31b0bebb668c35eb6f4
+  data.tar.gz: 2662bab987171ad5199be408d3b88af8076f261ee038265f1d143eeb3a56a6b6
 SHA512:
-  metadata.gz: 61712ff93d7157675c92971f88b07ac8e6a19004ee2fa077d7f60ebaf9dd98118f1af2ff7730d983c0c705a7cd5e120f996b9baabf44bbcff0ccba93a9321f6a
-  data.tar.gz: 0d3ec3b940c71b9a02599184e9d2b9f8afc23cea563794bc903940fbf6f0bb84bbf203b87f57c02d6bab7907cc845c6aefd93649be92d99e157e4249427629e6
+  metadata.gz: f6d067cd6b01d8f1244ab3c32587d377d7b33460b1110f5209df3f0b5fd6b57dab5e5aa34fd7e7bfa1f462178e46ce8e50ce16ebbb8e78463447211753fde260
+  data.tar.gz: a25a3ad8031fe74fc8861c52e6cdfe1069a54049fd306929e0164f88f77e7f215d5ed816f842b06b80868862523d3e022b27f4dc78448cc39cf0a3f5af1f720d

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.2.1
+      - image: darthjee/circleci_ruby_gems:0.2.3
         environment:
           PROJECT: sinclair
     steps:
@@ -31,3 +31,6 @@ jobs:
       - run:
           name: Rubycritcs check
           command: rubycritic.sh
+      - run:
+          name: Check unit tests
+          command: check_specs

data/Dockerfile

@@ -1,5 +1,5 @@
-FROM darthjee/ruby_gems:0.2.1 as base
-FROM darthjee/scripts:0.1.0 as scripts
+FROM darthjee/ruby_gems:0.2.3 as base
+FROM darthjee/scripts:0.1.2 as scripts
 
 ######################################
 
@@ -24,7 +24,7 @@ COPY --chown=app:app --from=builder /home/app/bundle/specifications /usr/local/b
 COPY --chown=app:app --from=builder /home/app/bundle/bin /usr/local/bundle/bin
 COPY --chown=app:app --from=builder /home/app/bundle/extensions /usr/local/bundle/extensions
 
-COPY --chown=app ./*.gemspec ./Gemfile* /home/app/app/
+COPY --chown=app ./*.gemspec ./Gemfile /home/app/app/
 COPY --chown=app ./lib/sinclair/version.rb /home/app/app/lib/sinclair/
 USER app
 RUN bundle install

data/README.md

@@ -14,7 +14,7 @@ methods
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/sinclair/1.4.2
+https://www.rubydoc.info/gems/sinclair/1.5.0
 
 Installation
 ---------------

data/config/check_specs.yml

@@ -0,0 +1,5 @@
+ignore:
+  - lib/sinclair/matchers/add_method_to.rb
+  - lib/sinclair/matchers/add_method.rb
+  - lib/sinclair/version.rb
+  - lib/sinclair/method_builder/base.rb

data/config/yardstick.yml

@@ -26,6 +26,7 @@ rules:
     exclude:
       - Sinclair::Matchers::AddClassMethodTo#raise_block_syntax_error
       - Sinclair::Matchers::AddInstanceMethodTo#raise_block_syntax_error
+      - Sinclair::MethodBuilder#build_from_definition
   Summary::Presence:
     enabled: true
     exclude:
@@ -35,6 +36,8 @@ rules:
       - Sinclair::Matchers::AddInstanceMethodTo#instance
       - Sinclair::Matchers::AddMethod#initialize
       - Sinclair::Matchers::AddMethodTo#initialize
+      - Sinclair::MethodBuilder
+      - Sinclair::MethodBuilder::Base#initialize
       - Sinclair::MethodDefinition#initialize
       - Sinclair::MethodDefinition::BlockDefinition#initialize
       - Sinclair::MethodDefinition::StringDefinition#initialize

data/lib/sinclair.rb

@@ -88,6 +88,7 @@ class Sinclair
   autoload :ConfigClass,       'sinclair/config_class'
   autoload :ConfigFactory,     'sinclair/config_factory'
   autoload :Configurable,      'sinclair/configurable'
+  autoload :MethodBuilder,     'sinclair/method_builder'
   autoload :MethodDefinition,  'sinclair/method_definition'
   autoload :MethodDefinitions, 'sinclair/method_definitions'
 
@@ -167,9 +168,8 @@ class Sinclair
   #
   # @return [Array<MethodDefinition>]
   def build
-    definitions.each do |definition|
-      definition.build(klass)
-    end
+    builder.build_methods(definitions, MethodBuilder::INSTANCE_METHOD)
+    builder.build_methods(class_definitions, MethodBuilder::CLASS_METHOD)
   end
 
   # Add a method to the method list to be created on klass instances
@@ -220,7 +220,6 @@ class Sinclair
   # @return [Array<MethodDefinition>]
   def add_method(name, code = nil, **options, &block)
     definitions.add(
-      MethodDefinition::InstanceMethodDefinition,
       name, code, **options, &block
     )
   end
@@ -266,8 +265,7 @@ class Sinclair
   #
   # @return [Array<MethodDefinition>]
   def add_class_method(name, code = nil, **options, &block)
-    definitions.add(
-      MethodDefinition::ClassMethodDefinition,
+    class_definitions.add(
       name, code, **options, &block
     )
   end
@@ -348,6 +346,7 @@ class Sinclair
 
   private
 
+  attr_reader :klass
   # @method klass
   # @api private
   # @private
@@ -355,16 +354,34 @@ class Sinclair
   # Class that will receive the methods
   #
   # @return [Class]
-  attr_reader :klass
 
   # @private
-  #
   # @api private
   #
-  # List of mthod definitions
+  # List of instance method definitions
   #
   # @return [MethodDefinitions]
   def definitions
     @definitions ||= MethodDefinitions.new
   end
+
+  # @private
+  # @api private
+  #
+  # List of class method definitions
+  #
+  # @return [MethodDefinitions]
+  def class_definitions
+    @class_definitions ||= MethodDefinitions.new
+  end
+
+  # @private
+  # @api private
+  #
+  # MethodBuilder binded to the class
+  #
+  # @return [MethodBuilder]
+  def builder
+    @builder ||= MethodBuilder.new(klass)
+  end
 end

data/lib/sinclair/config/methods_builder.rb

@@ -70,8 +70,10 @@ class Sinclair
 
       private
 
+      attr_reader :names, :defaults
       # @method names
       # @private
+      # @api private
       #
       # List of configuration names
       #
@@ -79,11 +81,11 @@ class Sinclair
 
       # @method defaults
       # @private
+      # @api private
       #
       # Configurations that will receive a default value
       #
       # @return [Hash]
-      attr_reader :names, :defaults
 
       # @private
       #

data/lib/sinclair/config_factory.rb

@@ -144,8 +144,10 @@ class Sinclair
 
     private
 
-    # method config_class
+    attr_reader :config_class, :config_attributes
+    # @method config_class
     # @private
+    # @api private
     #
     # Configuration class to be used
     #
@@ -153,11 +155,11 @@ class Sinclair
 
     # @method config_attributes
     # @private
+    # @api private
     #
     # List of possible configurations
     #
     # @return [Array<Symbol,String>]
-    attr_reader :config_class, :config_attributes
 
     # @private
     #

data/lib/sinclair/matchers/add_class_method_to.rb

@@ -71,6 +71,7 @@ class Sinclair
 
       # @method klass
       # @private
+      # @api private
       #
       # Class where class method should be added to
       #

data/lib/sinclair/method_builder.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class Sinclair
+  # @api private
+  # @author darthjee
+  #
+  # Class responsible for building methods
+  class MethodBuilder
+    autoload :Base,                'sinclair/method_builder/base'
+    autoload :StringMethodBuilder, 'sinclair/method_builder/string_method_builder'
+    autoload :BlockMethodBuilder,  'sinclair/method_builder/block_method_builder'
+
+    CLASS_METHOD = :class
+    INSTANCE_METHOD = :instance
+
+    # @param klass [Class] class to receive the method
+    def initialize(klass)
+      @klass = klass
+    end
+
+    # Builds methods
+    #
+    # @param definitions [MethodDefinitions] all methods
+    #   definitions to be built
+    # @param type [Symbol] type of method to be built
+    #
+    # @return [MethodDefinitions]
+    def build_methods(definitions, type)
+      definitions.each do |definition|
+        build_from_definition(definition, type)
+      end
+    end
+
+    private
+
+    attr_reader :klass
+    # @method klass
+    # @private
+    # @api private
+    #
+    # class to receive the method
+    #
+    # @return [Class]
+
+    # @private
+    #
+    # Build one method from definition
+    #
+    # @param definition [MethodDefinition] the method definition
+    # @param type [Symbol] type of method to be built
+    #
+    # @return (see Base#build)
+    def build_from_definition(definition, type)
+      if definition.string?
+        StringMethodBuilder.new(klass, definition, type: type).build
+      else
+        BlockMethodBuilder.new(klass, definition, type: type).build
+      end
+    end
+  end
+end

data/lib/sinclair/method_builder/base.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodBuilder
+    # @api private
+    # @author darthjee
+    #
+    # Base class responsible for building methods
+    class Base
+      # @param klass [Class] class to receive the method
+      # @param definition [MethodDefinition] method defined
+      # @param type [Symbol] type of method to be build
+      #   - +:instance+ instance methods
+      #   - +:class+ class methods
+      def initialize(klass, definition, type:)
+        @klass = klass
+        @definition = definition
+        @type = type
+      end
+
+      # Build method (should be implemented in subclass)
+      #
+      # @return [Symbol] name of the method built
+      #
+      # @raise NotImplementedYet
+      def build
+        raise 'Not implemented yet. this should be imlemented in subclasses'
+      end
+
+      private
+
+      attr_reader :klass, :definition, :type
+      # @method klass
+      # @private
+      # @api private
+      #
+      # Class to receive the methods
+      #
+      # @return [Class]
+
+      # @method definition
+      # @private
+      # @api private
+      #
+      # return a definition object
+      #
+      # @return [MethodDefinition]
+
+      # @method type
+      # @private
+      # @api private
+      #
+      # Type of method, class or instance
+      #
+      # @return [Symbol]
+
+      # @private
+      #
+      # Checks if builder will build an instance method
+      #
+      # @return [TrueClass,FalseClass]
+      def instance?
+        type == INSTANCE_METHOD
+      end
+    end
+  end
+end

data/lib/sinclair/method_builder/block_method_builder.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodBuilder
+    # @api private
+    # @author darthjee
+    #
+    # Class responsible to build methods from
+    # block definitions
+    #
+    # @see MethodDefinition::BlockDefinition
+    class BlockMethodBuilder < Base
+      # Builds the method
+      #
+      # @return (see Base#build)
+      def build
+        klass.send(method_definition, name, method_block)
+      end
+
+      private
+
+      delegate :name, :method_block, to: :definition
+
+      # @private
+      #
+      # name of the method used to define a new method on class
+      #
+      # @return [Symbol]
+      def method_definition
+        instance? ? :define_method : :define_singleton_method
+      end
+    end
+  end
+end

data/lib/sinclair/method_builder/string_method_builder.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodBuilder
+    # @api private
+    # @author darthjee
+    #
+    # Class responsible to build methods from
+    # string definitions
+    #
+    # @see MethodDefinition::StringDefinition
+    class StringMethodBuilder < Base
+      # Builds the method
+      #
+      # @return (see Base#build)
+      def build
+        klass.module_eval(code_definition, __FILE__, __LINE__ + 1)
+      end
+
+      private
+
+      # @private
+      #
+      # string used for method name definition
+      #
+      # the string changes depending if it is
+      # a class or instance method
+      #
+      # @return [String]
+      def definition_name
+        instance? ? name : "self.#{name}"
+      end
+
+      # @private
+      #
+      # string with the code to be defined
+      #
+      # @return [String]
+      def code_definition
+        <<-CODE
+          def #{definition_name}
+            #{code_line}
+          end
+        CODE
+      end
+
+      delegate :code_line, :name, to: :definition
+    end
+  end
+end

data/lib/sinclair/method_definition.rb

@@ -8,20 +8,50 @@ class Sinclair
   class MethodDefinition
     include Sinclair::OptionsParser
 
-    autoload :InstanceMethodDefinition, 'sinclair/method_definition/instance_method_definition'
-    autoload :ClassMethodDefinition,    'sinclair/method_definition/class_method_definition'
-    autoload :BlockDefinition,          'sinclair/method_definition/block_definition'
-    autoload :StringDefinition,         'sinclair/method_definition/string_definition'
-    autoload :InstanceBlockDefinition,  'sinclair/method_definition/instance_block_definition'
-    autoload :InstanceStringDefinition, 'sinclair/method_definition/instance_string_definition'
-    autoload :ClassBlockDefinition,     'sinclair/method_definition/class_block_definition'
-    autoload :ClassStringDefinition,    'sinclair/method_definition/class_string_definition'
+    autoload :BlockHelper,      'sinclair/method_definition/block_helper'
+    autoload :BlockDefinition,  'sinclair/method_definition/block_definition'
+    autoload :StringDefinition, 'sinclair/method_definition/string_definition'
+
+    # @method name
+    #
+    # name of the method
+    #
+    # @return [String,Symbol]
+    attr_reader :name
 
     # Default options of initialization
     DEFAULT_OPTIONS = {
       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
+
+    # @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)
+      end
+    end
+
     # @param name    [String,Symbol] name of the method
     # @param options [Hash] Options of construction
     # @option options cached [Boolean] Flag telling to create
@@ -48,15 +78,6 @@ class Sinclair
         "Use #{self.class}.from to initialize a proper object"
     end
 
-    private
-
-    # @method name
-    # @private
-    #
-    # name of the method
-    #
-    # @return [String,Symbol]
-    attr_reader :name
     delegate :cached, to: :options_object
 
     # @private