appydave-tools 0.10.4 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40337ac9a46d2a5d2b7a645b14e572f011c84b52e958ba880be666d6dfe3413b
-  data.tar.gz: 4e4e4bd076cae97a6cdec63dd70313f49efcbb19fb6295ffd1ef297dbbf08e42
+  metadata.gz: eee6c36595a4e874d3c74f65698ca89d68f8c324a4d0482fa77f8f53de8a3029
+  data.tar.gz: 744aaa75b3c1ec2dc9ac065b2931fcdef45b4ad713bcbb5771d3fef96de10bbd
 SHA512:
-  metadata.gz: 86448501dd1959eb0173ed98af2dead6965b56bf9cfcdc5007d335b73ecd94f8bb7e5cda9f099997285509e93f7ecff1368740fbe38c16c5e4240b1578462116
-  data.tar.gz: 9e32acedc6fbc3b7e21123a56f068e7c91a6b6b4cc58a7315102a08b9455950f531755c5d1405b66dd52a9df60132aab08395877f771d8b096bb364aa6e83e7e
+  metadata.gz: ce5e8b078060a8f548c350bfcad02efce169c3d8922f1177656ed76df44adbaac99ba1712a2247f3f1af6eb1a819c6a5ff0e4b1d46a02709d2ff972cd4f22ae1
+  data.tar.gz: aa8422a814f69703c3444ace26576eda05c1777d81eb15178582331ec0b60bab47d89918debb31d4a4707ea7a6bf69186a17c05e2c7faacd414fa5b668b06c1d

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+# [0.11.0](https://github.com/klueless-io/appydave-tools/compare/v0.10.4...v0.11.0) (2024-10-16)
+
+
+### Bug Fixes
+
+* gpt context improvements ([1a1db97](https://github.com/klueless-io/appydave-tools/commit/1a1db976317d1b6056d14e226a5635c3b7dea83d))
+
+
+### Features
+
+* gpt_context has improved options, this may break some previous calls ([21c984a](https://github.com/klueless-io/appydave-tools/commit/21c984a61d215da93783a3df55f10301cae55e1c))
+
+## [0.10.4](https://github.com/klueless-io/appydave-tools/compare/v0.10.3...v0.10.4) (2024-10-09)
+
+
+### Bug Fixes
+
+* cleanup code base before building documenation ([e473c44](https://github.com/klueless-io/appydave-tools/commit/e473c44546d8f0f5a35461fae263c348e7e2c58f))
+* cleanup code base before building documenation ([38d8fb4](https://github.com/klueless-io/appydave-tools/commit/38d8fb46929e7c055308aa0b918c18a56fcd5842))
+* cleanup code base before building documenation ([8dad12a](https://github.com/klueless-io/appydave-tools/commit/8dad12aadb9952f0174df45caed91c9e96070294))
+* cleanup code base before building documenation ([eddfcc7](https://github.com/klueless-io/appydave-tools/commit/eddfcc78e39c93bfd4de6482690cc66cf90cc54a))
+* extend prompt tools ([a628d08](https://github.com/klueless-io/appydave-tools/commit/a628d08fcdda521b7d148f0bab3261b879fca07d))
+* extending bank reconciliation ([b435a20](https://github.com/klueless-io/appydave-tools/commit/b435a20237ef40a8a7d0a4f365ccd3eafdfcce1a))
+* extending bank reconciliation ([b7878df](https://github.com/klueless-io/appydave-tools/commit/b7878dff0bca4ff1a3af7db19c280a8c245b6c3b))
+
 ## [0.10.3](https://github.com/klueless-io/appydave-tools/compare/v0.10.2...v0.10.3) (2024-06-17)
 
 

data/README.md

@@ -33,8 +33,7 @@ See all [stories](./STORIES.md)
 
 ## Usage
 
-See all [usage examples](./USAGE.md)
-
+- [GPT Context Gatherer](./docs/usage/gpt-context.md)
 
 
 ## Development

data/bin/gpt_context.rb

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# GPT Chats:
+# https://chatgpt.com/c/670df475-04f4-8002-a758-f5711bf433eb
+
 # Usage:
 #   ./bin/gpt_context.rb -d -i 'lib/openai_101/tools/**/*.rb'
 #   ./bin/gpt_context.rb -d -i 'lib/openai_101/tools/**/*' -e 'node_modules/**/*' -e 'package-lock.json' -e 'lib/openai_101/tools/prompts/*.txt'
@@ -11,39 +14,42 @@ $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 require 'appydave/tools'
 
-options = {
-  include_patterns: [],
-  exclude_patterns: [],
-  format: 'tree,content',
-  line_limit: nil,
-  debug: 'none'
-}
+options = Appydave::Tools::GptContext::Options.new(
+  working_directory: nil
+)
 
 OptionParser.new do |opts|
   opts.banner = 'Usage: gather_content.rb [options]'
 
   opts.on('-i', '--include PATTERN', 'Pattern or file to include (can be used multiple times)') do |pattern|
-    options[:include_patterns] << pattern
+    options.include_patterns << pattern
   end
 
   opts.on('-e', '--exclude PATTERN', 'Pattern or file to exclude (can be used multiple times)') do |pattern|
-    options[:exclude_patterns] << pattern
+    options.exclude_patterns << pattern
   end
 
-  opts.on('-f', '--format FORMAT', 'Output format: content or tree, if not provided then both are used') do |format|
-    options[:format] = format
+  opts.on('-f', '--format FORMAT', 'Output format: content, tree, or json, if not provided then both are used') do |format|
+    options.format = format
   end
 
   opts.on('-l', '--line-limit LIMIT', 'Limit the number of lines included from each file') do |limit|
-    options[:line_limit] = limit.to_i
+    options.line_limit = limit.to_i
   end
 
-  # None - No debug output
-  # Output - Output the content to the console, this is the same as found in the clipboard
-  # Params - Output the options that were passed to the script
-  # Debug - Output content, options and debug information
-  opts.on('-d', '--debug [MODE]', 'Enable debug mode [none, output, params, debug]', 'none', 'output', 'params', 'debug') do |debug|
-    options[:debug] = debug || 'output'
+  # New option for specifying base directory
+  opts.on('-b', '--base-dir DIRECTORY', 'Set the base directory to gather files from') do |directory|
+    options.working_directory = directory
+  end
+
+  # Debug output options
+  opts.on('-d', '--debug [MODE]', 'Enable debug mode [none, info, params, debug]', 'none', 'info', 'params', 'debug') do |debug|
+    options.debug = debug || 'info'
+  end
+
+  # Output targets: clipboard or file
+  opts.on('-o', '--output TARGET', 'Output target: clipboard, or a file path (can be used multiple times)') do |target|
+    options.output_target << target
   end
 
   opts.on_tail('-h', '--help', 'Show this message') do
@@ -59,7 +65,7 @@ OptionParser.new do |opts|
   end
 end.parse!
 
-if options[:include_patterns].empty? && options[:exclude_patterns].empty? && options[:format].nil?
+if options.include_patterns.empty? && options.exclude_patterns.empty? && options.format.nil?
   script_name = File.basename($PROGRAM_NAME, File.extname($PROGRAM_NAME))
 
   puts 'No options provided to GPT Context. Please specify patterns to include or exclude.'
@@ -67,24 +73,25 @@ if options[:include_patterns].empty? && options[:exclude_patterns].empty? && opt
   exit
 end
 
-pp options if options[:debug] == 'params'
+if options.output_target.empty?
+  puts 'No output target provided. Will default to `clipboard`. You can set the output target using -o'
+  options.output_target << 'clipboard'
+end
+
+pp options if options.debug == 'params'
 
-gatherer = Appydave::Tools::GptContext::FileCollector.new(
-  include_patterns: options[:include_patterns],
-  exclude_patterns: options[:exclude_patterns],
-  format: options[:format],
-  line_limit: options[:line_limit],
-  working_directory: Dir.pwd
-)
+options.working_directory ||= Dir.pwd
 
+gatherer = Appydave::Tools::GptContext::FileCollector.new(options)
 content = gatherer.build
 
-if %w[output debug].include?(options[:debug])
+if %w[info debug].include?(options.debug)
   puts '-' * 80
   puts content
   puts '-' * 80
 end
 
-pp options if options[:debug] == 'debug'
+output_handler = Appydave::Tools::GptContext::OutputHandler.new(content, options)
+output_handler.execute
 
-Clipboard.copy(content)
+pp options if options.debug == 'debug'

data/docs/usage/gpt-context.md

@@ -0,0 +1,96 @@
+# GPT Context Usage Guide
+
+This guide provides a comprehensive reference for using the `gpt_context` tool. Below you'll find examples of different use cases and command line invocations to help you effectively use `gpt_context` for gathering and organizing your project files. These examples will help you remember how to leverage various options available in `gpt_context`.
+
+## Overview
+
+`gpt_context` is a command line utility designed to collect, filter, and organize context from different files within a project. It allows for gathering files based on include and exclude patterns, visualizing the project structure, and exporting collected information in multiple formats, such as content, tree, or JSON.
+
+### Common Options
+- **`-i` or `--include`**: Specify patterns or files to include (multiple entries allowed).
+- **`-e` or `--exclude`**: Specify patterns or files to exclude (multiple entries allowed).
+- **`-f` or `--format`**: Define output format (`content`, `tree`, or `json`). If not provided, then `tree` followed by `content` is used by defaultboth are used by default.
+- **`-d` or `--debug`**: Enable debug mode (e.g., `info`, `params`, `debug`). The default is `info` and this is how output to console is invoked. (Yes I know, it should be part of the --output option as well)
+- **`-o` or `--output`**: Set the output target (`clipboard` or a file path). The default is `clipboard`, I know this is potentially desctructive.
+- **`-l` or `--line-limit`**: Limit the number of lines included from each file.
+- **`-b` or `--base-dir`**: Set the base directory to gather files from. Current working directory is used if not supplied
+
+## Usage Examples
+
+### 1. Gathering File Contents
+To gather the content of specific files and print it to the console, you can use the `-f content` format option:
+
+```sh
+$ gpt_context -i "**/gpt_context.rb" -i "**/gpt_context/*.rb" -d -f content
+```
+**Explanation**: This command collects the content of all Ruby files matching the specified patterns (`gpt_context.rb` and files in the `gpt_context` directory). It includes debug output (`-d`) to log the content to the console during execution. The is stored in the clipboard in content format.
+
+### 2. Displaying Directory Structure as a Tree
+To visualize the structure of the included files as a tree, use the `-f tree` option:
+
+```sh
+$ gpt_context -i "**/gpt_context.rb" -i "**/gpt_context/*.rb" -d -f tree
+```
+**Explanation**: This command collects files based on the patterns and using the `-d` prints them in a tree-like structure. The tree is also loaded into the clipboard by default. This is useful for understanding the overall organization of files within the project. 
+
+### 3. Exporting File Data as JSON
+You can export the gathered file data as JSON by using the `-f json` format option, along with specifying an output file:
+
+```sh
+$ gpt_context -i "**/gpt_context.rb" -i "**/gpt_context/*.rb" -f json -o somefile.json
+```
+**Explanation**: This command collects files and outputs the gathered data in JSON format. The result is saved to `somefile.json` (`-o somefile.json`). There is no `-d` so there will be no console output, also the `-o` will replace the default which is `clipboard` and so the only output in this case is the file which will go into the working directory. This is helpful when you need a structured representation of your project files, such as for further processing or analysis.
+
+### 4. Combining Multiple Formats
+You can generate multiple formats at once by specifying them in a comma-separated list:
+
+```sh
+$ gpt_context -i "**/gpt_context.rb" -i "**/gpt_context/*.rb" -f tree,content
+```
+**Explanation**: This command gathers the files and produces both a tree view and concatenated content output. The combined output can help visualize both the structure and content of your project files. This would be the default if you did not use `-f`, but interestling you can reverse them `-f content,tree` if you want the tree at the bottom of the concatenated output.
+
+### 5. Limiting the Number of Lines Collected
+To limit the number of lines collected from each file, use the `-l` option:
+
+```sh
+$ gpt_context -i "**/*.rb" -l 10
+```
+**Explanation**: This command gathers the first 10 lines from each Ruby file in the current directory and its subdirectories. This can be useful for getting an overview without including complete files.
+
+### 6. Setting the Working Directory
+You can specify a base directory to gather files from by using the `-b` option:
+
+```sh
+$ gpt_context -b "lib/" -i "**/*.rb" -f tree
+```
+**Explanation**: This command sets the base directory to `lib/` and gathers all Ruby files within it, displaying the output in a tree format. This helps scope your collection to a specific part of your project.
+
+## Debugging Tips
+- **Debugging Mode**: The `-d` option can be followed by levels like `info`, `params`, or `debug` to control the verbosity of debug output.
+  - `params`: Prints out the parameters being used.
+  - `debug`: Provides detailed output, which can be helpful for troubleshooting issues.
+
+Example:
+```sh
+$ gpt_context -i "**/*.rb" -d debug -f content
+```
+This will provide detailed debug output while collecting file contents.
+
+## Output Targets
+- **Clipboard**: By default, if no output target is specified, the content is copied to the clipboard.
+- **File Output**: Use the `-o` option with a file path to save the output to a file.
+
+Example:
+```sh
+$ gpt_context -i "**/*.rb" -o output.txt
+```
+This saves the gathered content to `output.txt`.
+
+## Summary
+The `gpt_context` tool is versatile for gathering, visualizing, and exporting project context in various formats. Whether you need a structured view of your files, a quick JSON export, or just the content concatenated, these examples should help you remember how to leverage the tool's full capabilities effectively.
+
+Feel free to expand this guide with more examples as you explore new ways to use `gpt_context`!
+
+## References
+
+- [ChatGPT Documentation](https://chatgpt.com/c/670f2150-08b4-8002-b2d7-04aff6fe304f)

data/lib/appydave/tools/gpt_context/file_collector.rb

@@ -6,32 +6,33 @@ module Appydave
     module GptContext
       # Gathers file names and content based on include and exclude patterns
       class FileCollector
-        attr_reader :include_patterns, :exclude_patterns, :format, :working_directory, :line_limit
-
-        def initialize(include_patterns: [], exclude_patterns: [], format: 'tree,content', working_directory: nil, line_limit: nil)
-          @include_patterns = include_patterns
-          @exclude_patterns = exclude_patterns
-          @format = format
-          @working_directory = working_directory
-          @line_limit = line_limit
+        def initialize(options)
+          @options = options
+          @include_patterns = options.include_patterns
+          @exclude_patterns = options.exclude_patterns
+          @format = options.format
+          @working_directory = options.working_directory
+          @line_limit = options.line_limit
         end
 
         def build
-          FileUtils.cd(working_directory) if working_directory && Dir.exist?(working_directory)
+          FileUtils.cd(@working_directory) if @working_directory && Dir.exist?(@working_directory)
 
-          formats = format.split(',')
+          formats = @format.split(',')
           result = formats.map do |fmt|
             case fmt
             when 'tree'
               build_tree
             when 'content'
               build_content
+            when 'json'
+              build_json
             else
               ''
             end
           end.join("\n\n")
 
-          FileUtils.cd(Dir.home) if working_directory
+          FileUtils.cd(Dir.home) if @working_directory
 
           result
         end
@@ -41,7 +42,7 @@ module Appydave
         def build_content
           concatenated_content = []
 
-          include_patterns.each do |pattern|
+          @include_patterns.each do |pattern|
             Dir.glob(pattern).each do |file_path|
               next if excluded?(file_path) || File.directory?(file_path)
 
@@ -55,7 +56,7 @@ module Appydave
 
         def read_file_content(file_path)
           lines = File.readlines(file_path)
-          return lines.first(line_limit).join if line_limit
+          return lines.first(@line_limit).join if @line_limit
 
           lines.join
         end
@@ -63,7 +64,7 @@ module Appydave
         def build_tree
           tree_view = {}
 
-          include_patterns.each do |pattern|
+          @include_patterns.each do |pattern|
             Dir.glob(pattern).each do |file_path|
               next if excluded?(file_path)
 
@@ -93,8 +94,35 @@ module Appydave
           output
         end
 
+        def build_json
+          json_output = {
+            'tree' => {},
+            'content' => []
+          }
+
+          # Building tree structure in JSON
+          @include_patterns.each do |pattern|
+            Dir.glob(pattern).each do |file_path|
+              next if excluded?(file_path)
+
+              path_parts = file_path.split('/')
+              insert_into_tree(json_output['tree'], path_parts)
+
+              # Building content structure in JSON
+              next if excluded?(file_path) || File.directory?(file_path)
+
+              json_output['content'] << {
+                'file' => file_path,
+                'content' => read_file_content(file_path)
+              }
+            end
+          end
+
+          JSON.pretty_generate(json_output)
+        end
+
         def excluded?(file_path)
-          exclude_patterns.any? { |pattern| File.fnmatch(pattern, file_path, File::FNM_PATHNAME | File::FNM_DOTMATCH) }
+          @exclude_patterns.any? { |pattern| File.fnmatch(pattern, file_path, File::FNM_PATHNAME | File::FNM_DOTMATCH) }
         end
       end
     end

data/lib/appydave/tools/gpt_context/options.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Appydave
+  module Tools
+    module GptContext
+      # Struct with keyword_init: true to allow named parameters
+      Options = Struct.new(
+        :include_patterns,
+        :exclude_patterns,
+        :format,
+        :line_limit,
+        :debug,
+        :output_target,
+        :working_directory,
+        keyword_init: true
+      ) do
+        def initialize(**args)
+          super
+          self.include_patterns ||= []
+          self.exclude_patterns ||= []
+          self.format ||= 'tree,content'
+          self.debug ||= 'none'
+          self.output_target ||= []
+        end
+      end
+    end
+  end
+end

data/lib/appydave/tools/gpt_context/output_handler.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Appydave
+  module Tools
+    module GptContext
+      # OutputHandler is responsible for writing the output to the desired target
+      class OutputHandler
+        def initialize(content, options)
+          @content = content
+          @output_targets = options.output_target
+          @working_directory = options.working_directory
+        end
+
+        def execute
+          @output_targets.each do |target|
+            case target
+            when 'clipboard'
+              Clipboard.copy(@content)
+            when /^.+$/
+              write_to_file(target)
+            end
+          end
+        end
+
+        private
+
+        attr_reader :content, :output_targets, :working_directory
+
+        def write_to_file(target)
+          resolved_path = Pathname.new(target).absolute? ? target : File.join(working_directory, target)
+          File.write(resolved_path, content)
+        end
+      end
+    end
+  end
+end

data/lib/appydave/tools/version.rb

@@ -2,6 +2,6 @@
 
 module Appydave
   module Tools
-    VERSION = '0.10.4'
+    VERSION = '0.11.1'
   end
 end

data/lib/appydave/tools.rb

@@ -7,6 +7,7 @@ require 'json'
 require 'open3'
 require 'openai'
 require 'optparse'
+require 'pathname'
 require 'k_log'
 require 'active_model'
 
@@ -34,7 +35,9 @@ require 'appydave/tools/cli_actions/prompt_completion_action'
 require 'appydave/tools/cli_actions/get_video_action'
 require 'appydave/tools/cli_actions/update_video_action'
 
+require 'appydave/tools/gpt_context/options'
 require 'appydave/tools/gpt_context/file_collector'
+require 'appydave/tools/gpt_context/output_handler'
 
 require 'appydave/tools/configuration/openai'
 require 'appydave/tools/configuration/configurable'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "appydave-tools",
-  "version": "0.10.4",
+  "version": "0.11.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appydave-tools",
-      "version": "0.10.4",
+      "version": "0.11.1",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.3",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appydave-tools",
-  "version": "0.10.4",
+  "version": "0.11.1",
   "description": "AppyDave YouTube Automation Tools",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appydave-tools
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.11.1
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -165,6 +165,7 @@ files:
 - bin/subtitle_master.rb
 - bin/youtube_automation.rb
 - bin/youtube_manager.rb
+- docs/usage/gpt-context.md
 - images.log
 - lib/appydave/tools.rb
 - lib/appydave/tools/cli_actions/_doc.md
@@ -184,6 +185,8 @@ files:
 - lib/appydave/tools/debuggable.rb
 - lib/appydave/tools/gpt_context/_doc.md
 - lib/appydave/tools/gpt_context/file_collector.rb
+- lib/appydave/tools/gpt_context/options.rb
+- lib/appydave/tools/gpt_context/output_handler.rb
 - lib/appydave/tools/llm/models/llm_info.rb
 - lib/appydave/tools/llm/openai_completion.rb
 - lib/appydave/tools/name_manager/_doc.md