context_spook 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf46500652e697db299ccdfe21d5dd4c02953b699ca528b21810f87348eddceb
-  data.tar.gz: ad41e6c9f6141ba5303c845aaf26c2d141125201d82575834a62efc05c2ae7b8
+  metadata.gz: 58670ead7c97c0681f39da47670f4afeb1ac08d1dc3ab8ddcb740fa2bf679a00
+  data.tar.gz: 48db4e54b8a5bbdfe2dcd3e58196d0f42801ada41668d4e43338adb68a9acd82
 SHA512:
-  metadata.gz: edab814b82519dc36f9bb01c4e59dfb372aad6c2e1fa0d8ef7f487a288281ad6bf9bf1474d09a7ff7b818c1a6140ef08c0ba464b986e9bf56a34bd2720f9e778
-  data.tar.gz: 052e05ca7fc2825a75b43e1b9a8585344f9d4e8a6a805e3a5d826680d81bfed723d4359db7083d6451ce4afa6e35e82688a979dae0fcd0dcde401784d373b2de
+  metadata.gz: c6f4d3fc5143082767f5bd361575a130d37710eeeb36965a2d5cb578ddcea5716047b17f6220d4a2a82ad857685d58dae7ae77e53bb355f1c7e54807b941b0d8
+  data.tar.gz: e50fe54b405153348f1936023c81330b67bfe0f7dc620cf9d85cb929cb7558383c6a2ec65b37e4502a7fd5608ec8028935f56e229a4f9e0c4734948ce3176f77

data/.contexts/project.rb

@@ -45,5 +45,9 @@ context do
 
   meta nixda_json: json('nixda_json.json')
 
+  meta hey_world: yaml('hey_world.yaml')
+
+  meta nixda_yaml: yaml('nixda_yaml.yaml')
+
   meta code_coverage: json('coverage/coverage_context.json')
 end

data/Rakefile

@@ -36,6 +36,7 @@ GemHadar do
   dependency 'term-ansicolor', '~> 1.11'
   dependency 'mize',           '~> 0.6'
   dependency 'mime-types',     '~> 3.0'
+  dependency 'yaml',           '~> 0.4'
   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 0.5.0 ruby lib
+# stub: context_spook 0.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "context_spook".freeze
-  s.version = "0.5.0".freeze
+  s.version = "0.6.1".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/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, "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.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.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]
@@ -34,4 +34,5 @@ Gem::Specification.new do |s|
   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])
+  s.add_runtime_dependency(%q<yaml>.freeze, ["~> 0.4".freeze])
 end

data/hey_world.yaml

@@ -0,0 +1,2 @@
+---
+hey: world

data/lib/context_spook/generator.rb

@@ -3,12 +3,37 @@ require 'term/ansicolor'
 require 'json'
 require 'mize'
 require 'mime-types'
+require 'yaml'
 
 # 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.
   #
@@ -32,10 +57,11 @@ 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)
+    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:).send(:parse, File.read(filename))
                 else
                   Generator.send(:new, verbose:, &block)
                 end
@@ -48,6 +74,8 @@ module ContextSpook
   # project metadata, file contents, command outputs, and variables for AI
   # assistance.
   class Generator
+    include VerbosePuts
+
     private_class_method :new
 
     # The initialize method sets up the object by evaluating the provided block
@@ -58,7 +86,7 @@ module ContextSpook
     # @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
+      @verbose = !!verbose
       block and instance_eval(&block)
     end
 
@@ -70,7 +98,7 @@ module ContextSpook
     def context(&block)
       if block
         @context and raise ArgumentError, "only one context allowed"
-        @context = Context.new(&block)
+        @context = Context.new(verbose: @verbose, &block)
       else
         @context
       end
@@ -87,24 +115,27 @@ module ContextSpook
       json_content_size = Tins::Unit.format(
         context_size, format: '%.2f %U', unit: ?b, prefix: 1024
       )
-      if @verbose
-        STDERR.puts "Built #{json_content_size} of JSON context in total."
-      end
+      verbose_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.
     class Context
+      include VerbosePuts
       include Tins::Scope
       include Tins::DSLAccessor
       include Term::ANSIColor
 
-      # The initialize method sets up the object by evaluating a block in the
-      # object's context.
+      # The initialize method sets up the object by evaluating the provided block
+      # in the object's context.
       #
-      # @param block [ Proc ] A block to be evaluated within the object's context.
-      def initialize(&block)
+      # @param verbose [ TrueClass, FalseClass ] flag to enable verbose output
+      #   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
         block and instance_eval(&block)
       end
 
@@ -173,14 +204,34 @@ module ContextSpook
         file_size = Tins::Unit.format(
           File.size(filename), format: '%.2f %U', unit: ?b, prefix: 1024
         )
-        if @verbose
-          STDERR.puts "Read #{filename.inspect} as JSON (%s) for context." % file_size
-        end
+        verbose_puts "Read #{filename.inspect} as JSON (%s) for context." % file_size
         JSON.load_file(filename)
-      rescue Errno::ENOENT => e
-        if @verbose
-          STDERR.puts color(208) { "Reading #{filename.inspect} as JSON caused #{e.class}: #{e}" }
-        end
+      rescue Errno::ENOENT, JSON::ParserError => e
+        verbose_puts color(208) { "Reading #{filename.inspect} as JSON caused #{e.class}: #{e}" }
+        nil
+      end
+
+      # The yaml method reads and parses a YAML file, returning the resulting
+      # data structure.
+      #
+      # This method attempts to load a YAML file from the specified path and
+      # returns the resulting Ruby data structure. It provides verbose output
+      # about the file size when successfully reading the file. In case of file
+      # not found errors or YAML syntax errors, it outputs a colored warning
+      # message to standard error and returns nil.
+      #
+      # @param filename [ String ] the path to the YAML file to be read and parsed
+      #
+      # @return [ Object, nil ] the parsed YAML data structure or nil if the
+      #   file cannot be read
+      def yaml(filename)
+        file_size = Tins::Unit.format(
+          File.size(filename), format: '%.2f %U', unit: ?b, prefix: 1024
+        )
+        verbose_puts "Read #{filename.inspect} as YAML (%s) for context." % file_size
+        YAML.load_file(filename)
+      rescue Errno::ENOENT, Psych::SyntaxError => e
+        verbose_puts color(208) { "Reading #{filename.inspect} as YAML caused #{e.class}: #{e}" }
         nil
       end
 
@@ -214,14 +265,10 @@ module ContextSpook
         file_size = Tins::Unit.format(
           content.size, format: '%.2f %U', unit: ?b, prefix: 1024
         )
-        if @verbose
-          STDERR.puts "Read #{filename.inspect} (%s) for context." % file_size
-        end
+        verbose_puts "Read #{filename.inspect} (%s) for context." % file_size
         nil
       rescue Errno::ENOENT => e
-        if @verbose
-          STDERR.puts color(208) { "Reading #{filename.inspect} caused #{e.class}: #{e}" }
-        end
+        verbose_puts color(208) { "Reading #{filename.inspect} caused #{e.class}: #{e}" }
       end
 
       # The commands method sets up a DSL accessor for provided command outputs.
@@ -244,11 +291,9 @@ module ContextSpook
         output = `#{shell_command}`
         exit_code = $?&.exitstatus.to_i
         if exit_code != 0
-          if @verbose
-            STDERR.puts color(208) {
-              "Executing #{shell_command.inspect} resulted in exit code #{exit_code}."
-            }
-          end
+          verbose_puts color(208) {
+            "Executing #{shell_command.inspect} resulted in exit code #{exit_code}."
+          }
         end
         commands[shell_command] = {
           namespace: scope_top,
@@ -260,9 +305,7 @@ module ContextSpook
         output_size = Tins::Unit.format(
           output.size, format: '%.2f %U', unit: ?b, prefix: 1024
         )
-        if @verbose
-          STDERR.puts "Executed #{shell_command.inspect} with output (%s) for context." % output_size
-        end
+        verbose_puts "Executed #{shell_command.inspect} with output (%s) for context." % output_size
         nil
       end
 

data/lib/context_spook/version.rb

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

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe ContextSpook::Generator do
   let :context do
-    ContextSpook.generate_context('.contexts/project.rb')
+    ContextSpook.generate_context('.contexts/project.rb', verbose: true)
   end
 
   it 'context can be generated from block' do
@@ -76,5 +76,37 @@ describe ContextSpook::Generator do
     it 'can have metada' do
       expect(context.metadata[:ruby]).to eq RUBY_DESCRIPTION
     end
+
+    it 'can have json metadata' do
+      expect(context.metadata[:hello_world]).to eq("hello" => "world")
+    end
+
+    it 'can have yaml metadata' do
+      expect(context.metadata[:hey_world]).to eq("hey" => "world")
+    end
+
+    it 'handles missing json files gracefully' do
+      expect(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
+      end
+    end
+
+    it 'handles missing yaml files gracefully' do
+      expect(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
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: context_spook
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Florian Frank
@@ -149,6 +149,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: |
   context_spook is a library that collects and organizes project
   information to help AI assistants understand codebases better.
@@ -170,6 +184,7 @@ files:
 - bin/context_spook
 - context_spook.gemspec
 - hello_world.json
+- hey_world.yaml
 - lib/context_spook.rb
 - lib/context_spook/generator.rb
 - lib/context_spook/version.rb