sinclair 1.14.1 → 1.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4984ad62935fbe5a85e51b846b5124b72153b94cf9433a8a668f824c11e5eeaf
-  data.tar.gz: 336e7c54378ccd676f59eb92fe2a1bf32de84ff9a8bc2a91c8a6dd1e6494b46d
+  metadata.gz: b6bd1d9896437c341e52648bac78c70d453a773c92a2fba06111d88d12be06a3
+  data.tar.gz: 5cb2ba761532e3db60ffc8a09b821509c1355949071c5346cef962b0d43dfe9d
 SHA512:
-  metadata.gz: f3a84c2a80644b15e31991cb99a314378453e642c29c9864080e96f28bd34234f2476735284291ba56dd48ab9d67883a5b16709a1aa67b31116ef262dd6b1df1
-  data.tar.gz: d1405b56826158314eb4d304b33c02dc18015e63fe58e716371f5a58c7a8f417652ea1026d5b533c844e7c5a89ffeae7990f70334e61dbf4019006f412359dfe
+  metadata.gz: bf2fd682ae8e6c57a8a173a5f78492bf6c7011dfef7734fd9c0c2d3d4d73fa599bac72a9317920dd0ebf5bb6c98f0f2f511c0fcc9fe5b683f766b5624359ccf3
+  data.tar.gz: db83a68fd9b11d0a227afca422f5a6e8e33bc64e3624a55c0d8f3b87d49235d8e17b1393c44b6ac2a67c8b9869e58d5780a3a06aad4f76429a4c4b0c48247f43

data/README.md

@@ -15,13 +15,13 @@ create custom comparators, configure your application, create powerfull options,
 
 Employing Sinclair in your applications helps you streamline your development workflow and enhance your development process through more efficient, cleaner code
 
-Current Release: [1.14.1](https://github.com/darthjee/sinclair/tree/1.14.1)
+Current Release: [1.14.2](https://github.com/darthjee/sinclair/tree/1.14.2)
 
-[Next release](https://github.com/darthjee/sinclair/compare/1.14.1...master)
+[Next release](https://github.com/darthjee/sinclair/compare/1.14.2...master)
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.14.1](https://www.rubydoc.info/gems/sinclair/1.14.1)
+[https://www.rubydoc.info/gems/sinclair/1.14.2](https://www.rubydoc.info/gems/sinclair/1.14.2)
 
 Installation
 ---------------
@@ -79,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
 
@@ -104,6 +104,10 @@ class HttpJsonModel
     @hash ||= JSON.parse(json)
   end
 end
+```
+
+```ruby
+# http_person.rb
 
 class HttpPerson < HttpJsonModel
   parse :uid
@@ -112,7 +116,9 @@ class HttpPerson < HttpJsonModel
   parse :username, path: [:digital_information]
   parse :email,    path: [:digital_information]
 end
+```
 
+```ruby
 json = <<-JSON
   {
     "uid": "12sof511",
@@ -675,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
@@ -698,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/yardstick.yml

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

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Sinclair
-  VERSION = '1.14.1'
+  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/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/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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.14.2
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -273,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
@@ -338,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
@@ -359,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