context_spook 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4088e8a4f8de00062dcea1b56b696dd1190731c0c30944a95c60a14cad995fa9
-  data.tar.gz: 996fb30d8a2542a387451416ece827dd1b8062344317ef798db803c216d39e17
+  metadata.gz: acac1bb23044efca6b50d929dfeda70b409cb95fc81f2a18f269d67ca2fb857d
+  data.tar.gz: 80c69f95ab2f595daf33eb5646d0cc0133c0752ea74ac73b4737eb0b2f57cd32
 SHA512:
-  metadata.gz: df6ce1080b5b98a1e279f945cb0e5934592ea586c15abc24234b1c44aaa0d5aac55308227c2966a1e2e9912f620f4d13a5bda0940726028f589aa0ee522dc3fd
-  data.tar.gz: 2b787ae025a227d47f7d6ab53d850bc0c2084a6872e16bb2b60d122965d3dcdb17531fc4118371de82da0edcdd29b7a4ebe143b55019d3116bb424117edb85f4
+  metadata.gz: c68f160740a7b1af14ce1f6260fd08430745e7f338e4151c88a46da708d8635572471400600ad119fcfdd9c33d7f9944ec9fe5ca8710778d61f919403de8c38d
+  data.tar.gz: 20a6c25fc8097d67d6b4111b4d6fd6c15b5ad12512e05b93e68d27f32ca8adb58d9f20255a30b9dfcb679b2c4e89a4108eaaa37fc2388153243ae6812f33b4f7

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.
 
@@ -71,10 +71,10 @@ 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`:
+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
 
@@ -114,7 +114,7 @@ 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
 ```
 
@@ -123,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

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,9 +29,10 @@ GemHadar do
   dependency 'tins',           '~>1.39'
   dependency 'json',           '~>2.0'
   dependency 'term-ansicolor', '~> 1.11'
-  dependency  'mize',          '~> 0.6'
-  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/context_spook.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: context_spook 0.2.0 ruby lib
+# stub: context_spook 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "context_spook".freeze
-  s.version = "0.2.0".freeze
+  s.version = "0.4.0".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 = ["Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/context_spook".freeze, "context_spook.gemspec".freeze, "contexts/project.rb".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, "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]
@@ -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.2".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])
@@ -33,4 +33,5 @@ Gem::Specification.new do |s|
   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/lib/context_spook/generator.rb

@@ -2,6 +2,7 @@ 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.
@@ -186,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(
@@ -236,16 +238,19 @@ 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.
+      #
+      # @param args [ Array ] pass-through arguments
       memoize method:
-      def to_json(*)
-        as_json.to_json(*)
+      def to_json(*args)
+        as_json.to_json(*args)
       end
 
       # The as_json method converts the context's files, commands, and metadata
       # into a hash representation.
       #
+      # @param ignored [ Array ] ignored arguments
       # @return [ Hash ] a hash containing the files, commands, and metadata
-      def as_json(*)
+      def as_json(*ignored)
         {
           files:,
           commands:,

data/lib/context_spook/version.rb

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

@@ -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')
   end
 
   it 'context can be generated from block' do
@@ -34,7 +34,7 @@ describe ContextSpook::Generator do
 
   it 'cannot do from block and filename' do
     expect {
-      ContextSpook.generate_context('contexts/project.rb') { }
+      ContextSpook.generate_context('.contexts/project.rb') { }
     }.to raise_error(ArgumentError, /need either a filename or a &block/)
   end
 
@@ -53,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: context_spook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +135,20 @@ dependencies:
     - - "~>"
       - !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.
@@ -148,13 +162,13 @@ extra_rdoc_files:
 - lib/context_spook/generator.rb
 - lib/context_spook/version.rb
 files:
+- ".contexts/project.rb"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/context_spook
 - context_spook.gemspec
-- contexts/project.rb
 - hello_world.json
 - lib/context_spook.rb
 - lib/context_spook/generator.rb