jsi 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0659cc34b129717ffb69089f1d3a25ba3c3ec5364d49a6c0cc93dd5979ac7638'
-  data.tar.gz: 5b0298a9843a61e6f5693d46dd6d86021d53767638e1f3f84e23fff4b167276e
+  metadata.gz: daf35895a6186a3d3123b037f917912ff65ea03c876da9dd5cb40e2a9b079641
+  data.tar.gz: b14524e9eb8796385fdd2ec96bcbb5129c2e80ad9eabb39d60637b9c6078d1c8
 SHA512:
-  metadata.gz: 8b68dcbb479756b8fa58a43f7a8e83accda02a8b0aa87617dabb6623a4b1a8aa05f94cb03de601cf7bf88c943ce62e42963b533ef125729847159e3b775f32c2
-  data.tar.gz: 49997a70900b9d250e4888bcf3e5470e68b116c3a558651db9e5551f73027ea4abd18b0585d23f5201b15e8d80f1d72b46488d1870ac530d40368c7577d3b048
+  metadata.gz: 005c27210c96f9b613f7f6959e86e17b41380c5366fe14f69cd047498fb5bfc8256b8404aa6c5f2ced04882b94edd1c9b62ff79c48001b7388b4b4faadf6c5b1
+  data.tar.gz: 9eccdec2038200c340df2365a3b179da83fd900deb8b4f8f21aa5e4430f785d80afa929e8d718e80850d463fd5d2cd0e0982f7b99352b9e4109cf7c781e07c74

data/.yardopts

@@ -1 +1,6 @@
---main README.md --markup=markdown --no-private {lib}/**/*.rb
+--main README.md
+--markup=markdown
+--markup-provider=commonmarker
+--no-private
+--hide-void-return
+{lib}/**/*.rb

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# v0.8.1
+
+- JSIs are immutable by default
+
+# v0.8.0
+
+- Immutable JSIs with new_jsi param `mutable`
+  - JSIs are still mutable by default, but in the next release they will default to immutable
+- Base#jsi_indicated_schemas
+- Base::StringNode
+- rename metaschema modules /JSONSchemaOrgDraft0X/JSONSchemaDraft0X/
+- terminology: /Metaschema/Meta-Schema/ and /metaschema/meta-schema/ (where hyphen is allowed)
+- Base::HashNode#jsi_each_propertyName
+- new_schema and/or new_jsi params register, schema_registry, stringify_symbol_keys, to_immutable
+- new_schema block param will module_exec on schema module
+- Base#[] param use_default default false, overridable
+- SchemaModule::Connects, SchemaModule::Connection
+- rm Schema#jsi_schema_instance_modules
+
 # v0.7.0
 
 - JSI::Base instances include Array/Hash-like modules on subclasses rather than extending each instance; are only Enumerable when appropriate instead of always

data/README.md

@@ -5,7 +5,7 @@
 
 JSI offers an Object-Oriented representation for JSON data using JSON Schemas. Given your JSON Schemas, JSI constructs Ruby modules and classes which are used to instantiate your JSON data. These modules let you use JSON with all the niceties of OOP such as property accessors and application-defined instance methods.
 
-To learn more about JSON Schema see [https://json-schema.org/](https://json-schema.org/).
+To learn more about JSON Schema see <https://json-schema.org/>.
 
 JSI marries object-oriented programming with JSON Schemas by associating a module with each schema, and extending every instance described by a schema with that module. When an application adds methods to a schema module, those methods can be used on its instances.
 
@@ -15,7 +15,9 @@ Note: The canonical location of this README is on [RubyDoc](http://rubydoc.info/
 
 ## Example
 
-Words are boring, let's code. Here's a schema in yaml:
+Words are boring, let's code. You can follow along from the code blocks - install the gem (`gem install jsi`), load an irb (`irb -r jsi`), and copy/paste/hack.
+
+Here's a schema in yaml:
 
 ```yaml
 $schema: "http://json-schema.org/draft-07/schema"
@@ -61,8 +63,12 @@ nickname: big b
 So, if we construct an instance like:
 
 ```ruby
-# this would usually load YAML or JSON; the schema instance is inlined for copypastability.
-bill = Contact.new_jsi({"name" => "bill", "phone" => [{"location" => "home", "number" => "555"}], "nickname" => "big b"})
+bill = Contact.new_jsi(
+  # this would typically load JSON or YAML; the schema instance is inlined for copypastability.
+  {"name" => "bill", "phone" => [{"location" => "home", "number" => "555"}], "nickname" => "big b"},
+  # note: bill is mutable to demonstrate setters below; the default is immutable.
+  mutable: true
+)
 # => #{<JSI (Contact)>
 #   "name" => "bill",
 #   "phone" => #[<JSI (Contact.properties["phone"])>
@@ -91,7 +97,7 @@ bill.phone.map(&:location)
 # => ["home"]
 ```
 
-We also get validations, as you'd expect given that's largely what json-schema exists to do:
+We also get validations, as you'd expect given that's largely what JSON Schema exists to do:
 
 ```ruby
 bill.jsi_valid?
@@ -115,7 +121,7 @@ bad.phone.jsi_validate
 #   #<Set: {#<JSI::Validation::Error
 #      message: "instance type does not match `type` value",
 #      keyword: "type",
-#      schema: #{<JSI (JSI::JSONSchemaOrgDraft07) Schema> "type" => "string"},
+#      schema: #{<JSI (JSI::JSONSchemaDraft07) Schema> "type" => "string"},
 #      instance_ptr: JSI::Ptr["phone", 0, "number"],
 #      instance_document: {"phone"=>[{"number"=>[5, 5, 5]}]}
 #   >,
@@ -140,7 +146,7 @@ There's plenty more JSI has to offer, but this should give you a pretty good ide
 ## Terminology and Concepts
 
 - `JSI::Base` is the base class for each JSI schema class representing instances of JSON Schemas.
-- a "JSI Schema" is a JSON Schema, instantiated as (usually) a JSI::Base described by a metaschema (see the sections on Metaschemas below). a JSI Schema is an instance of the module `JSI::Schema`.
+- a "JSI Schema" is a JSON Schema, instantiated as (usually) a JSI::Base described by a meta-schema (see the section on meta-schemas below). A JSI Schema is an instance of the module `JSI::Schema`.
 - a "JSI Schema Module" is a module which represents one schema, dynamically created by that Schema. Instances of that schema are extended with its JSI schema module. applications may reopen these modules to add functionality to JSI instances described by a given schema.
 - a "JSI schema class" is a subclass of `JSI::Base` representing one or more JSON schemas. Instances of such a class are described by all of the represented schemas. A JSI schema class includes the JSI schema module of each represented schema.
 - "instance" is a term that is significantly overloaded in this space, so documentation will attempt to be clear what kind of instance is meant:
@@ -154,9 +160,9 @@ JSI supports these JSON Schema specification versions:
 
 | Version | `$schema` URI                             | JSI Schema Module |
 | ---     | ---                                       | ---               |
-| Draft 4 | `http://json-schema.org/draft-04/schema#` | {JSI::JSONSchemaOrgDraft04} |
-| Draft 6 | `http://json-schema.org/draft-06/schema#` | {JSI::JSONSchemaOrgDraft06} |
-| Draft 7 | `http://json-schema.org/draft-07/schema#` | {JSI::JSONSchemaOrgDraft07} |
+| Draft 4 | `http://json-schema.org/draft-04/schema#` | {JSI::JSONSchemaDraft04} |
+| Draft 6 | `http://json-schema.org/draft-06/schema#` | {JSI::JSONSchemaDraft06} |
+| Draft 7 | `http://json-schema.org/draft-07/schema#` | {JSI::JSONSchemaDraft07} |
 
 ## JSI and Object Oriented Programming
 
@@ -190,7 +196,7 @@ bill['name']
 
 For `#name` and `#name=`, we're overriding existing accessor methods. note the use of `super` - this invokes the accessor methods defined by JSI which these override. You could alternatively use `self['name']` and `self['name']=` in these methods, with the same effect as `super`.
 
-Working with subschemas is just about as easy as with root schemas.
+Working with subschemas to add methods is just about as easy as with root schemas.
 
 You can subscript or use property accessors on a JSI schema module to refer to the schema modules of its subschemas, e.g.:
 
@@ -211,8 +217,7 @@ bill.phone.first.number_with_dashes
 # => "5-5-5"
 ```
 
-A recommended convention for naming subschemas is to define them in the namespace of the module of their
-parent schema. The module can then be opened to add methods to the subschema's module.
+A recommended convention for naming subschemas is to define them in the namespace of the module of their parent schema. The module can then be opened to add methods to the subschema's module.
 
 ```ruby
 module Contact
@@ -240,11 +245,15 @@ end
 
 The classes used to instantiate JSIs are dynamically generated subclasses of JSI::Base which include the JSI Schema Module of each schema describing the given instance. These are mostly intended to be ignored: applications aren't expected to instantiate these directly (rather, `#new_jsi` on a Schema or Schema Module is intended), and they are not intended for subclassing or method definition (applications should instead define methods on a schema's {JSI::Schema#jsi_schema_module}).
 
+## Mutability
+
+JSI instances are immutable by default. Mutable JSIs may be instantiated using the `mutable` param of `new_jsi`. Immutable JSIs are much more performant, because mutation may change what schemas apply to nodes in a document, and checking for that is costly. It is not recommended to instantiate large documents as mutable; their JSI instances become unusably slow.
+
 ## Registration
 
-In order for references across documents (generally from a `$ref` schema keyword) to resolve, JSI provides a registry which associates URIs with schemas (or resources containing schemas). This registry is accessible on {JSI.schema_registry} and is a {JSI::SchemaRegistry}.
+In order for references across documents (generally from a `$ref` schema keyword) to resolve, JSI provides a registry (a {JSI::SchemaRegistry}) which associates URIs with schemas (or resources containing schemas). The default registry is accessible on {JSI.schema_registry}.
 
-Schemas instantiated with `.new_schema`, and their subschemas, are automatically registered with `JSI.schema_registry` if they identify an absolute URI.
+Schemas instantiated with `.new_schema`, and their subschemas, are by default registered with `JSI.schema_registry` if they are identified by an absolute URI. This can be controlled by params `register` and `schema_registry`.
 
 Schemas can automatically be lazily loaded by registering a block which instantiates them with {JSI::SchemaRegistry#autoload_uri} (see its documentation).
 
@@ -258,13 +267,13 @@ The following optional features are not completely supported:
 - Regular expressions are interpreted by Ruby's Regexp class, whereas JSON Schema recommends interpreting these as ECMA 262 regular expressions. Certain expressions behave differently, particularly `^` and `$`.
 - Keywords `contentMediaType` and `contentEncoding` do not perform validation.
 
-## Metaschemas
+## Meta-Schemas
 
-A metaschema is a schema which describes schemas. Likewise, a schema is an instance of a metaschema.
+A meta-schema is a schema that describes schemas. Likewise, a schema is an instance of a meta-schema.
 
-In JSI, a schema is generally a JSI::Base instance whose schemas include a metaschema.
+In JSI, a schema is generally a JSI::Base instance whose schemas include a meta-schema.
 
-A self-descriptive metaschema - most commonly one of the JSON schema draft metaschemas - is an object whose schemas include itself. This is instantiated in JSI as a JSI::MetaschemaNode, a special subclass of JSI::Base.
+A self-descriptive meta-schema - most commonly one of the JSON schema draft meta-schemas - is an object whose schemas include itself. This is instantiated in JSI as a JSI::MetaSchemaNode, a special subclass of JSI::Base.
 
 ## ActiveRecord serialization
 
@@ -282,7 +291,7 @@ class User < ActiveRecord::Base
 end
 ```
 
-Now `user.contact_info` will be instantiated as a `Contact` JSI instance, from the JSON type in the database, with Contact's accessors, validations, and user-defined instance methods.
+Now `user.contact_info` will be instantiated as a `Contact` JSI instance, from the JSON type in the database, with Contact's accessors, validations, and application-defined instance methods.
 
 See the gem [`arms`](https://github.com/notEthan/arms) if you wish to serialize the dumped JSON-compatible objects further as text.
 

data/jsi.gemspec

@@ -1,6 +1,4 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "jsi/version"
+require_relative "lib/jsi/version"
 
 Gem::Specification.new do |spec|
   spec.name    = "jsi"
@@ -27,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "addressable", '~> 2.3'
+  spec.add_dependency "bigdecimal"
 end

data/lib/jsi/base/mutability.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module JSI
+  module Base::Mutable
+    include(Util::FingerprintHash)
+
+    def jsi_node_content
+      jsi_ptr.evaluate(jsi_document)
+    end
+
+    def jsi_mutable?
+      true
+    end
+
+    private
+
+    def jsi_mutability_initialize
+    end
+
+    def jsi_memomap_class
+      Util::MemoMap::Mutable
+    end
+  end
+
+  module Base::Immutable
+    include(Util::FingerprintHash::Immutable)
+
+    attr_reader(:jsi_node_content)
+
+    def jsi_mutable?
+      false
+    end
+
+    private
+
+    def jsi_mutability_initialize
+      @jsi_node_content = @jsi_ptr.evaluate(@jsi_document)
+    end
+
+    def jsi_memomap_class
+      Util::MemoMap::Immutable
+    end
+  end
+end

data/lib/jsi/base/node.rb

@@ -1,47 +1,73 @@
 # frozen_string_literal: true
 
 module JSI
-  module Base::Enumerable
-    include ::Enumerable
-
-    # an Array containing each item in this JSI.
+  # module extending a {JSI::Base} object when its instance (its {Base#jsi_node_content})
+  # is a Hash (or responds to `#to_hash`)
+  module Base::HashNode
+    # instantiates and yields each property name (hash key) as a JSI described by any `propertyNames` schemas.
     #
-    # @param kw keyword arguments are passed to {Base#[]} - see its keyword params
-    # @return [Array]
-    def to_a(**kw)
-      # TODO remove eventually (keyword argument compatibility)
-      # discard when all supported ruby versions Enumerable#to_a delegate keywords to #each (3.0.1 breaks; 2.7.x warns)
-      # https://bugs.ruby-lang.org/issues/18289
-      ary = []
-      each(**kw) do |e|
-        ary << e
+    # @yield [JSI::Base]
+    # @return [nil, Enumerator] an Enumerator if invoked without a block; otherwise nil
+    def jsi_each_propertyName
+      return to_enum(__method__) { jsi_node_content_hash_pubsend(:size) } unless block_given?
+
+      property_schemas = SchemaSet.build do |schemas|
+        jsi_schemas.each do |s|
+          if s.keyword?('propertyNames') && s['propertyNames'].is_a?(Schema)
+            schemas << s['propertyNames']
+          end
+        end
+      end
+      jsi_node_content_hash_pubsend(:each_key) do |key|
+        yield property_schemas.new_jsi(key)
       end
-      ary
+
+      nil
     end
 
-    alias_method :entries, :to_a
+    # See {Base#jsi_hash?}. Always true for HashNode.
+    def jsi_hash?
+      true
+    end
 
-    # a jsonifiable representation of the node content
-    # @return [Object]
-    def as_json(*opt)
-      # include Enumerable (above) means, if ActiveSupport is loaded, its undesirable #as_json is included
-      # https://github.com/rails/rails/blob/v7.0.0/activesupport/lib/active_support/core_ext/object/json.rb#L139-L143
-      # although Base#as_json does clobber activesupport's, I want as_json defined correctly on the module too.
-      Typelike.as_json(jsi_node_content, *opt)
+    # Yields each key - see {Base#jsi_each_child_token}
+    def jsi_each_child_token(&block)
+      return to_enum(__method__) { jsi_node_content_hash_pubsend(:size) } unless block
+      jsi_node_content_hash_pubsend(:each_key, &block)
+      nil
     end
-  end
 
-  # module extending a {JSI::Base} object when its instance (its {Base#jsi_node_content})
-  # is a Hash (or responds to `#to_hash`)
-  module Base::HashNode
-    include Base::Enumerable
+    # See {Base#jsi_child_token_in_range?}
+    def jsi_child_token_in_range?(token)
+      jsi_node_content_hash_pubsend(:key?, token)
+    end
+
+    # See {Base#jsi_node_content_child}
+    def jsi_node_content_child(token)
+      # I could check token_in_range? and return nil here (as ArrayNode does).
+      # without that check, if the instance defines Hash#default or #default_proc, that result is returned.
+      # the preferred mechanism for a JSI's default value should be its schema.
+      # but there's no compelling reason not to support both, so I'll return what #[] returns.
+      jsi_node_content_hash_pubsend(:[], token)
+    end
+
+    # See {Base#[]}
+    def [](token, as_jsi: jsi_child_as_jsi_default, use_default: jsi_child_use_default_default)
+      if jsi_node_content_hash_pubsend(:key?, token)
+        jsi_child(token, as_jsi: as_jsi)
+      else
+        if use_default
+          jsi_default_child(token, as_jsi: as_jsi)
+        else
+          nil
+        end
+      end
+    end
 
-    # yields each hash key and value of this node.
+    # yields each Hash key (JSON object property name) and value of this node.
     #
     # each yielded key is a key of the instance hash, and each yielded value is the result of {Base#[]}.
     #
-    # returns an Enumerator if no block is given.
-    #
     # @param kw keyword arguments are passed to {Base#[]}
     # @yield [Object, Object] each key and value of this hash node
     # @return [self, Enumerator] an Enumerator if invoked without a block; otherwise self
@@ -59,7 +85,22 @@ module JSI
     # @param kw keyword arguments are passed to {Base#[]}
     # @return [Hash]
     def to_hash(**kw)
-      {}.tap { |h| jsi_node_content_hash_pubsend(:each_key) { |k| h[k] = self[k, **kw] } }
+      hash = {}
+      jsi_node_content_hash_pubsend(:each_key) { |k| hash[k] = self[k, **kw] }
+      hash.freeze
+    end
+
+    # See {Base#as_json}
+    def as_json(options = {})
+      hash = {}
+      each_key do |k|
+        ks = k.is_a?(String) ? k :
+          k.is_a?(Symbol) ? k.to_s :
+          k.respond_to?(:to_str) && (kstr = k.to_str).is_a?(String) ? kstr :
+          raise(TypeError, "JSON object (Hash) cannot be keyed with: #{k.pretty_inspect.chomp}")
+        hash[ks] = jsi_child_node(k).as_json(**options)
+      end
+      hash
     end
 
     include Util::Hashlike
@@ -110,14 +151,99 @@ module JSI
   # module extending a {JSI::Base} object when its instance (its {Base#jsi_node_content})
   # is an Array (or responds to `#to_ary`)
   module Base::ArrayNode
-    include Base::Enumerable
+    # See {Base#jsi_array?}. Always true for ArrayNode.
+    def jsi_array?
+      true
+    end
+
+    # Yields each index - see {Base#jsi_each_child_token}
+    def jsi_each_child_token(&block)
+      return to_enum(__method__) { jsi_node_content_ary_pubsend(:size) } unless block
+      jsi_node_content_ary_pubsend(:each_index, &block)
+      nil
+    end
+
+    # See {Base#jsi_child_token_in_range?}
+    def jsi_child_token_in_range?(token)
+      token.is_a?(Integer) && token >= 0 && token < jsi_node_content_ary_pubsend(:size)
+    end
+
+    # See {Base#jsi_node_content_child}
+    def jsi_node_content_child(token)
+      # we check token_in_range? here (unlike HashNode) because we do not want to pass
+      # negative indices, Ranges, or non-Integers to Array#[]
+      if jsi_child_token_in_range?(token)
+        jsi_node_content_ary_pubsend(:[], token)
+      else
+        nil
+      end
+    end
+
+    # See {Base#[]}
+    def [](token, as_jsi: jsi_child_as_jsi_default, use_default: jsi_child_use_default_default)
+      size = jsi_node_content_ary_pubsend(:size)
+      if token.is_a?(Integer)
+        if token < 0
+          if token < -size
+            nil
+          else
+            jsi_child(token + size, as_jsi: as_jsi)
+          end
+        else
+          if token < size
+            jsi_child(token, as_jsi: as_jsi)
+          else
+            if use_default
+              jsi_default_child(token, as_jsi: as_jsi)
+            else
+              nil
+            end
+          end
+        end
+      elsif token.is_a?(Range)
+        type_err = proc do
+          raise(TypeError, [
+            "given range does not contain Integers",
+            "range: #{token.inspect}",
+          ].join("\n"))
+        end
+
+        start_idx = token.begin
+        if start_idx.is_a?(Integer)
+          start_idx += size if start_idx < 0
+          return Util::EMPTY_ARY if start_idx == size
+          return nil if start_idx < 0 || start_idx > size
+        elsif start_idx.nil?
+          start_idx = 0
+        else
+          type_err.call
+        end
+
+        end_idx = token.end
+        if end_idx.is_a?(Integer)
+          end_idx += size if end_idx < 0
+          end_idx += 1 unless token.exclude_end?
+          end_idx = size if end_idx > size
+          return Util::EMPTY_ARY if start_idx >= end_idx
+        elsif end_idx.nil?
+          end_idx = size
+        else
+          type_err.call
+        end
+
+        (start_idx...end_idx).map { |i| jsi_child(i, as_jsi: as_jsi) }.freeze
+      else
+        raise(TypeError, [
+          "expected `token` param to be an Integer or Range",
+          "token: #{token.inspect}",
+        ].join("\n"))
+      end
+    end
 
     # yields each array element of this node.
     #
     # each yielded element is the result of {Base#[]} for each index of the instance array.
     #
-    # returns an Enumerator if no block is given.
-    #
     # @param kw keyword arguments are passed to {Base#[]}
     # @yield [Object] each element of this array node
     # @return [self, Enumerator] an Enumerator if invoked without a block; otherwise self
@@ -135,6 +261,11 @@ module JSI
       to_a(**kw)
     end
 
+    # See {Base#as_json}
+    def as_json(options = {})
+      each_index.map { |i| jsi_child_node(i).as_json(**options) }
+    end
+
     include Util::Arraylike
 
     if Util::LAST_ARGUMENT_AS_KEYWORD_PARAMETERS
@@ -180,4 +311,38 @@ module JSI
       end
     end
   end
+
+  module Base::StringNode
+    delegate_methods = %w(% * + << =~ [] []=
+      ascii_only? b byteindex byterindex bytes bytesize byteslice bytesplice capitalize capitalize!
+      casecmp casecmp? center chars chomp chomp! chop chop! chr clear codepoints concat count delete delete!
+      delete_prefix delete_prefix! delete_suffix delete_suffix! downcase downcase!
+      each_byte each_char each_codepoint each_grapheme_cluster each_line
+      empty? encode encode! encoding end_with? force_encoding getbyte grapheme_clusters gsub gsub! hex
+      include? index insert intern length lines ljust lstrip lstrip! match match? next next! oct ord
+      partition prepend replace reverse reverse! rindex rjust rpartition rstrip rstrip! scan scrub scrub!
+      setbyte size slice slice! split squeeze squeeze! start_with? strip strip! sub sub! succ succ! sum
+      swapcase swapcase! to_c to_f to_i to_r to_s to_str to_sym tr tr! tr_s tr_s!
+      unicode_normalize unicode_normalize! unicode_normalized? unpack unpack1 upcase upcase! upto valid_encoding?
+    )
+    delegate_methods.each do |method_name|
+      if Util::LAST_ARGUMENT_AS_KEYWORD_PARAMETERS
+        define_method(method_name) do |*a, &b|
+          if jsi_node_content.respond_to?(method_name)
+            jsi_node_content.public_send(method_name, *a, &b)
+          else
+            jsi_node_content.to_str.public_send(method_name, *a, &b)
+          end
+        end
+      else
+        define_method(method_name) do |*a, **kw, &b|
+          if jsi_node_content.respond_to?(method_name)
+            jsi_node_content.public_send(method_name, *a, **kw, &b)
+          else
+            jsi_node_content.to_str.public_send(method_name, *a, **kw, &b)
+          end
+        end
+      end
+    end
+  end
 end