context_spook 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8061fffaf039f19b3b37a0df7ce5ce62624c04c303fd525a6b2a96b74bbf0fd4
-  data.tar.gz: 72b878f810bd5695aa0a09144fb3eb66475d7e12d73ba1cd1b17694e54a89c00
+  metadata.gz: f52806b7e9dbd38070ca282415d5e05df58824be37f36389e6d7d820030e864c
+  data.tar.gz: 91a2f4016d0affe3d5e0105cbd456dcc73b6a23c580b85909cfcc2190cb195ff
 SHA512:
-  metadata.gz: f5f21ce7d81d9488732ebbe27e2b17096fa6c92afcd2e9dadf0427cad36a33eb48e4e114a7bd687a0fb60a37351297b8cbbcc035e4a6644c530a3007ee2aedc3
-  data.tar.gz: 38bc4a4e00193b70fce74115e8ba8d230dbb06d3c6179cebb1c889b83fb10310fe3d9699f8bbc26ef4d16fbd9c646c080274ea738e56d94fe08381250c7c1a96
+  metadata.gz: 1b2facc2b87f0e3a880b45eeee25e0155baf713f461531343ce4906ce5e6f51a153789def95c4b1741b11f468db7c7d6a7698c8e6dda858f14811e6fd85255f7
+  data.tar.gz: ae47a38687a3911af559d39229ee48abaed1970abd124401d20f3bf8392c7790a765793d9ec5e25ab0c5460e7c41f1ac52f1377827e3414baf5815688fb18fb6

data/README.md

@@ -8,7 +8,7 @@ be exported as structured JSON data.
 The DSL is general-purpose and can be used for any kind of project or
 collection of files, whether software development, documentation, research
 data, educational materials, creative projects, or any other type of organized
-information. The `contexts/project.rb` example below demonstrates how to
+information. The `.contexts/project.rb` example below demonstrates how to
 describe a Ruby project, but the same principles apply across many different
 domains.
 
@@ -32,16 +32,54 @@ $ gem install context_spook
 
 ## Usage
 
-Create a `contexts/project.rb` file that describes your project context using
-the DSL in a context definition file:
+### Programmatic Usage
+
+#### Directly in Ruby
+
+Now you can generate context from a block directly in Ruby using the DSL:
+
+```ruby
+context = ContextSpook::generate_context do
+  context do
+    variable branch: `git rev-parse --abbrev-ref HEAD`.chomp
+    
+    namespace "structure" do
+      command "tree", tags: %w[ project_structure ]
+    end
+    
+    namespace "lib" do
+      Dir['lib/**/*.rb'].each do |filename|
+        file filename, tags: 'lib'
+      end
+    end
+    
+    # ... rest of your context definition, see below for full example
+  end
+end
+```
+
+This approach can be used to dynamically generate a context when it is not
+configurable via a user context definition file, or as a fallback when users
+have not yet created such files.
+
+Afterwards you can store the context as JSON in Ruby or send it to another
+application.
+
+```ruby
+File.write 'context.json', context.to_json
+```
+
+#### From a context definition file
+
+Alternatively store the block's content above to a file `.contexts/project.rb`:
 
 ```ruby
-# contexts/project.rb
+# .contexts/project.rb
 context do
   variable branch: `git rev-parse --abbrev-ref HEAD`.chomp
 
   namespace "structure" do
-    command "tree lib", tags: %w[ project_structure ]
+    command "tree", tags: %w[ project_structure ]
   end
 
   namespace "lib" do
@@ -72,12 +110,11 @@ context do
 end
 ```
 
-### Programmatic Usage
-
-Now you can generate the context from the file, and store it as JSON in Ruby.
+Now you can generate the context from the file, and store it as JSON in Ruby or
+send it to another application.
 
 ```ruby
-context = ContextSpook::generate_context('contexts/project.rb')
+context = ContextSpook::generate_context('.contexts/project.rb')
 File.write 'context.json', context.to_json
 ```
 
@@ -86,13 +123,13 @@ File.write 'context.json', context.to_json
 Generate context and save to file:
 
 ```bash
-./bin/context_spook contexts/project.rb > context.json
+./bin/context_spook .contexts/project.rb > context.json
 ```
 
 Or pipe directly to another tool:
 
 ```
-./bin/context_spook contexts/project.rb | ollama_chat_send
+./bin/context_spook .contexts/project.rb | ollama_chat_send
 ```
 
 You will see two orange warning messages, that demonstrates how errors like
@@ -129,11 +166,13 @@ assistants understand:
       "content": "...",
       "size": 1234,
       "lines": 56,
-      "tags": ["lib"]
+      "tags": [
+        "lib"
+      ]
     }
   },
   "commands": {
-    "tree lib": {
+    "tree": {
       "namespace": "structure",
       "output": "lib\n├── context_spook\n│   └── generator.rb\n└── context_spook.rb\n\n2 directories, 3 files",
       "exit_code": 0,
@@ -142,7 +181,7 @@ assistants understand:
   },
   "metadata": {
     "ruby": "ruby 3.1.0 ...",
-    "code_coverage": { ... }
+    "code_coverage": {}
   },
   "variables": {
     "branch": "main"

data/Rakefile

@@ -19,9 +19,9 @@ GemHadar do
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble', '.bundle',
     '.yardoc', 'doc', 'tags', 'errors.lst', 'cscope.out', 'coverage', 'tmp',
-    'yard'
+    'yard', 'TODO.md'
   package_ignore '.all_images.yml', '.tool-versions', '.gitignore', 'VERSION',
-     '.rspec', *Dir.glob('.github/**/*', File::FNM_DOTMATCH)
+     '.rspec', '.github'
   readme      'README.md'
 
   required_ruby_version  '~> 3.1'
@@ -29,8 +29,10 @@ GemHadar do
   dependency 'tins',           '~>1.39'
   dependency 'json',           '~>2.0'
   dependency 'term-ansicolor', '~> 1.11'
-  development_dependency 'all_images',            '~> 0.6'
-  development_dependency 'rspec',                 '~> 3.2'
+  dependency 'mize',           '~> 0.6'
+  dependency 'mime-types',     '~> 3.0'
+  development_dependency 'all_images', '~> 0.6'
+  development_dependency 'rspec',      '~> 3.2'
   development_dependency 'debug'
   development_dependency 'simplecov'
 

data/bin/context_spook

@@ -4,8 +4,4 @@ require 'context_spook'
 
 filename = ARGV.shift or fail 'require context definition file as first argument'
 context_json = ContextSpook.generate_context(filename).to_json
-context_json_size = Tins::Unit.format(
-  context_json.size, format: '%.2f %U', unit: ?b, prefix: 1024
-)
-STDERR.puts "Now outputting #{context_json_size} of JSON context in total."
 puts context_json

data/context_spook.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: context_spook 0.1.0 ruby lib
+# stub: context_spook 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "context_spook".freeze
-  s.version = "0.1.0".freeze
+  s.version = "0.3.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.0".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.1".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])
@@ -32,4 +32,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.39".freeze])
   s.add_runtime_dependency(%q<json>.freeze, ["~> 2.0".freeze])
   s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.11".freeze])
+  s.add_runtime_dependency(%q<mize>.freeze, ["~> 0.6".freeze])
+  s.add_runtime_dependency(%q<mime-types>.freeze, ["~> 3.0".freeze])
 end

data/contexts/project.rb

@@ -2,7 +2,7 @@ context do
   variable branch: `git rev-parse --abbrev-ref HEAD`.chomp
 
   namespace "structure" do
-    command "tree lib", tags: %w[ project_structure ]
+    command "tree", tags: %w[ project_structure ]
   end
 
   namespace "lib" do

data/lib/context_spook/generator.rb

@@ -1,7 +1,8 @@
 require 'tins/xt'
 require 'term/ansicolor'
 require 'json'
-
+require 'mize'
+require 'mime-types'
 
 # The ContextSpook module serves as a namespace container for collecting and
 # organizing project information for AI assistance.
@@ -19,8 +20,16 @@ module ContextSpook
   #
   # @return [ ContextSpook::Generator::Context ] the context object generated
   # from the file contents
-  def self.generate_context(filename)
-    Generator.send(:new).send(:parse, File.read(filename)).context
+  def self.generate_context(filename = nil, &block)
+    filename.present? ^ block or
+      raise ArgumentError, 'need either a filename or a &block argument'
+    generator = if filename
+                Generator.send(:new).send(:parse, File.read(filename))
+                else
+                  Generator.send(:new, &block)
+                end
+    generator.output_context_size
+    generator.context
   end
 
   # The Generator class provides a DSL parser that interprets context
@@ -52,6 +61,20 @@ module ContextSpook
       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_content_size = Tins::Unit.format(
+        context_size, format: '%.2f %U', unit: ?b, prefix: 1024
+      )
+      STDERR.puts "Built #{json_content_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.
@@ -164,6 +187,7 @@ module ContextSpook
           content:,
           size: content.size,
           lines: content.lines.size,
+          content_types: MIME::Types.type_for(filename).map(&:content_type).full?,
           tags: (Array(tags) if tags),
         }.compact
         file_size = Tins::Unit.format(
@@ -214,6 +238,7 @@ module ContextSpook
       # The to_json method converts the object to a JSON representation by
       # first generating its hash form and then serializing that hash into JSON
       # format.
+      memoize method:
       def to_json(*)
         as_json.to_json(*)
       end
@@ -230,6 +255,19 @@ module ContextSpook
           variables:
         }
       end
+
+      # The size method calculates and returns the byte size of the JSON
+      # representation of the context.
+      #
+      # This method determines the size in bytes of the JSON-serialized version
+      # of the context object, which is useful for understanding the total data
+      # payload being sent to an AI assistant.
+      #
+      # @return [ Integer ] the size in bytes of the JSON representation of the
+      # context
+      def size
+        to_json.size
+      end
     end
 
     private

data/lib/context_spook/version.rb

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

@@ -5,19 +5,46 @@ describe ContextSpook::Generator do
     ContextSpook.generate_context('contexts/project.rb')
   end
 
-  it 'context can be generated' do
+  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'
+      end
+    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 '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 'context be transformed to JSON if loaded' do
     context_as_json = context.to_json
-    expect(context_as_json.size).to be > 1024
+    expect(context.size).to be > 1024
     expect(JSON(context_as_json)).to be_a Hash
   end
 
   describe 'Context' do
-
     it 'can have variables' do
       expect(context.variables[:branch]).to be_present
     end
@@ -26,6 +53,7 @@ describe ContextSpook::Generator do
       file = context.files['lib/context_spook.rb']
       expect(file).to be_present
       expect(file[:content]).to be_present
+      expect(file[:content_types]).to be_present
       expect(file[:size]).to be > 0
       expect(file[:lines]).to be > 0
       expect(file[:namespace]).to eq :lib
@@ -33,7 +61,7 @@ describe ContextSpook::Generator do
     end
 
     it 'can have commands' do
-      command = context.commands['tree lib']
+      command = context.commands['tree']
       expect(command).to be_present
       expect(command[:working_directory]).to eq Dir.pwd
       expect(command[:exit_code]).to be_present

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: context_spook
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +121,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: mize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: |
   context_spook is a library that collects and organizes project
   information to help AI assistants understand codebases better.