context_spook 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce46a8a82422662465714da76e66762d8ce6ca9f44b2231c1064ca774e45696e
-  data.tar.gz: 3e6c9fbb246330a69232b4ddc4527aea2bc83385293b8a2d16829cd1f47dc3f4
+  metadata.gz: a00a3e36535b351b630e539a1dfae938bb2325c2f639e3d0b318f1cac0e8c14f
+  data.tar.gz: 3c7976d1672dd67d6b0b07d64350e3baf211d6e8752b83631de9f5a17ae642f3
 SHA512:
-  metadata.gz: 22b6f481325481fbb323cc354c404a7c87a595a5546b9c70f0cfe99b3ef2e1871dd653864dfa460f45df23a10c3573a497cefb46e83b7b7e24fb2d69892279fe
-  data.tar.gz: 1f8228f7e8300d887865bf262b148433ab06ef680b3bf593b404a60732f5751b66384d668366b37168195fb463b168bbe9bd8211bbf6402c8d6cc4b95016daec
+  metadata.gz: 82bf0afffa28eab0b379ec94c9a7a7cd34406ca82ccf4a7e78d26103082b8610ce3461a06a26772381fe59d6cfa401516eed532d33c6742cff980d08dea5508d
+  data.tar.gz: f969059b0b7ca9490ceb6560c5735da343c4ee5ee5ff856bae919da5ab66f02886e55a7096ad33b91241a147d78f5b5a82ec652ce25800658d46e4dc6a87bbc2

data/bin/context_spook

@@ -61,7 +61,7 @@ context = nil
 output  = nil
 
 if opts[?i]
-  context = ContextSpook.generate_context(verbose: opts[?v]) do
+  context = ContextSpook.generate_context(verbose: opts[?v], format: opts[?F]) do
     context do
       opts[?i].to_a.each do |glob|
         glob = File.expand_path(glob)
@@ -74,9 +74,10 @@ if opts[?i]
   end
 else
   filename = ARGV.shift or fail 'require context definition file as an argument'
-  context = ContextSpook.generate_context(filename, verbose: opts[?v])
+  context = ContextSpook.generate_context(filename, verbose: opts[?v], format: opts[?F])
 end
 
+output = STDOUT
 if opts[?S]
   output = NULL
 else
@@ -85,18 +86,11 @@ else
       fail "Filename #{output_filename.inspect} already exists!"
     end
     output = File.new output_filename, ?w
-  else
-    output = STDOUT
   end
 end
 case opts[?F]
-when /\ATOON\z/i
-  if opts[?v]
-    STDERR.puts "Built #{ContextSpook::Utils.format_size(context.toon_size)} of TOON context in total."
-  end
-  output.puts context.to_toon
-when /\AJSON\z/i, nil
-  JSON.dump(context.as_json, output)
+when /\A(JSON|TOON)\z/i, nil
+  context.generator.output_context(output:)
 else
   STDERR.puts "Invalid output format #{opts[?F].inspect}"
 end

data/context_spook.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: context_spook 1.2.0 ruby lib
+# stub: context_spook 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "context_spook".freeze
-  s.version = "1.2.0".freeze
+  s.version = "1.3.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -12,19 +12,19 @@ Gem::Specification.new do |s|
   s.description = "context_spook is a library that collects and organizes project\ninformation to help AI assistants understand codebases better.\n".freeze
   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/toon.rb".freeze, "lib/context_spook/utils.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/toon.rb".freeze, "lib/context_spook/utils.rb".freeze, "lib/context_spook/version.rb".freeze, "spec/context_spook/generator_spec.rb".freeze, "spec/spec_helper.rb".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.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]
   s.required_ruby_version = Gem::Requirement.new(">= 3.1".freeze)
   s.rubygems_version = "4.0.3".freeze
   s.summary = "context_spook collects project context for AI".freeze
-  s.test_files = ["spec/context_spook/generator_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.test_files = ["spec/context_spook/generator_spec.rb".freeze, "spec/context_spook/toon_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.16.2".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.17.0".freeze])
   s.add_development_dependency(%q<all_images>.freeze, ["~> 0.6".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2".freeze])
   s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])

data/lib/context_spook/generator.rb

@@ -5,36 +5,14 @@ require 'mize'
 require 'mime-types'
 require 'yaml'
 require 'context_spook/toon'
+require 'context_spook/verbose_puts'
+require 'context_spook/output_context'
 
 # The ContextSpook module serves as a namespace container for collecting and
 # organizing project information for AI assistance.
 module ContextSpook
   include DSLKit::Interpreter
 
-  # The VerbosePuts module provides a conditional output mechanism for
-  # displaying status or debug messages.
-  #
-  # This module includes a method that outputs messages to standard error only
-  # when a verbose flag is enabled. It is designed to be included in classes
-  # that need to conditionally emit verbose logging information during
-  # processing.
-  module VerbosePuts
-    # The verbose_puts method outputs the given arguments to standard error
-    # only if verbose mode is enabled.
-    #
-    # This method serves as a conditional output mechanism, allowing debug or
-    # status messages to be displayed based on the verbosity setting of the
-    # object.
-    #
-    # @param a [ Array ] the arguments to be printed to standard error
-    #
-    # @return [ nil ] always returns nil after attempting to output
-    def verbose_puts(*a)
-      @verbose or return
-      STDERR.puts(a)
-    end
-  end
-
   # The generate_context method processes a context definition file or block
   # and returns the resulting context object.
   #
@@ -57,14 +35,14 @@ module ContextSpook
   #
   # @raise [ ArgumentError ] if neither a filename nor a block is provided
   # @raise [ ArgumentError ] if both a filename and a block are provided
-  def self.generate_context(filename = nil, verbose: false, &block)
+  def self.generate_context(filename = nil, verbose: false, format: nil, &block)
     verbose = !!verbose
     filename.present? ^ block or
       raise ArgumentError, 'need either a filename or a &block argument'
     generator = if filename
-                  Generator.send(:new, verbose:).send(:parse, File.read(filename))
+                  Generator.send(:new, verbose:, format:).send(:parse, File.read(filename))
                 else
-                  Generator.send(:new, verbose:, &block)
+                  Generator.send(:new, verbose:, format:, &block)
                 end
     generator.output_context_size
     generator.context
@@ -76,6 +54,9 @@ module ContextSpook
   # assistance.
   class Generator
     include VerbosePuts
+    include OutputContext
+
+    attr_reader :verbose
 
     private_class_method :new
 
@@ -86,8 +67,9 @@ module ContextSpook
     #   output during processing, defaults to lfalse.
     # @param block [ Proc ] a block of code to be evaluated within the object's context
     #                       If no block is given, the method does nothing.
-    def initialize(verbose: false, &block)
+    def initialize(verbose: false, format: nil, &block)
       @verbose = !!verbose
+      @format  = (format || 'JSON').upcase
       block and instance_eval(&block)
     end
 
@@ -99,24 +81,12 @@ module ContextSpook
     def context(&block)
       if block
         @context and raise ArgumentError, "only one context allowed"
-        @context = Context.new(verbose: @verbose, &block)
+        @context = Context.new(generator: self, &block)
       else
         @context
       end
     end
 
-    # The output_context_size method prints the total size of the generated
-    # context JSON representation.
-    #
-    # This method calculates the size of the context object when serialized to
-    # JSON, formats it using binary units (KiB, MiB, etc.), and outputs the
-    # result to standard error.
-    def output_context_size
-      context_size      = @context&.size.to_i
-      json_context_size = ContextSpook::Utils.format_size(context_size)
-      verbose_puts "Built #{json_context_size} of JSON context in total."
-    end
-
     # The Context class represents and manages project context data, providing
     # structured storage for file contents, command outputs, variables, and
     # metadata that can be serialized to JSON for AI assistance.
@@ -134,11 +104,15 @@ module ContextSpook
       #   during processing, defaults to false.
       # @param block [ Proc ] a block of code to be evaluated within the object's context
       #                       If no block is given, the method does nothing.
-      def initialize(verbose: false, &block)
-        @verbose = !!verbose
+      def initialize(generator:, &block)
+        @generator = generator
         block and instance_eval(&block)
       end
 
+      attr_reader :generator
+
+      delegate :verbose, to: :generator
+
       # The namespace method creates a scoped block with a given name.
       #
       # @param name [ Object ] the name to scope the block with

data/lib/context_spook/output_context.rb

@@ -0,0 +1,36 @@
+# The ContextSpook::OutputContext module provides methods for outputting
+# context data in various formats.
+#
+# This module is included in the ContextSpook::Generator class to enable output
+# functionality for generated context objects.
+module ContextSpook::OutputContext
+  # The output_context_size method prints the total size of the generated
+  # context JSON representation.
+  #
+  # This method calculates the size of the context object when serialized to
+  # JSON, formats it using binary units (KiB, MiB, etc.), and outputs the
+  # result to standard error.
+  def output_context_size
+    context_size =
+      (@format == 'TOON' ? @context&.toon_size : @context&.size).to_i
+    context_size = ContextSpook::Utils.format_size(context_size)
+    verbose_puts "Built #{context_size} of #@format context in total."
+  end
+
+  # The output_context method writes the generated context to the specified
+  # output stream in either TOON or JSON format.
+  #
+  # This method serializes the context object into either TOON format or JSON
+  # format depending on the configured format, and writes the result to the
+  # provided output stream, which defaults to STDOUT.
+  #
+  # @param output [ IO ] the output stream to write the context data to,
+  #   defaults to STDOUT
+  def output_context(output: STDOUT)
+    if @format == 'TOON'
+      output.puts(@context.to_toon)
+    else
+      JSON.dump(@context.as_json, output)
+    end
+  end
+end

data/lib/context_spook/toon.rb

@@ -1,11 +1,19 @@
 require 'ruby_json_toon'
 
+# The ContextSpook::TOON module provides TOON (Token-Oriented Object Notation)
+# serialization functionality for context objects.
 module ContextSpook::TOON
+  # Converts the context object to TOON format.
+  #
+  # @return [String] the TOON-encoded representation of the context
   def to_toon
     RubyJsonToon.encode(as_json)
   end
   memoize method: :to_toon
 
+  # Calculates the size of the TOON representation.
+  #
+  # @return [Integer] the size in bytes of the TOON representation
   def toon_size
     to_toon.size
   end

data/lib/context_spook/utils.rb

@@ -1,3 +1,5 @@
+# The ContextSpook::Utils module provides utility methods for formatting and
+# processing context data.
 module ContextSpook::Utils
   module_function
 

data/lib/context_spook/verbose_puts.rb

@@ -0,0 +1,25 @@
+module ContextSpook
+  # The VerbosePuts module provides a conditional output mechanism for
+  # displaying status or debug messages.
+  #
+  # This module includes a method that outputs messages to standard error only
+  # when a verbose flag is enabled. It is designed to be included in classes
+  # that need to conditionally emit verbose logging information during
+  # processing.
+  module VerbosePuts
+    # The verbose_puts method outputs the given arguments to standard error
+    # only if verbose mode is enabled.
+    #
+    # This method serves as a conditional output mechanism, allowing debug or
+    # status messages to be displayed based on the verbosity setting of the
+    # object.
+    #
+    # @param a [ Array ] the arguments to be printed to standard error
+    #
+    # @return [ nil ] always returns nil after attempting to output
+    def verbose_puts(*a)
+      verbose or return
+      STDERR.puts(a)
+    end
+  end
+end

data/lib/context_spook/version.rb

@@ -1,6 +1,6 @@
 module ContextSpook
   # ContextSpook version
-  VERSION         = '1.2.0'
+  VERSION         = '1.3.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

@@ -1,56 +1,92 @@
 require 'spec_helper'
 
 describe ContextSpook::Generator do
-  let :context do
-    ContextSpook.generate_context('.contexts/project.rb', verbose: true)
+  let :my_context do
+    ContextSpook.generate_context('.contexts/project.rb', verbose: false)
   end
 
-  it 'context can be generated from block' do
-    expect_any_instance_of(described_class).to\
-      receive(:output_context_size).and_call_original
-    context = ContextSpook.generate_context do
-      context do
-        variable foo: 'bar'
-        metadata version: '1.0'
+  describe 'generating w/o verbose' do
+    it 'context can be generated from block' do
+      expect_any_instance_of(described_class).to\
+        receive(:output_context_size).and_call_original
+      my_context = ContextSpook.generate_context do
+        context do
+          variable foo: 'bar'
+          metadata version: '1.0'
+        end
       end
+      expect(my_context).to be_a described_class::Context
+      expect(my_context.variables[:foo]).to eq 'bar'
+      expect(my_context.metadata[:version]).to eq '1.0'
     end
-    expect(context).to be_a described_class::Context
-    expect(context.variables[:foo]).to eq 'bar'
-    expect(context.metadata[:version]).to eq '1.0'
-  end
 
-  it 'context can be generated from filename' do
-    expect_any_instance_of(described_class).to\
-      receive(:output_context_size).and_call_original
-    expect(context).to be_a described_class::Context
-    expect(context.metadata[:ruby]).to eq RUBY_DESCRIPTION
-  end
+    it 'context can be generated from filename' do
+      expect_any_instance_of(described_class).to\
+        receive(:output_context_size).and_call_original
+      expect(my_context).to be_a described_class::Context
+      expect(my_context.metadata[:ruby]).to eq RUBY_DESCRIPTION
+    end
 
-  it 'could handle premature output_context_size calls' do
-    expect_any_instance_of(described_class).to\
-      receive(:output_context_size).and_call_original
-    described_class.send(:new).output_context_size
-  end
+    it 'could handle premature output_context_size calls' do
+      expect_any_instance_of(described_class).to\
+        receive(:output_context_size).and_call_original
+      described_class.send(:new).output_context_size
+    end
+
+    it 'cannot do from block and filename' do
+      expect {
+        ContextSpook.generate_context('.contexts/project.rb') { }
+      }.to raise_error(ArgumentError, /need either a filename or a &block/)
+    end
 
-  it 'cannot do from block and filename' do
-    expect {
-      ContextSpook.generate_context('.contexts/project.rb') { }
-    }.to raise_error(ArgumentError, /need either a filename or a &block/)
+    it 'context be transformed to JSON if loaded' do
+      context_as_json = my_context.to_json
+      expect(my_context.size).to be > 1024
+      expect(JSON(context_as_json)).to be_a Hash
+    end
+
+    it 'can output context in JSON' do
+      output = StringIO.new
+      expect_any_instance_of(described_class).to receive(:output_context).
+        with(output:).and_call_original
+      my_context.generator.output_context(output:)
+      expect(output.string).to include '"ruby":%s' % RUBY_DESCRIPTION.dump
+    end
+
+    it 'can output context in TOON' do
+      my_context = ContextSpook.generate_context(
+        '.contexts/project.rb', verbose: false, format: 'TOON'
+      )
+      output = StringIO.new
+      expect_any_instance_of(described_class).to receive(:output_context).
+        with(output:).and_call_original
+      my_context.generator.output_context(output:)
+      expect(output.string).to include 'ruby: %s' % RUBY_DESCRIPTION.dump
+    end
   end
 
-  it 'context be transformed to JSON if loaded' do
-    context_as_json = context.to_json
-    expect(context.size).to be > 1024
-    expect(JSON(context_as_json)).to be_a Hash
+  describe 'generating with verbose' do
+    let :my_context do
+      ContextSpook.generate_context('.contexts/project.rb', verbose: true)
+    end
+
+    it 'can output context size' do
+      expect_any_instance_of(described_class).to receive(:output_context_size).
+        and_call_original
+      expect_any_instance_of(described_class).to receive(:verbose_puts).
+        with(/Built.*of JSON context in total/)
+      allow_any_instance_of(described_class::Context).to receive(:verbose_puts)
+      my_context
+    end
   end
 
   describe 'Context' do
     it 'can have variables' do
-      expect(context.variables[:branch]).to be_present
+      expect(my_context.variables[:branch]).to be_present
     end
 
     it 'can have files' do
-      file = context.files['lib/context_spook.rb']
+      file = my_context.files['lib/context_spook.rb']
       expect(file).to be_present
       expect(file[:content]).to be_present
       expect(file[:content_types]).to be_present
@@ -61,7 +97,7 @@ describe ContextSpook::Generator do
     end
 
     it 'can have commands' do
-      command = context.commands['tree']
+      command = my_context.commands['tree']
       expect(command).to be_present
       expect(command[:working_directory]).to eq Dir.pwd
       expect(command[:exit_code]).not_to be_nil
@@ -74,38 +110,38 @@ describe ContextSpook::Generator do
     end
 
     it 'can have metada' do
-      expect(context.metadata[:ruby]).to eq RUBY_DESCRIPTION
+      expect(my_context.metadata[:ruby]).to eq RUBY_DESCRIPTION
     end
 
     it 'can have json metadata' do
-      expect(context.metadata[:hello_world]).to eq("hello" => "world")
+      expect(my_context.metadata[:hello_world]).to eq("hello" => "world")
     end
 
     it 'can have yaml metadata' do
-      expect(context.metadata[:hey_world]).to eq("hey" => "world")
+      expect(my_context.metadata[:hey_world]).to eq("hey" => "world")
     end
 
     it 'handles missing json files gracefully' do
-      expect(context.json('nixda.json')).to be_nil
+      expect(my_context.json('nixda.json')).to be_nil
     end
 
     it 'handles invalid json content gracefully' do
       Tempfile.create('invalid.json') do |f|
         f.write('{ invalid json }')
         f.close
-        expect(context.json(f.path)).to be_nil
+        expect(my_context.json(f.path)).to be_nil
       end
     end
 
     it 'handles missing yaml files gracefully' do
-      expect(context.yaml('nixda.yaml')).to be_nil
+      expect(my_context.yaml('nixda.yaml')).to be_nil
     end
 
     it 'handles invalid yaml content gracefully' do
       Tempfile.create('invalid.yaml') do |f|
         f.write('invalid: [yaml')
         f.close
-        expect(context.yaml(f.path)).to be_nil
+        expect(my_context.yaml(f.path)).to be_nil
       end
     end
   end

data/spec/context_spook/toon_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe ContextSpook::TOON do
+  let(:context) do
+    ContextSpook.generate_context do
+      context do
+        variable foo: 'bar'
+        metadata version: '1.0'
+        file 'lib/context_spook.rb'
+      end
+    end
+  end
+
+  describe '#to_toon' do
+    it 'converts context to TOON format' do
+      toon_output = context.to_toon
+      expect(toon_output).to be_a(String)
+      expect(toon_output).to_not be_empty
+    end
+
+    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
+    end
+  end
+
+  describe '#toon_size' do
+    it 'returns the size of TOON representation in bytes' do
+      size = context.toon_size
+      expect(size).to be_a(Integer)
+      expect(size).to be > 0
+    end
+
+    it 'matches the size of the TOON output' do
+      size = context.toon_size
+      toon_output = context.to_toon
+      expect(size).to eq(toon_output.size)
+    end
+  end
+
+  describe 'integration with ContextSpook::Generator::Context' do
+    it 'is included in Context class' do
+      expect(context).to respond_to(:to_toon)
+      expect(context).to respond_to(:toon_size)
+    end
+
+    it 'works with context data' do
+      toon_output = context.to_toon
+      expect(toon_output).to include('variables:')
+      expect(toon_output).to include('metadata:')
+      expect(toon_output).to include('files:')
+      expect(toon_output).to include('commands:')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: context_spook
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.16.2
+        version: 2.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.16.2
+        version: 2.17.0
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -202,8 +202,10 @@ extra_rdoc_files:
 - README.md
 - lib/context_spook.rb
 - lib/context_spook/generator.rb
+- lib/context_spook/output_context.rb
 - lib/context_spook/toon.rb
 - lib/context_spook/utils.rb
+- lib/context_spook/verbose_puts.rb
 - lib/context_spook/version.rb
 files:
 - ".contexts/project.rb"
@@ -217,10 +219,13 @@ files:
 - hey_world.yaml
 - lib/context_spook.rb
 - lib/context_spook/generator.rb
+- lib/context_spook/output_context.rb
 - lib/context_spook/toon.rb
 - lib/context_spook/utils.rb
+- lib/context_spook/verbose_puts.rb
 - lib/context_spook/version.rb
 - spec/context_spook/generator_spec.rb
+- spec/context_spook/toon_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/flori/context_spook
 licenses:
@@ -249,4 +254,5 @@ specification_version: 4
 summary: context_spook collects project context for AI
 test_files:
 - spec/context_spook/generator_spec.rb
+- spec/context_spook/toon_spec.rb
 - spec/spec_helper.rb