openai-please 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88db2eab8d2aafb7387f3f13b7da57ec499f85ab25c75b51a2ee342c4a0fa5c1
+  data.tar.gz: f50f4df10b90b1ab68543a9fb14a6494d47a33bccaf3fa54e829c43fe6215caa
+SHA512:
+  metadata.gz: 692f1d6e44402e12d6fa59a7733b7b6620323be48f8ef999b367616a917d53262ee8bc1aeb9f4628a583978fea77f653536112f2c2a29b2eaddb915feb28f8d7
+  data.tar.gz: 675d9326b5e682e7d45c36162ec1fb52ea6487058843a274f8e75eb9cf8505fc5759241987f7f986bcf2bc13570ebbfa81ee1abed16864d024a98a6c77501b47

data/.env.example

@@ -0,0 +1 @@
+OPENAI_ACCESS_TOKEN=[YOUR ACCESS_TOKEN HERE]

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 3
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM ruby:3
+
+WORKDIR /app
+
+RUN apt-get update -y && apt-get install vim nano -y
+
+COPY Gemfile Gemfile.lock please.gemspec ./
+COPY lib/please/version.rb ./lib/please/version.rb
+RUN bundle install
+
+COPY ./ ./

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in please.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
+
+gem 'rubocop', '~> 1.7'

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    please (0.1.0)
+      ruby-openai (>= 1.3)
+      tty-prompt (>= 0.23)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    dotenv (2.7.6)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    minitest (5.14.4)
+    multi_xml (0.6.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.21.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-openai (1.3.1)
+      dotenv (~> 2.7.6)
+      httparty (~> 0.18.1)
+    ruby-progressbar (1.11.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unicode-display_width (2.0.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  please!
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Please
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/please`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'please'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install please
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/please.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'please'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

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/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3'
+
+services:
+  please:
+    build: .
+    tty: true
+    stdin_open: true
+    env_file: .env
+    volumes:
+      - '.:/app'

data/exe/please

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'please/cli'

data/lib/please/cli.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+require 'optparse'
+require 'please'
+require 'tempfile'
+
+tty_prompt = TTY::Prompt.new
+
+options = {}
+
+USAGE = 'Usage: please [options] <instruction>'
+
+OptionParser.new do |opts|
+  opts.banner = USAGE
+end.parse!
+
+access_token = ENV.fetch('OPENAI_ACCESS_TOKEN') do
+  tty_prompt.error 'Ensure the OPENAI_ACCESS_TOKEN environment variable is set'
+  exit 1
+end
+
+codex_service = Please::OpenAI::CodexService.new(access_token: access_token)
+
+instruction = ARGV.join(' ')
+
+if instruction.empty?
+  tty_prompt.error USAGE
+  exit 1
+end
+
+request = Please::Request.new(
+  options: options,
+  instruction: instruction,
+  codex_service: codex_service,
+)
+
+command = request.send
+
+loop do
+  print '$ '
+  tty_prompt.ok command
+
+  action = tty_prompt.expand('Run the command?') do |q|
+    q.choice key: 'y', name: 'Yes', value: :run
+    q.choice key: 'n', name: 'No', value: :abort
+    q.choice key: 'e', name: 'Edit command before running', value: :edit
+  end
+
+  case action
+  when :run
+    Process.wait spawn(command)
+    exit $?.exitstatus
+  when :abort
+    break
+  when :edit
+    Tempfile.open('command') do |file|
+      file << command
+      file.flush
+
+      Process.wait spawn("${EDITOR:-vi} #{file.path}")
+
+      file.rewind
+      command = file.read.chomp
+    end
+  end
+end

data/lib/please/openai/codex_service.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'ruby/openai'
+
+module Please
+  module OpenAI
+    CodexService = Struct.new(:access_token, keyword_init: true) do
+      def completion(prompt)
+        client = ::OpenAI::Client.new(access_token: access_token)
+
+        response = client.completions(
+          engine: 'davinci-codex',
+          parameters: default_parameters.merge(
+            prompt: prompt,
+          ),
+        )
+
+        response.parsed_response.fetch('choices').first.fetch('text')
+      end
+
+      private
+
+      def default_parameters
+        {
+          temperature: 0,
+          max_tokens: 300,
+          top_p: 1,
+          frequency_penalty: 0,
+          presence_penalty: 0,
+          stop: ["\n"],
+        }
+      end
+    end
+  end
+end

data/lib/please/request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Please
+  Request = Struct.new(:options, :instruction, :codex_service, keyword_init: true) do
+    def send
+      codex_service.completion(<<~PROMPT.chomp).strip
+        Write a one-line bash command each of the following tasks.
+
+        # Print the current working directory
+        $ pwd
+        #{`pwd`}
+
+        # Show information about the operating system
+        $ uname -a
+        #{`uname -a`}
+      
+        # List all files in the current directory
+        $ ls -a
+        #{`ls -a`}
+
+        # #{instruction.gsub(/\n/, " ")}
+        $
+      PROMPT
+    end
+  end
+end

data/lib/please/version.rb

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

data/lib/please.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'please/version'
+require_relative 'please/request'
+require_relative 'please/openai/codex_service'
+
+module Please
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/please.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/please/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'openai-please'
+  spec.version       = Please::VERSION
+  spec.authors       = ['Joe Anderson']
+  spec.email         = ['joe@osbert.me']
+
+  spec.summary       = 'Convert natural language to bash commands using OpenAI Codex'
+  spec.homepage      = 'https://github.com/12joan/please'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'ruby-openai', '>= 1.3'
+  spec.add_dependency 'tty-prompt', '>= 0.23'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: openai-please
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Anderson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.23'
+description: 
+email:
+- joe@osbert.me
+executables:
+- please
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rubocop.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- exe/please
+- lib/please.rb
+- lib/please/cli.rb
+- lib/please/openai/codex_service.rb
+- lib/please/request.rb
+- lib/please/version.rb
+- please.gemspec
+homepage: https://github.com/12joan/please
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/12joan/please
+  source_code_uri: https://github.com/12joan/please
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Convert natural language to bash commands using OpenAI Codex
+test_files: []