openai-please 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d2e77c2b839915788f9db15c6f6a75b90d3c52c4a9033f3145aa687ff0d21a3
-  data.tar.gz: b021e9384596d305d472224ee726cd9a4f16c514cc378c051d079b1ac9c58555
+  metadata.gz: de7075efdfbec978dc13fa6621f80e9e146e81cffb9652b19c17577befb4258a
+  data.tar.gz: 22fcdec50244d7d02826e25a3f4fb7a5e542f151da749ab67d7d9a3de0e7d7cb
 SHA512:
-  metadata.gz: 3f349c795f25116281574e882f2299104654d399a29dc7481d1066ca576d8f6bb2f754b25dd12d6d9725aa4edc677fac7bb827e10307a69caee0da03f471cee9
-  data.tar.gz: 97014f5dfc48adb96767c9b52996511d1cc2d1666256c0f8720181503b9aa9780c5c81ad34ae384c8e880ac9c853e3c9b25f795a0ccad78a6fab27a002f02e32
+  metadata.gz: 7aa0a478868627ba84898ca812958f5c37a46bd0872fe4ddbba4d1c222d2700f0d887b0e7ba207683e3a4620e9a73c63e61d73f77e6bf76f8b422a9f54a2bbf6
+  data.tar.gz: 978bcfb2597c5b2f7c1157cedd755b6a058395c9d844472649524ddc9531d5f9a4fde7e6f7af5dd237ed4801274f3274d14753cfd6c25e65387ff16b38ee2250

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 .env
+config.yml

data/.rubocop.yml

@@ -19,8 +19,15 @@ Style/TrailingCommaInArguments:
   Enabled: true
   EnforcedStyleForMultiline: comma
 
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
 Style/Documentation:
   Enabled: false
 
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
 Layout/LineLength:
-  Max: 120
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openai-please (0.1.1)
+    openai-please (0.1.2)
       ruby-openai (>= 1.3)
       tty-prompt (>= 0.23)
 

data/docker-compose.yml

@@ -8,3 +8,4 @@ services:
     env_file: .env
     volumes:
       - '.:/app'
+      - './config.yml:/root/.config/please/config.yml:ro'

data/lib/please/cli.rb

@@ -2,10 +2,14 @@
 
 require 'English'
 require 'tty-prompt'
+require 'yaml'
 require 'optparse'
 require 'please'
 require 'tempfile'
 
+USAGE = 'Usage: please [options] <instruction>'
+CONFIG_FILE_PATH = File.expand_path('~/.config/please/config.yml')
+
 begin
   tty_prompt = TTY::Prompt.new
 
@@ -14,13 +18,27 @@ begin
     send_pwd: true,
     send_uname: true,
     send_ls: true,
+    access_token: ENV.fetch('OPENAI_ACCESS_TOKEN', nil),
+    examples: [],
+    skip_default_examples: false,
   }
 
-  USAGE = 'Usage: please [options] <instruction>'
+  if File.exist?(CONFIG_FILE_PATH)
+    begin
+      options.merge! YAML.load_file(CONFIG_FILE_PATH).transform_keys(&:to_sym)
+      options[:examples].each { |example| example.transform_keys!(&:to_sym) }
+    rescue StandardError
+      tty_prompt.warn 'Could not parse config file. Ignoring.'
+    end
+  end
 
   OptionParser.new do |opts|
     opts.banner = USAGE
 
+    opts.on('--show-config-path', 'Output the location of the config file, and then exit') do |v|
+      options[:show_config_path] = v
+    end
+
     opts.on('--show-prompt', 'Output the prompt that would ordinarily be sent to OpenAI Codex, and then exit') do |v|
       options[:show_prompt] = v
     end
@@ -38,12 +56,17 @@ begin
     end
   end.parse!
 
-  access_token = ENV.fetch('OPENAI_ACCESS_TOKEN') do
-    tty_prompt.error 'Ensure the OPENAI_ACCESS_TOKEN environment variable is set'
+  if options[:show_config_path]
+    tty_prompt.say CONFIG_FILE_PATH
+    exit
+  end
+
+  if options[:access_token].nil?
+    tty_prompt.error "Access token not found. Set it in #{CONFIG_FILE_PATH} or $OPENAI_ACCESS_TOKEN."
     exit 1
   end
 
-  codex_service = Please::OpenAI::CodexService.new(access_token: access_token)
+  codex_service = Please::OpenAI::CodexService.new(access_token: options[:access_token])
 
   instruction = ARGV.join(' ')
 

data/lib/please/context.rb

@@ -1,30 +1,69 @@
 # frozen_string_literal: true
 
+DEFAULT_EXAMPLES = [
+  {
+    instruction: 'Find all files older than 1 week and open each of them in vim',
+    command: 'find . -type f -mtime +7 -exec vim {} \;',
+  },
+
+  {
+    instruction: 'Show a clock which updates every second on a single line',
+    command: 'printf \'import time\nwhile True:\n\tprint(time.strftime("%%H:%%M:%%S"), end="\\\\r")\n\ttime.sleep(1)\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
+  },
+
+  {
+    instruction: 'Write a python program that prints out hello world with each letter on its own line',
+    command: 'printf \'print("\\\\n".join(list("Hello World"))\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
+  },
+
+  {
+    instruction: 'Read from stdin until EOF, and then output the length of the string',
+    command: 'printf \'import sys\nprint(len(sys.stdin.read().strip()))\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
+  },
+
+  {
+    instruction: 'Run the fortune command 5 times',
+    command: 'for i in $(seq 5); do fortune; done',
+  },
+
+  {
+    instruction: 'Repeadedly read a single line from the user, reverse it, and print it back',
+    command: 'printf \'while True:\n\tline = input()\n\tprint(line[::-1])\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
+  },
+].freeze
+
+OPTIONAL_EXAMPLES = {
+  pwd: {
+    instruction: 'Print the current working directory',
+    command: 'pwd',
+    execute: true,
+  },
+
+  uname: {
+    instruction: 'Show information about the operating system',
+    command: 'uname -a',
+    execute: true,
+  },
+
+  ls: {
+    instruction: 'List all files in the current directory',
+    command: 'ls -a',
+    execute: true,
+  },
+}.freeze
+
 module Please
   class Context
     def initialize(options)
-      @examples = default_examples
+      @examples = []
 
-      if options[:send_pwd]
-        @examples << {
-          instruction: 'Print the current working directory',
-          command: 'pwd',
-        }
-      end
+      @examples += DEFAULT_EXAMPLES unless options[:skip_default_examples]
 
-      if options[:send_uname]
-        @examples << {
-          instruction: 'Show information about the operating system',
-          command: 'uname -a',
-        }
-      end
+      @examples << OPTIONAL_EXAMPLES[:pwd] if options[:send_pwd]
+      @examples << OPTIONAL_EXAMPLES[:uname] if options[:send_uname]
+      @examples << OPTIONAL_EXAMPLES[:ls] if options[:send_ls]
 
-      if options[:send_ls]
-        @examples << {
-          instruction: 'List all files in the current directory',
-          command: 'ls -a',
-        }
-      end
+      @examples += options[:examples]
     end
 
     def to_s
@@ -32,45 +71,9 @@ module Please
         <<~EXAMPLE.chomp
           # #{example[:instruction]}
           $ #{example[:command]}
-          #{example.fetch(:result) { `#{example[:command]}` }}
+          #{example[:execute] ? `#{example[:command]}` : ""}
         EXAMPLE
       end.join("\n")
     end
-
-    private
-
-    def default_examples
-      [
-        {
-          instruction: 'Find all files older than 1 week and open each of them in vim',
-          command: 'find . -type f -mtime +7 -exec vim {} \;',
-          result: '',
-        },
-
-        {
-          instruction: 'Download a random dog picture',
-          command: 'printf \'import urllib.request\nimport json\nimport subprocess\ndata = urllib.request.urlopen("https://dog.ceo/api/breeds/image/random").read()\nurl = json.loads(data)["message"]\nsubprocess.call(["curl", url, "-o", "dog.jpg"])\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
-          result: '',
-        },
-
-        {
-          instruction: 'Read from stdin until EOF, and then output the length of the string',
-          command: 'printf \'import sys\nprint(len(sys.stdin.read().strip()))\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
-          result: '',
-        },
-
-        {
-          instruction: 'Run the fortune command 5 times',
-          command: 'for i in $(seq 5); do fortune; done',
-          result: '',
-        },
-
-        {
-          instruction: 'Repeadedly read a single line from the user, reverse it, and print it back',
-          command: 'printf \'while True:\n\tline = input()\n\tprint(line[::-1])\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
-          result: '',
-        },
-      ]
-    end
   end
 end

data/lib/please/request.rb

@@ -8,7 +8,7 @@ module Please
         # Collapse multiline commands into one line
         .gsub(/\s*\\\n\s*/, ' ')
         # Remove subsequent lines that do not contain commands
-        .gsub(/\n[^\$][^\n]*$/, '')
+        .gsub(/\n[^$][^\n]*$/, '')
         # Collapse multiple commands into one line
         .gsub(/\n\$ /, '; ')
         # Remove multiple consecutive spaces
@@ -19,7 +19,7 @@ module Please
       <<~PROMPT.chomp
         Write a one-line bash command for each of the following tasks.
 
-        #{context.to_s}
+        #{context}
 
         # #{instruction.gsub(/\n/, " ")}
         $

data/lib/please/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Please
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai-please
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Joe Anderson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai