sinclair 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9873a31c5a1ab56553a834bb0acdae13abeb3189b19a79789911d914c72f52c
-  data.tar.gz: cb209f36a4bd60319e6133e6526a4145a58649bc78a2fd68632e63ef0c157255
+  metadata.gz: 15c8c49649134851cc9f1fb6a92d4ea19ff82cc2e68ce2d09339987b2623a5d4
+  data.tar.gz: def1468dbdf88b1f700edc6fd172cc6dc06d56b9aba07171cb6d7c3a7bcdc32e
 SHA512:
-  metadata.gz: 8cb67cbeb1032f090809daaebb92f57e9f3bb5db023e413f3101aa79415f319089ef22080a9086772c37ba03870553825be651c6ed1568cb21d9f39db398e47b
-  data.tar.gz: 2852f036aec1df4ecdd7be65497c83389fd481aecf0e9783f55258646fbb8e18d064e1cfa23b0b8f901e4bfa8a1e4b33ac9b114a2ebb5e8f268b945e9d37ba24
+  metadata.gz: fcaf42f0c6ee8b2cdb4986e003b487f1f53184d9486c9479477fcfe4fb38550ff9deecc4b3029da563812179152ecee68c379b5673f60eedfb7df9a4f945b30c
+  data.tar.gz: 622f77edaeb7d9b247a15c071ecb80981e82d915124dbeb57851c86153c1790bd301ea7be067b9020281dc9aeecd6cec54ec4403a74972bf7f8d9d89cf444020

data/.rubocop.yml

@@ -28,6 +28,7 @@ RSpec/DescribedClass:
 RSpec/ExampleLength:
   Exclude:
     - 'spec/integration/yard/**/*_spec.rb'
+    - 'spec/integration/readme/**/*_spec.rb'
 
 RSpec/MultipleExpectations:
   Exclude:

data/README.md

@@ -15,7 +15,7 @@ methods
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.6.1](https://www.rubydoc.info/gems/sinclair/1.6.1)
+[https://www.rubydoc.info/gems/sinclair/1.6.2](https://www.rubydoc.info/gems/sinclair/1.6.2)
 
 Installation
 ---------------
@@ -446,6 +446,25 @@ a simple meta-programable way
   ServiceClient.default # returns #<ServiceClient:0x0000556fa1b366e8 @username="my-login", @password=nil, @port=80, @hostname="host.com">'
 ```
 
+### Sinclair::Options
+Options allows projects to have an easy to configure option object
+
+```ruby
+  class ConnectionOptions < Sinclair::Options
+    with_options :timeout, :retries, port: 443, protocol: 'https'
+  end
+
+ options = ConnectionOptions.new(
+   timeout: 10,
+   protocol: 'http'
+ )
+
+ options.timeout  # returns 10
+ options.retries  # returns nil
+ options.protocol # returns 'http'
+ options.port     # returns 443
+```
+
 RSspec matcher
 ---------------
 
@@ -529,3 +548,4 @@ Projects Using
 ---------------
 
 -   [Arstotzka](https://github.com/darthjee/arstotzka)
+-   [Azeroth](https://github.com/darthjee/azeroth)

data/lib/sinclair/options/builder.rb

@@ -25,8 +25,19 @@ class Sinclair
         super(klass)
 
         @attributes = Sinclair::InputHash.input_hash(*options)
+      end
 
+      # Finish building options
+      #
+      # Add options to allowed options
+      # and adds all methods
+      #
+      # @see Sinclair#build
+      # @return (see Sinclair#build)
+      def build
         add_all_methods
+
+        super
       end
 
       private
@@ -45,7 +56,7 @@ class Sinclair
       # @return [Array<MethodDefinition>]
       def add_all_methods
         attributes.each do |option, value|
-          add_method(option, cached: true) { value }
+          add_method(option, cached: :full) { value }
           klass.allowed_options.push(option.to_sym)
         end
       end

data/lib/sinclair/version.rb

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

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Options do
+  describe 'readme' do
+    it 'creates options object' do
+      options = ConnectionOptions.new(
+        timeout: 10,
+        protocol: 'http'
+      )
+
+      expect(options.timeout).to eq(10)
+      expect(options.retries).to eq(nil)
+      expect(options.protocol).to eq('http')
+      expect(options.port).to eq(443)
+    end
+  end
+end

data/spec/lib/sinclair/options_spec.rb

@@ -169,6 +169,30 @@ describe Sinclair::Options do
         expect { klass.new('timeout' => 20, retries: 30) }
           .not_to raise_error
       end
+
+      context 'when calling the method' do
+        let(:options) { klass.new('timeout' => 20, retries: 30) }
+
+        it 'sets value of string key' do
+          expect(options.timeout).to eq(20)
+        end
+
+        it 'sets value of symbol key' do
+          expect(options.retries).to eq(30)
+        end
+      end
+    end
+
+    context 'when overriding values with nil' do
+      let(:options) { klass.new(protocol: nil) }
+
+      it { expect(options.protocol).to be_nil }
+    end
+
+    context 'when overriding values with false' do
+      let(:options) { klass.new(protocol: false) }
+
+      it { expect(options.protocol).to eq(false) }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2020-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -309,6 +309,7 @@ files:
 - spec/integration/readme/sinclair/configurable_spec.rb
 - spec/integration/readme/sinclair/env_settable_spec.rb
 - spec/integration/readme/sinclair/matchers_spec.rb
+- spec/integration/readme/sinclair/options_spec.rb
 - spec/integration/readme/sinclair_spec.rb
 - spec/integration/yard/my_builder_spec.rb
 - spec/integration/yard/sinclair/config_builder_spec.rb