easy_talk 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da6e2b2c29860236280b654d18e4df4af908ab0246f01e1e5e376805f8359d37
-  data.tar.gz: 1a36d4e08f82069391386c3b2bd03becfeaea198657b8db05ff2ebda793d4ec8
+  metadata.gz: cac3597b203d800e1c15c79ea019a6d81080dd5c5ed669dc96500e262a32a505
+  data.tar.gz: 626bb67445db8ffa2d41df7a0b82ceba30db827ed0cb610f4d1b382d161a5191
 SHA512:
-  metadata.gz: 9026006c5e296adf2f3a7c826757ffe4b17a1387c3621907442ac47293d2d7d89eb4779fe3863ef24f6a8fc34174a7b4e7e22d2aaf0a26a4534ddc65f08ab482
-  data.tar.gz: d3cd70fb2ac65241cf395606d0eae55e2282006578f4f78096f9e03256ae6fa91bd371b0874d20aa797667b4972be4ff91c5b38b4396ee1be89a3b4d057d4681
+  metadata.gz: e58629e7e0b4aff314f04d0a0d14f3129e0af8b54c23c1d061d57464648aa97caaf2db514353fcf34713d1d14113eb13c599ccc28b6106a3c5f06cd4197671af
+  data.tar.gz: f3ba1ec6c87ff2028a5bd26f22ebade4446717c8d9e27702c94f5e4080fd951885dd033a0d4f88078d44849cb7b251fc1dbb303f9da84b2a592bf85c1daaf9ef

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.1.9] - 2024-04-29
+- Added the ability to describe an object schema withing the define_schema block. Example:
+```ruby
+...
+property :email, :object do
+    property :address, :string
+    property :verified, :boolean
+end
+```
+
 ## [0.1.8] - 2024-04-24
 - mostly refactoring without changes to the public API.
 

data/README.md

@@ -12,7 +12,10 @@ class User
     title "User"
     description "A user of the system"
     property :name, String, description: "The user's name", title: "Full Name"
-    property :email, String, description: "The user's email", format: "email", title: "Email Address"
+    property :email, :object do
+      property :address, String, format: "email", description: "The user's email", title: "Email Address"
+      property :verified, T::Boolean, description: "Whether the email is verified"
+    end
     property :group, String, enum: [1, 2, 3], default: 1, description: "The user's group"
     property :age, Integer, minimum: 18, maximum: 100, description: "The user's age"
     property :tags, T::Array[String], min_items: 1, unique_item: true, description: "The user's tags"
@@ -34,10 +37,23 @@ Calling `User.json_schema` will return the JSON Schema for the User class:
             "type": "string"
         },
         "email": {
-            "title": "Email Address",
-            "description": "The user's email",
-            "type": "string",
-            "format": "email"
+            "type": "object",
+            "properties": {
+                "address": {
+                    "title": "Email Address",
+                    "description": "The user's email",
+                    "type": "string",
+                    "format": "email"
+                },
+                "verified": {
+                    "type": "boolean",
+                    "description": "Whether the email is verified"
+                }
+            },
+            "required": [
+                "address",
+                "verified"
+            ]
         },
         "group": {
             "type": "number",

data/easy_talk.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'lib/easy_talk/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'easy_talk'
+  spec.version = EasyTalk::VERSION
+  spec.authors = ['Sergio Bayona']
+  spec.email = ['bayona.sergio@gmail.com']
+
+  spec.summary = 'Generate json-schema from Ruby classes.'
+  spec.description = 'Generate json-schema from plain Ruby classes.'
+  spec.homepage = 'https://github.com/sergiobayona/easy_talk'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/sergiobayona/easy_talk'
+  spec.metadata['changelog_uri'] = 'https://github.com/sergiobayona/easy_talk/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ spec/ .git .github Gemfile])
+    end
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 7.0'
+  spec.add_dependency 'json-schema', '~> 4'
+  spec.add_dependency 'sorbet-runtime', '~> 0.5'
+  spec.add_development_dependency 'pry-byebug', '>= 3.10'
+  spec.add_development_dependency 'rake', '~> 13.1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-json_expectations', '~> 2.0'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.29'
+end

data/lib/easy_talk/builders/object_builder.rb

@@ -11,7 +11,7 @@ module EasyTalk
       attr_reader :schema
 
       VALID_OPTIONS = {
-        properties: { type: T::Hash[Symbol, T.untyped], key: :properties },
+        properties: { type: T::Hash[T.any(Symbol, String), T.untyped], key: :properties },
         additional_properties: { type: T::Boolean, key: :additionalProperties },
         subschemas: { type: T::Array[T.untyped], key: :subschemas },
         required: { type: T::Array[Symbol], key: :required },
@@ -33,42 +33,58 @@ module EasyTalk
 
       private
 
-      def properties_from_schema_definition(properties)
+      def properties_from_schema_definition
+        properties = schema.delete(:properties) || {}
         properties.each_with_object({}) do |(property_name, options), context|
-          @required_properties << property_name unless options[:type].respond_to?(:nilable?) && options[:type].nilable?
-          context[property_name] = Property.new(property_name, options[:type], options[:constraints])
+          add_required_property(property_name, options)
+          context[property_name] = build_property(property_name, options)
         end
       end
 
-      def subschemas_from_schema_definition(subschemas)
+      def add_required_property(property_name, options)
+        return unless options.is_a?(Hash) && !(options[:type].respond_to?(:nilable?) && options[:type].nilable?)
+
+        @required_properties << property_name
+      end
+
+      def build_property(property_name, options)
+        if options.is_a?(EasyTalk::SchemaDefinition)
+          ObjectBuilder.new(options).build
+        else
+          Property.new(property_name, options[:type], options[:constraints])
+        end
+      end
+
+      def subschemas_from_schema_definition
+        subschemas = schema.delete(:subschemas) || []
         subschemas.each do |subschema|
-          definitions = subschema.items.each_with_object({}) do |item, hash|
-            hash[item.name] = item.schema
-          end
-          schema[:defs] = definitions
-          references = subschema.items.map do |item|
-            { '$ref': item.ref_template }
-          end
-          schema[subschema.name] = references
+          add_definitions(subschema)
+          add_references(subschema)
+        end
+      end
+
+      def add_definitions(subschema)
+        definitions = subschema.items.each_with_object({}) do |item, hash|
+          hash[item.name] = item.schema
+        end
+        schema[:defs] = definitions
+      end
+
+      def add_references(subschema)
+        references = subschema.items.map do |item|
+          { '$ref': item.ref_template }
         end
+        schema[subschema.name] = references
       end
 
       def options
-        subschemas_from_schema_definition(subschemas)
         @options = schema
-        @options[:properties] = properties_from_schema_definition(properties)
+        subschemas_from_schema_definition
+        @options[:properties] = properties_from_schema_definition
         @options[:required] = @required_properties
         @options.reject! { |_key, value| [nil, [], {}].include?(value) }
         @options
       end
-
-      def properties
-        schema.delete(:properties) || {}
-      end
-
-      def subschemas
-        schema.delete(:subschemas) || []
-      end
     end
   end
 end

data/lib/easy_talk/schema_definition.rb

@@ -32,10 +32,19 @@ module EasyTalk
       @schema[:subschemas] += subschemas
     end
 
-    sig { params(name: Symbol, type: T.untyped, constraints: T.untyped).void }
-    def property(name, type, **constraints)
+    sig do
+      params(name: T.any(Symbol, String), type: T.untyped, constraints: T.untyped, blk: T.nilable(T.proc.void)).void
+    end
+    def property(name, type, **constraints, &blk)
       @schema[:properties] ||= {}
-      @schema[:properties][name] = { type:, constraints: }
+
+      if block_given?
+        property_schema = SchemaDefinition.new(name)
+        property_schema.instance_eval(&blk)
+        @schema[:properties][name] = property_schema
+      else
+        @schema[:properties][name] = { type:, constraints: }
+      end
     end
   end
 end

data/lib/easy_talk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_talk
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Sergio Bayona
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -177,6 +177,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- easy_talk.gemspec
 - lib/easy_talk.rb
 - lib/easy_talk/builders/all_of_builder.rb
 - lib/easy_talk/builders/any_of_builder.rb