easy_talk 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef35c90e8f4ecd74af7743e5c4e8503a3f1df9099c4395c5d8376d8b7be2f325
-  data.tar.gz: 85e4bec40186ed896834b59707ad68a9ede133db9fe1c4da99570de416f8abb9
+  metadata.gz: f412e6a4ef70f8a8912def5e60e4f9a2fbb80a47c0f22e7f46af9caed9d153fa
+  data.tar.gz: ee7bfc2e77fef086bff23db293eec6f6d7f47ed47488a803737e2831895feb88
 SHA512:
-  metadata.gz: 0a74dd4133b14bb81882224e06c97488be0ac1e85e4c3a52452c3ce396a52928aefc13de45a7e284c846ae8acc09e73043381bb46d9acad7cfcfdfcf5e290a45
-  data.tar.gz: 0f78ef87354030469e5c9b8897331870a1232724bc33a2e6d0af7bffaf44617f86e8ecd4a44684955d964d9dd55fbdca5944a14699db49fc981d0803a31489a9
+  metadata.gz: feb1884f28b4c0400ccbe3fb651f2d87e4650a25180ed804bab8c7b2493ebc7f0d7fb769271788a7dc0e0e6cdc6c2793fb1cbaa064df881aef2d797242b70860
+  data.tar.gz: 1c2ac812a423169c0bc0d43afac4f86711acad7bbab28aeb40e249df65258be4cb845903edc585d43f835b2717b9fc4003817b0ae2c704d20a28ff583290f3c5

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.1.7] - 2024-04-16
+- general cleanup and refactoring.
+
 ## [0.1.6] - 2024-04-16
 - model instance takes a hash and converts it to attribute methods.
 

data/lib/easy_talk/builders/base_builder.rb

@@ -53,6 +53,10 @@ module EasyTalk
           obj[value[:key]] = T.let(@options[key], value[:type])
         end
       end
+
+      def self.collection_type?
+        false
+      end
     end
   end
 end

data/lib/easy_talk/builders/boolean_builder.rb

@@ -11,12 +11,11 @@ module EasyTalk
       # VALID_OPTIONS defines the valid options for a boolean property.
       VALID_OPTIONS = {
         enum: { type: T::Array[T::Boolean], key: :enum },
-        const: { type: T::Boolean, key: :const },
         default: { type: T::Boolean, key: :default }
       }.freeze
 
-      sig { params(name: Symbol, _type: T.untyped, constraints: Hash).void }
-      def initialize(name, _type = nil, constraints = {})
+      sig { params(name: Symbol, constraints: Hash).void }
+      def initialize(name, constraints = {})
         super(name, { type: 'boolean' }, constraints, VALID_OPTIONS)
       end
     end

data/lib/easy_talk/builders/collection_helpers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module EasyTalk
+  module Builders
+    # Base builder class for array-type properties.
+    module CollectionHelpers
+      def collection_type?
+        true
+      end
+    end
+  end
+end

data/lib/easy_talk/builders/composition_builder.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'base_builder'
+require_relative 'collection_helpers'
 
 module EasyTalk
   module Builders
     # This class represents a builder for composing JSON schemas using the "allOf", "anyOf", or "oneOf" keywords.
     class CompositionBuilder
+      extend CollectionHelpers
       extend T::Sig
 
       COMPOSER_TO_KEYWORD = {

data/lib/easy_talk/builders/integer_builder.rb

@@ -19,8 +19,8 @@ module EasyTalk
       }.freeze
 
       # Initializes a new instance of the IntegerBuilder class.
-      sig { params(name: Symbol, _type: T.untyped, constraints: Hash).void }
-      def initialize(name, _type = nil, constraints = {})
+      sig { params(name: Symbol, constraints: Hash).void }
+      def initialize(name, constraints = {})
         super(name, { type: 'integer' }, constraints, VALID_OPTIONS)
       end
     end

data/lib/easy_talk/builders/null_builder.rb

@@ -7,8 +7,8 @@ module EasyTalk
     # builder class for Null properties.
     class NullBuilder < BaseBuilder
       # Initializes a new instance of the NullBuilder class.
-      sig { params(name: Symbol, _type: T.untyped, _constraints: Hash).void }
-      def initialize(name, _type = nil, _constraints = {})
+      sig { params(name: Symbol, _constraints: Hash).void }
+      def initialize(name, _constraints = {})
         super(name, { type: 'null' }, {}, {})
       end
     end

data/lib/easy_talk/builders/number_builder.rb

@@ -18,8 +18,8 @@ module EasyTalk
       }.freeze
 
       # Initializes a new instance of the NumberBuilder class.
-      sig { params(name: Symbol, _type: T.untyped, constraints: Hash).void }
-      def initialize(name, _type = nil, constraints = {})
+      sig { params(name: Symbol, constraints: Hash).void }
+      def initialize(name, constraints = {})
         super(name, { type: 'number' }, constraints, VALID_OPTIONS)
       end
     end

data/lib/easy_talk/builders/object_builder.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'base_builder'
+
 module EasyTalk
   module Builders
     # Builder class for json schema objects.

data/lib/easy_talk/builders/string_builder.rb

@@ -18,8 +18,8 @@ module EasyTalk
         default: { type: String, key: :default }
       }.freeze
 
-      sig { params(name: Symbol, _type: T.untyped, constraints: Hash).void }
-      def initialize(name, _type = nil, constraints = {})
+      sig { params(name: Symbol, constraints: Hash).void }
+      def initialize(name, constraints = {})
         super(name, { type: 'string' }, constraints, VALID_OPTIONS)
       end
     end

data/lib/easy_talk/builders/typed_array_builder.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'collection_helpers'
+
 module EasyTalk
   module Builders
     # Builder class for array properties.
     class TypedArrayBuilder < BaseBuilder
+      extend CollectionHelpers
+      extend T::Sig
+
       VALID_OPTIONS = {
         min_items: { type: Integer, key: :minItems },
         max_items: { type: Integer, key: :maxItems },

data/lib/easy_talk/builders/union_builder.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'base_builder'
+require_relative 'collection_helpers'
 
 module EasyTalk
   module Builders
     # Base builder class for array-type properties.
     class UnionBuilder
+      extend CollectionHelpers
       extend T::Sig
+
       sig { params(name: Symbol, type: T.untyped, constraints: T.untyped).void }
       def initialize(name, type, constraints)
         @name = name

data/lib/easy_talk/model.rb

@@ -7,54 +7,14 @@ require 'active_support/time'
 require 'active_support/concern'
 require 'active_support/json'
 require 'json-schema'
-require_relative 'builder'
+require_relative 'builders/object_builder'
 require_relative 'schema_definition'
 
 module EasyTalk
   # The Model module can be included in a class to add JSON schema definition and generation support.
   module Model
-    def self.included(base)
-      base.extend(ClassMethods)
-
-      base.singleton_class.instance_eval do
-        define_method(:inherited) do |subclass|
-          super(subclass)
-          subclass.extend(SubclassExtension)
-        end
-      end
-    end
-
-    def initialize(properties = {})
-      properties.each do |key, value|
-        instance_variable_set("@#{key}", value)
-        self.class.class_eval { attr_reader key }
-      end
-    end
-
-    def valid?
-      self.class.validate_json(properties)
-    end
-
-    def properties
-      as_json.symbolize_keys!
-    end
-
-    # This module provides extension methods for subclasses with schema definitions.
-    module SubclassExtension
-      # Returns true if the class inherits a schema.
-      def inherits_schema?
-        true
-      end
-
-      # Returns the superclass that the class inherits from.
-      def inherits_from
-        superclass
-      end
-    end
-
-    # Module containing class-level methods for defining and accessing the schema of a model.
+    # The `Model` module is a mixin that provides functionality for defining and accessing the schema of a model.
     #
-    # This module provides methods for defining and accessing the JSON schema of a model.
     # It includes methods for defining the schema, retrieving the schema definition,
     # and generating the JSON schema for the model.
     #
@@ -83,37 +43,85 @@ module EasyTalk
     #   MyModel.json_schema #=> returns the JSON schema for MyModel
     #
     # @see SchemaDefinition
-    # @see Builder
+    #
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Initializes a new instance of the Model class.
+    #
+    # @param properties [Hash] The properties to set for the instance.
+    def initialize(properties = {})
+      properties.each do |key, value|
+        instance_variable_set("@#{key}", value)
+        self.class.class_eval { attr_reader key }
+      end
+    end
+
+    # Checks if the model is valid.
+    #
+    # This method calls the `validate_json` class method on the current class,
+    # passing the `properties` as the argument.
+    #
+    # @return [Boolean] true if the model is valid, false otherwise.
+    def valid?
+      self.class.validate_json(properties)
+    end
+
+    # Returns the properties of the model as a hash with symbolized keys.
+    def properties
+      as_json.symbolize_keys!
+    end
+
+    # Module containing class-level methods for defining and accessing the schema of a model.
     module ClassMethods
+      # Returns the schema for the model.
+      #
+      # @return [Schema] The schema for the model.
       def schema
-        @schema ||= Builder.new(schema_definition).schema
+        @schema ||= build_schema(schema_definition)
       end
 
+      # Returns true if the class inherits a schema.
+      #
+      # @return [Boolean] `true` if the class inherits a schema, `false` otherwise.
       def inherits_schema?
         false
       end
 
+      # Returns the reference template for the model.
+      #
+      # @return [String] The reference template for the model.
       def ref_template
         "#/$defs/#{name}"
       end
 
+      # Returns the name of the model as a human-readable function name.
+      #
+      # @return [String] The human-readable function name of the model.
       def function_name
         name.humanize.titleize
       end
 
+      # Validates the given JSON against the model's JSON schema.
+      #
+      # @param json [Hash] The JSON to validate.
+      # @return [Boolean] `true` if the JSON is valid, `false` otherwise.
       def validate_json(json)
         JSON::Validator.validate(json_schema, json)
       end
 
       # Returns the JSON schema for the model.
+      #
+      # @return [Hash] The JSON schema for the model.
       def json_schema
-        @json_schema ||= begin
-          schema = Builder.new(schema_definition).schema
-          schema.as_json
-        end
+        @json_schema ||= schema.as_json
       end
 
-      # Define the schema using the provided block.
+      # Define the schema for the model using the provided block.
+      #
+      # @yield The block to define the schema.
+      # @raise [ArgumentError] If the class does not have a name.
       def define_schema(&block)
         raise ArgumentError, 'The class must have a name' unless name.present?
 
@@ -121,9 +129,22 @@ module EasyTalk
         @schema_definition.instance_eval(&block)
       end
 
+      # Returns the unvalidated schema definition for the model.
+      #
+      # @return [SchemaDefinition] The unvalidated schema definition for the model.
       def schema_definition
         @schema_definition ||= {}
       end
+
+      private
+
+      # Builds the schema using the provided schema definition.
+      #
+      # @param schema_definition [SchemaDefinition] The schema definition.
+      # @return [Schema] The validated schema.
+      def build_schema(schema_definition)
+        Builders::ObjectBuilder.new(schema_definition).build
+      end
     end
   end
 end

data/lib/easy_talk/property.rb

@@ -57,13 +57,12 @@ module EasyTalk
     end
 
     def build
-      if type.is_a?(T::Types::Simple)
-        @type = type.raw_type
-        return self
-      end
-
       if builder
-        builder.new(name, type, constraints).build
+        if builder.collection_type?
+          builder.new(name, type, constraints).build
+        else
+          builder.new(name, constraints).build
+        end
       else
         type.respond_to?(:schema) ? type.schema : 'object'
       end

data/lib/easy_talk/tools/function_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EasyTalk
   module Tools
     module FunctionBuilder

data/lib/easy_talk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EasyTalk
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/lib/easy_talk.rb

@@ -9,7 +9,6 @@ module EasyTalk
   require 'easy_talk/types/all_of'
   require 'easy_talk/types/one_of'
   require 'easy_talk/model'
-  require 'easy_talk/builder'
   require 'easy_talk/property'
   require 'easy_talk/schema_definition'
   require 'easy_talk/tools/function_builder'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_talk
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Sergio Bayona
@@ -95,11 +95,11 @@ files:
 - Rakefile
 - easy_talk.gemspec
 - lib/easy_talk.rb
-- lib/easy_talk/builder.rb
 - lib/easy_talk/builders/all_of_builder.rb
 - lib/easy_talk/builders/any_of_builder.rb
 - lib/easy_talk/builders/base_builder.rb
 - lib/easy_talk/builders/boolean_builder.rb
+- lib/easy_talk/builders/collection_helpers.rb
 - lib/easy_talk/builders/composition_builder.rb
 - lib/easy_talk/builders/date_builder.rb
 - lib/easy_talk/builders/datetime_builder.rb
@@ -108,7 +108,6 @@ files:
 - lib/easy_talk/builders/number_builder.rb
 - lib/easy_talk/builders/object_builder.rb
 - lib/easy_talk/builders/one_of_builder.rb
-- lib/easy_talk/builders/ref_array_builder.rb
 - lib/easy_talk/builders/string_builder.rb
 - lib/easy_talk/builders/time_builder.rb
 - lib/easy_talk/builders/typed_array_builder.rb

data/lib/easy_talk/builder.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'property'
-require_relative 'builders/object_builder'
-
-module EasyTalk
-  # The Builder class is responsible for building a schema for a class.
-  class Builder
-    extend T::Sig
-
-    sig { params(schema_definition: SchemaDefinition).void }
-    # Initializes a new instance of the Builder class.
-    #
-    # @param schema_definition [SchemaDefinition] The schema definition.
-    def initialize(schema_definition)
-      @schema_definition = schema_definition
-    end
-
-    sig { returns(Hash) }
-    # Retrieves the schema document.
-    #
-    # @return [Hash] The schema document.
-    def schema
-      @schema = schema_document
-    end
-
-    sig { returns(String) }
-    # Returns the JSON representation of the schema document.
-    #
-    # @return [String] The JSON schema.
-    def json_schema
-      @json_schema ||= schema_document.to_json
-    end
-
-    sig { returns(Hash) }
-    # Returns the schema document, building it if necessary.
-    #
-    # @return [Hash] The schema document.
-    def schema_document
-      @schema_document ||= build_schema
-    end
-
-    sig { returns(Hash) }
-    # Builds the schema using the schema definition.
-    #
-    # Returns the built schema.
-    def build_schema
-      Builders::ObjectBuilder.new(@schema_definition).build
-    end
-  end
-end

data/lib/easy_talk/builders/ref_array_builder.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_builder'
-
-module EasyTalk
-  module Builders
-    # Builder class for array properties.
-    class RefArrayBuilder < BaseBuilder
-      # Initializes a new instance of the ArrayBuilder class.
-      sig { params(name: Symbol).void }
-      def initialize(name)
-        super(name, { type: 'array' }, options, {})
-      end
-
-      private
-
-      sig { void }
-      # Updates the option types for the array builder.
-      def update_option_types
-        VALID_OPTIONS[:enum][:type] = T::Array[@inner_type]
-        VALID_OPTIONS[:const][:type] = T::Array[@inner_type]
-      end
-    end
-  end
-end