context_spook 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a00a3e36535b351b630e539a1dfae938bb2325c2f639e3d0b318f1cac0e8c14f
-  data.tar.gz: 3c7976d1672dd67d6b0b07d64350e3baf211d6e8752b83631de9f5a17ae642f3
+  metadata.gz: 48da6b99283d3e0b02730a5ef6c02d07726dca15c7d29d6e40b73cc5d1f11e37
+  data.tar.gz: 3c8f65d9f003f1c7053157beab50d95ff692852bca4c5efef83241c01ff2740c
 SHA512:
-  metadata.gz: 82bf0afffa28eab0b379ec94c9a7a7cd34406ca82ccf4a7e78d26103082b8610ce3461a06a26772381fe59d6cfa401516eed532d33c6742cff980d08dea5508d
-  data.tar.gz: f969059b0b7ca9490ceb6560c5735da343c4ee5ee5ff856bae919da5ab66f02886e55a7096ad33b91241a147d78f5b5a82ec652ce25800658d46e4dc6a87bbc2
+  metadata.gz: 3f0c9d83fc057968a95f74dff08f035908ea9e362e608007046919acc7e9e5d0e2d6cc7a4e9526d24ba8d50cc5ca8c450b8537c4b4d4dead1910b429806a5978
+  data.tar.gz: a6bea380021e97a6095c66418628e67cfa6afdcc1f85585a71d622d17355e5640f8cb64403c8eb196183753f260be40a20fc1c32dd7d39db1d24cae0f6518cbc

data/context_spook.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: context_spook 1.3.0 ruby lib
+# stub: context_spook 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "context_spook".freeze
-  s.version = "1.3.0".freeze
+  s.version = "1.4.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.email = "flori@ping.de".freeze
   s.executables = ["context_spook".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/context_spook.rb".freeze, "lib/context_spook/generator.rb".freeze, "lib/context_spook/output_context.rb".freeze, "lib/context_spook/toon.rb".freeze, "lib/context_spook/utils.rb".freeze, "lib/context_spook/verbose_puts.rb".freeze, "lib/context_spook/version.rb".freeze]
-  s.files = [".contexts/project.rb".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/context_spook".freeze, "context_spook.gemspec".freeze, "hello_world.json".freeze, "hey_world.yaml".freeze, "lib/context_spook.rb".freeze, "lib/context_spook/generator.rb".freeze, "lib/context_spook/output_context.rb".freeze, "lib/context_spook/toon.rb".freeze, "lib/context_spook/utils.rb".freeze, "lib/context_spook/verbose_puts.rb".freeze, "lib/context_spook/version.rb".freeze, "spec/context_spook/generator_spec.rb".freeze, "spec/context_spook/toon_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.files = [".contexts/project.rb".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/context_spook".freeze, "context_spook.gemspec".freeze, "hello_world.json".freeze, "hey_world.yaml".freeze, "lib/context_spook.rb".freeze, "lib/context_spook/generator.rb".freeze, "lib/context_spook/output_context.rb".freeze, "lib/context_spook/toon.rb".freeze, "lib/context_spook/toon/example.md".freeze, "lib/context_spook/utils.rb".freeze, "lib/context_spook/verbose_puts.rb".freeze, "lib/context_spook/version.rb".freeze, "spec/context_spook/generator_spec.rb".freeze, "spec/context_spook/toon_spec.rb".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "https://github.com/flori/context_spook".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "ContextSpook - context_spook collects project context for AI".freeze, "--main".freeze, "README.md".freeze]

data/lib/context_spook/generator.rb

@@ -56,8 +56,18 @@ module ContextSpook
     include VerbosePuts
     include OutputContext
 
+    # The verbose method returns the verbose flag indicating whether verbose
+    # output is enabled.
+    #
+    # @return [ TrueClass, FalseClass ] true if verbose output is enabled,
+    #   false otherwise
     attr_reader :verbose
 
+    # The format method returns the format identifier for the context output.
+    #
+    # @return [ String ] the format identifier, either 'JSON' or 'TOON'
+    attr_reader :format
+
     private_class_method :new
 
     # The initialize method sets up the object by evaluating the provided block
@@ -107,8 +117,17 @@ module ContextSpook
       def initialize(generator:, &block)
         @generator = generator
         block and instance_eval(&block)
+        meta(format: generator.format)
+        if generator.format == 'TOON'
+          meta(toon_example: toon_example)
+        end
       end
 
+      # The generator method returns the generator object associated with this
+      # context.
+      #
+      # @return [ ContextSpook::Generator ] the generator instance that created
+      #   this context
       attr_reader :generator
 
       delegate :verbose, to: :generator

data/lib/context_spook/toon/example.md

@@ -0,0 +1,69 @@
+# TOON (Token-Oriented Object Notation)
+
+It is a compact, human-readable serialization format that reduces JSON token
+count by 30-40% while maintaining lossless data fidelity. It uses CSV-style
+tabular arrays for uniform data structures and YAML-like indentation for nested
+objects, making it ideal for LLM input where token efficiency and parsing
+reliability matter.
+
+Key benefit: Same data, fewer tokens, better LLM understanding.
+
+**Original JSON:**
+```json
+{
+  "database": {
+    "name": "user_management",
+    "tables": [
+      {
+        "name": "users",
+        "columns": [
+          {
+            "name": "id",
+            "type": "integer",
+            "primary_key": true
+          },
+          {
+            "name": "email",
+            "type": "string",
+            "unique": true
+          }
+        ],
+        "row_count": 1000
+      },
+      {
+        "name": "orders",
+        "columns": [
+          {
+            "name": "id",
+            "type": "integer",
+            "primary_key": true
+          },
+          {
+            "name": "user_id",
+            "type": "integer"
+          }
+        ],
+        "row_count": 5000
+      }
+    ]
+  }
+}
+```
+
+**TOON equivalent:**
+```
+database:
+  name: user_management
+  tables[2]{name,row_count}:
+    users,1000
+    orders,5000
+  tables[2]{name,columns}:
+    users:
+      columns[2]{name,type,primary_key}:
+        id,integer,true
+        email,string,true
+    orders:
+      columns[2]{name,type}:
+        id,integer,true
+        user_id,integer,false
+```

data/lib/context_spook/toon.rb

@@ -17,4 +17,17 @@ module ContextSpook::TOON
   def toon_size
     to_toon.size
   end
+
+  # The toon_example method reads and returns the content of an example
+  # Markdown file that demonstrates the TOON (Token-Oriented Object Notation)
+  # format.
+  #
+  # This method is used to provide a sample representation of how context data
+  # can be formatted in TOON, which is an alternative serialization format
+  # supported by the ContextSpook library.
+  #
+  # @return [ String ] the content of the TOON example Markdown file
+  def toon_example
+    File.read(Pathname.new(__dir__) + 'toon/example.md')
+  end
 end

data/lib/context_spook/version.rb

@@ -1,6 +1,6 @@
 module ContextSpook
   # ContextSpook version
-  VERSION         = '1.3.0'
+  VERSION         = '1.4.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: context_spook
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Florian Frank
@@ -221,6 +221,7 @@ files:
 - lib/context_spook/generator.rb
 - lib/context_spook/output_context.rb
 - lib/context_spook/toon.rb
+- lib/context_spook/toon/example.md
 - lib/context_spook/utils.rb
 - lib/context_spook/verbose_puts.rb
 - lib/context_spook/version.rb