sinclair 1.6.7 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecab9b7d077c8641fa413a2e8e8b673e2412a900f5a9322b81dff53e47a7c51d
-  data.tar.gz: 816d60a81f193492df1fa44cc5ae405e8521c4dca914ff862171e3381e9e4c7f
+  metadata.gz: 4e9a5068ba9c9c0f3def716decd2cea72fbdea0e6a3255d2bd0d324462de4ef5
+  data.tar.gz: c067ae53d0320738e785675306dc7f8848851a3adb964217bd30593c15eaedbf
 SHA512:
-  metadata.gz: 75b74e8881fe963bccff4b154727e354eeb9189d73774f86cbc53bbcea345d89cb34cc09fcd38db5136e9aad819f90179707ff7e6016e749c4fd336ef680169d
-  data.tar.gz: 195d742d548b6d9cfe218dc23ba8ae8194882abf0203b5cda7c90f4f06f122e1768da71d7f51e05ca3f32563ef5335046ab0f5d5e9513fcaf1dd36eec50059cf
+  metadata.gz: ddc575979d46b47983aa57083243e674ac1da951e1e8407b98ee188a17e60e7683d5a73ad829914e34d076764970fb93484f9da67b767a89b301f47d081aad47
+  data.tar.gz: 0052e1e9b9e86758cf2b35c215509d6d4946b5e8bd0fde994b2e8121b83807de04d8c4e84d3fa3ee47565e4a07f89313f0ef871d6156f93ebdd7e6c8df0a83c5

data/.circleci/config.yml

@@ -18,7 +18,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.5.3
+      - image: darthjee/circleci_ruby_270:1.1.0
         environment:
           PROJECT: sinclair
     steps:
@@ -52,7 +52,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.5.3
+      - image: darthjee/circleci_ruby_270:1.1.0
         environment:
           PROJECT: sinclair
     steps:

data/Dockerfile

@@ -1,6 +1,6 @@
-FROM darthjee/scripts:0.1.8 as scripts
+FROM darthjee/scripts:0.3.1 as scripts
 
-FROM darthjee/ruby_gems:0.5.3 as base
+FROM darthjee/ruby_270:1.1.0 as base
 
 COPY --chown=app:app ./ /home/app/app/
 

data/README.md

@@ -15,7 +15,7 @@ methods
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.6.7](https://www.rubydoc.info/gems/sinclair/1.6.7)
+[https://www.rubydoc.info/gems/sinclair/1.7.0](https://www.rubydoc.info/gems/sinclair/1.7.0)
 
 Installation
 ---------------

data/lib/sinclair/config.rb

@@ -37,5 +37,51 @@ class Sinclair
         hash[attribute.to_s] = public_send(attribute)
       end
     end
+
+    # Returns options with configurated values
+    #
+    # The returned options will use the values defined in
+    # the config merged with the extra attributes
+    #
+    # @param options_hash [Hash] optional values for the options
+    #
+    # @return [Sinclair::Option]
+    #
+    # @example returning default options
+    #   class LoginConfig < Sinclair::Config
+    #     add_configs :password, username: 'bob'
+    #   end
+    #
+    #   class LoginConfigurable
+    #     extend Sinclair::Configurable
+    #
+    #     configurable_by LoginConfig
+    #   end
+    #
+    #   LoginConfigurable.configure do |conf|
+    #     conf.username :some_username
+    #     conf.password :some_password
+    #   end
+    #
+    #   options = LoginConfigurable.config.options
+    #
+    #   config.options.username # returns :some_username
+    #   config.options.password # returns :some_password
+    #
+    # @example returning custom options
+    #   LoginConfigurable.configure do |conf|
+    #     conf.username :some_username
+    #     conf.password :some_password
+    #   end
+    #
+    #   options = LoginConfigurable.config.options(
+    #     password: :correct_password
+    #   )
+    #
+    #   config.options.username # returns :some_username
+    #   config.options.password # returns :correct_password
+    def options(options_hash = {})
+      self.class.options_class.new(to_hash.merge(options_hash))
+    end
   end
 end

data/lib/sinclair/config_class.rb

@@ -89,8 +89,23 @@ class Sinclair
       Config::MethodsBuilder.new(self, *args).tap do |builder|
         builder.build
 
+        Sinclair::InputHash.input_hash(*args).each do |name, value|
+          options_class.with_options(name => value)
+        end
+
         config_attributes(*builder.config_names)
       end
     end
+
+    # @api private
+    # Returns the options class exclusive to this configurable
+    #
+    # The returned class is configured in parallel with the
+    # configurable itself
+    #
+    # @return [Class<Sinclair::Options>]
+    def options_class
+      @options_class ||= Class.new(Sinclair::Options)
+    end
   end
 end

data/lib/sinclair/configurable.rb

@@ -78,6 +78,14 @@ class Sinclair
     # @see ConfigFactory#configure
     delegate :config, :reset_config, :configure, to: :config_factory
 
+    # @method options(options_hash = {})
+    # @api public
+    #
+    # @param (see Sinclair::Config#options)
+    # @return (see Sinclair::Config#options)
+    # @example (see Sinclair::Config#options)
+    delegate :options, to: :config
+
     protected
 
     # @api private

data/lib/sinclair/matchers/add_method.rb

@@ -10,7 +10,33 @@ class Sinclair
       #
       # 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)
       end

data/lib/sinclair/matchers.rb

@@ -7,26 +7,7 @@ class Sinclair
   # Matchers module will have the DSL to be included in RSpec in order to have
   # access to the matchers
   #
-  # @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
+  # @example (see Sinclair::Matchers::AddMethod#to)
   module Matchers
     autoload :Base,                   'sinclair/matchers/base'
     autoload :AddInstanceMethod,      'sinclair/matchers/add_instance_method'

data/lib/sinclair/options/class_methods.rb

@@ -47,10 +47,7 @@ class Sinclair
         @skip_validation ||= superclass.try(:skip_validation?) || false
       end
 
-      private
-
       # @api public
-      # @!visibility public
       #
       # Add available options
       #
@@ -71,7 +68,6 @@ class Sinclair
       end
 
       # @api public
-      # @!visibility public
       #
       # Changes class to skip attributes validation
       #

data/lib/sinclair/version.rb

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

data/sinclair.gemspec

@@ -21,20 +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',                '0.12.2'
-  gem.add_development_dependency 'pry-nav',            '0.3.0'
+  gem.add_development_dependency 'bundler',            '2.3.20'
+  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'
-  gem.add_development_dependency 'reek',               '5.6.0'
-  gem.add_development_dependency 'rspec',              '3.9.0'
-  gem.add_development_dependency 'rspec-core',         '3.9.1'
-  gem.add_development_dependency 'rspec-expectations', '3.9.1'
-  gem.add_development_dependency 'rspec-mocks',        '3.9.1'
-  gem.add_development_dependency 'rspec-support',      '3.9.2'
+  gem.add_development_dependency 'reek',               '6.0.3'
+  gem.add_development_dependency 'rspec',              '3.11.0'
+  gem.add_development_dependency 'rspec-core',         '3.11.0'
+  gem.add_development_dependency 'rspec-expectations', '3.11.0'
+  gem.add_development_dependency 'rspec-mocks',        '3.11.1'
+  gem.add_development_dependency 'rspec-support',      '3.11.0'
   gem.add_development_dependency 'rubocop',            '0.80.1'
   gem.add_development_dependency 'rubocop-rspec',      '1.38.1'
-  gem.add_development_dependency 'rubycritic',         '4.4.1'
-  gem.add_development_dependency 'simplecov',          '0.17.1'
-  gem.add_development_dependency 'yard',               '0.9.24'
+  gem.add_development_dependency 'rubycritic',         '4.7.0'
+  gem.add_development_dependency 'simplecov',          '0.21.2'
+  gem.add_development_dependency 'yard',               '0.9.27'
   gem.add_development_dependency 'yardstick',          '0.9.9'
 end

data/spec/integration/readme/my_class_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe MyClass do
-  subject(:model) { klass.new(attributes) }
+  subject(:model) { klass.new(**attributes) }
 
   let(:klass) { described_class }
   let(:name)  { 'name' }

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

@@ -24,5 +24,32 @@ describe Sinclair::Config do
           .to eq('{"password":null,"username":"bob"}')
       end
     end
+
+    describe '#options' do
+      subject(:config) { configurable.config }
+
+      let(:configurable) { LoginConfigurable }
+
+      before do
+        LoginConfigurable.configure do |conf|
+          conf.username :some_username
+          conf.password :some_password
+        end
+      end
+
+      it 'returns options with correct values' do
+        expect(config.options.username).to eq(:some_username)
+        expect(config.options.password).to eq(:some_password)
+      end
+
+      context 'when merging with given attributes' do
+        subject(:options) { config.options(password: :correct_password) }
+
+        it 'returns options with custom values' do
+          expect(options.username).to eq(:some_username)
+          expect(options.password).to eq(:correct_password)
+        end
+      end
+    end
   end
 end

data/spec/lib/sinclair/config_class_spec.rb

@@ -16,38 +16,6 @@ describe Sinclair::ConfigClass do
   end
 
   describe '.add_configs' do
-    let(:setter_block) do
-      proc { |value| config.instance_variable_set(:@name, value) }
-    end
-
-    it_behaves_like 'a config methods builder adding config' do
-      let(:code_block) { proc { klass.add_configs(:name) } }
-
-      it 'sets nil value by default' do
-        code_block.call
-        expect(config.name).to be_nil
-      end
-
-      it 'adds attributes to class' do
-        expect(&code_block).to change(klass, :config_attributes)
-          .from([]).to(%i[name])
-      end
-    end
-
-    context 'when giving defaults' do
-      it_behaves_like 'a config methods builder adding config' do
-        let(:code_block) { proc { klass.add_configs(name: 'Bob') } }
-
-        it 'sets default value' do
-          code_block.call
-          expect(config.name).to eq('Bob')
-        end
-
-        it 'adds attributes to class' do
-          expect(&code_block).to change(klass, :config_attributes)
-            .from([]).to(%i[name])
-        end
-      end
-    end
+    it_behaves_like 'a config class with .add_configs method'
   end
 end

data/spec/lib/sinclair/config_spec.rb

@@ -13,6 +13,10 @@ describe Sinclair::Config do
     it_behaves_like 'a config class with .config_attributes method'
   end
 
+  describe '.add_configs' do
+    it_behaves_like 'a config class with .add_configs method'
+  end
+
   describe '#to_hash' do
     it 'returns empty hash' do
       expect(config.as_json).to eq({})
@@ -104,4 +108,71 @@ describe Sinclair::Config do
       end
     end
   end
+
+  describe '#options' do
+    let(:expected_options) do
+      klass.options_class.new(username: :user, password: nil)
+    end
+
+    before do
+      klass.add_configs(:password, username: :user)
+    end
+
+    it do
+      expect(config.options).to be_a(Sinclair::Options)
+    end
+
+    it 'returns an option with default values' do
+      expect(config.options)
+        .to eq(expected_options)
+    end
+
+    context 'when config has been changed' do
+      let(:builder) do
+        Sinclair::ConfigBuilder.new(config, :username, :password)
+      end
+
+      let(:expected_options) do
+        klass.options_class.new(
+          username: :other_user, password: :some_password
+        )
+      end
+
+      before do
+        builder.username :other_user
+        builder.password :some_password
+      end
+
+      it 'returns an option with values from config' do
+        expect(config.options)
+          .to eq(expected_options)
+      end
+    end
+
+    context 'when passing options_hash' do
+      let(:expected_options) do
+        klass.options_class.new(
+          username: :user, password: :some_password
+        )
+      end
+
+      it 'returns merged options' do
+        expect(config.options(password: :some_password))
+          .to eq(expected_options)
+      end
+    end
+
+    context 'when passing options_hash with string keys' do
+      let(:expected_options) do
+        klass.options_class.new(
+          username: :user, password: :some_password
+        )
+      end
+
+      it 'returns merged options' do
+        expect(config.options('password' => :some_password))
+          .to eq(expected_options)
+      end
+    end
+  end
 end

data/spec/support/models/login_configurable.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class LoginConfigurable
+  extend Sinclair::Configurable
+
+  configurable_by LoginConfig
+end

data/spec/support/shared_examples/config.rb

@@ -115,3 +115,51 @@ shared_examples 'a config class with .config_attributes method' do
     end
   end
 end
+
+shared_examples 'a config class with .add_configs method' do
+  let(:setter_block) do
+    proc { |value| config.instance_variable_set(:@name, value) }
+  end
+
+  it_behaves_like 'a config methods builder adding config' do
+    let(:code_block) { proc { klass.add_configs(:name) } }
+
+    it 'sets nil value by default' do
+      code_block.call
+      expect(config.name).to be_nil
+    end
+
+    it 'adds attributes to class' do
+      expect(&code_block).to change(klass, :config_attributes)
+        .from([]).to(%i[name])
+    end
+
+    it do
+      expect(&code_block)
+        .to add_method(:name)
+        .to(klass.options_class)
+    end
+  end
+
+  context 'when giving defaults' do
+    it_behaves_like 'a config methods builder adding config' do
+      let(:code_block) { proc { klass.add_configs(name: 'Bob') } }
+
+      it 'sets default value' do
+        code_block.call
+        expect(config.name).to eq('Bob')
+      end
+
+      it 'adds attributes to class' do
+        expect(&code_block).to change(klass, :config_attributes)
+          .from([]).to(%i[name])
+      end
+
+      it do
+        expect(&code_block)
+          .to add_method(:name)
+          .to(klass.options_class)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.6.7
+  version: 1.7.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-01 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.16.1
+        version: 2.3.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.16.1
+        version: 2.3.20
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,84 +86,84 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: 6.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: 6.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.1
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.1
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.1
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.1
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.1
+        version: 3.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.1
+        version: 3.11.1
 - !ruby/object:Gem::Dependency
   name: rspec-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.2
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.2
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -198,42 +198,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: 4.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: 4.7.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        version: 0.9.27
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        version: 0.9.27
 - !ruby/object:Gem::Dependency
   name: yardstick
   requirement: !ruby/object:Gem::Requirement
@@ -387,6 +387,7 @@ files:
 - spec/support/models/http_person.rb
 - spec/support/models/initial_valuer.rb
 - spec/support/models/login_config.rb
+- spec/support/models/login_configurable.rb
 - spec/support/models/my_app_client.rb
 - spec/support/models/my_builder.rb
 - spec/support/models/my_class.rb
@@ -426,8 +427,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.3.20
 signing_key: 
 specification_version: 4
 summary: Gem for easy concern creation