sinclair 1.14.0 → 1.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ee09cd280144bc873d89c0272856bf716e0a20c2ca5d3f7fe8bf11ac972c859
-  data.tar.gz: c5107aa15ffab29f4dd14b45efd0387913c60064ad62a58c4ec85adb09d91c9c
+  metadata.gz: b6bd1d9896437c341e52648bac78c70d453a773c92a2fba06111d88d12be06a3
+  data.tar.gz: 5cb2ba761532e3db60ffc8a09b821509c1355949071c5346cef962b0d43dfe9d
 SHA512:
-  metadata.gz: 38994db2d8a69ef1b9f3827a84bcb53a0bd18e2073a4840b004a89ac00a0fe0f5d9a8a69ce231b9d6c5f2cfc51b3a96c5ee898c848ce7ba802eac1d8556a058b
-  data.tar.gz: 4812c5a5793de217eb0cdd895c8cc94ac698af119c60fded29ea6929bddf0240b9dbcdba237dba7c1f060a3c3b8a3a173d2c7fef0509f6181d738ca0c7f0ef34
+  metadata.gz: bf2fd682ae8e6c57a8a173a5f78492bf6c7011dfef7734fd9c0c2d3d4d73fa599bac72a9317920dd0ebf5bb6c98f0f2f511c0fcc9fe5b683f766b5624359ccf3
+  data.tar.gz: db83a68fd9b11d0a227afca422f5a6e8e33bc64e3624a55c0d8f3b87d49235d8e17b1393c44b6ac2a67c8b9869e58d5780a3a06aad4f76429a4c4b0c48247f43

data/Dockerfile.circleci

@@ -0,0 +1,28 @@
+FROM darthjee/scripts:0.3.1 as scripts
+
+FROM darthjee/circleci_ruby_270:1.2.0 as base
+
+COPY --chown=app:app ./ /home/circleci/project/
+
+######################################
+
+FROM base as builder
+
+COPY --chown=circleci:circleci --from=scripts /home/scripts/builder/bundle_builder.sh /usr/local/sbin/bundle_builder.sh
+
+ENV PROJECT sinclair
+ENV HOME_DIR /home/circleci
+RUN bundle_builder.sh
+
+#######################
+#FINAL IMAGE
+FROM base
+
+COPY --chown=circleci:circleci --from=builder /home/circleci/bundle/ /home/circleci/.rubygems/
+
+COPY --chown=circleci:circleci --from=scripts /home/scripts/sbin/rubycritic.sh /usr/local/sbin/
+COPY --chown=circleci:circleci --from=scripts /home/scripts/sbin/check_specs /usr/local/sbin/
+COPY --chown=circleci:circleci --from=scripts /home/scripts/sbin/check_readme.sh /usr/local/sbin/
+COPY --chown=circleci:circleci --from=scripts /home/scripts/sbin/build_gem.sh /usr/local/sbin/
+
+RUN bundle install

data/README.md

@@ -9,17 +9,19 @@ Sinclair
 
 ![sinclair](https://raw.githubusercontent.com/darthjee/sinclair/master/sinclair.jpg)
 
-This gem helps the creation of complex gems/concerns
-that enables creation of methods on the fly through class
-methods
+Sinclair is a Ruby gem that provides developers with a variety of utility modules and classes
+to simplify common tasks, reusability and avoid boilerplate code. Whether you need to class methods to create methods on the fly,
+create custom comparators, configure your application, create powerfull options, Sinclair has got you covered.
 
-Current Release: [1.14.0](https://github.com/darthjee/sinclair/tree/1.14.0)
+Employing Sinclair in your applications helps you streamline your development workflow and enhance your development process through more efficient, cleaner code
 
-[Next release](https://github.com/darthjee/sinclair/compare/1.14.0...master)
+Current Release: [1.14.2](https://github.com/darthjee/sinclair/tree/1.14.2)
+
+[Next release](https://github.com/darthjee/sinclair/compare/1.14.2...master)
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.14.0](https://www.rubydoc.info/gems/sinclair/1.14.0)
+[https://www.rubydoc.info/gems/sinclair/1.14.2](https://www.rubydoc.info/gems/sinclair/1.14.2)
 
 Installation
 ---------------
@@ -77,20 +79,20 @@ puts "One Hundred => #{Clazz.one_hundred_twenty}" # One Hundred Twenty => 120
 <summary>Builder in class method</summary>
 
 ```ruby
+# http_json_model.rb
+
 class HttpJsonModel
   attr_reader :json
 
   class << self
     def parse(attribute, path: [])
-      builder = Sinclair.new(self)
-
       keys = (path + [attribute]).map(&:to_s)
 
-      builder.add_method(attribute) do
-        keys.inject(hash) { |h, key| h[key] }
+      Sinclair.build(self) do
+        add_method(attribute) do
+          keys.inject(hash) { |h, key| h[key] }
+        end
       end
-
-      builder.build
     end
   end
 
@@ -102,6 +104,10 @@ class HttpJsonModel
     @hash ||= JSON.parse(json)
   end
 end
+```
+
+```ruby
+# http_person.rb
 
 class HttpPerson < HttpJsonModel
   parse :uid
@@ -110,7 +116,9 @@ class HttpPerson < HttpJsonModel
   parse :username, path: [:digital_information]
   parse :email,    path: [:digital_information]
 end
+```
 
+```ruby
 json = <<-JSON
   {
     "uid": "12sof511",
@@ -524,8 +532,16 @@ Client.config.url # returns 'http://interstella.com:8080'
 
 ### Sinclair::EnvSettable
 
-Settable allows classes to extract configuration from environments through
-a simple meta-programable way
+EnvSettable is a convenient utility that allows you to read environment
+variables using Ruby class methods.
+
+With this tool, you can define the usage of environment variables for your application in a single location
+allowing the use of prefixes to isolate groups of variables.
+
+This not only makes your code more readable and maintainable but also adds layer of security by ensuring
+that sensitive information like API keys and passwords are not exposed in your source code.
+
+EnvSettable allows accessing those variables thorugh a simple meta-programable way
 
 <details>
 <summary>Using env settable example</summary>
@@ -645,7 +661,8 @@ human1 == human2 # returns true
 <summary>Example with options</summary>
 
 ```ruby
-class Tv < Sinclair::Model.for(:model, writter: false, comparable: false)
+class Tv < Sinclair::Model
+  initialize_with :model, writter: false, comparable: false
 end
 
 tv1 = Tv.new(model: 'Sans Sunga Xt')
@@ -664,6 +681,15 @@ You can use the provided matcher to check that your builder is adding a method c
 <summary>Sample of specs over adding methods</summary>
 
 ```ruby
+# spec_helper.rb
+
+RSpec.configure do |config|
+  config.include Sinclair::Matchers
+end
+```
+
+```ruby
+# default_value.rb
 class DefaultValue
   delegate :build, to: :builder
   attr_reader :klass, :method, :value, :class_method
@@ -687,8 +713,12 @@ class DefaultValue
     end
   end
 end
+```
+
+```ruby
+# default_value_spec.rb
 
-RSpec.describe Sinclair::Matchers do
+RSpec.describe DefaultValue do
   subject(:builder_class) { DefaultValue }
 
   let(:klass)         { Class.new }

data/config/check_specs.yml

@@ -7,4 +7,5 @@ ignore:
   - lib/sinclair/matchers/base.rb
   - lib/sinclair/matchers/change_method_on.rb
   - lib/sinclair/matchers/method_to.rb
+  - lib/sinclair/model/builder_options.rb
   - lib/sinclair/version.rb

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 100
+threshold: 99.8
 require_exact_threshold: false
 rules:
   ApiTag::Presence:

data/docker-compose.yml

@@ -21,3 +21,14 @@ services:
     <<: *base
     depends_on: [base_build]
     command: /bin/bash -c 'rspec && yard && rake yardstick_measure && rake verify_measurements'
+
+  sinclair_circleci:
+    <<: *base
+    image: sinclair_circleci
+    container_name: sinclair_circleci
+    volumes:
+      - .:/home/circleci/project
+    working_dir: /home/circleci/project
+    command: /bin/bash
+    build:
+      dockerfile: Dockerfile.circleci

data/lib/sinclair/class_methods.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class Sinclair
+  # @author darthjee
+  # @api public
+  #
+  # Class methods for {Sinclair}
+  module ClassMethods
+    # Runs build using a block for adding the methods
+    #
+    # The block is executed adding the methods and after the builder
+    # runs build building all the methods
+    #
+    # @param (see Sinclair#initialize)
+    # @param block [Proc] block to be executed by the builder
+    #   in order to add the methods before running build
+    #
+    # @yield an instance of a builder ({Sinclair})
+    #
+    # @return (see Sinclair#build)
+    #
+    # @example Simple usage
+    #   class MyPerson
+    #   end
+    #
+    #   Sinclair.build(model_class) do
+    #     add_method(:random_name, cached: true) do
+    #       "John #{Random.rand(1000)} Doe"
+    #     end
+    #   end
+    #
+    #   model = MyPerson.new
+    #
+    #   model.random_name # returns 'John 803 Doe'
+    def build(klass, options = {}, &block)
+      new(klass, options).tap do |builder|
+        builder.instance_eval(&block)
+      end.build
+    end
+  end
+end

data/lib/sinclair/method_definition/parameter_helper.rb

@@ -26,7 +26,7 @@ class Sinclair
       # @param parameters_list [Array<Object>] list of parameters and defaults
       # @param named [TrueClass,FalseClass] Flag informing if the parameters are
       #   named parameters
-      def initialize(parameters_list, named: false)
+      def initialize(parameters_list, named: nil)
         @parameters_list = parameters_list
         @named           = named
       end
@@ -40,7 +40,7 @@ class Sinclair
       def strings
         return [] unless parameters_list
 
-        parameters_strings + defaults_strings
+        parameters_strings + defaults_strings + wild_card_parameters
       end
 
       private
@@ -81,7 +81,18 @@ class Sinclair
       # @return [Array<Symbol>]
       def parameters
         parameters_list.reject do |param|
-          param.is_a?(Hash)
+          param.is_a?(Hash) || param.to_s.match?(/^\*/)
+        end
+      end
+
+      # Returns the named parameters that have not been defined
+      #
+      # THis is usually extra options
+      #
+      # @return [Array<String>]
+      def wild_card_parameters
+        parameters_list.reject do |param|
+          param.is_a?(Hash) || !param.to_s.match?(/^\*/)
         end
       end
 

data/lib/sinclair/model/builder.rb

@@ -26,11 +26,10 @@ class Sinclair
       #     method should be added
       #   @param comparable [TrueClass,FalseClass] flag to make the class {Comparable}
       #     by the fields
-      def initialize(klass, *attributes, writter: true, comparable: true)
+      def initialize(klass, *attributes, **options)
         super(klass)
         @attributes = attributes.flatten
-        @writter    = writter
-        @comparable = comparable
+        @options = BuilderOptions.new(**options)
 
         add_methods
         change_equals
@@ -39,7 +38,9 @@ class Sinclair
 
       private
 
-      attr_reader :attributes, :writter, :comparable
+      attr_reader :attributes, :options
+
+      delegate :writter, :comparable, to: :options
       alias writter? writter
       alias comparable? comparable
 
@@ -54,6 +55,14 @@ class Sinclair
       #
       # @return [Array<Symbol,Hash>]
 
+      # @!method options
+      # @api private
+      # @private
+      #
+      # Class building options
+      #
+      # @return [BuilderOptions]
+
       # @!method writter
       # @api private
       # @private
@@ -118,11 +127,15 @@ class Sinclair
       #
       # @return [Array<MethodDefinition>]
       def change_initializer
-        code = attributes_names.map do |attr|
+        lines = attributes_names.map do |attr|
           "@#{attr} = #{attr}"
-        end.join("\n")
+        end
+
+        lines << 'super(**attributes)'
+
+        code = lines.join("\n")
 
-        add_method(:initialize, code, named_parameters: attributes)
+        add_method(:initialize, code, named_parameters: attributes + ['**attributes'])
       end
 
       # @private

data/lib/sinclair/model/builder_options.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class Model
+    # @api private
+    # @author Darthjee
+    #
+    # Options for building model class
+    class BuilderOptions < Sinclair::Options
+      with_options writter: true, comparable: true
+    end
+  end
+end

data/lib/sinclair/model.rb

@@ -6,7 +6,8 @@ class Sinclair
   #
   # Basic model to be used when defining new classes quickly
   class Model
-    autoload :Builder, 'sinclair/model/builder'
+    autoload :Builder,        'sinclair/model/builder'
+    autoload :BuilderOptions, 'sinclair/model/builder_options'
 
     class << self
       # Returns a new class that inherits from model

data/lib/sinclair/version.rb

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

data/lib/sinclair.rb

@@ -83,6 +83,7 @@ class Sinclair
   require 'sinclair/options_parser'
 
   autoload :VERSION,           'sinclair/version'
+  autoload :ClassMethods,      'sinclair/class_methods'
   autoload :Config,            'sinclair/config'
   autoload :ConfigBuilder,     'sinclair/config_builder'
   autoload :ConfigClass,       'sinclair/config_class'
@@ -100,6 +101,21 @@ class Sinclair
   autoload :Options,           'sinclair/options'
 
   include OptionsParser
+  extend ClassMethods
+
+  # @method self.build(klass, options = {}, &block)
+  # Runs build using a block for adding the methods
+  #
+  # The block is executed adding the methods and after the builder
+  # runs build building all the methods
+  #
+  # @see Sinclair::ClassMethods#build
+  #
+  # @param (see Sinclair::ClassMethods#build)
+  # @return (see Sinclair::ClassMethods#build)
+  # @yield (see Sinclair::ClassMethods#build)
+  #
+  # @example (see Sinclair::ClassMethods#build)
 
   # Returns a new instance of Sinclair
   #

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.25'
+  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/yard/sinclair/class_methods/build_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: false
+
+require 'spec_helper'
+
+describe Sinclair::ClassMethods do
+  describe 'yard for .build' do
+    before { allow(Random).to receive(:rand).and_return(803) }
+
+    it 'Simple usage' do
+      model_class = Class.new
+
+      Sinclair.build(model_class) do
+        add_method(:random_name, cached: true) do
+          "John #{Random.rand(1000)} Doe"
+        end
+      end
+
+      model = model_class.new
+
+      expect(model.random_name).to eq('John 803 Doe')
+    end
+  end
+end

data/spec/integration/yard/sinclair_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe Sinclair do
-  describe 'yarn' do
+  describe 'yard' do
     let(:klass)         { Class.new(MyModel) }
     let(:instance)      { klass.new }
     let(:builder)       { described_class.new(klass) }

data/spec/lib/sinclair/class_methods_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::ClassMethods do
+  subject(:builder) { builder_class.new(dummy_class, options) }
+
+  let(:options)       { {} }
+  let(:instance)      { dummy_class.new }
+  let(:dummy_class)   { Class.new }
+  let(:builder_class) { Sinclair }
+
+  describe '#build' do
+    let(:block) do
+      method_name = :some_method
+      value = 1
+
+      proc do
+        add_method(method_name) { value }
+      end
+    end
+
+    it 'executes the block and builds' do
+      expect { builder_class.build(dummy_class, options, &block) }
+        .to add_method(:some_method).to(dummy_class)
+    end
+
+    context 'when the method is built and called' do
+      before do
+        builder_class.build(dummy_class, options, &block)
+      end
+
+      it 'returns the value' do
+        expect(instance.some_method).to eq(1)
+      end
+    end
+  end
+end

data/spec/lib/sinclair/method_definition/parameter_helper_spec.rb

@@ -22,6 +22,17 @@ describe Sinclair::MethodDefinition::ParameterHelper do
             .to eq(['a = 10', 'b = "word"', 'c = true', 'd = false', 'e = nil', 'f = :symbol'])
         end
       end
+
+      context 'when the parameter is an undefined parameter' do
+        let(:parameters) do
+          [:a, :b, '*args', { c: 10, d: 'word' }]
+        end
+
+        it 'returns a list of parameters' do
+          expect(described_class.parameters_from(parameters))
+            .to eq(['a', 'b', 'c = 10', 'd = "word"', '*args'])
+        end
+      end
     end
 
     context 'when parameters are named' do
@@ -42,6 +53,17 @@ describe Sinclair::MethodDefinition::ParameterHelper do
             .to eq(['a: 10', 'b: "word"', 'c: true', 'd: false', 'e: nil', 'f: :symbol'])
         end
       end
+
+      context 'when the parameter is an undefined parameter' do
+        let(:parameters) do
+          [:a, :b, '**opts', { c: 10, d: 'word' }]
+        end
+
+        it 'returns a list of parameters' do
+          expect(described_class.parameters_from(parameters, named: true))
+            .to eq(['a:', 'b:', 'c: 10', 'd: "word"', '**opts'])
+        end
+      end
     end
   end
 end

data/spec/lib/sinclair/model_spec.rb

@@ -54,6 +54,37 @@ describe Sinclair::Model do
       end
     end
 
+    context 'when class is subclass of another model' do
+      subject(:model) { klass.new(name: name, age: age) }
+
+      let(:age) { Random.rand(10..20) }
+
+      let(:superclass) do
+        Class.new(described_class) do
+          initialize_with(:age)
+        end
+      end
+
+      let(:klass) do
+        Class.new(superclass) do
+          initialize_with(:name)
+        end
+      end
+
+      it 'is initialized with both attributes' do
+        expect { klass.new(name: name, age: age) }
+          .not_to raise_error
+      end
+
+      it 'is initializes new attributes' do
+        expect(model.name).to eq(name)
+      end
+
+      it 'is initializes old attributes' do
+        expect(model.age).to eq(age)
+      end
+    end
+
     context 'when the build is done' do
       before do
         klass.initialize_with(*attributes, **options)

data/spec/support/models/http_json_model.rb

@@ -5,15 +5,13 @@ class HttpJsonModel
 
   class << self
     def parse(attribute, path: [])
-      builder = Sinclair.new(self)
-
       keys = (path + [attribute]).map(&:to_s)
 
-      builder.add_method(attribute) do
-        keys.inject(hash) { |h, key| h[key] }
+      Sinclair.build(self) do
+        add_method(attribute) do
+          keys.inject(hash) { |h, key| h[key] }
+        end
       end
-
-      builder.build
     end
   end
 

data/spec/support/models/tv.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
-class Tv < Sinclair::Model.for(:model, writter: false, comparable: false)
+class Tv < Sinclair::Model
+  initialize_with :model, writter: false, comparable: false
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.2
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,14 +28,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.25
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.25
 - !ruby/object:Gem::Dependency
@@ -261,6 +261,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Dockerfile
+- Dockerfile.circleci
 - Gemfile
 - LICENSE
 - README.md
@@ -272,6 +273,7 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/sinclair.rb
+- lib/sinclair/class_methods.rb
 - lib/sinclair/comparable.rb
 - lib/sinclair/comparable/class_methods.rb
 - lib/sinclair/config.rb
@@ -316,6 +318,7 @@ files:
 - lib/sinclair/method_definitions.rb
 - lib/sinclair/model.rb
 - lib/sinclair/model/builder.rb
+- lib/sinclair/model/builder_options.rb
 - lib/sinclair/options.rb
 - lib/sinclair/options/builder.rb
 - lib/sinclair/options/class_methods.rb
@@ -336,6 +339,7 @@ files:
 - spec/integration/yard/my_builder_spec.rb
 - spec/integration/yard/sinclair/add_class_method_spec.rb
 - spec/integration/yard/sinclair/add_method_spec.rb
+- spec/integration/yard/sinclair/class_methods/build_spec.rb
 - spec/integration/yard/sinclair/comparable_spec.rb
 - spec/integration/yard/sinclair/config_builder_spec.rb
 - spec/integration/yard/sinclair/config_class_spec.rb
@@ -357,6 +361,7 @@ files:
 - spec/integration/yard/sinclair/options_parser_spec.rb
 - spec/integration/yard/sinclair/options_spec.rb
 - spec/integration/yard/sinclair_spec.rb
+- spec/lib/sinclair/class_methods_spec.rb
 - spec/lib/sinclair/comparable_spec.rb
 - spec/lib/sinclair/config/methods_builder_spec.rb
 - spec/lib/sinclair/config_builder_spec.rb
@@ -468,7 +473,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gem for easy concern creation