context_spook 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94058fa45fd85552ea4e54d5f67d991d90d7d29a8a344490c71942a568032755
-  data.tar.gz: a12296d4822f6cc01294ecc8c6bb3d544f894eebcaaaddc83956420b33c28c56
+  metadata.gz: ce46a8a82422662465714da76e66762d8ce6ca9f44b2231c1064ca774e45696e
+  data.tar.gz: 3e6c9fbb246330a69232b4ddc4527aea2bc83385293b8a2d16829cd1f47dc3f4
 SHA512:
-  metadata.gz: b9f81bb6d859590f83b7febf9dbfeac3223da9624d4d6851204ad5e255b22dcff2db3d4c0eb4c741228edaac07a23565ab56abe9946b2e8b9059973c6f82de2e
-  data.tar.gz: 3439f27cac24f0d78e3a3fa99586d6d20aa9b3a33ebe4892a2757614c27eaba9073cffeb5da81d5502c5e245d8c38c282e6964656227e24e42d90a512ea686b7
+  metadata.gz: 22b6f481325481fbb323cc354c404a7c87a595a5546b9c70f0cfe99b3ef2e1871dd653864dfa460f45df23a10c3573a497cefb46e83b7b7e24fb2d69892279fe
+  data.tar.gz: 1f8228f7e8300d887865bf262b148433ab06ef680b3bf593b404a60732f5751b66384d668366b37168195fb463b168bbe9bd8211bbf6402c8d6cc4b95016daec

data/README.md

@@ -127,20 +127,20 @@ File.write 'context.json', context.to_json
 Generate context and save to file:
 
 ```bash
-./bin/context_spook .contexts/project.rb > context.json
+context_spook .contexts/project.rb > context.json
 ```
 
 Or pipe directly to another tool:
 
 ```bash
-./bin/context_spook .contexts/project.rb | ollama_chat_send
+context_spook .contexts/project.rb | ollama_chat_send
 ```
 
 The CLI tool also supports verbose output:
 
 ```bash
 # Generate context without verbose output
-./bin/context_spook .contexts/project.rb ~v
+context_spook .contexts/project.rb ~v
 ```
 
 Now you can see two orange warning messages, that demonstrates how errors like
@@ -150,7 +150,7 @@ The CLI tool also supports file redirection:
 
 ```bash
 # Generate context and save to file
-./bin/context_spook .contexts/project.rb -o context.json
+context_spook .contexts/project.rb -o context.json
 ```
 
 You can also use include patterns to automatically collect files without
@@ -158,22 +158,33 @@ manually specifying each one:
 
 ```bash
 # Collect all Ruby files from lib/ and spec/ directories
-./bin/context_spook -i 'lib/**/*.rb' -i 'spec/**/*.rb'
+context_spook -i 'lib/**/*.rb' -i 'spec/**/*.rb'
 
 # Collect Markdown and YAML files from current directory
-./bin/context_spook -i '*.md' -i '*.yaml' -i '*.yml'
+context_spook -i '*.md' -i '*.yaml' -i '*.yml'
 
 # Collect files with complex patterns
-./bin/context_spook -i 'lib/**/{*.rb,*.rake}'     # Brace expansion
-./bin/context_spook -i 'lib/**/*_spec.rb'         # Pattern matching
-./bin/context_spook -i 'lib/**/*.rb' -i 'spec/**/*_spec.rb'  # Mixed patterns
+context_spook -i 'lib/**/{*.rb,*.rake}'     # Brace expansion
+context_spook -i 'lib/**/*_spec.rb'         # Pattern matching
+context_spook -i 'lib/**/*.rb' -i 'spec/**/*_spec.rb'  # Mixed patterns
 ```
 
+### Size Estimation
+
+To estimate the size of your context without generating the large output file:
+
+```bash
+# Show context size information only
+context_spook .contexts/project.rb -S
+```
+
+This is useful for optimizing context size before committing to large output files.
+
 This is how you can show the usage message:
 
 ```
 # Show help
-./bin/context_spook -h
+context_spook -h
 ```
 
 ## What Gets Collected
@@ -232,4 +243,4 @@ assistants understand:
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](./LICENSE)
+The gem is available as open source under the terms of the [MIT License](LICENSE)

data/Rakefile

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

data/bin/context_spook

@@ -22,10 +22,12 @@ def usage
 
   Options:
     -o FILE      Write output to FILE instead of stdout
-    ~v           Disable verbose output, enabled by default
-    -h           Show this help message
+    ~v           Disable verbose informational output, enabled by default
+    -S           suppress output (just show informational output)
     -i PATTERN   Include files matching PATTERN (can be used multiple times)
                  Supports glob patterns like **, *, ?, [abc], {a,b,c}
+    -F FORMAT    Output context as format JSON (the default) or TOON
+    -h           Show this help message
 
   Examples:
     # Generate context and output to stdout
@@ -44,13 +46,16 @@ def usage
     # Generate context without verbose output
     #{File.basename($0)} .contexts/project.rb ~v
 
+    # Generate informational output only to estimate context size
+    #{File.basename($0)} .contexts/project.rb -S
+
     # Generate context and save to file
     #{File.basename($0)} .contexts/project.rb -o context.json
   EOT
   exit 0
 end
 
-opts    = go 'o:i:pvh', defaults: { ?v => true }
+opts    = go 'o:i:F:pvSh', defaults: { ?v => true }
 opts[?h] and usage
 context = nil
 output  = nil
@@ -72,12 +77,26 @@ else
   context = ContextSpook.generate_context(filename, verbose: opts[?v])
 end
 
-if output_filename = opts[?o]
-  if File.exist?(output_filename)
-    fail "Filename #{output_filename.inspect} already exists!"
+if opts[?S]
+  output = NULL
+else
+  if output_filename = opts[?o]
+    if File.exist?(output_filename)
+      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 = File.new output_filename, ?w
+  output.puts context.to_toon
+when /\AJSON\z/i, nil
+  JSON.dump(context.as_json, output)
 else
-  output = STDOUT
+  STDERR.puts "Invalid output format #{opts[?F].inspect}"
 end
-JSON.dump(context.as_json, output)

data/context_spook.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: context_spook 1.0.1 ruby lib
+# stub: context_spook 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "context_spook".freeze
-  s.version = "1.0.1".freeze
+  s.version = "1.2.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -12,8 +12,8 @@ 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/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/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/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.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]
@@ -36,4 +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])
 end

data/lib/context_spook/generator.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'mize'
 require 'mime-types'
 require 'yaml'
+require 'context_spook/toon'
 
 # The ContextSpook module serves as a namespace container for collecting and
 # organizing project information for AI assistance.
@@ -111,11 +112,9 @@ module ContextSpook
     # 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_content_size = Tins::Unit.format(
-        context_size, format: '%.2f %U', unit: ?b, prefix: 1024
-      )
-      verbose_puts "Built #{json_content_size} of JSON context in total."
+      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
@@ -126,6 +125,7 @@ module ContextSpook
       include Tins::Scope
       include Tins::DSLAccessor
       include Term::ANSIColor
+      include ContextSpook::TOON
 
       # The initialize method sets up the object by evaluating the provided block
       # in the object's context.

data/lib/context_spook/toon.rb

@@ -0,0 +1,12 @@
+require 'ruby_json_toon'
+
+module ContextSpook::TOON
+  def to_toon
+    RubyJsonToon.encode(as_json)
+  end
+  memoize method: :to_toon
+
+  def toon_size
+    to_toon.size
+  end
+end

data/lib/context_spook/utils.rb

@@ -0,0 +1,17 @@
+module ContextSpook::Utils
+  module_function
+
+  # The format_size method converts a byte size value into a human-readable
+  # string with binary units.
+  #
+  # This method takes a raw byte count and formats it using the Tins::Unit
+  # library to display the size with appropriate binary prefixes (KiB, MiB,
+  # etc.) and two decimal places.
+  #
+  # @param context_size [ Integer ] the size in bytes to be formatted
+  #
+  # @return [ String ] the formatted size string with binary units
+  def format_size(context_size)
+    Tins::Unit.format(context_size, format: '%.2f %U', unit: ?b, prefix: 1024)
+  end
+end

data/lib/context_spook/version.rb

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

data/lib/context_spook.rb

@@ -1,4 +1,5 @@
 module ContextSpook
 end
 require 'context_spook/version'
+require 'context_spook/utils'
 require 'context_spook/generator'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: context_spook
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Florian Frank
@@ -177,6 +177,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: ruby-json-toon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |
   context_spook is a library that collects and organizes project
   information to help AI assistants understand codebases better.
@@ -188,6 +202,8 @@ extra_rdoc_files:
 - README.md
 - lib/context_spook.rb
 - lib/context_spook/generator.rb
+- lib/context_spook/toon.rb
+- lib/context_spook/utils.rb
 - lib/context_spook/version.rb
 files:
 - ".contexts/project.rb"
@@ -201,6 +217,8 @@ files:
 - hey_world.yaml
 - lib/context_spook.rb
 - lib/context_spook/generator.rb
+- lib/context_spook/toon.rb
+- lib/context_spook/utils.rb
 - lib/context_spook/version.rb
 - spec/context_spook/generator_spec.rb
 - spec/spec_helper.rb