sinclair 1.9.0 → 1.11.0

data/spec/lib/sinclair/method_definitions_spec.rb

@@ -6,7 +6,8 @@ describe Sinclair::MethodDefinitions do
   subject(:definitions) { described_class.new }
 
   describe '#add' do
-    let(:name) { :the_method }
+    let(:name)  { :the_method }
+    let(:klass) { Class.new }
 
     context 'when passing block' do
       it 'returns the resulting array' do
@@ -41,5 +42,82 @@ describe Sinclair::MethodDefinitions do
           .to be_a(Sinclair::MethodDefinition::StringDefinition)
       end
     end
+
+    context 'when there are no options nor block' do
+      let(:type)      { :call }
+      let(:arguments) { %i[attr_reader some_attribute other_attribute] }
+
+      it do
+        expect(definitions.add(*arguments, type: type))
+          .to be_a(Array)
+      end
+
+      it 'creates a new definition' do
+        expect(definitions.add(*arguments, type: type).last)
+          .to be_a(Sinclair::MethodDefinition)
+      end
+
+      it 'creates a new definition of the chosen type' do
+        expect(definitions.add(*arguments, type: type).last)
+          .to be_a(Sinclair::MethodDefinition::CallDefinition)
+      end
+
+      it 'initializes it correctly' do
+        expect { klass.module_eval(&definitions.add(*arguments, type: type).last.code_block) }
+          .to add_method(:some_attribute).to(klass)
+      end
+    end
+
+    context 'when a block is given' do
+      let(:type)        { :block }
+      let(:method_name) { :the_method }
+      let(:block)       { proc { 10 } }
+
+      it do
+        expect(definitions.add(type, method_name, &block))
+          .to be_a(Array)
+      end
+
+      it 'creates a new definition' do
+        expect(definitions.add(type, method_name, &block).last)
+          .to be_a(Sinclair::MethodDefinition)
+      end
+
+      it 'creates a new definition of the chosen type' do
+        expect(definitions.add(type, method_name, &block).last)
+          .to be_a(Sinclair::MethodDefinition::BlockDefinition)
+      end
+
+      it 'initializes it correctly' do
+        expect(definitions.add(method_name, type: type, &block).last.name)
+          .to eq(method_name)
+      end
+    end
+
+    context 'when options are given' do
+      let(:type)        { :string }
+      let(:method_name) { :the_method }
+      let(:code)        { '10' }
+
+      it do
+        expect(definitions.add(method_name, code, type: type))
+          .to be_a(Array)
+      end
+
+      it 'creates a new definition' do
+        expect(definitions.add(method_name, code, type: type).last)
+          .to be_a(Sinclair::MethodDefinition)
+      end
+
+      it 'creates a new definition of the chosen type' do
+        expect(definitions.add(method_name, code, type: type).last)
+          .to be_a(Sinclair::MethodDefinition::StringDefinition)
+      end
+
+      it 'initializes it correctly' do
+        expect(definitions.add(method_name, code, type: type).last.name)
+          .to eq(method_name)
+      end
+    end
   end
 end

data/spec/lib/sinclair/options/builder_spec.rb

@@ -40,6 +40,19 @@ describe Sinclair::Options::Builder do
           .not_to change { Sinclair::Options.invalid_options_in(test_keys) }
       end
 
+      context 'when the object is compared with others' do
+        before { klass.skip_validation }
+
+        let(:options1) { klass.new(timeout: 10) }
+        let(:options2) { klass.new(timeout: 15) }
+
+        it 'adds the field to the equals check' do
+          expect { builder.build }
+            .to change { options1 == options2 }
+            .from(true).to(false)
+        end
+      end
+
       context 'when when calling method after building' do
         before { builder.build }
 

data/spec/lib/sinclair/options/class_methods_spec.rb

@@ -27,11 +27,26 @@ describe Sinclair::Options::ClassMethods do
           .to([:invalid])
       end
 
+      context 'when the added fild makes an object different' do
+        let(:options1_hash) { { timeout: 10 } }
+        let(:options2_hash) { { timeout: 11 } }
+
+        before do
+          klass.skip_validation
+        end
+
+        it 'adds the field to == check' do
+          expect { klass.send(:with_options, :timeout) }
+            .to change { klass.new(options1_hash) == klass.new(options2_hash) }
+            .from(true).to(false)
+        end
+      end
+
       it do
         expect { klass.send(:with_options, :timeout, 'retries') }
           .not_to change {
-                    Sinclair::Options.invalid_options_in(%i[timeout retries invalid])
-                  }
+            Sinclair::Options.invalid_options_in(%i[timeout retries invalid])
+          }
       end
 
       context 'when when calling method after building' do
@@ -46,8 +61,8 @@ describe Sinclair::Options::ClassMethods do
         it do
           expect { klass.send(:with_options, :timeout, :retries) }
             .not_to change {
-                      klass.invalid_options_in(%i[timeout retries invalid])
-                    }
+              klass.invalid_options_in(%i[timeout retries invalid])
+            }
         end
       end
     end
@@ -90,16 +105,16 @@ describe Sinclair::Options::ClassMethods do
       it do
         expect { klass.send(:with_options, 'protocol', port: 443) }
           .to change {
-                klass.invalid_options_in(test_keys)
-              }.from(%i[protocol port invalid])
+            klass.invalid_options_in(test_keys)
+          }.from(%i[protocol port invalid])
           .to([:invalid])
       end
 
       it do
         expect { klass.send(:with_options, 'protocol', port: 443) }
           .not_to change {
-                    super_class.invalid_options_in(%i[protocol port])
-                  }
+            super_class.invalid_options_in(%i[protocol port])
+          }
       end
 
       context 'when overriding a method' do

data/spec/lib/sinclair_spec.rb

@@ -11,86 +11,15 @@ describe Sinclair do
   let(:builder_class) { described_class }
 
   describe '#add_method' do
-    context 'when extending the class' do
-      let(:builder_class) { described_class::DummyBuilder }
+    let(:object) { instance }
 
-      before do
-        builder.init
-        builder.build
-      end
-
-      context 'when describing a method with block' do
-        it 'creates a method with the block' do
-          expect(instance.blocked).to eq(1)
-        end
-      end
-
-      context 'when describing a method with string' do
-        it 'creates a method using the string definition' do
-          expect(instance.defined).to eq(1)
-          expect(instance.defined).to eq(2)
-        end
-      end
-
-      context 'when passing options' do
-        let(:options) { { increment: 2 } }
-
-        it 'parses the options' do
-          expect(instance.defined).to eq(2)
-          expect(instance.defined).to eq(4)
-        end
-      end
-    end
-
-    context 'when using the builder without extending' do
-      context 'when declaring a method with a block' do
-        before do
-          builder.add_method(:blocked) { 1 }
-          builder.add_method(:blocked) { 2 }
-          builder.build
-        end
-
-        it 'respect the order of method addtion' do
-          expect(instance.blocked).to eq(2)
-        end
-      end
-
-      context 'when declaring a method string' do
-        before do
-          builder.add_method(:string, '1')
-          builder.add_method(:string, '2')
-          builder.build
-        end
-
-        it 'respect the order of method addtion' do
-          expect(instance.string).to eq(2)
-        end
-      end
-
-      context 'when declaring block and string' do
-        before do
-          builder.add_method(:value) { 1 }
-          builder.add_method(:value, '2')
-          builder.build
-        end
-
-        it 'respect the order of method addtion' do
-          expect(instance.value).to eq(2)
-        end
-      end
+    it_behaves_like 'A sinclair builder', :instance
+  end
 
-      context 'when declaring string and block' do
-        before do
-          builder.add_method(:value, '1')
-          builder.add_method(:value) { 2 }
-          builder.build
-        end
+  describe '#add_class_method' do
+    let(:object) { dummy_class }
 
-        it 'respect the order of method addtion' do
-          expect(instance.value).to eq(2)
-        end
-      end
-    end
+    it_behaves_like 'A sinclair builder', :class
   end
 
   describe '#eval_and_add_method' do
@@ -149,87 +78,4 @@ describe Sinclair do
       end
     end
   end
-
-  describe '#add_class_method' do
-    context 'when extending the class' do
-      let(:builder_class) { described_class::DummyClassBuilder }
-
-      before do
-        builder.init
-        builder.build
-      end
-
-      context 'when describing a method with block' do
-        it 'creates a method with the block' do
-          expect(dummy_class.blocked).to eq(1)
-        end
-      end
-
-      context 'when describing a method with string' do
-        it 'creates a method using the string definition' do
-          expect(dummy_class.defined).to eq(1)
-          expect(dummy_class.defined).to eq(2)
-        end
-      end
-
-      context 'when passing options' do
-        let(:options) { { increment: 2 } }
-
-        it 'parses the options' do
-          expect(dummy_class.defined).to eq(2)
-          expect(dummy_class.defined).to eq(4)
-        end
-      end
-    end
-
-    context 'when using the builder without extending' do
-      context 'when declaring a method with a block' do
-        before do
-          builder.add_class_method(:blocked) { 1 }
-          builder.add_class_method(:blocked) { 2 }
-          builder.build
-        end
-
-        it 'respect the order of method addtion' do
-          expect(dummy_class.blocked).to eq(2)
-        end
-      end
-
-      context 'when declaring a method string' do
-        before do
-          builder.add_class_method(:string, '1')
-          builder.add_class_method(:string, '2')
-          builder.build
-        end
-
-        it 'respect the order of method addtion' do
-          expect(dummy_class.string).to eq(2)
-        end
-      end
-
-      context 'when declaring block and string' do
-        before do
-          builder.add_class_method(:value) { 1 }
-          builder.add_class_method(:value, '2')
-          builder.build
-        end
-
-        it 'respect the order of method addtion' do
-          expect(dummy_class.value).to eq(2)
-        end
-      end
-
-      context 'when declaring string and block' do
-        before do
-          builder.add_class_method(:value, '1')
-          builder.add_class_method(:value) { 2 }
-          builder.build
-        end
-
-        it 'respect the order of method addtion' do
-          expect(dummy_class.value).to eq(2)
-        end
-      end
-    end
-  end
 end

data/spec/support/models/dummy_builder.rb

@@ -5,7 +5,10 @@ class Sinclair
     def init
       add_method(:blocked) { 1 }
       add_method(:defined, "@value = value + #{options_object&.increment || 1}")
-      add_method(:value, '@value ||= 0')
+      add_method(:value, cached: true) { 0 }
+      add_method(:type_block, type: :block) { 3 }
+      add_method(:type_string, '10', type: :string)
+      add_method(:attr_accessor, :some_attribute, type: :call)
     end
   end
 end

data/spec/support/models/dummy_class_builder.rb

@@ -6,6 +6,9 @@ class Sinclair
       add_class_method(:blocked) { 1 }
       add_class_method(:defined, "@value = value + #{options_object&.increment || 1}")
       add_class_method(:value, '@value ||= 0')
+      add_class_method(:type_block, type: :block) { 3 }
+      add_class_method(:type_string, '10', type: :string)
+      add_class_method(:attr_accessor, :some_attribute, type: :call)
     end
   end
 end

data/spec/support/models/person.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Person
-  attr_reader :first_name, :last_name
+  attr_accessor :first_name, :last_name
 
   def initialize(first_name, last_name)
     @first_name = first_name

data/spec/support/shared_examples/attribute_accessor.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+shared_examples 'a method builder that adds attribute reader' do
+  let(:klass)       { Class.new }
+  let(:instance)    { klass.new }
+  let(:value)       { Random.rand(10..20) }
+  let(:method_name) { :the_method }
+  let(:attributes)  { [method_name] }
+
+  context 'when type is instance' do
+    let(:type) { Sinclair::MethodBuilder::INSTANCE_METHOD }
+
+    it do
+      expect { builder.build }
+        .to add_method(method_name).to(instance)
+    end
+
+    context 'when the method is built' do
+      before do
+        builder.build
+        instance.instance_variable_set("@#{method_name}", value)
+      end
+
+      it 'returns the value of the instance variable' do
+        expect(instance.the_method).to eq(value)
+      end
+    end
+  end
+
+  context 'when type is class' do
+    let(:type) { Sinclair::MethodBuilder::CLASS_METHOD }
+
+    it do
+      expect { builder.build }
+        .to add_class_method(method_name).to(klass)
+    end
+
+    context 'when the method is built' do
+      before do
+        builder.build
+        klass.instance_variable_set("@#{method_name}", value)
+      end
+
+      it 'returns the value of the instance variable' do
+        expect(klass.the_method).to eq(value)
+      end
+    end
+  end
+end
+
+shared_examples 'a method builder that adds attribute writer' do
+  let(:klass)       { Class.new }
+  let(:instance)    { klass.new }
+  let(:value)       { Random.rand }
+  let(:method_name) { :the_method }
+  let(:attributes)  { [method_name] }
+
+  context 'when type is instance' do
+    let(:type) { Sinclair::MethodBuilder::INSTANCE_METHOD }
+
+    it do
+      expect { builder.build }
+        .to add_method("#{method_name}=").to(instance)
+    end
+
+    context 'when the method is built' do
+      let(:value) { Random.rand(10..20) }
+
+      before do
+        builder.build
+      end
+
+      it 'change the instance variable' do
+        expect { instance.the_method = value }
+          .to change { instance.instance_variable_get("@#{method_name}") }
+          .from(nil).to(value)
+      end
+    end
+  end
+
+  context 'when type is class' do
+    let(:type) { Sinclair::MethodBuilder::CLASS_METHOD }
+
+    it do
+      expect { builder.build }
+        .to add_class_method("#{method_name}=").to(klass)
+    end
+
+    context 'when the method is built' do
+      let(:value) { Random.rand(10..20) }
+
+      before do
+        builder.build
+      end
+
+      it 'change the instance variable' do
+        expect { klass.the_method = value }
+          .to change { klass.instance_variable_get("@#{method_name}") }
+          .from(nil).to(value)
+      end
+    end
+  end
+end

data/spec/support/shared_examples/sinclair.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'A sinclair builder' do |type|
+  let(:method_name) do
+    type == :instance ? :add_method : :add_class_method
+  end
+
+  context 'when extending the builder' do
+    let(:builder_class) do
+      type == :instance ? described_class::DummyBuilder : described_class::DummyClassBuilder
+    end
+
+    before do
+      builder.init
+      builder.build
+    end
+
+    context 'when describing a method with block' do
+      it 'creates a method with the block' do
+        expect(object.blocked).to eq(1)
+      end
+    end
+
+    context 'when describing a method with string' do
+      it 'creates a method using the string definition' do
+        expect(object.defined).to eq(1)
+        expect(object.defined).to eq(2)
+      end
+    end
+
+    context 'when describing a method using a block specific type' do
+      it 'creates a method with the block' do
+        expect(object.type_block).to eq(3)
+      end
+    end
+
+    context 'when describing a method using a string specific type' do
+      it 'creates a method with the string' do
+        expect(object.type_string).to eq(10)
+      end
+    end
+
+    context 'when describing a method using a call specific type for attr_acessor' do
+      let(:value) { Random.rand }
+
+      it 'creates acessors' do
+        expect { object.some_attribute = value }
+          .to change(object, :some_attribute)
+          .from(nil).to(value)
+      end
+    end
+
+    context 'when passing options' do
+      let(:options) { { increment: 2 } }
+
+      it 'parses the options' do
+        expect(object.defined).to eq(2)
+        expect(object.defined).to eq(4)
+      end
+    end
+  end
+
+  context 'when adding methods to a regular builder' do
+    context 'when declaring a method with a block' do
+      before do
+        builder.public_send(method_name, :blocked) { 1 }
+        builder.public_send(method_name, :blocked) { 2 }
+        builder.build
+      end
+
+      it 'respect the order of method addtion' do
+        expect(object.blocked).to eq(2)
+      end
+    end
+
+    context 'when declaring a method string' do
+      before do
+        builder.public_send(method_name, :string, '1')
+        builder.public_send(method_name, :string, '2')
+        builder.build
+      end
+
+      it 'respect the order of method addtion' do
+        expect(object.string).to eq(2)
+      end
+    end
+
+    context 'when declaring block and string' do
+      before do
+        builder.public_send(method_name, :value) { 1 }
+        builder.public_send(method_name, :value, '2')
+        builder.build
+      end
+
+      it 'respect the order of method addtion' do
+        expect(object.value).to eq(2)
+      end
+    end
+
+    context 'when declaring string and block' do
+      before do
+        builder.public_send(method_name, :value, '1')
+        builder.public_send(method_name, :value) { 2 }
+        builder.build
+      end
+
+      it 'respect the order of method addtion' do
+        expect(object.value).to eq(2)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -302,10 +302,12 @@ files:
 - lib/sinclair/method_builder.rb
 - lib/sinclair/method_builder/base.rb
 - lib/sinclair/method_builder/block_method_builder.rb
+- lib/sinclair/method_builder/call_method_builder.rb
 - lib/sinclair/method_builder/string_method_builder.rb
 - lib/sinclair/method_definition.rb
 - lib/sinclair/method_definition/block_definition.rb
 - lib/sinclair/method_definition/block_helper.rb
+- lib/sinclair/method_definition/call_definition.rb
 - lib/sinclair/method_definition/string_definition.rb
 - lib/sinclair/method_definitions.rb
 - lib/sinclair/options.rb
@@ -322,8 +324,11 @@ files:
 - 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/types_of_definition_spec.rb
 - spec/integration/readme/sinclair_spec.rb
 - 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/comparable_spec.rb
 - spec/integration/yard/sinclair/config_builder_spec.rb
 - spec/integration/yard/sinclair/config_class_spec.rb
@@ -332,11 +337,14 @@ files:
 - spec/integration/yard/sinclair/configurable_spec.rb
 - spec/integration/yard/sinclair/env_settable_spec.rb
 - spec/integration/yard/sinclair/equals_checker_spec.rb
+- spec/integration/yard/sinclair/eval_and_add_method_spec.rb
 - spec/integration/yard/sinclair/input_hash_spec.rb
 - spec/integration/yard/sinclair/matchers/add_class_method_spec.rb
 - spec/integration/yard/sinclair/matchers/add_class_method_to_spec.rb
 - spec/integration/yard/sinclair/matchers/add_instance_method_spec.rb
 - spec/integration/yard/sinclair/matchers/add_instance_method_to_spec.rb
+- spec/integration/yard/sinclair/matchers/change_class_method_spec.rb
+- spec/integration/yard/sinclair/matchers/change_instance_method_spec.rb
 - spec/integration/yard/sinclair/options_parser_spec.rb
 - spec/integration/yard/sinclair/options_spec.rb
 - spec/integration/yard/sinclair_spec.rb
@@ -361,11 +369,14 @@ files:
 - spec/lib/sinclair/matchers/change_instance_method_on_spec.rb
 - spec/lib/sinclair/matchers/change_instance_method_spec.rb
 - spec/lib/sinclair/matchers_spec.rb
+- spec/lib/sinclair/method_builder/base_spec.rb
 - spec/lib/sinclair/method_builder/block_method_builder_spec.rb
+- spec/lib/sinclair/method_builder/call_method_builder_spec.rb
 - spec/lib/sinclair/method_builder/string_method_builder_spec.rb
 - spec/lib/sinclair/method_builder_spec.rb
 - spec/lib/sinclair/method_definition/block_definition_spec.rb
 - spec/lib/sinclair/method_definition/block_helper_spec.rb
+- spec/lib/sinclair/method_definition/call_definition_spec.rb
 - spec/lib/sinclair/method_definition/string_definition_spec.rb
 - spec/lib/sinclair/method_definition_spec.rb
 - spec/lib/sinclair/method_definitions_spec.rb
@@ -413,11 +424,13 @@ files:
 - spec/support/models/service_client.rb
 - spec/support/models/validator_builder.rb
 - spec/support/sample_model.rb
+- spec/support/shared_examples/attribute_accessor.rb
 - spec/support/shared_examples/class_method_definition.rb
 - spec/support/shared_examples/config.rb
 - spec/support/shared_examples/config_factory.rb
 - spec/support/shared_examples/env_settable.rb
 - spec/support/shared_examples/instance_method_definition.rb
+- spec/support/shared_examples/sinclair.rb
 homepage: https://github.com/darthjee/sinclair
 licenses: []
 metadata: {}