easy_talk 1.0.2 → 1.0.4

data/lib/easy_talk/model.rb

@@ -9,6 +9,7 @@ require 'active_support/json'
 require 'active_model'
 require_relative 'builders/object_builder'
 require_relative 'schema_definition'
+require_relative 'active_record_schema_builder'
 
 module EasyTalk
   # The `Model` module is a mixin that provides functionality for defining and accessing the schema of a model.
@@ -39,6 +40,11 @@ module EasyTalk
       base.extend ActiveModel::Callbacks
       base.extend(ClassMethods)
       base.include(InstanceMethods)
+
+      # Apply ActiveRecord-specific functionality if appropriate
+      return unless defined?(ActiveRecord) && base.ancestors.include?(ActiveRecord::Base)
+
+      base.extend(ActiveRecordClassMethods)
     end
 
     module InstanceMethods
@@ -90,7 +96,16 @@ module EasyTalk
       #
       # @return [Schema] The schema for the model.
       def schema
-        @schema ||= build_schema(schema_definition)
+        @schema ||= if defined?(@schema_definition) && @schema_definition
+                      # Schema defined explicitly via define_schema
+                      build_schema(@schema_definition)
+                    elsif respond_to?(:active_record_schema_definition)
+                      # ActiveRecord model without explicit schema definition
+                      build_schema(active_record_schema_definition)
+                    else
+                      # Default case - empty schema
+                      {}
+                    end
       end
 
       # Returns the reference template for the model.
@@ -140,9 +155,8 @@ module EasyTalk
         @schema_definition&.schema&.fetch(:additional_properties, false)
       end
 
-      private
-
       # Builds the schema using the provided schema definition.
+      # This is the convergence point for all schema generation.
       #
       # @param schema_definition [SchemaDefinition] The schema definition.
       # @return [Schema] The validated schema.
@@ -150,5 +164,34 @@ module EasyTalk
         Builders::ObjectBuilder.new(schema_definition).build
       end
     end
+
+    # Module containing ActiveRecord-specific methods for schema generation
+    module ActiveRecordClassMethods
+      # Gets a SchemaDefinition that's built from the ActiveRecord database schema
+      #
+      # @return [SchemaDefinition] A schema definition built from the database
+      def active_record_schema_definition
+        @active_record_schema_definition ||= ActiveRecordSchemaBuilder.new(self).build_schema_definition
+      end
+
+      # Store enhancements to be applied to the schema
+      #
+      # @return [Hash] The schema enhancements
+      def schema_enhancements
+        @schema_enhancements ||= {}
+      end
+
+      # Enhance the generated schema with additional information
+      #
+      # @param enhancements [Hash] The schema enhancements
+      # @return [void]
+      def enhance_schema(enhancements)
+        @schema_enhancements = enhancements
+        # Clear cached values to force regeneration
+        @active_record_schema_definition = nil
+        @schema = nil
+        @json_schema = nil
+      end
+    end
   end
 end

data/lib/easy_talk/property.rb

@@ -6,12 +6,8 @@ require_relative 'builders/number_builder'
 require_relative 'builders/boolean_builder'
 require_relative 'builders/null_builder'
 require_relative 'builders/string_builder'
-require_relative 'builders/date_builder'
-require_relative 'builders/datetime_builder'
-require_relative 'builders/time_builder'
-require_relative 'builders/any_of_builder'
-require_relative 'builders/all_of_builder'
-require_relative 'builders/one_of_builder'
+require_relative 'builders/temporal_builder'
+require_relative 'builders/composition_builder'
 require_relative 'builders/typed_array_builder'
 require_relative 'builders/union_builder'
 
@@ -40,12 +36,12 @@ module EasyTalk
       'BigDecimal' => Builders::NumberBuilder,
       'T::Boolean' => Builders::BooleanBuilder,
       'NilClass' => Builders::NullBuilder,
-      'Date' => Builders::DateBuilder,
-      'DateTime' => Builders::DatetimeBuilder,
-      'Time' => Builders::TimeBuilder,
-      'anyOf' => Builders::AnyOfBuilder,
-      'allOf' => Builders::AllOfBuilder,
-      'oneOf' => Builders::OneOfBuilder,
+      'Date' => Builders::TemporalBuilder::DateBuilder,
+      'DateTime' => Builders::TemporalBuilder::DatetimeBuilder,
+      'Time' => Builders::TemporalBuilder::TimeBuilder,
+      'anyOf' => Builders::CompositionBuilder::AnyOfBuilder,
+      'allOf' => Builders::CompositionBuilder::AllOfBuilder,
+      'oneOf' => Builders::CompositionBuilder::OneOfBuilder,
       'T::Types::TypedArray' => Builders::TypedArrayBuilder,
       'T::Types::Union' => Builders::UnionBuilder
     }.freeze

data/lib/easy_talk/schema_definition.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 require_relative 'keywords'
+require_relative 'types/composer'
 
 module EasyTalk
-  class InvalidPropertyNameError < StandardError; end
-
   #
   #= EasyTalk \SchemaDefinition
   # SchemaDefinition provides the methods for defining a schema within the define_schema block.
@@ -20,6 +19,7 @@ module EasyTalk
 
     def initialize(name, schema = {})
       @schema = schema
+      @schema[:additional_properties] = false unless schema.key?(:additional_properties)
       @name = name
     end
 
@@ -65,5 +65,21 @@ module EasyTalk
     def optional?
       @schema[:optional]
     end
+
+    # Helper method for nullable and optional properties
+    def nullable_optional_property(name, type, constraints = {}, &blk)
+      # Ensure type is nilable
+      nilable_type = if type.respond_to?(:nilable?) && type.nilable?
+                       type
+                     else
+                       T.nilable(type)
+                     end
+
+      # Ensure constraints include optional: true
+      constraints = constraints.merge(optional: true)
+
+      # Call standard property method
+      property(name, nilable_type, constraints, &blk)
+    end
   end
 end

data/lib/easy_talk/types/composer.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'base_composer'
+
+module EasyTalk
+  module Types
+    # Base class for composition types
+    class Composer < BaseComposer
+      # Returns the name of the composition type.
+      def self.name
+        raise NotImplementedError, "#{self.class.name} must implement the name method"
+      end
+
+      # Returns the name of the composition type.
+      def name
+        self.class.name
+      end
+
+      # Represents a composition type that allows all of the specified types.
+      class AllOf < Composer
+        def self.name
+          :allOf
+        end
+
+        def name
+          :allOf
+        end
+      end
+
+      # Represents a composition type that allows any of the specified types.
+      class AnyOf < Composer
+        def self.name
+          :anyOf
+        end
+
+        def name
+          :anyOf
+        end
+      end
+
+      # Represents a composition type that allows one of the specified types.
+      class OneOf < Composer
+        def self.name
+          :oneOf
+        end
+
+        def name
+          :oneOf
+        end
+      end
+    end
+  end
+end
+
+# Shorthand module for accessing the AllOf composer
+module T
+  module AllOf
+    # Creates a new instance of `EasyTalk::Types::Composer::AllOf` with the given arguments.
+    #
+    # @param args [Array] the list of arguments to be passed to the constructor
+    # @return [EasyTalk::Types::Composer::AllOf] a new instance
+    def self.[](*args)
+      EasyTalk::Types::Composer::AllOf.new(*args)
+    end
+  end
+
+  # Shorthand module for accessing the AnyOf composer
+  module AnyOf
+    # Creates a new instance of `EasyTalk::Types::Composer::AnyOf` with the given arguments.
+    #
+    # @param args [Array] the list of arguments to be passed to the constructor
+    # @return [EasyTalk::Types::Composer::AnyOf] a new instance
+    def self.[](*args)
+      EasyTalk::Types::Composer::AnyOf.new(*args)
+    end
+  end
+
+  # Shorthand module for accessing the OneOf composer
+  module OneOf
+    # Creates a new instance of `EasyTalk::Types::Composer::OneOf` with the given arguments.
+    #
+    # @param args [Array] the list of arguments to be passed to the constructor
+    # @return [EasyTalk::Types::Composer::OneOf] a new instance
+    def self.[](*args)
+      EasyTalk::Types::Composer::OneOf.new(*args)
+    end
+  end
+end

data/lib/easy_talk/version.rb

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

data/lib/easy_talk.rb

@@ -2,18 +2,28 @@
 
 # The EasyTalk module is the main namespace for the gem.
 module EasyTalk
-  class Error < StandardError; end
   require 'sorbet-runtime'
   require 'easy_talk/sorbet_extension'
-  require 'easy_talk/types/any_of'
-  require 'easy_talk/types/all_of'
-  require 'easy_talk/types/one_of'
+  require 'easy_talk/errors'
+  require 'easy_talk/errors_helper'
+  require 'easy_talk/configuration'
+  require 'easy_talk/types/composer'
   require 'easy_talk/model'
   require 'easy_talk/property'
   require 'easy_talk/schema_definition'
   require 'easy_talk/tools/function_builder'
   require 'easy_talk/version'
 
-  class UnsupportedTypeError < ArgumentError; end
-  class UnsupportedConstraintError < ArgumentError; end
+  def self.assert_valid_property_options(property_name, options, *valid_keys)
+    valid_keys.flatten!
+    options.each_key do |k|
+      next if valid_keys.include?(k)
+
+      ErrorHelper.raise_unknown_option_error(property_name: property_name, option: options, valid_options: valid_keys)
+    end
+  end
+
+  def self.configure_nilable_behavior(nilable_is_optional = false)
+    configuration.nilable_is_optional = nilable_is_optional
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: easy_talk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Sergio Bayona
 bindir: bin
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -51,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +177,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.29'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
 description: Generate json-schema from plain Ruby classes.
 email:
 - bayona.sergio@gmail.com
@@ -184,33 +212,30 @@ files:
 - docs/about.markdown
 - docs/index.markdown
 - lib/easy_talk.rb
-- lib/easy_talk/builders/all_of_builder.rb
-- lib/easy_talk/builders/any_of_builder.rb
+- lib/easy_talk/active_record_schema_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
 - lib/easy_talk/builders/integer_builder.rb
 - lib/easy_talk/builders/null_builder.rb
 - 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/string_builder.rb
-- lib/easy_talk/builders/time_builder.rb
+- lib/easy_talk/builders/temporal_builder.rb
 - lib/easy_talk/builders/typed_array_builder.rb
 - lib/easy_talk/builders/union_builder.rb
+- lib/easy_talk/configuration.rb
+- lib/easy_talk/errors.rb
+- lib/easy_talk/errors_helper.rb
 - lib/easy_talk/keywords.rb
 - lib/easy_talk/model.rb
 - lib/easy_talk/property.rb
 - lib/easy_talk/schema_definition.rb
 - lib/easy_talk/sorbet_extension.rb
 - lib/easy_talk/tools/function_builder.rb
-- lib/easy_talk/types/all_of.rb
-- lib/easy_talk/types/any_of.rb
 - lib/easy_talk/types/base_composer.rb
-- lib/easy_talk/types/one_of.rb
+- lib/easy_talk/types/composer.rb
 - lib/easy_talk/version.rb
 homepage: https://github.com/sergiobayona/easy_talk
 licenses:

data/lib/easy_talk/builders/all_of_builder.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'composition_builder'
-
-module EasyTalk
-  module Builders
-    # Builder class for integer properties.
-    class AllOfBuilder < CompositionBuilder
-    end
-  end
-end

data/lib/easy_talk/builders/any_of_builder.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'composition_builder'
-
-module EasyTalk
-  module Builders
-    # Builder class for integer properties.
-    class AnyOfBuilder < CompositionBuilder
-    end
-  end
-end

data/lib/easy_talk/builders/date_builder.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_builder'
-
-module EasyTalk
-  module Builders
-    # Builder class for date properties.
-    class DateBuilder < StringBuilder
-      # Modifies the schema to include the format constraint for a date property.
-      sig { returns(T::Hash[Symbol, T.untyped]) }
-      def schema
-        super.tap do |schema|
-          schema[:format] = 'date'
-        end
-      end
-    end
-  end
-end

data/lib/easy_talk/builders/datetime_builder.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_builder'
-
-module EasyTalk
-  module Builders
-    # Builder class for datetime properties.
-    class DatetimeBuilder < StringBuilder
-      # Modifies the schema to include the format constraint for a datetime property.
-      sig { returns(T::Hash[Symbol, T.untyped]) }
-      def schema
-        super.tap do |schema|
-          schema[:format] = 'date-time'
-        end
-      end
-    end
-  end
-end

data/lib/easy_talk/builders/one_of_builder.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'composition_builder'
-
-module EasyTalk
-  module Builders
-    # Builder class for integer properties.
-    class OneOfBuilder < CompositionBuilder
-    end
-  end
-end

data/lib/easy_talk/builders/time_builder.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_builder'
-
-module EasyTalk
-  module Builders
-    # Builder class for time properties.
-    class TimeBuilder < StringBuilder
-      def schema
-        super.tap do |schema|
-          schema[:format] = 'time'
-        end
-      end
-    end
-  end
-end

data/lib/easy_talk/types/all_of.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_composer'
-# The EasyTalk module provides a collection of types for composing schemas.
-module EasyTalk
-  # The `Types` module provides a collection of classes for composing different types.
-  module Types
-    # Represents a composition type that allows all of the specified types.
-    class AllOf < BaseComposer
-      def self.name
-        :allOf
-      end
-
-      def name
-        :allOf
-      end
-    end
-  end
-end
-
-module T
-  # no-doc
-  module AllOf
-    # Creates a new instance of `EasyTalk::Types::AllOf` with the given arguments.
-    #
-    # @param args [Array] the list of arguments to be passed to the `EasyTalk::Types::AllOf` constructor
-    # @return [EasyTalk::Types::AllOf] a new instance of `EasyTalk::Types::AllOf`
-    def self.[](*args)
-      EasyTalk::Types::AllOf.new(*args)
-    end
-  end
-end

data/lib/easy_talk/types/any_of.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_composer'
-module EasyTalk
-  module Types
-    # The `Types` module provides a collection of composers for defining different types.
-    #
-    # This module contains composers for various types such as `AnyOf`, `AllOf`, etc.
-    # Each composer is responsible for defining the behavior and properties of its respective type.
-    class AnyOf < BaseComposer
-      # Returns the name of the AnyOf composer.
-      #
-      # @return [Symbol] The name of the composer.
-      def self.name
-        :anyOf
-      end
-
-      # Returns the name of the AnyOf composer.
-      #
-      # @return [Symbol] The name of the composer.
-      def name
-        :anyOf
-      end
-    end
-  end
-end
-
-module T
-  # no-doc
-  module AnyOf
-    # Creates a new instance of `EasyTalk::Types::AnyOf` with the given arguments.
-    #
-    # @param args [Array] the list of arguments to be passed to the `EasyTalk::Types::AnyOf` constructor
-    # @return [EasyTalk::Types::AnyOf] a new instance of `EasyTalk::Types::AnyOf`
-    def self.[](*args)
-      EasyTalk::Types::AnyOf.new(*args)
-    end
-  end
-end

data/lib/easy_talk/types/one_of.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_composer'
-module EasyTalk
-  module Types
-    # Represents a composition type that allows one of the specified types.
-    class OneOf < BaseComposer
-      # Returns the name of the composition type.
-      def self.name
-        :oneOf
-      end
-
-      # Returns the name of the composition type.
-      def name
-        :oneOf
-      end
-    end
-  end
-end
-
-module T
-  # Creates a new instance of `EasyTalk::Types::OneOf` with the given arguments.
-  #
-  # @param args [Array] the list of arguments to be passed to the `EasyTalk::Types::OneOf` constructor
-  # @return [EasyTalk::Types::OneOf] a new instance of `EasyTalk::Types::OneOf`
-  module OneOf
-    def self.[](*args)
-      EasyTalk::Types::OneOf.new(*args)
-    end
-  end
-end