sinclair 1.14.1 → 1.15.0

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

@@ -69,22 +69,16 @@ class Sinclair
     #
     #   config = AppConfig.new
     #
-    #   config.secret
-    #   # return nil
-    #
-    #   config.app_name
-    #   # return 'MyApp'
+    #   config.secret # return nil
+    #   config.app_name # return 'MyApp'
     #
     #   config_builder = Sinclair::ConfigBuilder.new(config)
     #
     #   config_builder.secret '123abc'
     #   config_builder.app_name 'MySuperApp'
     #
-    #   config.secret
-    #   # return '123abc'
-    #
-    #   config.app_name
-    #   # return 'MySuperApp'
+    #   config.secret # return '123abc'
+    #   config.app_name # return 'MySuperApp'
     def add_configs(*args)
       Config::MethodsBuilder.new(self, *args).tap do |builder|
         builder.build

data/lib/sinclair/method_definition/stringifier.rb

@@ -8,7 +8,14 @@ class Sinclair
     # @author darthjee
     #
     # Stringgify a value for {StringDefinition}
-    class Stringifier
+    class Stringifier < Caster
+      master_caster!
+
+      cast_with(NilClass) { 'nil' }
+      cast_with(Symbol) { |value| ":#{value}" }
+      cast_with(String, :to_json)
+      cast_with(Object, :to_s)
+
       # Convert a value to a string format
       #
       # The returned string can be evaluated as code, returning the
@@ -18,12 +25,7 @@ class Sinclair
       #
       # @return [String]
       def self.value_string(value)
-        return 'nil' if value.nil?
-        return ":#{value}" if value.is_a?(Symbol)
-
-        return value.to_s if value.is_any?(Class, Hash, Array)
-
-        value.to_json
+        cast(value, value.class)
       end
     end
   end

data/lib/sinclair/version.rb

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

data/lib/sinclair.rb

@@ -12,13 +12,13 @@ require 'active_support/core_ext'
 #   class MyModel
 #   end
 #
-#   buider = Sinclair.new(MyModel)
-#
 #   value = 10
-#   builder.add_method(:default_value) { value }
-#   builder.add_method(:value, '@value || default_value')
-#   builder.add_method(:value=) { |val| @value = val }
-#   builder.build
+#
+#   Sinclair.build(MyModel) do
+#     add_method(:default_value) { value }
+#     add_method(:value, '@value || default_value')
+#     add_method(:value=) { |val| @value = val }
+#   end
 #
 #   instance = MyModel.new
 #   instance.value # returns 10
@@ -83,6 +83,8 @@ class Sinclair
   require 'sinclair/options_parser'
 
   autoload :VERSION,           'sinclair/version'
+  autoload :Caster,            'sinclair/caster'
+  autoload :ClassMethods,      'sinclair/class_methods'
   autoload :Config,            'sinclair/config'
   autoload :ConfigBuilder,     'sinclair/config_builder'
   autoload :ConfigClass,       'sinclair/config_class'
@@ -100,6 +102,23 @@ class Sinclair
   autoload :Options,           'sinclair/options'
 
   include OptionsParser
+  extend ClassMethods
+
+  # @method self.build(klass, options = {}, &block)
+  # @api public
+  #
+  # 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
   #
@@ -119,7 +138,6 @@ class Sinclair
   #   builder = Sinclair.new(Purchase)
   #
   # @example Passing building options (Used on subclasses)
-  #
   #   class MyBuilder < Sinclair
   #     def add_methods
   #       if options_object.rescue_error
@@ -143,10 +161,9 @@ class Sinclair
   #   class MyModel
   #   end
   #
-  #   builder = MyBuilder.new(MyModel, rescue_error: true)
-  #
-  #   builder.add_method
-  #   builder.build
+  #   MyBuilder.build(MyModel, rescue_error: true) do
+  #     add_method
+  #   end
   #
   #   instance = MyModel.new
   #
@@ -200,9 +217,9 @@ class Sinclair
   #       end
   #     end
   #
-  #     builder = Sinclair.new(Person)
-  #     builder.add_method(:full_name, '[first_name, last_name].join(" ")')
-  #     builder.build
+  #     Sinclair.build(Person) do
+  #       add_method(:full_name, '[first_name, last_name].join(" ")')
+  #     end
   #
   #     Person.new('john', 'wick').full_name # returns 'john wick'
   #
@@ -224,9 +241,9 @@ class Sinclair
   #       end
   #     end
   #
-  #     builder = Sinclair.new(Person)
-  #     builder.add_method(:bond_name) { "#{last_name}, #{first_name} #{last_name}" }
-  #     builder.build
+  #     Sinclair.build(Person) do
+  #       add_method(:bond_name) { "#{last_name}, #{first_name} #{last_name}" }
+  #     end
   #
   #     Person.new('john', 'wick').bond_name # returns 'wick, john wick'
   #
@@ -251,11 +268,11 @@ class Sinclair
   #       end
   #     end
   #
-  #     builder = Sinclair.new(Person)
-  #     builder.add_method(:bond_name, type: :block, cached: true) do
-  #       "{last_name}, #{first_name} #{last_name}"
+  #     Sinclair.build(Person) do
+  #       add_method(:bond_name, type: :block, cached: true) do
+  #         "{last_name}, #{first_name} #{last_name}"
+  #       end
   #     end
-  #     builder.build
   #
   #     person.Person.new('john', 'wick')
   #

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

@@ -9,9 +9,9 @@ describe Sinclair do
         klass = Class.new
         instance = klass.new
 
-        builder = described_class.new(klass)
-        builder.add_method(:random_number) { Random.rand(10..20) }
-        builder.build
+        Sinclair.build(klass) do
+          add_method(:random_number) { Random.rand(10..20) }
+        end
 
         expect(instance.random_number).to be_between(10, 20)
       end
@@ -34,11 +34,11 @@ describe Sinclair do
       it 'adds the method' do
         klass = Class.new
 
-        builder = described_class.new(klass)
-        builder.add_class_method(
-          :function, 'a ** b + c', parameters: [:a], named_parameters: [:b, { c: 15 }]
-        )
-        builder.build
+        Sinclair.build(klass) do
+          add_class_method(
+            :function, 'a ** b + c', parameters: [:a], named_parameters: [:b, { c: 15 }]
+          )
+        end
 
         expect(klass.function(10, b: 2)).to eq(115)
       end

data/spec/integration/yard/my_builder_spec.rb

@@ -4,23 +4,17 @@ require 'spec_helper'
 
 describe MyBuilder do
   describe '#yard' do
-    subject(:builder) do
-      described_class.new(klass, rescue_error: true)
-    end
+    let(:klass) { Class.new }
 
-    let(:klass)    { Class.new }
-    let(:instance) { klass.new }
+    describe 'Passing building options (Used on subclasses)' do
+      it 'builds the methods' do
+        MyBuilder.build(klass, rescue_error: true) do
+          add_methods
+        end
 
-    describe '#build' do
-      before do
-        builder.add_methods
-        builder.build
-      end
+        instance = klass.new
 
-      context 'when calling built method' do
-        it 'returns default value' do
-          expect(instance.symbolize).to eq(:default)
-        end
+        expect(instance.symbolize).to eq(:default)
       end
     end
   end

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

@@ -7,9 +7,9 @@ describe 'yard Sinclair#add_method' do
     let(:klass) { Class.new(Person) }
 
     it 'creates new method' do
-      builder = Sinclair.new(klass)
-      builder.add_method(:full_name, '[first_name, last_name].join(" ")')
-      builder.build
+      Sinclair.build(klass) do
+        add_method(:full_name, '[first_name, last_name].join(" ")')
+      end
 
       expect(klass.new('john', 'wick').full_name).to eq('john wick')
     end
@@ -19,9 +19,9 @@ describe 'yard Sinclair#add_method' do
     let(:klass) { Class.new(Person) }
 
     it 'creates new method' do
-      builder = Sinclair.new(klass)
-      builder.add_method(:bond_name) { "#{last_name}, #{first_name} #{last_name}" }
-      builder.build
+      Sinclair.build(klass) do
+        add_method(:bond_name) { "#{last_name}, #{first_name} #{last_name}" }
+      end
 
       expect(klass.new('john', 'wick').bond_name).to eq('wick, john wick')
     end
@@ -31,11 +31,12 @@ describe 'yard Sinclair#add_method' do
     let(:klass) { Class.new(Person) }
 
     it 'creates new method' do
-      builder = Sinclair.new(klass)
-      builder.add_method(:bond_name, type: :block, cached: true) do
-        "#{last_name}, #{first_name} #{last_name}"
+      Sinclair.build(klass) do
+        add_method(:bond_name, type: :block, cached: true) do
+          "#{last_name}, #{first_name} #{last_name}"
+        end
       end
-      builder.build
+
       person = klass.new('john', 'wick')
 
       expect(person.bond_name).to eq('wick, john wick')

data/spec/integration/yard/sinclair/caster/cast_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: false
+
+require 'spec_helper'
+
+describe 'yard Sinclair::Caster' do
+  describe '.cast' do
+    it 'Casts with a symbol key' do
+      initial = Random.rand(10..20)
+      log = MathCaster.cast(initial, :log)
+      exp = MathCaster.cast(log, :exp)
+
+      expect(exp).to be_between(initial - 0.0001, initial + 0.0001)
+    end
+
+    it 'Casts passing parameter' do
+      base = Random.rand(3..6)
+      initial = Random.rand(10..20)
+      log = MathCaster.cast(initial, :log, base: base)
+      exp = MathCaster.cast(log, :exp, base: base)
+
+      expect(exp).to be_between(initial - 0.0001, initial + 0.0001)
+    end
+
+    it 'Casts with class key' do
+      hash = { a: 1, b: 2, 'c' => nil }
+      string = 'my string'
+      symbol = :the_symbol
+      number = 10
+      null = nil
+
+      code = <<-RUBY
+        hash_value = #{RubyStringCaster.to_ruby_string(hash)}
+        string_value = #{RubyStringCaster.to_ruby_string(string)}
+        symbol_value = #{RubyStringCaster.to_ruby_string(symbol)}
+        number = #{RubyStringCaster.to_ruby_string(number)}
+        null_value = #{RubyStringCaster.to_ruby_string(null)}
+      RUBY
+
+      expect(code).to eq(<<-RUBY)
+        hash_value = {:a=>1, :b=>2, "c"=>nil}
+        string_value = "my string"
+        symbol_value = :the_symbol
+        number = 10
+        null_value = nil
+      RUBY
+    end
+  end
+
+  describe '#cast' do
+    it 'Casts from a selected caster' do
+      caster = MathCaster.caster_for(:log)
+
+      expect(caster.cast(100)).to eq(2)
+      expect(caster.cast(8, base: 2)).to eq(3)
+    end
+  end
+end

data/spec/integration/yard/sinclair/caster/cast_with_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: false
+
+require 'spec_helper'
+
+describe 'yard Sinclair::Caster.cast_with' do
+  let(:my_caster) { Class.new(Sinclair::Caster) }
+
+  it 'Casting from pre registered symbol caster' do
+    my_caster.cast_with(:json, :to_json)
+
+    expect(my_caster.cast({ key: :value }, :json)).to eq('{"key":"value"}')
+  end
+
+  it 'Casting from pre registered block caster' do
+    my_caster.cast_with(:complex) do |hash|
+      real = hash[:real]
+      imaginary = hash[:imaginary]
+
+      "#{real.to_f} + #{imaginary.to_f} i"
+    end
+
+    value = { real: 10, imaginary: 5 }
+
+    expect(my_caster.cast(value, :complex)).to eq('10.0 + 5.0 i')
+  end
+
+  it 'Casting from pre registered class' do
+    my_caster.cast_with(Numeric, :to_i)
+
+    expect(my_caster.cast('10', Integer)).to eq(10)
+  end
+
+  it 'Casting from pre registered block caster from a class' do
+    my_caster.cast_with(HashModel) do |value, klass:|
+      klass.new(value)
+    end
+
+    my_caster.cast_with(String, &:to_json)
+
+    values = [
+      { klass: String, value: { name: 'john', age: 20, country: 'BR' } },
+      { klass: HashPerson, value: { name: 'Mary', age: 22, country: 'IT' } }
+    ]
+
+    values.map! do |config|
+      value = config[:value]
+      klass = config[:klass]
+      my_caster.cast(value, klass, klass: klass)
+    end
+
+    expect(values[0]).to eq('{"name":"john","age":20,"country":"BR"}')
+    expect(values[1]).to eq(HashPerson.new(name: 'Mary', age: 22))
+  end
+end

data/spec/integration/yard/sinclair/caster/caster_for_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: false
+
+require 'spec_helper'
+
+describe 'yard Sinclair::Caster.cast' do
+  it 'Getting the caster with symbol key' do
+    expect(EnumConverter.to_array({ key: :value })).to eq([%i[key value]])
+    expect(EnumConverter.to_hash([%i[key value]])).to eq({ key: :value })
+  end
+
+  it 'Getting the caster with class key' do
+    expect(StringParser.cast('{"key":"value"}', JSON)).to eq({ 'key' => 'value' })
+    expect(StringParser.cast('10.2', Integer)).to eq(10)
+    expect(StringParser.cast('10.2', Float)).to eq(10.2)
+  end
+end

data/spec/integration/yard/sinclair/caster/class_methods_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: false
+
+require 'spec_helper'
+
+describe 'yard Sinclair::Caster::ClassMethods' do
+  let(:my_caster) { Class.new(Sinclair::Caster) }
+
+  describe '.master_caster!' do
+    it 'Making a class to be a master caster' do
+      expect(my_caster.cast(10, :string)).to eq('10')
+
+      my_caster.master_caster!
+
+      expect(my_caster.cast(10, :string)).to eq(10)
+    end
+  end
+end

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

@@ -5,16 +5,14 @@ require 'spec_helper'
 describe Sinclair::ConfigBuilder do
   describe 'yard' do
     describe '#instance_eval' do
-      subject(:builder) do
-        described_class.new(config, :name)
-      end
+      it 'sets variable from config' do
+        config =  MyConfig.new
 
-      let(:config) { MyConfig.new }
+        builder = described_class.new(config, :name)
 
-      it 'sets variable from config' do
-        expect { builder.instance_eval { |c| c.name 'John' } }
-          .to change(config, :name)
-          .from(nil).to('John')
+        builder.instance_eval { |c| c.name 'John' }
+
+        expect(config.name).to eq('John')
       end
     end
   end

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

@@ -5,33 +5,19 @@ require 'spec_helper'
 describe Sinclair::ConfigClass do
   describe 'yard' do
     describe '.add_configs' do
-      subject(:config) { AppConfig.new }
+      it 'Adding configurations to config class' do
+        config = AppConfig.new
 
-      it 'has a secret configuration method' do
         expect(config.secret).to be_nil
-      end
-
-      it 'has a app_name configuration method' do
         expect(config.app_name).to eq('MyApp')
-      end
-
-      context 'when configured' do
-        let(:config_builder) do
-          Sinclair::ConfigBuilder.new(config)
-        end
 
-        before do
-          config_builder.secret '123abc'
-          config_builder.app_name 'MySuperApp'
-        end
+        config_builder = Sinclair::ConfigBuilder.new(config)
 
-        it 'has a secret configuration method' do
-          expect(config.secret).to eq('123abc')
-        end
+        config_builder.secret '123abc'
+        config_builder.app_name 'MySuperApp'
 
-        it 'has a app_name configuration method' do
-          expect(config.app_name).to eq('MySuperApp')
-        end
+        expect(config.secret).to eq('123abc')
+        expect(config.app_name).to eq('MySuperApp')
       end
     end
   end

data/spec/integration/yard/sinclair_spec.rb

@@ -3,11 +3,9 @@
 require 'spec_helper'
 
 describe Sinclair do
-  describe 'yarn' do
-    let(:klass)         { Class.new(MyModel) }
-    let(:instance)      { klass.new }
-    let(:builder)       { described_class.new(klass) }
-    let(:default_value) { 10 }
+  describe 'yard' do
+    let(:klass)   { Class.new(MyModel) }
+    let(:builder) { described_class.new(klass) }
 
     describe 'Using cache' do
       subject(:server) { Server.new }
@@ -85,38 +83,21 @@ describe Sinclair do
       end
     end
 
-    describe '#build' do
-      before do
-        value = default_value
-        builder.add_method(:default_value) { value }
-        builder.add_method(:value, '@value || default_value')
-        builder.add_method(:value=) { |val| @value = val }
-      end
-
-      describe 'after the build' do
-        before { builder.build }
+    describe 'Stand alone usage' do
+      it 'builds the methods' do
+        value = 10
 
-        it 'creates the expected methods' do
-          expect(instance.value).to eq(10)
+        Sinclair.build(klass) do
+          add_method(:default_value) { value }
+          add_method(:value, '@value || default_value')
+          add_method(:value=) { |val| @value = val }
         end
 
-        context 'when default value is overwritten' do
-          before do
-            instance.value = 20
-          end
+        instance = klass.new
 
-          it 'returns the new written value' do
-            expect(instance.value).to eq(20)
-          end
-        end
-      end
-
-      context 'when calling the build' do
-        it do
-          expect do
-            builder.build
-          end.to change { instance.respond_to?(:default_value) }.to(true)
-        end
+        expect(instance.value).to eq(10)
+        instance.value = 20
+        expect(instance.value).to eq(20)
       end
     end
   end