sinclair 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46b430c9db3658979d128e45ecbbb03aab30bb993d8651ecc8cc3bd9fe1b18e3
-  data.tar.gz: fa78aa3bde540b7f90675566086e65d884cea51b2874b6cd5166ffc50018ab73
+  metadata.gz: 6ee09cd280144bc873d89c0272856bf716e0a20c2ca5d3f7fe8bf11ac972c859
+  data.tar.gz: c5107aa15ffab29f4dd14b45efd0387913c60064ad62a58c4ec85adb09d91c9c
 SHA512:
-  metadata.gz: 9a290bcea44d39854bd7b8bd99b28c18d0a6c827b31f140fb339b82d49a9add6e505f738b4925b27c25ddedd695d06963a4221c55ff9b869157aaec5753a5747
-  data.tar.gz: dfdc3723b6a6d31611eceb727007680aafc3f56d9cda1e16922768df7e9ce14238d0c982ff7e4232a914015c8d22850b869ab08601b8121727ce0673c43ca10b
+  metadata.gz: 38994db2d8a69ef1b9f3827a84bcb53a0bd18e2073a4840b004a89ac00a0fe0f5d9a8a69ce231b9d6c5f2cfc51b3a96c5ee898c848ce7ba802eac1d8556a058b
+  data.tar.gz: 4812c5a5793de217eb0cdd895c8cc94ac698af119c60fded29ea6929bddf0240b9dbcdba237dba7c1f060a3c3b8a3a173d2c7fef0509f6181d738ca0c7f0ef34

data/README.md

@@ -13,13 +13,13 @@ This gem helps the creation of complex gems/concerns
 that enables creation of methods on the fly through class
 methods
 
-Current Release: [1.13.0](https://github.com/darthjee/sinclair/tree/1.13.0)
+Current Release: [1.14.0](https://github.com/darthjee/sinclair/tree/1.14.0)
 
-[Next release](https://github.com/darthjee/sinclair/compare/1.13.0...master)
+[Next release](https://github.com/darthjee/sinclair/compare/1.14.0...master)
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.13.0](https://www.rubydoc.info/gems/sinclair/1.13.0)
+[https://www.rubydoc.info/gems/sinclair/1.14.0](https://www.rubydoc.info/gems/sinclair/1.14.0)
 
 Installation
 ---------------
@@ -627,7 +627,8 @@ When creating a model class, options can be passed
 <summary>Example of simple usage</summary>
 
 ```ruby
-class Human < Sinclair::Model.for(:name, :age, { gender: :undefined }, **{})
+class Human < Sinclair::Model
+  initialize_with :name, :age, { gender: :undefined }, **{}
 end
 
 human1 = Human.new(name: 'John Doe', age: 22)

data/config/yardstick.yml

@@ -30,6 +30,7 @@ rules:
       - Sinclair::Matchers#change_method
       - Sinclair::Matchers#change_class_method
       - Sinclair::Model.for
+      - Sinclair::Model.initialize_with
   ReturnTag:
     enabled: true
     exclude:

data/lib/sinclair/model.rb

@@ -11,6 +11,8 @@ class Sinclair
     class << self
       # Returns a new class that inherits from model
       #
+      # @deprecated Use {.initialize_with} instead
+      #
       # @overload for(*attributes, writter: true, comparable: true)
       #   @param attributes [Array<Symbol>] attributes to be added in both the
       #     initialization and adding the methos to the model
@@ -53,6 +55,53 @@ class Sinclair
           Builder.new(klass, *attributes, **options).build
         end
       end
+
+      # Adds methods needed for the model
+      #
+      # The readers/writters, +==+ and initializer are added
+      #
+      # @overload initialize_with(*attributes, writter: true, comparable: true)
+      #   @param attributes [Array<Symbol>] attributes to be added in both the
+      #     initialization and adding the methos to the model
+      #   @param writter [TrueClass,FalseClass] flag informing if the writter/setter
+      #     method should be added
+      #   @param comparable [TrueClass,FalseClass] flag to make the class {Comparable}
+      #     by the fields
+      #
+      #   @example A model with readers
+      #     class Car < Sinclair::Model
+      #       initialize_with(:brand, :model, writter: false)
+      #     end
+      #
+      #     car = Car.new(brand: :ford, model: :T)
+      #
+      #     car.brand # returns :ford
+      #     car.model # returns :T
+      #
+      # @overload initialize_with(*attributes, defaults, writter: true, comparable: true)
+      #   @param attributes [Array<Symbol>] attributes to be added in both the
+      #     initialization and adding the methos to the model
+      #   @param defaults [Hash] attributes to be added with a default value in the initializer
+      #   @param writter [TrueClass,FalseClass] flag informing if the writter/setter
+      #     method should be added
+      #   @param comparable [TrueClass,FalseClass] flag to make the class {Comparable}
+      #     by the fields
+      #
+      #   @example A model with writters
+      #     class Job < Sinclair::Model
+      #       initialize_with({ state: :starting }, writter: true)
+      #     end
+      #
+      #     job = Job.new
+      #
+      #     job.state # returns :starting
+      #     job.state = :done
+      #     job.state # returns :done
+      #
+      # @return [Array<MethodDefinition>]
+      def initialize_with(*attributes, **options)
+        Builder.new(self, *attributes, **options).build
+      end
     end
   end
 end

data/lib/sinclair/version.rb

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

data/spec/lib/sinclair/model_spec.rb

@@ -3,136 +3,63 @@
 require 'spec_helper'
 
 describe Sinclair::Model do
-  describe '.with_attributes' do
-    subject(:model) { klass.new(name: name) }
+  subject(:model) { klass.new(name: name) }
 
-    let(:name)       { SecureRandom.hex(10) }
-    let(:attributes) { %i[name] }
+  let(:name)       { SecureRandom.hex(10) }
+  let(:attributes) { %i[name] }
+  let(:options)    { {} }
 
-    context 'when the call happens with no options' do
-      subject(:klass) { described_class.for(*attributes) }
+  describe '.for' do
+    subject(:klass) { described_class.for(*attributes, **options) }
 
-      it 'Returns a new class' do
-        expect(klass.superclass)
-          .to eq(described_class)
-      end
-
-      it 'returns a class with getter' do
-        expect(klass.instance_method(:name))
-          .to be_a(UnboundMethod)
-      end
-
-      it 'returns a class with setter' do
-        expect(klass.instance_method(:name=))
-          .to be_a(UnboundMethod)
-      end
+    it_behaves_like 'sinclair model building'
+  end
 
-      it 'returns a new class with a comparable that finds matches' do
-        expect(model).to eq(klass.new(name: name))
-      end
+  describe '.initialize_with' do
+    subject(:klass) { Class.new(described_class) }
 
-      it 'returns a new class with a comparable that find misses' do
-        expect(model).not_to eq(klass.new(name: SecureRandom.hex(10)))
+    context 'when no options are given' do
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .to add_method(:name).to(klass)
       end
 
-      context 'when reader is called' do
-        it do
-          expect(model.name).to eq(name)
-        end
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .to add_method(:name=).to(klass)
       end
 
-      context 'when setter is called' do
-        let(:name)  { SecureRandom.hex(10) }
-        let(:model) { klass.new(name: nil) }
-
-        it do
-          expect { model.name = name }
-            .to change(model, :name)
-            .from(nil)
-            .to(name)
-        end
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .to change_method(:==).on(klass)
       end
     end
 
-    context 'when the call happens with comparable false' do
-      subject(:klass) { described_class.for(*attributes, **options) }
+    context 'when writter and comparable are not enabled' do
+      let(:options) { { writter: false, comparable: false } }
 
-      let(:options) { { comparable: false } }
-
-      it 'returns a new class without comparable' do
-        expect(model).not_to eq(klass.new(name: name))
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .to add_method(:name).to(klass)
       end
-    end
-
-    context 'when the call happens with reader options' do
-      subject(:klass) { described_class.for(*attributes, **options) }
-
-      let(:options) { { writter: false } }
 
-      it 'Returns a new class' do
-        expect(klass.superclass)
-          .to eq(described_class)
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .not_to add_method(:name=).to(klass)
       end
 
-      it 'returns a class with getter' do
-        expect(klass.instance_method(:name))
-          .to be_a(UnboundMethod)
-      end
-
-      it 'returns a class without setter' do
-        expect { klass.instance_method(:name=) }
-          .to raise_error(NameError)
-      end
-
-      context 'when reader is called' do
-        it do
-          expect(model.name).to eq(name)
-        end
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .not_to change_method(:==).on(klass)
       end
     end
 
-    context 'when the call happens with defaults' do
-      subject(:klass) do
-        described_class.for({ name: 'John Doe' }, **{})
-      end
-
-      it 'Returns a new class' do
-        expect(klass.superclass)
-          .to eq(described_class)
-      end
-
-      it 'returns a class with getter' do
-        expect(klass.instance_method(:name))
-          .to be_a(UnboundMethod)
-      end
-
-      it 'returns a class with setter' do
-        expect(klass.instance_method(:name=))
-          .to be_a(UnboundMethod)
+    context 'when the build is done' do
+      before do
+        klass.initialize_with(*attributes, **options)
       end
 
-      context 'when reader is called' do
-        subject(:model) { klass.new }
-
-        let(:name) { SecureRandom.hex(10) }
-
-        it 'returns the dfault value' do
-          expect(model.name).to eq('John Doe')
-        end
-      end
-
-      context 'when setter is called' do
-        subject(:model) { klass.new }
-
-        let(:name) { SecureRandom.hex(10) }
-
-        it do
-          expect { model.name = name }
-            .to change(model, :name)
-            .from('John Doe')
-            .to(name)
-        end
-      end
+      it_behaves_like 'sinclair model building'
     end
   end
 end

data/spec/support/models/car.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: false
 
-class Car < Sinclair::Model.for(:brand, :model, writter: false)
+class Car < Sinclair::Model
+  initialize_with(:brand, :model, writter: false)
 end

data/spec/support/models/human.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
-class Human < Sinclair::Model.for(:name, :age, { gender: :undefined }, **{})
+class Human < Sinclair::Model
+  initialize_with :name, :age, { gender: :undefined }, **{}
 end

data/spec/support/models/job.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: false
 
-class Job < Sinclair::Model.for({ state: :starting }, writter: true)
+class Job < Sinclair::Model
+  initialize_with({ state: :starting }, writter: true)
 end

data/spec/support/shared_examples/model.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+shared_examples 'sinclair model building' do
+  context 'when the call happens with no options' do
+    it 'Returns a new class' do
+      expect(klass.superclass)
+        .to eq(described_class)
+    end
+
+    it 'returns a class with getter' do
+      expect(klass.instance_method(:name))
+        .to be_a(UnboundMethod)
+    end
+
+    it 'returns a class with setter' do
+      expect(klass.instance_method(:name=))
+        .to be_a(UnboundMethod)
+    end
+
+    it 'returns a new class with a comparable that finds matches' do
+      expect(model).to eq(klass.new(name: name))
+    end
+
+    it 'returns a new class with a comparable that find misses' do
+      expect(model).not_to eq(klass.new(name: SecureRandom.hex(10)))
+    end
+
+    context 'when reader is called' do
+      it do
+        expect(model.name).to eq(name)
+      end
+    end
+
+    context 'when setter is called' do
+      let(:name)  { SecureRandom.hex(10) }
+      let(:model) { klass.new(name: nil) }
+
+      it do
+        expect { model.name = name }
+          .to change(model, :name)
+          .from(nil)
+          .to(name)
+      end
+    end
+  end
+
+  context 'when the call happens with comparable false' do
+    let(:options) { { comparable: false } }
+
+    it 'returns a new class without comparable' do
+      expect(model).not_to eq(klass.new(name: name))
+    end
+  end
+
+  context 'when the call happens with reader options' do
+    let(:options) { { writter: false } }
+
+    it 'Returns a new class' do
+      expect(klass.superclass)
+        .to eq(described_class)
+    end
+
+    it 'returns a class with getter' do
+      expect(klass.instance_method(:name))
+        .to be_a(UnboundMethod)
+    end
+
+    it 'returns a class without setter' do
+      expect { klass.instance_method(:name=) }
+        .to raise_error(NameError)
+    end
+
+    context 'when reader is called' do
+      it do
+        expect(model.name).to eq(name)
+      end
+    end
+  end
+
+  context 'when the call happens with defaults' do
+    let(:attributes) { [{ name: 'John Doe' }] }
+
+    it 'Returns a new class' do
+      expect(klass.superclass)
+        .to eq(described_class)
+    end
+
+    it 'returns a class with getter' do
+      expect(klass.instance_method(:name))
+        .to be_a(UnboundMethod)
+    end
+
+    it 'returns a class with setter' do
+      expect(klass.instance_method(:name=))
+        .to be_a(UnboundMethod)
+    end
+
+    context 'when reader is called' do
+      subject(:model) { klass.new }
+
+      let(:name) { SecureRandom.hex(10) }
+
+      it 'returns the dfault value' do
+        expect(model.name).to eq('John Doe')
+      end
+    end
+
+    context 'when setter is called' do
+      subject(:model) { klass.new }
+
+      let(:name) { SecureRandom.hex(10) }
+
+      it do
+        expect { model.name = name }
+          .to change(model, :name)
+          .from('John Doe')
+          .to(name)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -448,6 +448,7 @@ files:
 - 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/model.rb
 - spec/support/shared_examples/sinclair.rb
 homepage: https://github.com/darthjee/sinclair
 licenses: []