gpt_helpr 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 517f6f3290d45ea8b2e9b14e6c77d051ae771948c2f1b37d39ddc27a891d624f
-  data.tar.gz: ab65c67d108926f07ecd777ec3ddfce14192d1a975c76da18ed59f919ee7095f
+  metadata.gz: 43764907432b7f7b41c2964247f352032dca55e3de3f64417f1d1ce2e1b0c3ca
+  data.tar.gz: 53df5907162806ee004909d8fcb449185d227cedc16d06ba2073d3254e9d099b
 SHA512:
-  metadata.gz: d04bcfee6aface86e18e757d5e2427ce048d9bf5f06190fd708353de915477598f14f0459a8d53a5a9cebeb80e01b0b0bf0a2b6a549b6ec78b7cade7e9ce7bba
-  data.tar.gz: 2a4036ccdd1b35bba237c55433c69924b22dc11f6fd28b5e0de4fc98d9f7f97da3759a01f74b653d37f29da693c24b4770d00d7122e36957ab4cc308446cce0b
+  metadata.gz: 7ed06023e1eac48a0239ac70a2ca4e4a2f3d8ff72281ccb09c7d0fa123b66c6bfbffbc74d90cedb9a9c619ecd6f632b8fdadf44dd094a933c8b8c7a9d68ed3aa
+  data.tar.gz: ea3d13668ad073d2734e66ef053edd5ca27b1da860c707bd890a2a59c166f806128c759628dd5685ef8137abe77119d01df992eaab4269d47680fadd25321825

data/lib/gpt_helpr/cli.rb

@@ -5,11 +5,10 @@ require 'time'
 
 module GptHelpr
   class CLI
-
-    def self.start(args=[])
+    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}]"
+      puts "== 🏴‍☠️ GptHelpr #{GptHelpr::VERSION} == Helping to dig your codebase and cook GPT-XX instructions [Location: #{Dir.pwd}]"
       line_numbers = args.include?('-ln') || args.include?('--line-numbers')
 
       if args.include?('-i') || args.include?('--interactive')
@@ -17,7 +16,7 @@ module GptHelpr
       else
 
         if args.empty?
-          puts 'Usage: gpt_helpr <file1> <re: instructions> / <file2> <re: instructions> [--f] [--file] [--i] [--interactive] [--ln] [--line-numbers]'
+          puts 'Usage: gpt_helpr <file1> <instructions> / <file2> <instructions> [--f] [--file] [--i] [--interactive] [--ln] [--line-numbers]'
           exit 1
         end
 
@@ -48,6 +47,7 @@ module GptHelpr
         write_to_file(final_output)
       else
         puts final_output
+        puts '(Output copied to clipboard)'
       end
     end
 
@@ -65,7 +65,7 @@ module GptHelpr
       end
 
       content
-    rescue => e
+    rescue StandardError => e
       "Error reading file: #{e.message}"
     end
 
@@ -76,12 +76,12 @@ module GptHelpr
 
         content = process_file(file_path, lines_range, line_numbers)
 
-        output += "#### file source  `#{file_path}`\n"
+        output += "\n==== file source `#{file_path} #{lines_range}`\n"
         output += "```\n"
         output += "#{content}\n"
         output += "```\n\n"
         output += "#{re_text}\n\n"
-        output += "#### end of  `#{file_path}`\n"
+        output += "==== end of `#{file_path}`\n"
         output += "\n"
       end
       output
@@ -96,29 +96,25 @@ module GptHelpr
       timestamp = Time.now.utc.iso8601
       filename = "gpt_#{timestamp}.md"
       File.write(filename, output)
-      puts "Output written to #{filename}"
+      puts "(Output written to #{filename})"
     end
 
-    def self.interactive_mode(line_numbers = false)
+    def self.interactive_mode(_line_numbers = false)
       files = []
 
       Readline.completion_append_character = nil
-      Readline.completion_proc = -> (input) {
-        Dir[input + '*'].grep(/^#{Regexp.escape(input)}/)
-      }
+      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?
+      loop do
+        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)
+        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
+        files << [file_path.strip, re_text.strip, lines_range]
+      rescue Interrupt
+        break
       end
 
       files

data/lib/gpt_helpr/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gpt_helpr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Emanuele Tozzato
@@ -24,9 +24,27 @@ dependencies:
     - - "~>"
       - !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.
+description: "It is sometime necessary to provide context and explanations for your
+  code. Instead of manually copying and formatting code snippets, GPT-Helpr automates
+  the process with an interactive cli, generating a well-structured Markdown output,
+  which can be copied to your clipboard or printed to file.\n\n### Example Usage:\n\n```sh\n#
+  lmk is an alias for gpt_helpr -i -ln\n\n$ lmk\n== \U0001F3F4‍☠️ GptHelpr 0.2.1 ==
+  Helping to dig your codebase and cook GPT-XX instructions [current directory /Users/etozzato/WorkSpace/_AINZ/pizzatarians.com]\n\nFile
+  Path (optional :start:end): TAB ->\nfavicon.ico                 hey.md                      js
+  \                         random-acts-of-pizza.md\n_config.yml                 _site
+  \                      draft                       fonts\nimages                      kneading-baking-academy.md
+  \ _exe                        academy\nfavicon.gif                 hands-in-dough.md
+  \          index.md                    parties-and-events.md\n\nFile Path (optional
+  :start:end): hey.md 1:22\nInstructions: can you improve this text? Do you see any
+  issues with the template?\nFile Path (optional :start:end): ENTER to exit\n\n====
+  file source  `hey.md`\n\n1: ---\n2: title: Hey, hello!\n3: layout: default\n4: ---\n5:\n6:
+  # {{ page.title }}\n7: ----\n8:\n9: <div class=\"row\">\n10:   <div class=\"col-md-12\">\n11:
+  \    <p class='justin'>\n12:       Nice to meet you, I am *Mek*!\n13:     </p>\n14:
+  \    <p class='listo'>\n15:       I am a self-proclaimed pizza guru and I am here
+  to teach & learn. Originally from Venice, Italy you can find me in San Diego, CA.\n16:
+  \    </p>\n17:     <p class='listo'>\n18:       In my spare time, I write code @
+  PlayStation!\n19:     </p>\n20:   </div>\n21: </div>\n22:\n\ncan you improve this
+  text? Do you see any issues with the template?\n\n==== end of  `hey.md`\n\n"
 email:
 - etozzato@gmail.com
 executables:
@@ -68,5 +86,6 @@ 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
+summary: "== \U0001F3F4‍☠️ GptHelpr 0.2.1 == Helping to dig your codebase and cook
+  GPT-XX instructions"
 test_files: []