easy_talk 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cac3597b203d800e1c15c79ea019a6d81080dd5c5ed669dc96500e262a32a505
-  data.tar.gz: 626bb67445db8ffa2d41df7a0b82ceba30db827ed0cb610f4d1b382d161a5191
+  metadata.gz: 1ebe87803e47220d1a3f6396a1735fd2aa04b3f2b1428bea43cd873cb32f3bca
+  data.tar.gz: ecdaaa2801742335160a89a38a92ef9b402be563d3ce0e54c52f3068d75c93ce
 SHA512:
-  metadata.gz: e58629e7e0b4aff314f04d0a0d14f3129e0af8b54c23c1d061d57464648aa97caaf2db514353fcf34713d1d14113eb13c599ccc28b6106a3c5f06cd4197671af
-  data.tar.gz: f3ba1ec6c87ff2028a5bd26f22ebade4446717c8d9e27702c94f5e4080fd951885dd033a0d4f88078d44849cb7b251fc1dbb303f9da84b2a592bf85c1daaf9ef
+  metadata.gz: 866e44d124957d2149bd67584c0e35129bd922c98da0bb9d4b37cead66636d84b508290be35b4ce79ad3940bd556585ee604aeb79c220f898450624765e3fd50
+  data.tar.gz: 551cd5c6f3de517efd56fadb407fd723de14764d3520b7be7ee73e12a7027d391816452ad13a00752e0fa690d5da2eef4aff2d0b12b585ed686eeb31635875ac

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.1.10] - 2024-04-29
+- Accept `:optional` key as constraint which excludes property from required node.
+- Spec fixes
 ## [0.1.9] - 2024-04-29
 - Added the ability to describe an object schema withing the define_schema block. Example:
 ```ruby

data/lib/easy_talk/builders/base_builder.rb

@@ -11,7 +11,8 @@ module EasyTalk
       # representing schema properties.
       COMMON_OPTIONS = {
         title: { type: T.nilable(String), key: :title },
-        description: { type: T.nilable(String), key: :description }
+        description: { type: T.nilable(String), key: :description },
+        optional: { type: T.nilable(T::Boolean), key: :optional }
       }.freeze
 
       attr_reader :name, :schema, :options

data/lib/easy_talk/builders/object_builder.rb

@@ -14,7 +14,7 @@ module EasyTalk
         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 },
+        required: { type: T::Array[T.any(Symbol, String)], key: :required },
         defs: { type: T.untyped, key: :$defs },
         allOf: { type: T.untyped, key: :allOf },
         anyOf: { type: T.untyped, key: :anyOf },
@@ -42,7 +42,9 @@ module EasyTalk
       end
 
       def add_required_property(property_name, options)
-        return unless options.is_a?(Hash) && !(options[:type].respond_to?(:nilable?) && options[:type].nilable?)
+        return if options.is_a?(Hash) && !!(options[:type].respond_to?(:nilable?) && options[:type].nilable?)
+
+        return if options.respond_to?(:optional?) && options.optional?
 
         @required_properties << property_name
       end

data/lib/easy_talk/builders/string_builder.rb

@@ -15,7 +15,8 @@ module EasyTalk
         max_length: { type: Integer, key: :maxLength },
         enum: { type: T::Array[String], key: :enum },
         const: { type: String, key: :const },
-        default: { type: String, key: :default }
+        default: { type: String, key: :default },
+        optional: { type: T::Boolean, key: :optional }
       }.freeze
 
       sig { params(name: Symbol, constraints: Hash).void }

data/lib/easy_talk/schema_definition.rb

@@ -16,8 +16,8 @@ module EasyTalk
 
     attr_reader :name, :schema
 
-    def initialize(name)
-      @schema = {}
+    def initialize(name, schema = {})
+      @schema = schema
       @name = name
     end
 
@@ -39,12 +39,16 @@ module EasyTalk
       @schema[:properties] ||= {}
 
       if block_given?
-        property_schema = SchemaDefinition.new(name)
+        property_schema = SchemaDefinition.new(name, constraints)
         property_schema.instance_eval(&blk)
         @schema[:properties][name] = property_schema
       else
         @schema[:properties][name] = { type:, constraints: }
       end
     end
+
+    def optional?
+      @schema[:optional]
+    end
   end
 end

data/lib/easy_talk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_talk
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Sergio Bayona
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -177,7 +177,6 @@ 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

data/easy_talk.gemspec

@@ -1,45 +0,0 @@
-# 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