jsi 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f38a4e48bd546b340af428489a4cb5361ddf0d4b322c598cd56a7d6e69e1949
-  data.tar.gz: 4028ff03d8f935fc5b9f328e1adf9f094dab5621183c0d3b2b6152105b672f5d
+  metadata.gz: d2733de7b7f61d30765ac1bedb3229618d12ea45b693aef931a63691279d37e2
+  data.tar.gz: 2bd9989382540a0e4f28dba7e2a0d6f32061857ea7704d5fbea74f446de1bd54
 SHA512:
-  metadata.gz: a7bc8a8ac76c4deaf859681f763e031f570cb04a557549e7b77b42055bea61132792347c2037ceed11c824f7968bda55db0ff69a317c425cf9576335ebc17af3
-  data.tar.gz: 04d7f8d2132c20051f9780b92990d1b0b65b6a5f1fda19572b01effbdfbff22b93c8ffa1267bbaca367279fa8547feaa326d9f861763509a799aff0ecf8dc534
+  metadata.gz: a57a46d4920cfe7e7af9d2d4e3f2e9720578f44ea52951da68d6352633add8689b602bd13ec210d38234b86c19e3ba49554b8b3b9f71531a9e43a3d0ad5690ab
+  data.tar.gz: 7a3da59ac6a5598cd867082f3ce31e4e3058f525f33e0e02addb743608b79fb5e2bc4d323e2b57e80b4c6aa57297215013b13ec8a26513aeca1a3d930bdfa07f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.2.1
+
+- bugfix JSI::Schema#described_object_property_names looks only at allOf, not oneOf/anyOf
+- rm unused Schema#default_value, #default_value?
+- misc
+
 # v0.2.0
 
 - JSI::PathedNode unifies interfaces of JSI::Base, JSI::JSON::Node

data/README.md

@@ -1,4 +1,4 @@
-# JSI: JSON-Schema Instantiation
+# JSI: JSON Schema Instantiation
 
 [![Build Status](https://travis-ci.org/notEthan/jsi.svg?branch=master)](https://travis-ci.org/notEthan/jsi)
 [![Coverage Status](https://coveralls.io/repos/github/notEthan/jsi/badge.svg)](https://coveralls.io/github/notEthan/jsi)
@@ -27,19 +27,28 @@ properties:
         number: {type: "string"}
 ```
 
-And here's the class for that schema from JSI:
+And here's how you'd normally instantiate the class for that schema using JSI:
 
 ```ruby
-Contact = JSI.class_for_schema(YAML.load_file('contact.schema.yml'))
-# you can copy/paste this line instead, to follow along in irb:
+# this would usually use a YAML.load/JSON.parse/whatever; it's inlined for copypastability.
 Contact = JSI.class_for_schema({"description" => "A Contact", "type" => "object", "properties" => {"name" => {"type" => "string"}, "phone" => {"type" => "array", "items" => {"type" => "object", "properties" => {"location" => {"type" => "string"}, "number" => {"type" => "string"}}}}}})
 ```
 
-This definition gives you not just the Contact class, but classes for the whole nested structure. So, if we construct an instance like:
+This definition gives you not just the Contact class, but classes for the whole nested structure. To instantiate it, we need some JSON data (expressed here as YAML)
 
-```ruby
-bill = Contact.new('name' => 'bill', 'phone' => [{'location' => 'home', 'number' => '555'}], 'nickname' => 'big b')
+```yaml
+name: bill
+phone:
+- location: home
+  number: "555"
+nickname: big b
+```
 
+So, if we construct an instance like:
+
+```ruby
+# this would usually use a YAML.load/JSON.parse/whatever; it's inlined for copypastability.
+bill = Contact.new({"name" => "bill", "phone" => [{"location" => "home", "number" => "555"}], "nickname" => "big b"})
 # => #{<Contact Hash>
 #   "name" => "bill",
 #   "phone" => #[<JSI::SchemaClasses["23d8#/properties/phone"] Array>

data/jsi.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Ethan"]
   spec.email   = ["ethan@unth.net"]
 
-  spec.summary     = "JSI: JSON-Schema instantiation"
-  spec.description = "JSI represents json-schemas as ruby classes and json-schema instances as instances of those classes"
+  spec.summary     = "JSI: JSON Schema Instantiation"
+  spec.description = "JSI offers an Object-Oriented representation for JSON data using JSON Schemas"
   spec.homepage    = "https://github.com/notEthan/jsi"
   spec.license     = "MIT"
   ignore_files = %w(.gitignore .travis.yml Gemfile test)
@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-around"
   spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "scorpio"
 end

data/lib/jsi/base.rb

@@ -318,9 +318,9 @@ module JSI
       end
     end
 
-    # @return [String] the instance's object_group_text
+    # @return [Array<String>]
     def object_group_text
-      instance.respond_to?(:object_group_text) ? instance.object_group_text : instance.class.inspect
+      instance.respond_to?(:object_group_text) ? instance.object_group_text : [instance.class.inspect]
     end
 
     # @return [Object] a jsonifiable representation of the instance

data/lib/jsi/json/node.rb

@@ -182,19 +182,22 @@ module JSI
       end
 
       # meta-information about the object, outside the content. used by #inspect / #pretty_print
+      # @return [Array<String>]
       def object_group_text
-        "fragment=#{fragment.inspect}" + (content.respond_to?(:object_group_text) ? ' ' + content.object_group_text : '')
+        [
+          "fragment=#{node_ptr.fragment.inspect}",
+        ] + (node_content.respond_to?(:object_group_text) ? node_content.object_group_text : [])
       end
 
       # a string representing this node
       def inspect
-        "\#<#{self.class.inspect} #{object_group_text} #{content.inspect}>"
+        "\#<#{self.class.inspect}#{JSI.object_group_str(object_group_text)} #{node_content.inspect}>"
       end
 
       # pretty-prints a representation this node to the given printer
       def pretty_print(q)
         q.instance_exec(self) do |obj|
-          text "\#<#{obj.class.inspect} #{obj.object_group_text}"
+          text "\#<#{obj.class.inspect}#{JSI.object_group_str(obj.object_group_text)}"
           group_sub {
             nest(2) {
               breakable ' '

data/lib/jsi/schema.rb

@@ -192,9 +192,8 @@ module JSI
     # @return [Set] any object property names this schema indicates may be
     #   present on its instances. this includes, if present: keys of this
     #   schema's "properties" object; entries of this schema's array of
-    #   "required" property keys. if this schema has oneOf/allOf/anyOf
-    #   subschemas, those schemas are checked (recursively) for their
-    #   described object property names.
+    #   "required" property keys. if this schema has allOf subschemas, those
+    #   schemas are checked (recursively) for their described object property names.
     def described_object_property_names
       memoize(:described_object_property_names) do
         Set.new.tap do |property_names|
@@ -204,33 +203,16 @@ module JSI
           if schema_node['required'].respond_to?(:to_ary)
             property_names.merge(schema_node['required'].to_ary)
           end
-          # we _could_ look at the properties of 'default' and each 'enum' but ... nah.
           # we should look at dependencies (TODO).
-          %w(oneOf allOf anyOf).select { |k| schema_node[k].respond_to?(:to_ary) }.each do |schemas_key|
-            schema_node[schemas_key].map(&:deref).map do |someof_node|
-              property_names.merge(self.class.new(someof_node).described_object_property_names)
+          if schema_node['allOf'].respond_to?(:to_ary)
+            schema_node['allOf'].map(&:deref).map do |allOf_node|
+              property_names.merge(self.class.new(allOf_node).described_object_property_names)
             end
           end
         end
       end
     end
 
-    def default_value
-      if schema_node.key?('default')
-        if schema_node['default'].respond_to?(:to_ary) || schema_node['default'].respond_to?(:to_hash)
-          schema_class.new(schema_node['default'])
-        else
-          schema_node['default']
-        end
-      else
-        nil
-      end
-    end
-
-    def default_value?
-      schema_node.key?('default')
-    end
-
     # @return [Array<String>] array of schema validation error messages for
     #   the given instance against this schema
     def fully_validate_instance(other_instance)

data/lib/jsi/typelike_modules.rb

@@ -136,8 +136,8 @@ module JSI
     # @return [String] basically the same #inspect as Hash, but has the
     #   class name and, if responsive, self's #object_group_text
     def inspect
-      object_group_text = respond_to?(:object_group_text) ? ' ' + self.object_group_text : ''
-      "\#{<#{self.class}#{object_group_text}>#{empty? ? '' : ' '}#{self.map { |k, v| "#{k.inspect} => #{v.inspect}" }.join(', ')}}"
+      object_group_str = JSI.object_group_str(respond_to?(:object_group_text) ? self.object_group_text : [])
+      "\#{<#{self.class}#{object_group_str}>#{empty? ? '' : ' '}#{self.map { |k, v| "#{k.inspect} => #{v.inspect}" }.join(', ')}}"
     end
 
     # @return [String] see #inspect
@@ -149,8 +149,8 @@ module JSI
     # @return [void]
     def pretty_print(q)
       q.instance_exec(self) do |obj|
-        object_group_text = obj.respond_to?(:object_group_text) ? ' ' + obj.object_group_text : ''
-        text "\#{<#{obj.class}#{object_group_text}>"
+        object_group_str = JSI.object_group_str(obj.respond_to?(:object_group_text) ? obj.object_group_text : [])
+        text "\#{<#{obj.class}#{object_group_str}>"
         group_sub {
           nest(2) {
             breakable(obj.any? { true } ? ' ' : '')
@@ -217,8 +217,8 @@ module JSI
     # @return [String] basically the same #inspect as Array, but has the
     #   class name and, if responsive, self's #object_group_text
     def inspect
-      object_group_text = respond_to?(:object_group_text) ? ' ' + self.object_group_text : ''
-      "\#[<#{self.class}#{object_group_text}>#{empty? ? '' : ' '}#{self.map { |e| e.inspect }.join(', ')}]"
+      object_group_str = JSI.object_group_str(respond_to?(:object_group_text) ? object_group_text : [])
+      "\#[<#{self.class}#{object_group_str}>#{empty? ? '' : ' '}#{self.map { |e| e.inspect }.join(', ')}]"
     end
 
     # @return [String] see #inspect
@@ -230,8 +230,8 @@ module JSI
     # @return [void]
     def pretty_print(q)
       q.instance_exec(self) do |obj|
-        object_group_text = obj.respond_to?(:object_group_text) ? ' ' + obj.object_group_text : ''
-        text "\#[<#{obj.class}#{object_group_text}>"
+        object_group_str = JSI.object_group_str(obj.respond_to?(:object_group_text) ? obj.object_group_text : [])
+        text "\#[<#{obj.class}#{object_group_str}>"
         group_sub {
           nest(2) {
             breakable(obj.any? { true } ? ' ' : '')

data/lib/jsi/util.rb

@@ -68,6 +68,12 @@ module JSI
       end
     end
 
+    # @param object_group_text [Array<String>]
+    # @return [String]
+    def object_group_str(object_group_text)
+      object_group_text.compact.map { |t| " #{t}" }.join('')
+    end
+
     # this is the Y-combinator, which allows anonymous recursive functions. for a simple example,
     # to define a recursive function to return the length of an array:
     #

data/lib/jsi/version.rb

@@ -1,3 +1,3 @@
 module JSI
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

data/test/test_helper.rb

@@ -4,6 +4,8 @@ if Coveralls.will_run?
 end
 require 'simplecov'
 
+require 'bundler/setup'
+
 require 'byebug'
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2019-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -80,8 +80,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: JSI represents json-schemas as ruby classes and json-schema instances
-  as instances of those classes
+- !ruby/object:Gem::Dependency
+  name: scorpio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: JSI offers an Object-Oriented representation for JSON data using JSON
+  Schemas
 email:
 - ethan@unth.net
 executables: []
@@ -147,7 +161,7 @@ rubyforge_project:
 rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
-summary: 'JSI: JSON-Schema instantiation'
+summary: 'JSI: JSON Schema Instantiation'
 test_files:
 - test/base_array_test.rb
 - test/base_hash_test.rb