sinclair 1.12.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b14d0d24d28075129d870b9f2b93c306e894407a70878d7950e0c73e7f747dbb
-  data.tar.gz: 5a3d836d3b8eb5dc299dd17836e50f387fe3273820e91ef95581aac25348407d
+  metadata.gz: 6ee09cd280144bc873d89c0272856bf716e0a20c2ca5d3f7fe8bf11ac972c859
+  data.tar.gz: c5107aa15ffab29f4dd14b45efd0387913c60064ad62a58c4ec85adb09d91c9c
 SHA512:
-  metadata.gz: c6bbf090685049aaa1936e632ed420060ccead6071bb9864de3b5e26f16ad68431b6d01de24442f4ac4ce87792158a5def414680fe9d6b941d4031b766bd386e
-  data.tar.gz: ef28a8f5b9f5b9e9e12cd36c558fe2bb14fededbea91df46cda1b2d8570d0fec22809dc3e36f4af61844da370ea659463df03562232883121d0ebc7f40a63e81
+  metadata.gz: 38994db2d8a69ef1b9f3827a84bcb53a0bd18e2073a4840b004a89ac00a0fe0f5d9a8a69ce231b9d6c5f2cfc51b3a96c5ee898c848ce7ba802eac1d8556a058b
+  data.tar.gz: 4812c5a5793de217eb0cdd895c8cc94ac698af119c60fded29ea6929bddf0240b9dbcdba237dba7c1f060a3c3b8a3a173d2c7fef0509f6181d738ca0c7f0ef34

data/.rubocop.yml

@@ -4,7 +4,6 @@ inherit_from: .rubocop_todo.yml
 AllCops:
   TargetRubyVersion: 2.5
 
-
 RSpec/DescribeClass:
   Exclude:
     - 'spec/integration/yard/**/*_spec.rb'

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.12.1](https://github.com/darthjee/sinclair/tree/1.12.1)
+Current Release: [1.14.0](https://github.com/darthjee/sinclair/tree/1.14.0)
 
-[Next release](https://github.com/darthjee/sinclair/compare/1.12.1...master)
+[Next release](https://github.com/darthjee/sinclair/compare/1.14.0...master)
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.12.1](https://www.rubydoc.info/gems/sinclair/1.12.1)
+[https://www.rubydoc.info/gems/sinclair/1.14.0](https://www.rubydoc.info/gems/sinclair/1.14.0)
 
 Installation
 ---------------
@@ -616,6 +616,45 @@ model1 == model2 # returns true
 ```
 </details>
 
+### Sinclair::Model
+Model class for quickly creation of plain simple classes/models
+
+When creating a model class, options can be passed
+-  writter: Adds writter/setter methods (defaults to true)
+-  comparable: Adds the fields when running a `==` method (defaults to true)
+
+<details>
+<summary>Example of simple usage</summary>
+
+```ruby
+class Human < Sinclair::Model
+  initialize_with :name, :age, { gender: :undefined }, **{}
+end
+
+human1 = Human.new(name: 'John Doe', age: 22)
+human2 = Human.new(name: 'John Doe', age: 22)
+
+human1.name      # returns 'John Doe'
+human1.age       # returns 22
+human1.gender    # returns :undefined
+human1 == human2 # returns true
+```
+</details>
+
+<details>
+<summary>Example with options</summary>
+
+```ruby
+class Tv < Sinclair::Model.for(:model, writter: false, comparable: false)
+end
+
+tv1 = Tv.new(model: 'Sans Sunga Xt')
+tv2 = Tv.new(model: 'Sans Sunga Xt')
+
+tv1 == tv2 # returns false
+```
+</details>
+
 RSspec matcher
 ---------------
 

data/config/check_specs.yml

@@ -1,4 +1,5 @@
 ignore:
+  - lib/sinclair/model/builder.rb
   - lib/sinclair/comparable/class_methods.rb
   - lib/sinclair/exception.rb
   - lib/sinclair/matchers/add_method.rb

data/config/yardstick.yml

@@ -29,6 +29,8 @@ rules:
       - Sinclair::Matchers#add_class_method
       - Sinclair::Matchers#change_method
       - Sinclair::Matchers#change_class_method
+      - Sinclair::Model.for
+      - Sinclair::Model.initialize_with
   ReturnTag:
     enabled: true
     exclude:
@@ -63,6 +65,7 @@ rules:
       - Sinclair::MethodDefinition::ParameterBuilder#initialize
       - Sinclair::MethodDefinition::ParameterHelper#initialize
       - Sinclair::MethodDefinition::StringDefinition#initialize
+      - Sinclair::Model::Builder#initialize
       - Sinclair::Options#initialize
       - Sinclair::Options::Builder#initialize
   Summary::Length:

data/lib/sinclair/core_ext/object.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# @api public
+# @author darthjee
+#
+# Extension to core class Object
+class Object
+  # rubocop:disable Naming/PredicateName
+
+  # @api public
+  # Checks if an object is an instance of any of the given classes
+  #
+  # @param classes [Array<Class>] classes to be checked against object
+  #
+  # @example
+  #   object = [1, 2, 3]
+  #
+  #   object.is_any?(Hash, Class) # returns false
+  #   object.is_any?(Hash, Array) # returns true
+  #
+  # @return [TrueClass,FalseClass]
+  def is_any?(*classes)
+    classes.any?(method(:is_a?))
+  end
+  # rubocop:enable Naming/PredicateName
+end

data/lib/sinclair/method_definition/parameter_helper.rb

@@ -45,6 +45,7 @@ class Sinclair
 
       private
 
+      delegate :value_string, to: Stringifier
       attr_reader :parameters_list, :named
       alias named? named
 
@@ -114,11 +115,29 @@ class Sinclair
       #
       # @return [Array<String>]
       def defaults_strings
-        joinner = named? ? ': ' : ' = '
-        defaults.map do |key, value|
-          "#{key}#{joinner}#{value.to_json}"
+        defaults.map do |parameter, value|
+          default_string(parameter, value)
         end
       end
+
+      # Returns the string for one default parameter
+      #
+      # @param parameter [Symbol] name of the parameter
+      # @param value [Object] default value
+      #
+      # @return [String]
+      def default_string(parameter, value)
+        "#{parameter}#{joinner}#{value_string(value)}"
+      end
+
+      # Returns the string used when joining a parameter with it's default value
+      #
+      # @see #named?
+      #
+      # @return [String]
+      def joinner
+        @joinner ||= named? ? ': ' : ' = '
+      end
     end
   end
 end

data/lib/sinclair/method_definition/stringifier.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'sinclair/core_ext/object'
+
+class Sinclair
+  class MethodDefinition
+    # @api private
+    # @author darthjee
+    #
+    # Stringgify a value for {StringDefinition}
+    class Stringifier
+      # Convert a value to a string format
+      #
+      # The returned string can be evaluated as code, returning the
+      # original value
+      #
+      # @param value [Object] object to be converted
+      #
+      # @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
+      end
+    end
+  end
+end

data/lib/sinclair/method_definition.rb

@@ -14,6 +14,7 @@ class Sinclair
     autoload :StringDefinition, 'sinclair/method_definition/string_definition'
     autoload :ParameterBuilder, 'sinclair/method_definition/parameter_builder'
     autoload :ParameterHelper,  'sinclair/method_definition/parameter_helper'
+    autoload :Stringifier,      'sinclair/method_definition/stringifier'
 
     # @method name
     #

data/lib/sinclair/model/builder.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class Model
+    # @api private
+    # @author Darthjee
+    #
+    # Builder responsible for building methods to a new {Sinclair::Model} class
+    #
+    # The building adds readers/setters and an initializer with named parameters
+    class Builder < Sinclair
+      # @overload initialize(klass, *attributes, writter: true, comparable: true)
+      #   @param klass [Class<Sinclair::Model>] the new class to receive the methods
+      #   @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
+      # @overload initialize(klass, *attributes, defaults, writter: true, comparable: true)
+      #   @param klass [Class<Sinclair::Model>] the new class to receive the methods
+      #   @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
+      def initialize(klass, *attributes, writter: true, comparable: true)
+        super(klass)
+        @attributes = attributes.flatten
+        @writter    = writter
+        @comparable = comparable
+
+        add_methods
+        change_equals
+        change_initializer
+      end
+
+      private
+
+      attr_reader :attributes, :writter, :comparable
+      alias writter? writter
+      alias comparable? comparable
+
+      # @!method attributes
+      # @api private
+      # @private
+      #
+      # Attributes to be added in the class
+      #
+      # Attributes without default values are symbols
+      # while attributes with defaults values are defined in a Hash
+      #
+      # @return [Array<Symbol,Hash>]
+
+      # @!method writter
+      # @api private
+      # @private
+      #
+      # Flag if writter methods (setter) should be added or not
+      #
+      # @return [TrueClass,FalseClass]
+
+      # @!method comparable
+      # @api private
+      # @private
+      #
+      # flag to make the class {Comparable} by the fields
+      #
+      # @return [TrueClass,FalseClass]
+
+      # @!method writter?
+      # @api private
+      # @private
+      #
+      # Flag if writter methods (setter) should be added or not
+      #
+      # @return [TrueClass,FalseClass]
+
+      # @!method comparable?
+      # @api private
+      # @private
+      #
+      # flag to make the class {Comparable} by the fields
+      #
+      # @return [TrueClass,FalseClass]
+
+      # @private
+      # Adds readers and setters
+      #
+      # Readers are always added, while setters depends on the flag {#writter?}
+      #
+      # @return [Array<MethodDefinition>]
+      def add_methods
+        call = writter? ? :attr_accessor : :attr_reader
+
+        add_method(call, *attributes_names, type: :call)
+      end
+
+      # @private
+      # Change the method +==+
+      #
+      # The change happens using {Sinclair::Comparable}
+      # and adding all the fields to be included in the comparisom
+      #
+      # @return [Array<MethodDefinition>]
+      def change_equals
+        return unless comparable?
+
+        add_method(:include, Comparable, type: :call)
+        add_method(:comparable_by, *attributes_names, type: :call)
+      end
+
+      # @private
+      #
+      # Changes the initializer to accept the parameters
+      #
+      # @return [Array<MethodDefinition>]
+      def change_initializer
+        code = attributes_names.map do |attr|
+          "@#{attr} = #{attr}"
+        end.join("\n")
+
+        add_method(:initialize, code, named_parameters: attributes)
+      end
+
+      # @private
+      # Returns the list of attributes
+      #
+      # This is used when defining the readers / setters
+      #
+      # @return [Array<Symbol>]
+      def attributes_names
+        @attributes_names ||= attributes.map do |attr|
+          attr.try(:keys) || attr.to_s
+        end.flatten
+      end
+    end
+  end
+end

data/lib/sinclair/model.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+class Sinclair
+  # @api public
+  # @author Darthjee
+  #
+  # Basic model to be used when defining new classes quickly
+  class Model
+    autoload :Builder, 'sinclair/model/builder'
+
+    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
+      #   @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.for(:brand, :model, writter: false)
+      #     end
+      #
+      #     car = Car.new(brand: :ford, model: :T)
+      #
+      #     car.brand # returns :ford
+      #     car.model # returns :T
+      #
+      # @overload for(*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.for({ state: :starting }, writter: true)
+      #     end
+      #
+      #     job = Job.new
+      #
+      #     job.state # returns :starting
+      #     job.state = :done
+      #     job.state # returns :done
+      #
+      # @return [Class<Model>] a new class with the chosen attributes
+      def for(*attributes, **options)
+        Class.new(self) do |klass|
+          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.12.1'
+  VERSION = '1.14.0'
 end

data/lib/sinclair.rb

@@ -96,6 +96,7 @@ class Sinclair
   autoload :MethodBuilder,     'sinclair/method_builder'
   autoload :MethodDefinition,  'sinclair/method_definition'
   autoload :MethodDefinitions, 'sinclair/method_definitions'
+  autoload :Model,             'sinclair/model'
   autoload :Options,           'sinclair/options'
 
   include OptionsParser

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Model do
+  describe 'readme' do
+    it 'Simple usage' do
+      human1 = Human.new(name: 'John Doe', age: 22)
+      human2 = Human.new(name: 'John Doe', age: 22)
+
+      expect(human1.name).to eq('John Doe')
+      expect(human1.age).to eq(22)
+      expect(human1.gender).to eq(:undefined)
+      expect(human1 == human2).to eq(true)
+    end
+
+    it 'Without comparable' do
+      tv1 = Tv.new(model: 'Sans Sunga Xt')
+      tv2 = Tv.new(model: 'Sans Sunga Xt')
+
+      expect(tv1 == tv2).to eq(false)
+    end
+  end
+end

data/spec/integration/yard/sinclair/core_ext/object_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+describe Object do
+  describe 'yard' do
+    describe '#is_any?' do
+      context 'when none match' do
+        it do
+          object = [1, 2, 3]
+
+          expect(object.is_any?(Hash, Class)).to eq(false)
+          expect(object.is_any?(Hash, Array)).to eq(true)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: false
+
+require 'spec_helper'
+
+describe 'yard Sinclair::Model#for' do
+  it 'Creating a Simple model' do
+    car = Car.new(brand: :ford, model: :T)
+
+    expect(car.brand).to eq(:ford)
+    expect(car.model).to eq(:T)
+  end
+
+  it 'Creating a model with default values and writter' do
+    job = Job.new
+
+    expect(job.state).to eq(:starting)
+    job.state = :done
+    expect(job.state).to eq(:done)
+  end
+end

data/spec/lib/sinclair/core_ext/object_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Object do
+  describe '#is_any?' do
+    subject(:object) { 1 }
+
+    it do
+      expect(object).to respond_to(:is_any?)
+    end
+
+    context 'when no argument is passed' do
+      it do
+        expect(object).not_to be_is_any
+      end
+    end
+
+    context 'when passing the correct class as argument' do
+      it do
+        expect(object).to be_is_any(object.class)
+      end
+
+      context 'when passing any other class' do
+        it do
+          expect(object).to be_is_any(Symbol, object.class)
+        end
+      end
+    end
+
+    context 'when passing the wrong class' do
+      it do
+        expect(object).not_to be_is_any(Symbol)
+      end
+    end
+  end
+end

data/spec/lib/sinclair/method_definition/parameter_helper_spec.rb

@@ -14,12 +14,12 @@ describe Sinclair::MethodDefinition::ParameterHelper do
 
       context 'when there are defaults' do
         let(:parameters) do
-          [{ a: 10, b: 'word', c: true, d: false }]
+          [{ a: 10, b: 'word', c: true, d: false, e: nil, f: :symbol }]
         end
 
         it 'returns a list of parameters' do
           expect(described_class.parameters_from(parameters))
-            .to eq(['a = 10', 'b = "word"', 'c = true', 'd = false'])
+            .to eq(['a = 10', 'b = "word"', 'c = true', 'd = false', 'e = nil', 'f = :symbol'])
         end
       end
     end
@@ -34,12 +34,12 @@ describe Sinclair::MethodDefinition::ParameterHelper do
 
       context 'when there are defaults' do
         let(:parameters) do
-          [{ a: 10, b: 'word', c: true, d: false }]
+          [{ a: 10, b: 'word', c: true, d: false, e: nil, f: :symbol }]
         end
 
         it 'returns a list of parameters' do
           expect(described_class.parameters_from(parameters, named: true))
-            .to eq(['a: 10', 'b: "word"', 'c: true', 'd: false'])
+            .to eq(['a: 10', 'b: "word"', 'c: true', 'd: false', 'e: nil', 'f: :symbol'])
         end
       end
     end

data/spec/lib/sinclair/method_definition/stringifier_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::MethodDefinition::Stringifier do
+  describe '.value_string' do
+    context 'when value is nil' do
+      it 'returns string representing nil' do
+        expect(described_class.value_string(nil)).to eq('nil')
+      end
+    end
+
+    context 'when value is a symbol' do
+      it 'returns string representing a symbol' do
+        expect(described_class.value_string(:symbol)).to eq(':symbol')
+      end
+    end
+
+    context 'when value is a string' do
+      it 'returns string representing a string' do
+        expect(described_class.value_string('string')).to eq('"string"')
+      end
+    end
+
+    context 'when value is a number' do
+      it 'returns string representing a number' do
+        expect(described_class.value_string(10)).to eq('10')
+      end
+    end
+
+    context 'when value is a float' do
+      it 'returns string representing a float' do
+        expect(described_class.value_string(1.20)).to eq('1.2')
+      end
+    end
+
+    context 'when value is a true' do
+      it 'returns string representing a true' do
+        expect(described_class.value_string(true)).to eq('true')
+      end
+    end
+
+    context 'when value is a false' do
+      it 'returns string representing a false' do
+        expect(described_class.value_string(false)).to eq('false')
+      end
+    end
+
+    context 'when value is a class' do
+      it 'returns string representing a class' do
+        expect(described_class.value_string(Sinclair::Model)).to eq('Sinclair::Model')
+      end
+    end
+
+    context 'when value is a hash' do
+      it 'returns string representing a Hash' do
+        expect(described_class.value_string({ a: 10, 'b' => 'value' }))
+          .to eq('{:a=>10, "b"=>"value"}')
+      end
+    end
+
+    context 'when value is an Array' do
+      it 'returns string representing a Array' do
+        expect(described_class.value_string([:a, 10, 'b', true, nil]))
+          .to eq('[:a, 10, "b", true, nil]')
+      end
+    end
+  end
+end

data/spec/lib/sinclair/model_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Model do
+  subject(:model) { klass.new(name: name) }
+
+  let(:name)       { SecureRandom.hex(10) }
+  let(:attributes) { %i[name] }
+  let(:options)    { {} }
+
+  describe '.for' do
+    subject(:klass) { described_class.for(*attributes, **options) }
+
+    it_behaves_like 'sinclair model building'
+  end
+
+  describe '.initialize_with' do
+    subject(:klass) { Class.new(described_class) }
+
+    context 'when no options are given' do
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .to add_method(:name).to(klass)
+      end
+
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .to add_method(:name=).to(klass)
+      end
+
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .to change_method(:==).on(klass)
+      end
+    end
+
+    context 'when writter and comparable are not enabled' do
+      let(:options) { { writter: false, comparable: false } }
+
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .to add_method(:name).to(klass)
+      end
+
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .not_to add_method(:name=).to(klass)
+      end
+
+      it do
+        expect { klass.initialize_with(*attributes, **options) }
+          .not_to change_method(:==).on(klass)
+      end
+    end
+
+    context 'when the build is done' do
+      before do
+        klass.initialize_with(*attributes, **options)
+      end
+
+      it_behaves_like 'sinclair model building'
+    end
+  end
+end

data/spec/support/models/car.rb

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

data/spec/support/models/human.rb

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

data/spec/support/models/job.rb

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

data/spec/support/models/tv.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Tv < Sinclair::Model.for(:model, writter: false, comparable: false)
+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.12.1
+  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
@@ -280,6 +280,7 @@ files:
 - lib/sinclair/config_class.rb
 - lib/sinclair/config_factory.rb
 - lib/sinclair/configurable.rb
+- lib/sinclair/core_ext/object.rb
 - lib/sinclair/env_settable.rb
 - lib/sinclair/env_settable/builder.rb
 - lib/sinclair/equals_checker.rb
@@ -311,7 +312,10 @@ files:
 - lib/sinclair/method_definition/parameter_builder.rb
 - lib/sinclair/method_definition/parameter_helper.rb
 - lib/sinclair/method_definition/string_definition.rb
+- lib/sinclair/method_definition/stringifier.rb
 - lib/sinclair/method_definitions.rb
+- lib/sinclair/model.rb
+- lib/sinclair/model/builder.rb
 - lib/sinclair/options.rb
 - lib/sinclair/options/builder.rb
 - lib/sinclair/options/class_methods.rb
@@ -325,6 +329,7 @@ files:
 - 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/model_spec.rb
 - spec/integration/readme/sinclair/options_spec.rb
 - spec/integration/readme/sinclair/types_of_definition_spec.rb
 - spec/integration/readme/sinclair_spec.rb
@@ -337,6 +342,7 @@ files:
 - 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/core_ext/object_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
@@ -347,6 +353,7 @@ files:
 - 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/model_spec.rb
 - spec/integration/yard/sinclair/options_parser_spec.rb
 - spec/integration/yard/sinclair/options_spec.rb
 - spec/integration/yard/sinclair_spec.rb
@@ -357,6 +364,7 @@ files:
 - spec/lib/sinclair/config_factory_spec.rb
 - spec/lib/sinclair/config_spec.rb
 - spec/lib/sinclair/configurable_spec.rb
+- spec/lib/sinclair/core_ext/object_spec.rb
 - spec/lib/sinclair/env_settable/builder_spec.rb
 - spec/lib/sinclair/env_settable_spec.rb
 - spec/lib/sinclair/equals_checker_spec.rb
@@ -382,8 +390,10 @@ files:
 - spec/lib/sinclair/method_definition/parameter_builder_spec.rb
 - spec/lib/sinclair/method_definition/parameter_helper_spec.rb
 - spec/lib/sinclair/method_definition/string_definition_spec.rb
+- spec/lib/sinclair/method_definition/stringifier_spec.rb
 - spec/lib/sinclair/method_definition_spec.rb
 - spec/lib/sinclair/method_definitions_spec.rb
+- spec/lib/sinclair/model_spec.rb
 - spec/lib/sinclair/options/builder_spec.rb
 - spec/lib/sinclair/options/class_methods_spec.rb
 - spec/lib/sinclair/options_parser_spec.rb
@@ -394,6 +404,7 @@ files:
 - spec/support/models/app_client.rb
 - spec/support/models/app_config.rb
 - spec/support/models/builder_options.rb
+- spec/support/models/car.rb
 - spec/support/models/client.rb
 - spec/support/models/connection_options.rb
 - spec/support/models/default_value.rb
@@ -408,7 +419,9 @@ files:
 - spec/support/models/host_config.rb
 - spec/support/models/http_json_model.rb
 - spec/support/models/http_person.rb
+- spec/support/models/human.rb
 - spec/support/models/initial_valuer.rb
+- spec/support/models/job.rb
 - spec/support/models/login_config.rb
 - spec/support/models/login_configurable.rb
 - spec/support/models/my_app_client.rb
@@ -426,6 +439,7 @@ files:
 - spec/support/models/server.rb
 - spec/support/models/server_config.rb
 - spec/support/models/service_client.rb
+- spec/support/models/tv.rb
 - spec/support/models/validator_builder.rb
 - spec/support/sample_model.rb
 - spec/support/shared_examples/attribute_accessor.rb
@@ -434,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: []