appydave-tools 0.11.1 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eee6c36595a4e874d3c74f65698ca89d68f8c324a4d0482fa77f8f53de8a3029
-  data.tar.gz: 744aaa75b3c1ec2dc9ac065b2931fcdef45b4ad713bcbb5771d3fef96de10bbd
+  metadata.gz: 769dc5f9807a7ff74b88650593e1db9da4cc81b479df5786a4849e188271bf66
+  data.tar.gz: d461f039fbec1f8afa45c95d64601b6aac7849b125175ce67429432ca625f699
 SHA512:
-  metadata.gz: ce5e8b078060a8f548c350bfcad02efce169c3d8922f1177656ed76df44adbaac99ba1712a2247f3f1af6eb1a819c6a5ff0e4b1d46a02709d2ff972cd4f22ae1
-  data.tar.gz: aa8422a814f69703c3444ace26576eda05c1777d81eb15178582331ec0b60bab47d89918debb31d4a4707ea7a6bf69186a17c05e2c7faacd414fa5b668b06c1d
+  metadata.gz: 7b8ee78c14b791d10b170507ee9525c382b6e9353d68b0fe005ec38a4ec9268cdd8413ca308864ddf2c6c1cf4f4633bd44dd0eaf5375fb6c59f6c5b54bc8854f
+  data.tar.gz: a6253ed35ed13962bec5a5b3ce31f359734bc04106b4e12d58bc8869a9c8df7019b92a0075cf62bd1dc9d119554e0554dced4028daa8f3ec1525f4157d82539f

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.11.2](https://github.com/klueless-io/appydave-tools/compare/v0.11.1...v0.11.2) (2024-10-16)
+
+
+### Bug Fixes
+
+* gpt context documentation updated for using from another gem ([a71072c](https://github.com/klueless-io/appydave-tools/commit/a71072ce24e61dd164f44d7425bad3013f0bdf1f))
+
+## [0.11.1](https://github.com/klueless-io/appydave-tools/compare/v0.11.0...v0.11.1) (2024-10-16)
+
+
+### Bug Fixes
+
+* gpt context documentation ([808fccd](https://github.com/klueless-io/appydave-tools/commit/808fccdea10c472522da02c8af7f9a2c9eaf361a))
+
 # [0.11.0](https://github.com/klueless-io/appydave-tools/compare/v0.10.4...v0.11.0) (2024-10-16)
 
 

data/docs/usage/gpt-context.md

@@ -9,11 +9,11 @@ This guide provides a comprehensive reference for using the `gpt_context` tool.
 ### 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.
+- **`-f` or `--format`**: Define output format (`content`, `tree`, or `json`). If not provided, then `tree` followed by `content` is 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 destructive).
 - **`-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
+- **`-b` or `--base-dir`**: Set the base directory to gather files from. Current working directory is used if not supplied.
 
 ## Usage Examples
 
@@ -23,7 +23,7 @@ To gather the content of specific files and print it to the console, you can use
 ```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.
+**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 result 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:
@@ -39,7 +39,7 @@ You can export the gathered file data as JSON by using the `-f json` format opti
 ```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.
+**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:
@@ -47,7 +47,7 @@ You can generate multiple formats at once by specifying them in a comma-separate
 ```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.
+**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 interestingly, 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:
@@ -91,6 +91,105 @@ The `gpt_context` tool is versatile for gathering, visualizing, and exporting pr
 
 Feel free to expand this guide with more examples as you explore new ways to use `gpt_context`!
 
+## Class-Level Usage Examples
+
+In addition to the command line interface, the `gpt_context` tool provides classes that can be used directly in Ruby code for greater flexibility. Here are some examples of how to use the main classes involved in `gpt_context`.
+
+### 1. Using `FileCollector`
+The `FileCollector` class can be used to gather files programmatically. Below is an example of how to instantiate and use the `FileCollector` class.
+
+```ruby
+require 'appydave/tools'
+
+# Set up options for FileCollector
+options = Appydave::Tools::GptContext::Options.new(
+  include_patterns: ['**/*.rb'],
+  exclude_patterns: ['spec/**/*'],
+  format: 'content',
+  line_limit: 20,
+  working_directory: Dir.pwd
+)
+
+# Create a new FileCollector instance
+collector = Appydave::Tools::GptContext::FileCollector.new(options)
+
+# Gather the file content
+content = collector.build
+
+# Output the collected content
+puts content
+```
+**Explanation**: This script sets up `Options` with specific parameters (including which files to include/exclude and the format), and then creates a `FileCollector` instance to gather the content. The gathered content is printed to the console.
+
+### 2. Setting Up `Options`
+The `Options` class is crucial for configuring how the `FileCollector` behaves. Here’s how you can use the `Options` class:
+
+```ruby
+require 'appydave/tools'
+
+# Create options with specific settings
+options = Appydave::Tools::GptContext::Options.new(
+  include_patterns: ['lib/**/*.rb'],
+  exclude_patterns: ['lib/excluded/**/*.rb'],
+  format: 'tree,content',
+  line_limit: 10,
+  debug: 'info',
+  output_target: ['clipboard'],
+  working_directory: 'lib'
+)
+
+# Display options
+pp options
+```
+**Explanation**: The `Options` class provides named parameters to specify how files should be gathered. This script creates an `Options` instance, which can then be used by `FileCollector` or other components of the tool.
+
+### 3. Using `OutputHandler`
+The `OutputHandler` class is responsible for handling the output after files are gathered. Here is how to use it:
+
+```ruby
+require 'appydave/tools'
+
+# Create options and gather content using FileCollector
+options = Appydave::Tools::GptContext::Options.new(
+  include_patterns: ['**/*.rb'],
+  format: 'content',
+  output_target: ['output.txt']
+)
+
+collector = Appydave::Tools::GptContext::FileCollector.new(options)
+content = collector.build
+
+# Handle output using OutputHandler
+output_handler = Appydave::Tools::GptContext::OutputHandler.new(content, options)
+output_handler.execute
+```
+**Explanation**: This script collects content using `FileCollector` and then uses `OutputHandler` to save the gathered content to `output.txt`. The `OutputHandler` manages different output targets, such as clipboard or files, based on the specified options.
+
+### 4. Combining Classes for Complete Workflow
+Here’s an example of combining `Options`, `FileCollector`, and `OutputHandler` to automate the entire workflow:
+
+```ruby
+require 'appydave/tools'
+
+# Step 1: Create Options
+options = Appydave::Tools::GptContext::Options.new(
+  include_patterns: ['**/*.rb'],
+  exclude_patterns: ['**/test/**/*.rb'],
+  format: 'json',
+  output_target: ['output.json'],
+  debug: 'params'
+)
+
+# Step 2: Gather Files using FileCollector
+collector = Appydave::Tools::GptContext::FileCollector.new(options)
+content = collector.build
+
+# Step 3: Output Results using OutputHandler
+output_handler = Appydave::Tools::GptContext::OutputHandler.new(content, options)
+output_handler.execute
+```
+**Explanation**: This complete example demonstrates how to use `Options` to configure the gathering process, `FileCollector` to collect the files, and `OutputHandler` to manage the output. This approach can be useful for programmatically automating context collection tasks in more complex workflows.
+
 ## References
 
 - [ChatGPT Documentation](https://chatgpt.com/c/670f2150-08b4-8002-b2d7-04aff6fe304f)

data/lib/appydave/tools/subtitle_master/_doc.md

@@ -1,6 +1,11 @@
 # Subtitle Master
 
-[ChatGPT](https://chatgpt.com/c/f80dfca5-8168-4561-b5c6-8efed8672a88)
+Older Chat
+- https://chatgpt.com/c/f80dfca5-8168-4561-b5c6-8efed8672a88
+
+New Features
+- https://chatgpt.com/c/670470b8-a0c4-8002-9678-d4d69c680481
+
 
 ## SubtitleMaster - Clean Component
 

data/lib/appydave/tools/version.rb

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

data/lib/appydave_tools.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'appydave/tools'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "appydave-tools",
-  "version": "0.11.1",
+  "version": "0.11.3",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appydave-tools",
-      "version": "0.11.1",
+      "version": "0.11.3",
       "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.11.1",
+  "version": "0.11.3",
   "description": "AppyDave YouTube Automation Tools",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appydave-tools
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.3
 platform: ruby
 authors:
 - David Cruwys
@@ -211,6 +211,7 @@ files:
 - lib/appydave/tools/youtube_manager/reports/video_details_report.rb
 - lib/appydave/tools/youtube_manager/update_video.rb
 - lib/appydave/tools/youtube_manager/youtube_base.rb
+- lib/appydave_tools.rb
 - package-lock.json
 - package.json
 - sig/appydave/tools.rbs