dotcodegen 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1301e1dd4819dbca49a82b09398c2e109443ba2d7717a57d4cbd816ab72dfe1
-  data.tar.gz: 85df9cf9e3206a6749695e377ece1856a70b1694e3f39dd27dbceeb99065d944
+  metadata.gz: e2617e3b970e9e982ba60cb5a45b686cf11d86ddf12457e289a2801d8387fe7d
+  data.tar.gz: 316db28cbcbfb0abb8230c080df86b065daf7361fc63e099d7615df5d0643f7c
 SHA512:
-  metadata.gz: 74efe685bf58050f77ed20a15e03c72ae7998f6e0b090118154266fdd68403c3ad205cba15f895f9697e4f873f821c0a0a66471ebbe4df44006a39d46b5b53cd
-  data.tar.gz: 3776772d1dd589ec7cb6d2c4222123312846991fa325974d25f1d8d955933aa11a523f08f17924e597d75acf7a5229552964805d2f5b62dc6138fc92dba6c46d
+  metadata.gz: 4bb6faa3e1944f372103946d31286143dc36ef47d5e2c4e4894fa51505ac26e0e9da3bef4bca38a2ba6497acc324466bcd3db9749f1179c6edb1df181023130a
+  data.tar.gz: 4e9b53b2665b436da1f65c28976333e863cbb03c18159151ae43409dd481bac188cfd0dade7921b9c14da035412e9ab7218387aeb5623a46c2ff9386ef30adca

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [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.
+
 ## [0.1.1] - 2024-03-10
 
 - Fix bug where the gemspec was excluding the `lib` directory from the gem. ([#1](https://github.com/ferrucc-io/dotcodegen/pull/1))

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 https://github.com/ferrucc-io/dotcodegen
+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.

data/dotcodegen.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github .codegen .rspec .rubocop.yml .simplecov appveyor Gemfile Rakefile])
     end
   end
   spec.bindir = 'exe'
@@ -32,8 +32,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'dotenv'
   spec.add_dependency 'front_matter_parser'
-  spec.add_dependency 'optparse'
-  spec.add_dependency 'ostruct'
   spec.add_dependency 'ruby-openai'
 
   # For more information and examples about making a new gem, check out our

data/exe/{run → codegen}

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # The program gets in as an argument the full file path and the matchers config file
-# Usage: ruby scripts/create_test_file.rb client/app/components/feature.tsx --openai_key sk42424242
+# Usage: exe/codegen client/app/components/feature.tsx --openai_key sk42424242
 
 require_relative '../lib/dotcodegen/cli'
 

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,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'openai'
+require_relative 'format_output'
+
 module Dotcodegen
   class TestCodeGenerator
     attr_reader :config, :file_to_test_path, :openai_key
@@ -19,7 +21,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 +55,7 @@ module Dotcodegen
     end
 
     def openai_client
-      @openai_client ||= OpenAI::Client.new(
-        access_token: openai_key,
-        organization_id: 'org-4nA9FJ8NajsLJ2fbHRAw7MLI'
-      )
+      @openai_client ||= OpenAI::Client.new(access_token: openai_key)
     end
   end
 end

data/lib/dotcodegen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotcodegen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Ferruccio Balestreri
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-10 00:00:00.000000000 Z
+date: 2024-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -38,34 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: optparse
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ostruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
@@ -88,26 +60,22 @@ description: Generate tests for your code using LLMs. This gem is a CLI tool tha
 email:
 - ferruccio.balestreri@gmail.com
 executables:
-- run
+- codegen
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codegen/instructions/ruby.md"
 - ".env.example"
-- ".rspec"
-- ".rubocop.yml"
-- ".simplecov"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - config/default/.codegen/instructions/react-vitest.md
 - config/default/.codegen/instructions/rspec-rails.md
 - docs/configuration.md
 - dotcodegen.gemspec
-- exe/run
+- 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

data/.codegen/instructions/ruby.md

@@ -1,145 +0,0 @@
----
-regex: 'lib/.*\.rb'
-root_path: 'lib'
-test_root_path: 'spec'
-test_file_suffix: '_spec.rb'
----
-
-When writing a test, you should follow these steps:
-
-1. Avoid typos.
-2. Avoid things that could be infinite loops.
-3. This codebase is a Ruby gem, try to follow the conventions of the Ruby community.
-4. Avoid things that could be security vulnerabilities.
-5. Keep the codebase clean and easy to understand.
-6. Use Rspec for tests, don't use any other testing framework.
-7. Don't include ANY dependencies that are not already in the files you are provided.
-8. Don't start your tests with ``` or other strings, as your reply will be run as a Ruby file.
-
-Here's an example of a good test you should reply with:
-
-```ruby
-# frozen_string_literal: true
-
-require 'dotcodegen/test_file_generator'
-
-RSpec.describe Dotcodegen::TestFileGenerator do
-  let(:file_path) { 'client/app/components/feature.tsx' }
-  let(:api_matcher) do
-    {
-      'regex' => 'api/.*\.rb',
-      'root_path' => 'api/app/',
-      'test_root_path' => 'api/spec/',
-      'test_file_suffix' => '_spec.rb'
-    }
-  end
-  let(:client_matcher) do
-    {
-      'regex' => 'client/app/.*\.tsx',
-      'test_file_suffix' => '.test.tsx'
-    }
-  end
-  let(:matchers) { [api_matcher, client_matcher] }
-  let(:openai_key) { 'test_openai_key' }
-  let(:codegen_instance) { instance_double(Dotcodegen::TestFileGenerator) }
-
-  subject { described_class.new(file_path:, matchers:, openai_key:) }
-
-  describe '#run' do
-    after(:each) { FileUtils.remove_dir('client/', force: true) }
-    let(:file_path) { 'spec/fixtures/feature.tsx' }
-    let(:client_matcher) do
-      {
-        'regex' => 'spec/fixtures/.*\.tsx',
-        'test_file_suffix' => '.test.tsx',
-        'root_path' => 'spec/fixtures/',
-        'test_root_path' => 'tmp/codegen_spec/',
-        'instructions' => 'instructions/react.md'
-      }
-    end
-
-    context 'when test file does not exist' do
-      it 'creates a test file and writes generated code once' do
-        allow(File).to receive(:exist?).with('tmp/codegen_spec/feature.test.tsx').and_return(false)
-        expect(FileUtils).to receive(:mkdir_p).with('tmp/codegen_spec')
-        allow(Dotcodegen::TestCodeGenerator).to receive_message_chain(:new, :generate_test_code).and_return('Mocked generated code')
-        expect(File).to receive(:write).with('tmp/codegen_spec/feature.test.tsx', '').once
-        expect(File).to receive(:write).with('tmp/codegen_spec/feature.test.tsx', 'Mocked generated code').once
-        subject.run
-      end
-    end
-
-    context 'when test file already exists' do
-      it 'does not create a test file but writes generated code' do
-        allow(File).to receive(:exist?).with('tmp/codegen_spec/feature.test.tsx').and_return(true)
-        expect(FileUtils).not_to receive(:mkdir_p)
-        allow(Dotcodegen::TestCodeGenerator).to receive_message_chain(:new, :generate_test_code).and_return('Mocked generated code')
-        expect(File).to receive(:write).with('tmp/codegen_spec/feature.test.tsx', 'Mocked generated code').once
-        subject.run
-      end
-    end
-  end
-
-  describe '#matcher' do
-    it 'returns the matching regex for the frontend' do
-      expect(subject.matcher).to eq(client_matcher)
-    end
-
-    context 'when file path is a ruby file' do
-      let(:file_path) { 'api/app/models/app.rb' }
-      it 'returns the matching regex for the backend' do
-        expect(subject.matcher).to eq(api_matcher)
-      end
-    end
-
-    context 'when there are no matches' do
-      let(:file_path) { 'terraform/models/app.rb' }
-      it 'returns nil' do
-        expect(subject.matcher).to be_nil
-      end
-    end
-
-    context 'when file path does not match any regex' do
-      let(:file_path) { 'api/models/app.go' }
-      it 'returns nil' do
-        expect(subject.matcher).to be_nil
-      end
-    end
-  end
-
-  describe '#test_file_path' do
-    it 'returns the test file path for the frontend' do
-      expect(subject.test_file_path).to eq('client/app/components/feature.test.tsx')
-    end
-
-    context 'when file path is a ruby file' do
-      let(:file_path) { 'api/app/models/app.rb' }
-      it 'returns the test file path for the backend' do
-        expect(subject.test_file_path).to eq('api/spec/models/app_spec.rb')
-      end
-    end
-  end
-end
-```
-
-Here's the skeleton of a test you can start from:
-
-```ruby
-# frozen_string_literal: true
-
-require 'dotcodegen/__file_path__'
-
-RSpec.describe Dotcodegen::__CLASS_NAME__ do
-  let(:params) do
-    {
-      # Add params here
-    }
-  end
-  subject { described_class.new(params) }
-
-
-  it 'runs' do
-    # Add assertions here
-  end
-end
-```

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.3.0
-  Exclude:
-    - "spec/**/*"
-
-Documentation:
-  Enabled: false
-
-Style/GlobalVars:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false

data/.simplecov

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-SimpleCov.start do
-  add_filter '/spec/'
-  add_filter '/vendor/bundle/'
-end

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec