sinclair 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf2a52c6d33753fa9a52ad79fc4657d9d8573526a471ffb8c4fad386b1063e63
-  data.tar.gz: e219d16240478c36417001ac957437c4bcd2b29b241d51dde3802a0f9114dd32
+  metadata.gz: c859413d4a0550d19e5578915d18a1a9e2c1fd3759af5445de6599eb604e56ab
+  data.tar.gz: 495fe0c0dc55e043647887fb1637a3149647deef58293ef18d1df30b4fd05196
 SHA512:
-  metadata.gz: 1d8348d94ceebf9dc9a303f7f9e394ee3e8d42351a5c9b78a503c0882fb65a6afa6054a124cae96d7cc77380c7c239e10774a6dc0b7bb4091ff2de5fb4cc9df6
-  data.tar.gz: 8c6177428b8184b3b949bfa493a17b23b4a401b5767ebd131ffbdf125c03f061e20be249f079194557dcaf429c91f58517ab76b1cea9f7e2635bea55df76276b
+  metadata.gz: 61712ff93d7157675c92971f88b07ac8e6a19004ee2fa077d7f60ebaf9dd98118f1af2ff7730d983c0c705a7cd5e120f996b9baabf44bbcff0ccba93a9321f6a
+  data.tar.gz: 0d3ec3b940c71b9a02599184e9d2b9f8afc23cea563794bc903940fbf6f0bb84bbf203b87f57c02d6bab7907cc845c6aefd93649be92d99e157e4249427629e6

data/.circleci/config.yml

@@ -2,7 +2,9 @@ version: 2
 jobs:
   build:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.1.0
+      - image: darthjee/circleci_ruby_gems:0.2.1
+        environment:
+          PROJECT: sinclair
     steps:
       - checkout
       - run:
@@ -25,7 +27,7 @@ jobs:
           command: bundle exec rake verify_measurements
       - run:
           name: Check version documentation
-          command: scripts/check_readme.sh
+          command: check_readme.sh
       - run:
           name: Rubycritcs check
-          command: scripts/rubycritic.sh
+          command: rubycritic.sh

data/.rubocop.yml

@@ -8,6 +8,7 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*_spec.rb'
     - 'spec/support/**/*.rb'
+    - '*.gemspec'
 
 Metrics/LineLength:
   Max: 100
@@ -22,17 +23,32 @@ RSpec/AlignLeftLetBrace:
 RSpec/InstanceVariable:
   Exclude:
     - spec/integration/yard/sinclair/method_definition_spec.rb
-    - spec/integration/yard/sinclair/method_definition/block_definition_spec.rb
-    - spec/lib/sinclair/method_definition/block_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/instance_block_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/instance_method_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/class_block_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/class_method_definition_spec.rb
+    - spec/lib/sinclair/method_definition/instance_block_definition_spec.rb
+    - spec/lib/sinclair/method_definition/instance_method_definition_spec.rb
+    - spec/lib/sinclair/method_definition/class_block_definition_spec.rb
+    - spec/lib/sinclair/method_definition/class_method_definition_spec.rb
     - spec/lib/sinclair/method_definition_spec.rb
+    - spec/lib/sinclair/method_definition/block_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/block_definition_spec.rb
+
 
 RSpec/MultipleExpectations:
   Exclude:
     - spec/integration/yard/sinclair/method_definition_spec.rb
-    - spec/integration/yard/sinclair/method_definition/block_definition_spec.rb
-    - spec/integration/yard/sinclair/method_definition/string_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/instance_block_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/instance_string_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/instance_method_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/class_block_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/class_string_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/class_method_definition_spec.rb
     - spec/lib/sinclair_spec.rb
     - spec/integration/readme/my_model_spec.rb
+    - spec/integration/yard/sinclair/method_definition/block_definition_spec.rb
+    - spec/integration/yard/sinclair/method_definition/string_definition_spec.rb
 
 RSpec/NestedGroups:
   Max: 4

data/Dockerfile

@@ -1,19 +1,20 @@
-FROM darthjee/ruby_gems:0.1.0 as base
-FROM darthjee/scripts:0.0.2 as scripts
+FROM darthjee/ruby_gems:0.2.1 as base
+FROM darthjee/scripts:0.1.0 as scripts
 
 ######################################
 
 FROM base as builder
 
 COPY --chown=app ./ /home/app/app/
-COPY --chown=app:app --from=scripts /home/scripts/ ./
+COPY --chown=app:app --from=scripts /home/scripts/builder/bundle_builder.sh /usr/local/sbin/
 
 ENV HOME_DIR /home/app
-RUN /bin/bash bundle_builder.sh
+RUN bundle_builder.sh
 
 #######################
 #FINAL IMAGE
 FROM base
+RUN mkdir lib/sinclair -p
 
 USER root
 
@@ -23,4 +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 ./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.1
+https://www.rubydoc.info/gems/sinclair/1.4.2
 
 Installation
 ---------------

data/config/yardstick.yml

@@ -16,53 +16,28 @@ rules:
   ExampleTag:
     enabled: true
     exclude:
-      - Sinclair::OptionsParser#options
-      - Sinclair::OptionsParser#options_object
       - Sinclair::Configurable#config
       - Sinclair::Configurable#reset_config
       - Sinclair::Configurable#configure
+      - Sinclair::OptionsParser#options
+      - Sinclair::OptionsParser#options_object
   ReturnTag:
     enabled: true
     exclude:
-      - Sinclair#klass
-      - Sinclair::Matchers::AddMethod#method
-      - Sinclair::Matchers::AddMethodTo#method
-      - Sinclair::Matchers::AddMethodTo#instance
-      - Sinclair::MethodDefinition#name
-      - Sinclair::MethodDefinition#code
-      - Sinclair::MethodDefinition#block
-      - Sinclair::OptionsParser#options
-      - Sinclair::OptionsParser#options_object
-      - Sinclair::Matchers::AddMethodTo#raise_block_syntax_error
-      - Sinclair::ConfigFactory#initialize
-      - Sinclair::ConfigFactory#config_class
-      - Sinclair::ConfigFactory#config_attributes
-      - Sinclair::Config::MethodsBuilder#names
-      - Sinclair::Config::MethodsBuilder#defaults
-      - Sinclair::Configurable#config
-      - Sinclair::Configurable#reset_config
-      - Sinclair::Configurable#configure
+      - Sinclair::Matchers::AddClassMethodTo#raise_block_syntax_error
+      - Sinclair::Matchers::AddInstanceMethodTo#raise_block_syntax_error
   Summary::Presence:
     enabled: true
     exclude:
-      - Sinclair#klass
-      - Sinclair::Matchers::AddMethod#method
-      - Sinclair::Matchers::AddMethodTo#method
-      - Sinclair::Matchers::AddMethodTo#instance
+      - Sinclair::Config::MethodsBuilder#initialize
+      - Sinclair::ConfigFactory#initialize
+      - Sinclair::Matchers::AddClassMethodTo#initialize
+      - Sinclair::Matchers::AddInstanceMethodTo#instance
+      - Sinclair::Matchers::AddMethod#initialize
+      - Sinclair::Matchers::AddMethodTo#initialize
       - Sinclair::MethodDefinition#initialize
-      - Sinclair::MethodDefinition#name
-      - Sinclair::MethodDefinition#code
-      - Sinclair::MethodDefinition#block
       - Sinclair::MethodDefinition::BlockDefinition#initialize
       - Sinclair::MethodDefinition::StringDefinition#initialize
-      - Sinclair::OptionsParser#options
-      - Sinclair::OptionsParser#options_object
-      - Sinclair::ConfigFactory#initialize
-      - Sinclair::ConfigFactory#config_class
-      - Sinclair::ConfigFactory#config_attributes
-      - Sinclair::Config::MethodsBuilder#initialize
-      - Sinclair::Config::MethodsBuilder#names
-      - Sinclair::Config::MethodsBuilder#defaults
   Summary::Length:
     enabled: true
     exclude: []

data/lib/sinclair.rb

@@ -82,19 +82,20 @@ require 'active_support/all'
 class Sinclair
   require 'sinclair/options_parser'
 
-  autoload :VERSION,          'sinclair/version'
-  autoload :MethodDefinition, 'sinclair/method_definition'
-  autoload :Config,           'sinclair/config'
-  autoload :ConfigBuilder,    'sinclair/config_builder'
-  autoload :ConfigClass,      'sinclair/config_class'
-  autoload :ConfigFactory,    'sinclair/config_factory'
-  autoload :Configurable,     'sinclair/configurable'
+  autoload :VERSION,           'sinclair/version'
+  autoload :Config,            'sinclair/config'
+  autoload :ConfigBuilder,     'sinclair/config_builder'
+  autoload :ConfigClass,       'sinclair/config_class'
+  autoload :ConfigFactory,     'sinclair/config_factory'
+  autoload :Configurable,      'sinclair/configurable'
+  autoload :MethodDefinition,  'sinclair/method_definition'
+  autoload :MethodDefinitions, 'sinclair/method_definitions'
 
   include OptionsParser
 
   # Returns a new instance of Sinclair
   #
-  # @param klass [Class] to receive the methods
+  # @param klass [Class] Class that will receive the methods
   # @param options [Hash] open hash options to be used by builders inheriting from Sinclair
   #   through the Sinclair::OptionsParser concern
   #
@@ -171,12 +172,19 @@ class Sinclair
     end
   end
 
-  # add a method to the method list to be created on klass
+  # Add a method to the method list to be created on klass instances
   #
-  # @overload add_method(name, code)
-  #   @param name [String,Symbol] name of the method to be added
+  # @param name [String,Symbol] name of the method to be added
+  # @param options [Hash] Options of construction
+  # @option options cached [Boolean] Flag telling to create
+  #   a method with cache
+  #
+  # @overload add_method(name, code, **options)
   #   @param code [String] code to be evaluated when the method is ran
   #
+  # @overload add_method(name, **options, &block)
+  #   @param block [Proc]  block to be ran as method
+  #
   # @example Using string code
   #   class Person
   #     attr_reader :first_name, :last_name
@@ -193,19 +201,75 @@ class Sinclair
   #
   #   Person.new('john', 'wick').full_name # returns 'john wick'
   #
-  # @overload add_method(name, &block)
-  #   @param name [String,Symbol] name of the method to be added
-  #   @param block [Proc]  block to be ran as method
-  #
   # @example Using block
+  #   class Person
+  #     attr_reader :first_name, :last_name
+  #
+  #     def initialize(first_name, last_name)
+  #       @first_name = first_name
+  #       @last_name = last_name
+  #     end
+  #   end
+  #
   #   builder = Sinclair.new(Person)
+  #   builder.add_method(:full_name, '[first_name, last_name].join(" ")')
   #   builder.add_method(:bond_name) { "#{last_name}, #{full_name}" }
   #   builder.build
   #
   #   Person.new('john', 'wick').bond_name # returns 'wick, john wick'
   # @return [Array<MethodDefinition>]
   def add_method(name, code = nil, **options, &block)
-    definitions << MethodDefinition.from(name, code, **options, &block)
+    definitions.add(
+      MethodDefinition::InstanceMethodDefinition,
+      name, code, **options, &block
+    )
+  end
+
+  # Add a method to the method list to be created on klass
+  #
+  # @param name [String,Symbol] name of the method to be added
+  # @param options [Hash] Options of construction
+  # @option options cached [Boolean] Flag telling to create
+  #   a method with cache
+  #
+  # @overload add_class_method(name, code, **options)
+  #   @param code [String] code to be evaluated when the method is ran
+  #
+  # @overload add_class_method(name, **options, &block)
+  #   @param block [Proc]  block to be ran as method
+  #
+  # @example
+  #   class EnvFetcher
+  #   end
+  #
+  #   builder = Sinclair.new(EnvFetcher)
+  #
+  #   builder.add_class_method(:hostname, 'ENV["HOSTNAME"]')
+  #   builder.build
+  #
+  #   ENV['HOSTNAME'] = 'myhost'
+  #
+  #   env_fetcher.hostname # returns 'myhost'
+  #
+  # @example
+  #   class EnvFetcher
+  #   end
+  #
+  #   builder = Sinclair.new(EnvFetcher)
+  #
+  #   builder.add_class_method(:timeout) { ENV['TIMEOUT'] }
+  #   builder.build
+  #
+  #   ENV['TIMEOUT'] = '300'
+  #
+  #   env_fetcher.timeout # returns '300'
+  #
+  # @return [Array<MethodDefinition>]
+  def add_class_method(name, code = nil, **options, &block)
+    definitions.add(
+      MethodDefinition::ClassMethodDefinition,
+      name, code, **options, &block
+    )
   end
 
   # Evaluetes a block which will result in a String, the method code
@@ -284,8 +348,13 @@ class Sinclair
 
   private
 
+  # @method klass
   # @api private
   # @private
+  #
+  # Class that will receive the methods
+  #
+  # @return [Class]
   attr_reader :klass
 
   # @private
@@ -294,8 +363,8 @@ class Sinclair
   #
   # List of mthod definitions
   #
-  # @return [Array<MethodDefinition>]
+  # @return [MethodDefinitions]
   def definitions
-    @definitions ||= []
+    @definitions ||= MethodDefinitions.new
   end
 end

data/lib/sinclair/config.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 class Sinclair
+  # @api public
+  # @author darthjee
+  #
   # Base class for configuration when using {Configurable}
   #
   # The methods will be added later by {ConfigFactory}

data/lib/sinclair/config/methods_builder.rb

@@ -3,6 +3,7 @@
 class Sinclair
   class Config
     # @api private
+    # @author darthjee
     #
     # Class responsible for adding method to configuration
     # classes
@@ -27,7 +28,7 @@ class Sinclair
       # @overload initialize(klass, *names, default)
       #   @param names [Array<Symbol,String>] List of configuration names
       #     to be added
-      #   @param default [Hash] Configurations that will receive a default
+      #   @param default [Hash] Configurations that will receive a default value
       #     value when not configured
       def initialize(klass, *names)
         super(klass)
@@ -69,6 +70,19 @@ class Sinclair
 
       private
 
+      # @method names
+      # @private
+      #
+      # List of configuration names
+      #
+      # @return [Array<Symbol,String>]
+
+      # @method defaults
+      # @private
+      #
+      # Configurations that will receive a default value
+      #
+      # @return [Hash]
       attr_reader :names, :defaults
 
       # @private

data/lib/sinclair/config_builder.rb

@@ -2,6 +2,7 @@
 
 class Sinclair
   # @api private
+  # @author darthjee
   #
   # Class responsible for setting the values on configuration
   #

data/lib/sinclair/config_class.rb

@@ -2,6 +2,7 @@
 
 class Sinclair
   # @api public
+  # @author darthjee
   #
   # Module with all class methods for {Config}
   #

data/lib/sinclair/config_factory.rb

@@ -2,6 +2,7 @@
 
 class Sinclair
   # @api private
+  # @author darthjee
   #
   # Class responsible for configuring the configuration class
   #
@@ -22,6 +23,7 @@ class Sinclair
     CONFIG_CLASS_WARNING = 'Config class is expected to be ConfigClass. ' \
       "In future releases this will be enforced.\n" \
       'see more on https://github.com/darthjee/sinclair/blob/master/WARNINGS.md#usage-of-custom-config-classes'
+
     # @param config_class [Class] configuration class to be used
     # @param config_attributes [Array<Symbol,String>] list of possible configurations
     def initialize(config_class: Class.new(Config), config_attributes: [])
@@ -29,6 +31,7 @@ class Sinclair
       @config_attributes = config_attributes.dup
 
       return if config_class.is_a?(ConfigClass)
+
       warn CONFIG_CLASS_WARNING
     end
 
@@ -141,7 +144,19 @@ class Sinclair
 
     private
 
+    # method config_class
+    # @private
+    #
+    # Configuration class to be used
+    #
+    # @return [Class]
+
+    # @method config_attributes
     # @private
+    #
+    # List of possible configurations
+    #
+    # @return [Array<Symbol,String>]
     attr_reader :config_class, :config_attributes
 
     # @private