gpt_helpr 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 517f6f3290d45ea8b2e9b14e6c77d051ae771948c2f1b37d39ddc27a891d624f
+  data.tar.gz: ab65c67d108926f07ecd777ec3ddfce14192d1a975c76da18ed59f919ee7095f
+SHA512:
+  metadata.gz: d04bcfee6aface86e18e757d5e2427ce048d9bf5f06190fd708353de915477598f14f0459a8d53a5a9cebeb80e01b0b0bf0a2b6a549b6ec78b7cade7e9ce7bba
+  data.tar.gz: 2a4036ccdd1b35bba237c55433c69924b22dc11f6fd28b5e0de4fc98d9f7f97da3759a01f74b653d37f29da693c24b4770d00d7122e36957ab4cc308446cce0b

data/README.md

@@ -0,0 +1,119 @@
+# GPT_Helpr
+
+GPT_Helpr is a Ruby gem that provides a command-line tool for generating formatted programming prompts based on the content of specified files. This tool is particularly useful for efficiently sharing code snippets with detailed explanations.
+
+## Features
+
+- **Interactive Mode**: Easily specify file paths and ranges interactively.
+- **Line Numbers**: Option to include line numbers in the output.
+- **Completion Support**: Supports tab completion for file paths.
+- **Output to File**: Option to write the generated output to a file.
+
+## Installation
+
+1. **Add the Gem to Your Gemfile**
+   ```ruby
+   gem 'gpt_helpr'
+   ```
+
+2. **Install the Gem**
+   ```sh
+   bundle install
+   ```
+
+3. **Or Install Directly via Gem Command**
+   ```sh
+   gem install gpt_helpr
+   ```
+
+## Usage
+
+### Basic Usage
+
+Run the tool in interactive mode:
+```sh
+gpt_helpr --interactive
+```
+
+### Command-Line Arguments
+
+You can also provide file paths and instructions directly via command-line arguments:
+```sh
+gpt_helpr <file1> <re: instructions> / <file2> <re: instructions>
+```
+
+### Options
+
+- `--interactive` or `-i`: Run the tool in interactive mode.
+- `--file` or `-f`: Write the output to a file.
+- `--line-numbers` or `-ln`: Include line numbers in the output.
+
+### Examples
+
+#### Interactive Mode
+
+1. Run the tool:
+
+```
+➜ gpt_helpr -i -ln
+File path (optional :start:end): TAB ->
+Capfile                   INSTALL.md                REVISION                  bin
+Gemfile                   Procfile                  Rakefile                  config
+Gemfile.lock              Procfile.dev              VERSION                   config.ru
+Guardfile                 README.md                 app                       db
+
+File path (optional :start:end): bin/ TAB ->
+bin/bundle         bin/db-backup.sh   bin/db-restore.sh  bin/gpt_helpr         bin/rails          bin/rake           bin/rubocop        bin/s3_sync.sh     bin/setup          bin/update
+
+File path (optional :start:end): bin/gpt_helpr:9:14
+Instructions: can you explain these lines?
+File path (optional :start:end):
+```
+
+2. The output will be:
+```
+   #### file source  `bin/gpt_helpr`
+   9:
+   10: Readline.completion_append_character = nil
+   11: Readline.completion_proc = -> (input) {
+   12:   Dir[input+'*'].grep(/^#{Regexp.escape(input)}/)
+   13: }
+   14:
+
+   can you explain these lines?
+
+   #### end of  `bin/gpt_helpr`
+```
+3. You can add more files and instructions in the same way.
+
+4. The output will be also copied to the clipboard!
+
+#### Command-Line Mode
+
+1. Generate output for specified files:
+   ```sh
+   gpt_helpr app/controllers/pos_controller.rb:10:20 "Describe the controller logic" / app/views/pos/index.html.erb "Explain the view template"
+   ```
+
+2. Write the output to a file:
+   ```sh
+   gpt_helpr app/controllers/pos_controller.rb:10:20 "Describe the controller logic" / app/views/pos/index.html.erb "Explain the view template" --file
+   ```
+
+## Why GPT_Helpr?
+
+GPT_Helpr is designed to save time and effort when sharing code snippets. It's often necessary to provide context and explanations for the code. Instead of manually copying and formatting code snippets, GPT_Helpr automates the process, generating well-structured Markdown output.
+
+This can be useful for:
+
+- **Creating Documentation**: Quickly generate descriptions of code segments for documentation.
+- **Sharing Code**: Share specific parts of your codebase with clear descriptions.
+- **Teaching and Learning**: Provide examples and explanations of code in a consistent format.
+
+## Contributing
+
+Contributions are welcome! If you have suggestions for improvements or find any issues, please open an issue or create a pull request.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'gpt_helpr'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/gpt_helpr

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'gpt_helpr'
+
+GptHelpr::CLI.start(ARGV)

data/bin/lmk

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'gpt_helpr'
+
+GptHelpr::CLI.start(%w[-i -ln])

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/gpt_helpr/cli.rb

@@ -0,0 +1,127 @@
+require 'fileutils'
+require 'readline'
+require 'shellwords'
+require 'time'
+
+module GptHelpr
+  class CLI
+
+    def self.start(args=[])
+      Dir.chdir(Dir.pwd)
+
+      puts "GptHelpr #{GptHelpr::VERSION} - To help dig your codebase and cook GPT-XX instructions [current directory #{Dir.pwd}]"
+      line_numbers = args.include?('-ln') || args.include?('--line-numbers')
+
+      if args.include?('-i') || args.include?('--interactive')
+        files = interactive_mode(line_numbers)
+      else
+
+        if args.empty?
+          puts 'Usage: gpt_helpr <file1> <re: instructions> / <file2> <re: instructions> [--f] [--file] [--i] [--interactive] [--ln] [--line-numbers]'
+          exit 1
+        end
+
+        separator_indices = args.each_index.select { |i| args[i] == '/' }
+        parts = []
+        last_index = 0
+
+        separator_indices.each do |index|
+          parts << args[last_index...index]
+          last_index = index + 1
+        end
+        parts << args[last_index..]
+
+        files = parts.map do |part|
+          file_path = part[0]
+          re_text = part[1]
+          lines_range = file_path.include?(':') ? file_path.split(':', 2).last : nil
+          file_path = file_path.split(':').first
+
+          [file_path, re_text, lines_range]
+        end
+      end
+
+      final_output = generate_output(files, line_numbers)
+      copy_to_clipboard(final_output)
+
+      if args.include?('-f') || args.include?('--file')
+        write_to_file(final_output)
+      else
+        puts final_output
+      end
+    end
+
+    def self.process_file(file_path, lines_range = nil, line_numbers = false)
+      content = File.read(file_path)
+
+      if lines_range
+        start_line, end_line = lines_range.split(':').map(&:to_i)
+        content = content.lines[start_line - 1, end_line - start_line + 1].join
+      end
+
+      if line_numbers
+        start_index = lines_range ? start_line : 1
+        content = content.lines.each_with_index.map { |line, index| "#{start_index + index}: #{line}" }.join
+      end
+
+      content
+    rescue => e
+      "Error reading file: #{e.message}"
+    end
+
+    def self.generate_output(files, line_numbers = false)
+      output = ''
+      files.each do |file_info|
+        file_path, re_text, lines_range = file_info
+
+        content = process_file(file_path, lines_range, line_numbers)
+
+        output += "#### file source  `#{file_path}`\n"
+        output += "```\n"
+        output += "#{content}\n"
+        output += "```\n\n"
+        output += "#{re_text}\n\n"
+        output += "#### end of  `#{file_path}`\n"
+        output += "\n"
+      end
+      output
+    end
+
+    def self.copy_to_clipboard(output)
+      escaped_output = Shellwords.escape(output)
+      system("echo #{escaped_output} | pbcopy")
+    end
+
+    def self.write_to_file(output)
+      timestamp = Time.now.utc.iso8601
+      filename = "gpt_#{timestamp}.md"
+      File.write(filename, output)
+      puts "Output written to #{filename}"
+    end
+
+    def self.interactive_mode(line_numbers = false)
+      files = []
+
+      Readline.completion_append_character = nil
+      Readline.completion_proc = -> (input) {
+        Dir[input + '*'].grep(/^#{Regexp.escape(input)}/)
+      }
+
+      while true
+        begin
+          file_input = Readline.readline('File Path (optional :start:end): ', true)
+          break if file_input.nil? || file_input.strip.empty?
+
+          file_path, lines_range = file_input.split(':', 2)
+          re_text = Readline.readline('Instructions: ', true)
+
+          files << [file_path.strip, re_text.strip, lines_range]
+        rescue Interrupt
+          break
+        end
+      end
+
+      files
+    end
+  end
+end

data/lib/gpt_helpr/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GptHelpr
+  VERSION = '0.2.0'
+end

data/lib/gpt_helpr.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'gpt_helpr/version'
+require_relative 'gpt_helpr/cli'
+
+module GptHelpr
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: gpt_helpr
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Emanuele Tozzato
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+description: It is often necessary to provide context and explanations for the code.
+  Instead of manually copying and formatting code snippets, GPT-Helpr automates the
+  process, generating well-structured Markdown output.
+email:
+- etozzato@gmail.com
+executables:
+- gpt_helpr
+- lmk
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/gpt_helpr
+- bin/lmk
+- bin/setup
+- lib/gpt_helpr.rb
+- lib/gpt_helpr/cli.rb
+- lib/gpt_helpr/version.rb
+homepage: https://etozzato.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://etozzato.com
+  source_code_uri: https://github.com/etozzato/gpt-helpr
+  changelog_uri: https://github.com/etozzato/gpt-helpr/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: GPT-Helpr is designed to save time and effort when sharing code snippets
+test_files: []