dotcodegen 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0354938621e705831e5f3f4a327b8da9e10901519e8d90181592f33dc584a53
-  data.tar.gz: 04631eaca2b2cfff73bec57958ea6f00e2d6741657b8d95638529fb60a42bd6d
+  metadata.gz: e41d9807ea2ec1242cf2a9b438bb0185f57d925f4cf73ee68f830551bc435850
+  data.tar.gz: 0b81574b9fc3a64c6405b8e4a52412cb0e4e92207ae0fa3b07116ae1864d4ef7
 SHA512:
-  metadata.gz: c83a1aba762c27be35068bc3148b32016b2505a4b63c1f1d8707685cf00654e09fdff4b8b26025972304ca304468ac493547c8af807025ec49725bae4b4d3624
-  data.tar.gz: df25ea36901d9ac9b94da9bf1f18be5cd1fb3b76122377581a2b44dbe6257dc101f1d0a5056be92203e9470902664538a5eef7c0fee6071019458e6cadd85a4c
+  metadata.gz: 6dd48471f5c6a8bd144d36020a633202008bffe9be2c7b6bb38a5fa1d2cae80f2949e256f7298181399521e39a051c702e8635bc827773e6840b98be30e7edd0
+  data.tar.gz: 7607420b9797f58b3a8c8fdffb301575ccbe8fc16c6466ac5b42d38645d126bdf3b13651d737667138d82f1e71d184e4151d9782371343119793061458ffe2d6

data/.env.example

@@ -1 +1,2 @@
-OPENAI_KEY=your-api-key
+OPENAI_KEY=your-api-key
+OPENAI_ORG_ID=your-openai-org-id

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.1.5] - 2024-03-11
+
+- Add support for specifying the OpenAI organization in the codegen command via the --openai_org_id flag.
+
+## [0.1.4] - 2024-03-11
+
+- Strip the leading and trailing ``` from the output of the codegen command.
+- Remove the organization from the OpenAI initialization code.
+
 # [0.1.3] - 2024-03-10
 
 - Move the execution to a /exe/codegen file. exe/run was removed.

data/README.md

@@ -1,25 +1,38 @@
-# Automatic test generation for monoliths
+# .codegen - Automatic test generation for your projects
+[![Gem Version](https://badge.fury.io/rb/dotcodegen.svg)](https://badge.fury.io/rb/dotcodegen) [![Test Coverage](https://api.codeclimate.com/v1/badges/8a9e8ffdf8f3c5322196/test_coverage)](https://codeclimate.com/github/ferrucc-io/dotcodegen/test_coverage)
+
 
 Never write a test from scratch again. Automatically generate tests for any file you open in your codebase.
 
 Keep your team up to date with the latest best practices and conventions you adopt. Customize the templates to fit your team's needs.
 
-We're using this tool to speed up writing tests for our monolith at [June](https://june.so). We open sourced it so you can use it too.
+We've built this tool internally to speed up writing tests for our monolith at [June](https://june.so). The main idea is that across your codebase, you can have a set of instructions that are used to generate tests. These templates are configurable so no matter what framework or language your current file is in, you can generate tests that fit your team's needs.
+
+Now we're open-sourcing it so you can use it too.
+
+https://github.com/ferrucc-io/dotcodegen/assets/8315559/aca74a87-5123-4305-88ff-cc3be3f34a9f
+
 
 ## Get started
 
 
-1. Install our CLI by running:
+1. Install our CLI via Homebrew:
 
 ```bash
 brew tap ferrucc-io/dotcodegen-tap
 brew install dotcodegen
 ```
 
+Or via RubyGems, this requires Ruby 3.3.0:
+
+```bash
+gem install dotcodegen
+```
+
 2. Initialise the `.codegen` directory in your codebase:
 
 ```bash
-codegen init
+codegen --init
 ```
 
 3. Configure the templates to fit your team's needs. See the [configuration](./docs/configuration.md) section for more details.
@@ -61,6 +74,13 @@ In order to do that you can add a task to your `tasks.json` file in the `.vscode
 
 We're currently building a VSCode extension to be able to generate tests directly from your editor. Stay tuned!
 
+## Organisation Id
+CLI takes an optional openai_org_id parameter. Used to specify the organisation to which the user making the API request belongs, especially in cases where the user is part of multiple organisations. This can be important for billing and access control, ensuring that the API usage is attributed to the correct organisation. 
+```bash
+codegen path/to/the/file/you/want/to/test --openai_key <your_openai_key>  --openai_org_id <your_openai_organisation_id>
+```
+
+
 ## How it works
 
 The extension uses AI to generate tests for any file you open in your codebase. It uses a set of customizable templates to generate the tests. You can customize the templates to fit your team's needs.

data/lib/dotcodegen/cli.rb

@@ -22,11 +22,10 @@ module Dotcodegen
       Dotenv.load unless defined?($running_tests) && $running_tests
       options = parse(args)
       return version if options.version
-
       return Init.run if options.init
 
       matchers = load_matchers('.codegen/instructions')
-      TestFileGenerator.new(file_path: options.file_path, matchers:, openai_key: options.openai_key).run
+      TestFileGenerator.new(file_path: options.file_path, matchers:, openai_key: options.openai_key, openai_org_id: options.openai_org_id).run
     end
 
     def self.version
@@ -41,11 +40,12 @@ module Dotcodegen
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def self.build_option_parser(options)
       OptionParser.new do |opts|
         opts.banner = 'Usage: dotcodegen [options] file_path'
-
         opts.on('--openai_key KEY', 'OpenAI API Key') { |key| options.openai_key = key }
+        opts.on('--openai_org_id Org_Id', 'OpenAI Organisation Id') { |key| options.openai_org_id = key }
         opts.on('--init', 'Initialize a .codegen configuration in the current directory') { options.init = true }
         opts.on('--version', 'Show version') { options.version = true }
         opts.on_tail('-h', '--help', 'Show this message') do
@@ -55,21 +55,25 @@ module Dotcodegen
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def self.handle_arguments(args, opt_parser, options)
       opt_parser.parse!(args)
       return if options.version || options.init
 
       validate_file_path(args, opt_parser)
       options.file_path = args.shift
-
       options.openai_key ||= ENV['OPENAI_KEY']
+      options.openai_org_id ||= ENV['OPENAI_ORG_ID']
 
       return unless options.openai_key.to_s.strip.empty?
 
       puts 'Error: Missing --openai_key flag or OPENAI_KEY environment variable.'
+
       puts opt_parser
       exit 1
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
     def self.validate_file_path(args, opt_parser)
       return unless args.empty?

data/lib/dotcodegen/format_output.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Dotcodegen
+  class FormatOutput
+    def self.format(generated_test_code)
+      generated_test_code.gsub(/^```[a-zA-Z]*\n/, '').gsub(/\n```$/, '')
+    end
+  end
+end

data/lib/dotcodegen/test_code_generator.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
 require 'openai'
+require_relative 'format_output'
+
 module Dotcodegen
   class TestCodeGenerator
-    attr_reader :config, :file_to_test_path, :openai_key
+    attr_reader :config, :file_to_test_path, :openai_key, :openai_org_id
 
-    def initialize(config:, file_to_test_path:, openai_key:)
+    def initialize(config:, file_to_test_path:, openai_key:, openai_org_id: nil)
       @config = config
       @file_to_test_path = file_to_test_path
       @openai_key = openai_key
+      @openai_org_id = openai_org_id
     end
 
     def generate_test_code
@@ -19,7 +22,7 @@ module Dotcodegen
           temperature: 0.7
         }
       )
-      response.dig('choices', 0, 'message', 'content')
+      FormatOutput.format(response.dig('choices', 0, 'message', 'content'))
     end
 
     def test_prompt_text
@@ -53,10 +56,9 @@ module Dotcodegen
     end
 
     def openai_client
-      @openai_client ||= OpenAI::Client.new(
-        access_token: openai_key,
-        organization_id: 'org-4nA9FJ8NajsLJ2fbHRAw7MLI'
-      )
+      client_options = { access_token: openai_key }
+      client_options[:organization_id] = openai_org_id unless openai_org_id.nil?
+      @openai_client ||= OpenAI::Client.new(client_options)
     end
   end
 end

data/lib/dotcodegen/test_file_generator.rb

@@ -5,12 +5,13 @@ require_relative 'test_code_generator'
 
 module Dotcodegen
   class TestFileGenerator
-    attr_reader :file_path, :matchers, :openai_key
+    attr_reader :file_path, :matchers, :openai_key, :openai_org_id
 
-    def initialize(file_path:, matchers:, openai_key:)
+    def initialize(file_path:, matchers:, openai_key:, openai_org_id: nil)
       @file_path = file_path
       @matchers = matchers
       @openai_key = openai_key
+      @openai_org_id = openai_org_id
     end
 
     def run
@@ -35,8 +36,10 @@ module Dotcodegen
     end
 
     def write_generated_code_to_test_file
-      generated_code = Dotcodegen::TestCodeGenerator.new(config: matcher, file_to_test_path: file_path,
-                                                         openai_key:).generate_test_code
+      generated_code = Dotcodegen::TestCodeGenerator.new(config: matcher,
+                                                         file_to_test_path: file_path,
+                                                         openai_key:,
+                                                         openai_org_id:).generate_test_code
       File.write(test_file_path, generated_code)
     end
 

data/lib/dotcodegen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotcodegen
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Ferruccio Balestreri
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-10 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -75,6 +75,7 @@ files:
 - exe/codegen
 - lib/dotcodegen.rb
 - lib/dotcodegen/cli.rb
+- lib/dotcodegen/format_output.rb
 - lib/dotcodegen/init.rb
 - lib/dotcodegen/test_code_generator.rb
 - lib/dotcodegen/test_file_generator.rb