jsi 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e18f4241f5f0013f657912295cb85db30095223a25030da3bbb690e68a5954d9
-  data.tar.gz: '083cbd8436424eeab11c36aeabb42f27ad9072d44450a0b8bfca391503131f9e'
+  metadata.gz: daf35895a6186a3d3123b037f917912ff65ea03c876da9dd5cb40e2a9b079641
+  data.tar.gz: b14524e9eb8796385fdd2ec96bcbb5129c2e80ad9eabb39d60637b9c6078d1c8
 SHA512:
-  metadata.gz: 1030a1013ae2209a7c6b1df083efe2466a670e1f644d64fd349475ba07331c182629c41a77d4d7220aaffcfb669f0c13bc5c49e6cb23a4f231747fbdc4b5ec7a
-  data.tar.gz: d9f24dec46a507e9d2f40046e891acec2bbef92150e72dd29bb1245618bb6be0ea9beb140cc4f0a465f187bd65e6e52c68bf82d906f8df0edaff67f062dd4c15
+  metadata.gz: 005c27210c96f9b613f7f6959e86e17b41380c5366fe14f69cd047498fb5bfc8256b8404aa6c5f2ced04882b94edd1c9b62ff79c48001b7388b4b4faadf6c5b1
+  data.tar.gz: 9eccdec2038200c340df2365a3b179da83fd900deb8b4f8f21aa5e4430f785d80afa929e8d718e80850d463fd5d2cd0e0982f7b99352b9e4109cf7c781e07c74

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.8.1
+
+- JSIs are immutable by default
+
 # v0.8.0
 
 - Immutable JSIs with new_jsi param `mutable`

data/README.md

@@ -63,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"])>
@@ -241,6 +245,10 @@ 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 (a {JSI::SchemaRegistry}) which associates URIs with schemas (or resources containing schemas). The default registry is accessible on {JSI.schema_registry}.

data/lib/jsi/schema.rb

@@ -155,6 +155,9 @@ module JSI
       # By default, the `schema_content` will have any Symbol keys of Hashes replaced with Strings
       # (recursively through the document). This is controlled by the param `stringify_symbol_keys`.
       #
+      # Schemas instantiated with `new_schema` are immutable, their content transformed using
+      # the `to_immutable` param.
+      #
       # @param schema_content an object to be instantiated as a JSI Schema - typically a Hash
       # @param uri [#to_str, Addressable::URI] The retrieval URI of the schema document.
       #   If specified, the root schema will be identified by this URI, in addition
@@ -198,6 +201,7 @@ module JSI
           schema_registry: schema_registry,
           stringify_symbol_keys: stringify_symbol_keys,
           to_immutable: to_immutable,
+          mutable: false,
         )
 
         schema_jsi.jsi_schema_module_exec(&block) if block
@@ -281,6 +285,9 @@ module JSI
       # {SchemaModule::MetaSchemaModule#new_schema schema module}, e.g.
       # `JSI::JSONSchemaDraft07.new_schema(my_schema_content)`
       #
+      # Schemas instantiated with `new_schema` are immutable, their content transformed using
+      # the `to_immutable` param.
+      #
       # @param schema_content (see Schema::MetaSchema#new_schema)
       # @param default_metaschema [Schema::MetaSchema, SchemaModule::MetaSchemaModule, #to_str]
       #   Indicates the meta-schema to use if the given `schema_content` does not have a `$schema` property.
@@ -626,10 +633,7 @@ module JSI
     # @param subptr [JSI::Ptr, #to_ary] a relative pointer, or array of tokens, pointing to the subschema
     # @return [JSI::Schema] the subschema at the location indicated by subptr. self if subptr is empty.
     def subschema(subptr)
-      @subschema_map[subptr: Ptr.ary_ptr(subptr)]
-    end
-
-    private def subschema_compute(subptr: )
+          subptr = Ptr.ary_ptr(subptr)
           Schema.ensure_schema(jsi_descendent_node(subptr), msg: [
             "subschema is not a schema at pointer: #{subptr.pointer}"
           ])
@@ -641,10 +645,7 @@ module JSI
     # @param ptr [JSI::Ptr, #to_ary] a pointer to a schema from our schema resource root
     # @return [JSI::Schema] the schema pointed to by ptr
     def resource_root_subschema(ptr)
-      @resource_root_subschema_map[ptr: Ptr.ary_ptr(ptr)]
-    end
-
-    private def resource_root_subschema_compute(ptr: )
+          ptr = Ptr.ary_ptr(ptr)
           Schema.ensure_schema(schema_resource_root.jsi_descendent_node(ptr),
             reinstantiate_as: jsi_schemas.select(&:describes_schema?)
           )
@@ -815,8 +816,6 @@ module JSI
         Schema::Ref.new(value, ref_schema: self)
       end
       @schema_uris_map = jsi_memomap(&method(:schema_uris_compute))
-      @subschema_map = jsi_memomap(&method(:subschema_compute))
-      @resource_root_subschema_map = jsi_memomap(&method(:resource_root_subschema_compute))
       @described_object_property_names_map = jsi_memomap(&method(:described_object_property_names_compute))
     end
   end

data/lib/jsi/schema_set.rb

@@ -101,7 +101,7 @@ module JSI
         schema_registry: JSI.schema_registry,
         stringify_symbol_keys: false,
         to_immutable: DEFAULT_CONTENT_TO_IMMUTABLE,
-        mutable: true
+        mutable: false
     )
       instance = Util.deep_stringify_symbol_keys(instance) if stringify_symbol_keys
 

data/lib/jsi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSI
-  VERSION = "0.8.0".freeze
+  VERSION = "0.8.1".freeze
 end

data/readme.rb

@@ -59,7 +59,7 @@ bill = Contact.new_jsi({
     }
   ],
   "nickname" => "big b",
-})
+}, mutable: true)
 
 print 'bill: '
 pp bill

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsi
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Ethan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable