context_spook 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48da6b99283d3e0b02730a5ef6c02d07726dca15c7d29d6e40b73cc5d1f11e37
-  data.tar.gz: 3c8f65d9f003f1c7053157beab50d95ff692852bca4c5efef83241c01ff2740c
+  metadata.gz: 5cca218e18443bf3698be556f93b822253a9f0dd4c93322d1ee9c826d1a26dc3
+  data.tar.gz: d8c48e20203cbc5c1c0741e93805480aa7fbe9987821fe2b9839447902879149
 SHA512:
-  metadata.gz: 3f0c9d83fc057968a95f74dff08f035908ea9e362e608007046919acc7e9e5d0e2d6cc7a4e9526d24ba8d50cc5ca8c450b8537c4b4d4dead1910b429806a5978
-  data.tar.gz: a6bea380021e97a6095c66418628e67cfa6afdcc1f85585a71d622d17355e5640f8cb64403c8eb196183753f260be40a20fc1c32dd7d39db1d24cae0f6518cbc
+  metadata.gz: a7f1fb4f2b26f9c59dc6a48be8db0a2ffc4381250334a401c6ad2944fe398cb18bcc0154df6111d26ceac1a9bcad7ac4386626aeb681bbe20f1286310fbe58f0
+  data.tar.gz: 990b7df25449551007c8e986ec479bdf5656195e47ef6d7243603849179a5fac6edaa6e245bbfaa99768115b3b46eeffc5baf6f37e542c8a4b729dc443ba8b13

data/Rakefile

@@ -38,7 +38,7 @@ GemHadar do
   dependency 'mime-types',     '~> 3.0'
   dependency 'yaml',           '~> 0.4'
   dependency 'pathname',       '~> 0.4'
-  dependency 'ruby-json-toon', '~> 1.0'
+  dependency 'toon-ruby',      '>= 0.1'
   development_dependency 'all_images', '~> 0.6'
   development_dependency 'rspec',      '~> 3.2'
   development_dependency 'debug'

data/context_spook.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: context_spook 1.4.0 ruby lib
+# stub: context_spook 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "context_spook".freeze
-  s.version = "1.4.0".freeze
+  s.version = "1.5.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -36,5 +36,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<mime-types>.freeze, ["~> 3.0".freeze])
   s.add_runtime_dependency(%q<yaml>.freeze, ["~> 0.4".freeze])
   s.add_runtime_dependency(%q<pathname>.freeze, ["~> 0.4".freeze])
-  s.add_runtime_dependency(%q<ruby-json-toon>.freeze, ["~> 1.0".freeze])
+  s.add_runtime_dependency(%q<toon-ruby>.freeze, [">= 0.1".freeze])
 end

data/lib/context_spook/generator.rb

@@ -13,28 +13,30 @@ require 'context_spook/output_context'
 module ContextSpook
   include DSLKit::Interpreter
 
-  # The generate_context method processes a context definition file or block
-  # and returns the resulting context object.
+  # The generate_context method creates a context object by either evaluating a
+  # block or parsing a file
   #
-  # This method serves as the primary entry point for generating project
-  # context data. It accepts either a filename pointing to a context definition
-  # file or a block containing the context definition, but not both.
-  # When a filename is provided, it reads and parses the file content. When a
-  # block is provided, it evaluates the block within the generator's context.
-  # The method ensures that only one context definition mechanism is used.
+  # This method serves as the primary entry point for generating context data.
+  # It accepts either a filename pointing to a context definition file or a
+  # block containing the context definition. The method handles the creation of
+  # a generator instance, processes the context definition, and returns the
+  # resulting context object.
   #
-  # @param filename [ String, nil ] the path to the context definition file to
-  #   be processed
+  # @param filename [ String, nil ] the path to a context definition file, or
+  #   nil if using a block
   # @param verbose [ TrueClass, FalseClass ] flag to enable verbose output
-  #   during processing, defaults to false.
-  # @param block [ Proc ] a block containing the context definition to be
-  #   evaluated
+  #   during processing
+  # @param format [ String, nil ] the output format for the context, either
+  #   'JSON' or 'TOON'
+  # @param block [ Proc ] a block containing the context definition, used if
+  #   filename is nil
   #
-  # @return [ ContextSpook::Generator::Context ] the context object generated
-  #   from the file contents or block
+  # @return [ ContextSpook::Generator::Context ] the generated context object containing
+  #   project metadata, file contents, command outputs, and variables
   #
   # @raise [ ArgumentError ] if neither a filename nor a block is provided
-  # @raise [ ArgumentError ] if both a filename and a block are provided
+  # @raise [ ArgumentError ] if an invalid format is specified
+  # @raise [ ArgumentError ] if the context definition file cannot be read or parsed
   def self.generate_context(filename = nil, verbose: false, format: nil, &block)
     verbose = !!verbose
     filename.present? ^ block or
@@ -80,6 +82,9 @@ module ContextSpook
     def initialize(verbose: false, format: nil, &block)
       @verbose = !!verbose
       @format  = (format || 'JSON').upcase
+      %w[ TOON JSON ].include?(@format) or
+        raise ArgumentError,
+          "format needs to be either JSON or TOON, was #{@format.inspect}"
       block and instance_eval(&block)
     end
 

data/lib/context_spook/toon.rb

@@ -1,4 +1,4 @@
-require 'ruby_json_toon'
+require 'toon'
 
 # The ContextSpook::TOON module provides TOON (Token-Oriented Object Notation)
 # serialization functionality for context objects.
@@ -7,7 +7,7 @@ module ContextSpook::TOON
   #
   # @return [String] the TOON-encoded representation of the context
   def to_toon
-    RubyJsonToon.encode(as_json)
+    ::Toon.encode(as_json)
   end
   memoize method: :to_toon
 

data/lib/context_spook/version.rb

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

data/spec/context_spook/generator_spec.rb

@@ -33,6 +33,21 @@ describe ContextSpook::Generator do
       described_class.send(:new).output_context_size
     end
 
+    context 'can handle formats' do
+      it 'raises exceptions for invalid formats' do
+        generator = described_class.send(:new, format: 'TOON')
+        expect(generator.format).to eq 'TOON'
+      end
+
+      it 'raises exceptions for invalid formats' do
+        expect {
+          described_class.send(:new, format: 'YAML')
+        }.to raise_error(
+          ArgumentError, /format needs to be either JSON or TOON, was "YAML"/
+        )
+      end
+    end
+
     it 'cannot do from block and filename' do
       expect {
         ContextSpook.generate_context('.contexts/project.rb') { }

data/spec/context_spook/toon_spec.rb

@@ -20,8 +20,22 @@ describe ContextSpook::TOON do
 
     it 'produces valid TOON output' do
       toon_output = context.to_toon
-      # TOON should be a valid string representation
-      expect { RubyJsonToon.decode(toon_output) }.not_to raise_error
+      expect(toon_output).to match(
+        %r{
+          \Afiles:\n
+          ^[ ]{2}"lib/context_spook\.rb":\n
+          ^[ ]{4}content:[ ]"[^"]+"\n
+          ^[ ]{4}size:[ ]120\n
+          ^[ ]{4}lines:[ ]5\n
+          ^[ ]{4}content_types\[2\]:[ ]application/x-ruby,text/x-ruby\n
+          ^commands:\n
+          ^metadata:\n
+          ^[ ]{2}version:[ ]"1\.0"\n
+          ^[ ]{2}format:[ ]JSON\n
+          ^variables:\n
+          ^[ ]{2}foo:[ ]bar\z
+        }x
+      )
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: context_spook
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Florian Frank
@@ -178,19 +178,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: ruby-json-toon
+  name: toon-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.1'
 description: |
   context_spook is a library that collects and organizes project
   information to help AI assistants understand codebases better.