sinclair 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e9a5068ba9c9c0f3def716decd2cea72fbdea0e6a3255d2bd0d324462de4ef5
-  data.tar.gz: c067ae53d0320738e785675306dc7f8848851a3adb964217bd30593c15eaedbf
+  metadata.gz: 0c06e4b7038a22a311b6ee13f1b8fd2df24211d8953982035df626dba8fb66c5
+  data.tar.gz: b19227562faa97bca59e76d997998917068ccb2d230a0b90dfa76140f2032209
 SHA512:
-  metadata.gz: ddc575979d46b47983aa57083243e674ac1da951e1e8407b98ee188a17e60e7683d5a73ad829914e34d076764970fb93484f9da67b767a89b301f47d081aad47
-  data.tar.gz: 0052e1e9b9e86758cf2b35c215509d6d4946b5e8bd0fde994b2e8121b83807de04d8c4e84d3fa3ee47565e4a07f89313f0ef871d6156f93ebdd7e6c8df0a83c5
+  metadata.gz: 87daf64f9e084ef37bb47efee4fb6ff174e70cfdf5005e506acdff45647fd4ad502b348b23c6a3bbb1cce09676c14d7be52cc816b493fdbb4c92d23b94b33ecf
+  data.tar.gz: 3d02e09271942cd50dc21eb9e9578b63db0374196e084b3ce9b54e3d816206731a88f8cb470581d791ecaf5a0f7a5435d2489ecf7465fa446b56d8f8c8b6dd24

data/README.md

@@ -15,7 +15,7 @@ methods
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.7.0](https://www.rubydoc.info/gems/sinclair/1.7.0)
+[https://www.rubydoc.info/gems/sinclair/1.8.0](https://www.rubydoc.info/gems/sinclair/1.8.0)
 
 Installation
 ---------------
@@ -369,6 +369,12 @@ hash
   MyConfigurable.config.host # returns 'interstella.art'
   MyConfigurable.config.port # returns 5555
 
+  # Configurable enables options that can be passed
+  MyConfigurable.as_options.host # returns 'interstella.art'
+
+  # Configurable enables options that can be passed with custom values
+  MyConfigurable.as_options(host: 'other').host # returns 'other'
+
   MyConfigurable.reset_config
 
   MyConfigurable.config.host # returns nil
@@ -553,3 +559,4 @@ Projects Using
 
 -   [Arstotzka](https://github.com/darthjee/arstotzka)
 -   [Azeroth](https://github.com/darthjee/azeroth)
+-   [Magicka](https://github.com/darthjee/magicka)

data/lib/sinclair/config.rb

@@ -63,10 +63,10 @@ class Sinclair
     #     conf.password :some_password
     #   end
     #
-    #   options = LoginConfigurable.config.options
+    #   options = LoginConfigurable.config.as_options
     #
-    #   config.options.username # returns :some_username
-    #   config.options.password # returns :some_password
+    #   config.as_options.username # returns :some_username
+    #   config.as_options.password # returns :some_password
     #
     # @example returning custom options
     #   LoginConfigurable.configure do |conf|
@@ -74,13 +74,13 @@ class Sinclair
     #     conf.password :some_password
     #   end
     #
-    #   options = LoginConfigurable.config.options(
+    #   options = LoginConfigurable.config.as_options(
     #     password: :correct_password
     #   )
     #
-    #   config.options.username # returns :some_username
-    #   config.options.password # returns :correct_password
-    def options(options_hash = {})
+    #   config.as_options.username # returns :some_username
+    #   config.as_options.password # returns :correct_password
+    def as_options(options_hash = {})
       self.class.options_class.new(to_hash.merge(options_hash))
     end
   end

data/lib/sinclair/config_class.rb

@@ -105,7 +105,7 @@ class Sinclair
     #
     # @return [Class<Sinclair::Options>]
     def options_class
-      @options_class ||= Class.new(Sinclair::Options)
+      @options_class ||= Class.new(superclass.try(:options_class) || Options)
     end
   end
 end

data/lib/sinclair/configurable.rb

@@ -9,8 +9,8 @@ class Sinclair
   # By extending Configurable, class receives the methods public
   # {ConfigFactory#config .config}, {ConfigFactory#reset_config .reset_config}
   # and {ConfigFactory#configure .configure}
-  # and the private methods {#configurable_with .configurable_with}
-  # and {#configurable_by .configurable_by}
+  # and the private methods {#configurable_with .configurable_with},
+  # {#configurable_by .configurable_by} and {#as_options .as_options}
   #
   # @see ConfigFactory
   # @see ConfigBuilder
@@ -78,13 +78,13 @@ class Sinclair
     # @see ConfigFactory#configure
     delegate :config, :reset_config, :configure, to: :config_factory
 
-    # @method options(options_hash = {})
+    # @method as_options(options_hash = {})
     # @api public
     #
-    # @param (see Sinclair::Config#options)
-    # @return (see Sinclair::Config#options)
-    # @example (see Sinclair::Config#options)
-    delegate :options, to: :config
+    # @param (see Sinclair::Config#as_options)
+    # @return (see Sinclair::Config#as_options)
+    # @example (see Sinclair::Config#as_options)
+    delegate :as_options, to: :config
 
     protected
 

data/lib/sinclair/matchers/change_class_method_on.rb

@@ -11,10 +11,10 @@ class Sinclair
     #  This is used with a RSpec DSL method
     #  change_class_method(method_name).on(class_object)
     class ChangeClassMethodOn < ChangeMethodOn
-      # @param [Class] klass
+      # @param target [Class]
       #   Class where the class method should be added to
       #
-      # @param method_name [SYmbol,String] method name
+      # @param method_name [Symbol,String] method name
       def initialize(target, method_name)
         @klass = target
         super(method_name)

data/lib/sinclair/options/class_methods.rb

@@ -4,7 +4,7 @@ require 'set'
 
 class Sinclair
   class Options
-    # Class Methods for {Sinclai::Options}
+    # Class Methods for {Sinclair::Options}
     module ClassMethods
       # @api private
       #

data/lib/sinclair/version.rb

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

data/spec/integration/readme/sinclair/configurable_spec.rb

@@ -25,7 +25,17 @@ describe Sinclair::Configurable do
           .to eq(5555)
       end
 
-      context 'when #rest_config is called' do
+      it 'enables options to be returned' do
+        expect(MyConfigurable.as_options.host)
+          .to eq('interstella.art')
+      end
+
+      it 'enables custom options to be returned' do
+        expect(MyConfigurable.as_options(host: 'other').host)
+          .to eq('other')
+      end
+
+      context 'when #reset_config is called' do
         before do
           MyConfigurable.reset_config
         end

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

@@ -38,12 +38,12 @@ describe Sinclair::Config do
       end
 
       it 'returns options with correct values' do
-        expect(config.options.username).to eq(:some_username)
-        expect(config.options.password).to eq(:some_password)
+        expect(config.as_options.username).to eq(:some_username)
+        expect(config.as_options.password).to eq(:some_password)
       end
 
       context 'when merging with given attributes' do
-        subject(:options) { config.options(password: :correct_password) }
+        subject(:options) { config.as_options(password: :correct_password) }
 
         it 'returns options with custom values' do
           expect(options.username).to eq(:some_username)

data/spec/lib/sinclair/config_spec.rb

@@ -109,29 +109,29 @@ describe Sinclair::Config do
     end
   end
 
-  describe '#options' do
+  describe '#as_options' do
     let(:expected_options) do
       klass.options_class.new(username: :user, password: nil)
     end
 
+    let(:builder) do
+      Sinclair::ConfigBuilder.new(config, :username, :password)
+    end
+
     before do
       klass.add_configs(:password, username: :user)
     end
 
     it do
-      expect(config.options).to be_a(Sinclair::Options)
+      expect(config.as_options).to be_a(Sinclair::Options)
     end
 
     it 'returns an option with default values' do
-      expect(config.options)
+      expect(config.as_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
@@ -144,7 +144,7 @@ describe Sinclair::Config do
       end
 
       it 'returns an option with values from config' do
-        expect(config.options)
+        expect(config.as_options)
           .to eq(expected_options)
       end
     end
@@ -157,7 +157,7 @@ describe Sinclair::Config do
       end
 
       it 'returns merged options' do
-        expect(config.options(password: :some_password))
+        expect(config.as_options(password: :some_password))
           .to eq(expected_options)
       end
     end
@@ -170,9 +170,23 @@ describe Sinclair::Config do
       end
 
       it 'returns merged options' do
-        expect(config.options('password' => :some_password))
+        expect(config.as_options('password' => :some_password))
           .to eq(expected_options)
       end
+
+      context 'when the config is changed' do
+        let(:options) { config.as_options }
+
+        it 'changes the option returned' do
+          expect { builder.username :other_user }
+            .to change { config.as_options.username }
+        end
+
+        it 'changes the option previously returned' do
+          expect { builder.username :other_user }
+            .not_to change(options, :username)
+        end
+      end
     end
   end
 end

data/spec/support/shared_examples/config.rb

@@ -161,5 +161,60 @@ shared_examples 'a config class with .add_configs method' do
           .to(klass.options_class)
       end
     end
+
+    context 'when there is a child class' do
+      let(:code_block) { proc { klass.add_configs(name: 'Bob') } }
+
+      it 'adds attributes to child class' do
+        expect(&code_block)
+          .to change(child_klass, :config_attributes)
+          .from([]).to(%i[name])
+      end
+
+      it 'adds attributes to child options class' do
+        expect(&code_block)
+          .to add_method(:name).to(child_klass)
+      end
+
+      context 'when child class already has attributes' do
+        before do
+          child_klass.add_configs('email')
+        end
+
+        it 'adds new attributes to child class' do
+          expect(&code_block)
+            .to change(child_klass, :config_attributes)
+            .from([:email]).to(%i[name email])
+        end
+      end
+    end
+
+    context 'when there is a parent class' do
+      let(:code_block) do
+        proc { child_klass.add_configs(name: 'Bob') }
+      end
+
+      it 'does not add attributes to parent class' do
+        expect(&code_block)
+          .not_to change(klass, :config_attributes)
+      end
+
+      it 'does not add attributes to child options class' do
+        expect(&code_block)
+          .not_to add_method(:name).to(klass)
+      end
+
+      context 'when parent already has attributes' do
+        before do
+          klass.config_attributes(:email, 'username')
+        end
+
+        it 'adds only attributes that had not been defined before' do
+          expect(&code_block)
+            .to change(child_klass, :config_attributes)
+            .from(%i[email username]).to(%i[email username name])
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - DarthJee