sinclair 1.8.0 → 1.10.0

data/spec/lib/sinclair/method_definition_spec.rb

@@ -42,4 +42,68 @@ describe Sinclair::MethodDefinition do
       end
     end
   end
+
+  describe '.for' do
+    context 'when there are no options nor block' do
+      let(:type)      { :call }
+      let(:arguments) { %i[attr_reader some_attribute other_attribute] }
+
+      it do
+        expect(described_class.for(type, *arguments))
+          .to be_a(described_class)
+      end
+
+      it 'Returns an instance of the given type' do
+        expect(described_class.for(type, *arguments))
+          .to be_a(described_class::CallDefinition)
+      end
+
+      it 'initializes it correctly' do
+        expect(described_class.for(type, *arguments).code_string)
+          .to eq('attr_reader :some_attribute, :other_attribute')
+      end
+    end
+
+    context 'when a block is given' do
+      let(:type)        { :block }
+      let(:method_name) { :the_method }
+      let(:block)       { proc { 10 } }
+
+      it do
+        expect(described_class.for(type, method_name, &block))
+          .to be_a(described_class)
+      end
+
+      it 'Returns an instance of the given type' do
+        expect(described_class.for(type, method_name, &block))
+          .to be_a(described_class::BlockDefinition)
+      end
+
+      it 'initializes it correctly' do
+        expect(described_class.for(type, method_name, &block).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(described_class.for(type, method_name, code))
+          .to be_a(described_class)
+      end
+
+      it 'Returns an instance of the given type' do
+        expect(described_class.for(type, method_name, code))
+          .to be_a(described_class::StringDefinition)
+      end
+
+      it 'initializes it correctly' do
+        expect(described_class.for(type, method_name, code).name)
+          .to eq(method_name)
+      end
+    end
+  end
 end

data/spec/lib/sinclair/method_definitions_spec.rb

@@ -42,4 +42,83 @@ describe Sinclair::MethodDefinitions do
       end
     end
   end
+
+  describe '#add_definition' do
+    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_definition(type, *arguments))
+          .to be_a(Array)
+      end
+
+      it 'creates a new definition' do
+        expect(definitions.add_definition(type, *arguments).last)
+          .to be_a(Sinclair::MethodDefinition)
+      end
+
+      it 'creates a new definition of the chosen type' do
+        expect(definitions.add_definition(type, *arguments).last)
+          .to be_a(Sinclair::MethodDefinition::CallDefinition)
+      end
+
+      it 'initializes it correctly' do
+        expect(definitions.add_definition(type, *arguments).last.code_string)
+          .to eq('attr_reader :some_attribute, :other_attribute')
+      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_definition(type, method_name, &block))
+          .to be_a(Array)
+      end
+
+      it 'creates a new definition' do
+        expect(definitions.add_definition(type, method_name, &block).last)
+          .to be_a(Sinclair::MethodDefinition)
+      end
+
+      it 'creates a new definition of the chosen type' do
+        expect(definitions.add_definition(type, method_name, &block).last)
+          .to be_a(Sinclair::MethodDefinition::BlockDefinition)
+      end
+
+      it 'initializes it correctly' do
+        expect(definitions.add_definition(type, method_name, &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_definition(type, method_name, code))
+          .to be_a(Array)
+      end
+
+      it 'creates a new definition' do
+        expect(definitions.add_definition(type, method_name, code).last)
+          .to be_a(Sinclair::MethodDefinition)
+      end
+
+      it 'creates a new definition of the chosen type' do
+        expect(definitions.add_definition(type, method_name, code).last)
+          .to be_a(Sinclair::MethodDefinition::StringDefinition)
+      end
+
+      it 'initializes it correctly' do
+        expect(definitions.add_definition(type, method_name, code).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/support/sample_model.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class SampleModel
+  def initialize(name: nil, age: nil)
+    @name = name
+    @age  = age
+  end
+
+  protected
+
+  attr_reader :name
+
+  private
+
+  attr_reader :age
+end
+
+class OtherModel < SampleModel
+end

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.10.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.20
+        version: 2.3.25
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.20
+        version: 2.3.25
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -272,6 +272,8 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/sinclair.rb
+- lib/sinclair/comparable.rb
+- lib/sinclair/comparable/class_methods.rb
 - lib/sinclair/config.rb
 - lib/sinclair/config/methods_builder.rb
 - lib/sinclair/config_builder.rb
@@ -280,6 +282,7 @@ files:
 - lib/sinclair/configurable.rb
 - lib/sinclair/env_settable.rb
 - lib/sinclair/env_settable/builder.rb
+- lib/sinclair/equals_checker.rb
 - lib/sinclair/exception.rb
 - lib/sinclair/input_hash.rb
 - lib/sinclair/matchers.rb
@@ -299,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
@@ -314,26 +319,32 @@ files:
 - sinclair.jpg
 - spec/integration/readme/my_class_spec.rb
 - spec/integration/readme/my_model_spec.rb
+- spec/integration/readme/sinclair/comparable_spec.rb
 - 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/comparable_spec.rb
 - spec/integration/yard/sinclair/config_builder_spec.rb
 - spec/integration/yard/sinclair/config_class_spec.rb
 - spec/integration/yard/sinclair/config_factory_spec.rb
 - spec/integration/yard/sinclair/config_spec.rb
 - 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/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
+- spec/lib/sinclair/comparable_spec.rb
 - spec/lib/sinclair/config/methods_builder_spec.rb
 - spec/lib/sinclair/config_builder_spec.rb
 - spec/lib/sinclair/config_class_spec.rb
@@ -342,6 +353,7 @@ files:
 - spec/lib/sinclair/configurable_spec.rb
 - spec/lib/sinclair/env_settable/builder_spec.rb
 - spec/lib/sinclair/env_settable_spec.rb
+- spec/lib/sinclair/equals_checker_spec.rb
 - spec/lib/sinclair/exception/invalid_options_spec.rb
 - spec/lib/sinclair/input_hash_spec.rb
 - spec/lib/sinclair/matchers/add_class_method_spec.rb
@@ -354,10 +366,12 @@ files:
 - spec/lib/sinclair/matchers/change_instance_method_spec.rb
 - spec/lib/sinclair/matchers_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
@@ -404,6 +418,8 @@ files:
 - spec/support/models/server_config.rb
 - 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
@@ -427,7 +443,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.3.25
 signing_key: 
 specification_version: 4
 summary: Gem for easy concern creation