air_test 0.1.5.7 → 0.1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8174f558c0b41c33acc6d4a468ad38c36e621c188a6ea022b7dc2ae500fcee3c
-  data.tar.gz: d84cc877b0841689de2f62e7055b68955fcf7352bbda10f65cc60969f959a1ac
+  metadata.gz: 76572704e0d1a8c3abc7e274def6c51611efba858a6f434b6bbfd5f871aedf12
+  data.tar.gz: 11235311464e8fe0db11323d3f0fee3fb156c676ab4b3b56f7c02abf410a71d0
 SHA512:
-  metadata.gz: f2089f266b3606af5c05f5153305a56e1e695391642c3b5775c81ba55b8d4752748628d74ec6e30f3a3b0df0d02cd2aca856fcf8b8d4350eaaa0fc3833b9cb44
-  data.tar.gz: c41e1ca2dfeb4e694126276a262dded5e62e1e0252024ecca5a6a9cbcb46a39d61e80754a0488cfee83b4e844604bba1362ad790e1f009b83df30f48b7e75b1f
+  metadata.gz: 793c1fd212fcbd747c85abd0130f69dafa849035d4ce69595b72342f119c73f69c9be5f88fe8375e9c439a8be12e96c487f7e93f733f36957163df49d3647d8a
+  data.tar.gz: dca493fc7c39853ae784be49e4b187e3d8b752b2d0e7306f2532b4b7d71584e185130f922527598b2e07e64633a256173a5c1fb8dca2053aedcc7a53eac9ff6d

data/README.md

@@ -1,10 +1,15 @@
 # air_test
 
-Automate the generation of Turnip/RSpec specs from Notion tickets, create branches, commits, pushes, and GitHub Pull Requests—all with a single Rake command.
+Automate the generation of Turnip/RSpec specs from Notion tickets, create branches, commits, pushes, and GitHub Pull Requests—all with a single command.
 
 ## 🚀 Features
 
-- Fetches Notion tickets (Gherkin format)
+- **Multi-platform support**: Works with Notion, Jira, and Monday.com
+- **Interactive CLI**: Choose which tickets to process
+- **Search and filtering**: Find tickets by keyword
+- **Dry-run mode**: Preview changes before applying them
+- **Flexible PR creation**: Generate specs with or without automatic PRs
+- Fetches tickets (Gherkin format)
 - Parses and extracts features/scenarios
 - Generates Turnip/RSpec spec files and matching step definitions
 - Creates a dedicated branch, commits, pushes
@@ -31,9 +36,96 @@ bundle install
 
 ---
 
+## 🛠 Quick Start
+
+### 1. Initialize Configuration
+
+Set up your project configuration interactively:
+
+```sh
+air_test init
+```
+
+This will:
+- Ask which ticketing tool you use (Notion, Jira, or Monday)
+- Configure your preferences (auto PR creation, dev assignee, etc.)
+- Create `.airtest.yml` configuration file
+- Create example environment file
+- Set up necessary directories
+
+For silent setup with defaults:
+```sh
+air_test init --silent
+```
+
+### 2. Set Environment Variables
+
+Copy the example environment file and fill in your tokens:
+
+```sh
+cp .env.air_test.example .env
+# Edit .env with your actual tokens
+```
+
+### 3. Generate Specs
+
+#### Interactive Mode (Recommended)
+```sh
+air_test generate --interactive
+```
+Shows you a list of available tickets and lets you choose which ones to process.
+
+#### Search and Filter
+```sh
+air_test generate --search "webhook"
+```
+Only processes tickets containing "webhook" in the title or content.
+
+#### Preview Mode
+```sh
+air_test generate --dry-run
+```
+Shows what would be generated without creating files or PRs.
+
+#### Disable PR Creation
+```sh
+air_test generate --no-pr
+```
+Generates spec files locally without creating Pull Requests.
+
+---
+
 ## ⚙️ Configuration
 
-Create an initializer in your Rails project:  
+### CLI Configuration (`.airtest.yml`)
+
+The `air_test init` command creates a `.airtest.yml` file with your preferences:
+
+```yaml
+tool: notion                    # Your ticketing tool (notion/jira/monday)
+auto_pr: 'yes'                  # Enable auto PR creation
+dev_assignee: 'your-name'       # Default dev assignee
+interactive_mode: 'yes'         # Enable interactive mode by default
+notion:
+  token: ENV["NOTION_TOKEN"]
+  database_id: ENV["NOTION_DATABASE_ID"]
+jira:
+  token: ENV["JIRA_TOKEN"]
+  project_id: ENV["JIRA_PROJECT_ID"]
+  domain: ENV["JIRA_DOMAIN"]
+  email: ENV["JIRA_EMAIL"]
+monday:
+  token: ENV["MONDAY_TOKEN"]
+  board_id: ENV["MONDAY_BOARD_ID"]
+  domain: ENV["MONDAY_DOMAIN"]
+github:
+  token: ENV["GITHUB_BOT_TOKEN"]
+  repo: 'your-org/your-repo'
+```
+
+### Rails Initializer (Optional)
+
+For Rails projects, you can also create an initializer:  
 `config/initializers/air_test.rb`
 
 ```ruby
@@ -45,17 +137,15 @@ AirTest.configure do |config|
 end
 ```
 
-Make sure your environment variables are set (in `.env`, your shell, or your CI/CD).
-
 ---
 
-## 📝 Creating Notion Tickets with Gherkin Format
+## 📝 Creating Tickets with Gherkin Format
 
-To ensure that your Notion tickets are compatible with the air_test automation, follow these guidelines when creating your tickets:
+To ensure that your tickets are compatible with the air_test automation, follow these guidelines when creating your tickets:
 
-### 1. Create a New Page in Notion
+### 1. Create a New Page/Ticket
 
-- Start by creating a new page in your Notion workspace for each ticket.
+- Start by creating a new page in your Notion workspace, Jira issue, or Monday.com item for each ticket.
 
 ### 2. Use the Gherkin Syntax
 
@@ -68,68 +158,117 @@ To ensure that your Notion tickets are compatible with the air_test automation,
 
 ### 3. Example Structure
 
-Here’s an example of how to structure a ticket in Notion:
+Here's an example of how to structure a ticket:
 
+```
 Feature: User Login
 Scenario: Successful login with valid credentials
 Given the user is on the login page
 When the user enters valid credentials
 Then the user should be redirected to the dashboard
+
 Scenario: Unsuccessful login with invalid credentials
 Given the user is on the login page
 When the user enters invalid credentials
 Then an error message should be displayed
+```
 
 ### 4. Additional Tips
 
 - Ensure that each ticket is clearly titled and contains all necessary scenarios.
-- Use bullet points or toggle lists in Notion to organize multiple scenarios under a single feature.
+- Use bullet points or toggle lists to organize multiple scenarios under a single feature.
 - Make sure to keep the Gherkin syntax consistent across all tickets for better parsing.
 
-By following these guidelines, you can create Notion tickets that are ready to be parsed by the air_test automation tool.
-
 ---
 
-## 🛠 Usage
+## 🛠 CLI Commands
+
+### `air_test init [--silent]`
+Initialize AirTest configuration for your project.
 
-Run the automated workflow from your Rails project terminal:
+**Options:**
+- `--silent`: Use default values without prompts
 
+**Examples:**
 ```sh
-bundle exec rake air_test:generate_specs_from_notion
+air_test init                    # Interactive setup
+air_test init --silent          # Silent setup with defaults
 ```
 
-- This will:
-  - Fetch Notion tickets
-  - Generate Turnip/RSpec specs and step files
-  - Create a branch, commit, push
-  - Open a Pull Request on GitHub with a rich template
+### `air_test generate [options]`
+Generate specs from tickets with advanced filtering and selection.
 
----
+**Options:**
+- `--interactive`: Interactive ticket selection
+- `--search "keyword"`: Search tickets by keyword
+- `--dry-run`: Preview changes without creating files
+- `--no-pr`: Disable PR creation
 
-## 📋 Requirements
+**Examples:**
+```sh
+air_test generate                    # Process all ready tickets
+air_test generate --interactive     # Choose tickets interactively
+air_test generate --search "webhook" --dry-run
+air_test generate --no-pr           # Generate files only, no PRs
+```
 
-- A Notion API token with access to your database
-- A GitHub token with push and PR creation rights
-- A configured remote git repository (`git remote -v`)
-- The folders `spec/features` and `spec/steps` (created automatically if needed)
+### `air_test create-pr --ticket-id ID`
+Create a Pull Request for a specific ticket (coming soon).
+
+**Examples:**
+```sh
+air_test create-pr --ticket-id 123
+```
+
+### `air_test help`
+Show help information and usage examples.
 
 ---
 
-## 📝 Example .env
+## 📋 Requirements
 
+### Environment Variables
+
+#### For Notion:
 ```
 NOTION_TOKEN=secret_xxx
 NOTION_DATABASE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 GITHUB_BOT_TOKEN=ghp_xxx
 ```
 
+#### For Jira:
+```
+JIRA_TOKEN=your_jira_token
+JIRA_PROJECT_ID=your_project_id
+JIRA_DOMAIN=your_domain.atlassian.net
+JIRA_EMAIL=your_email@example.com
+GITHUB_BOT_TOKEN=ghp_xxx
+```
+
+#### For Monday.com:
+```
+MONDAY_TOKEN=your_monday_token
+MONDAY_BOARD_ID=your_board_id
+MONDAY_DOMAIN=your_domain.monday.com
+GITHUB_BOT_TOKEN=ghp_xxx
+```
+
+### System Requirements
+
+- A ticketing tool API token with access to your tickets
+- A GitHub token with push and PR creation rights
+- A configured remote git repository (`git remote -v`)
+- The folders `spec/features` and `spec/steps` (created automatically if needed)
+
 ---
 
 ## 🆘 Troubleshooting
 
-- **Notion or GitHub authentication error**: check your tokens.
-- **PR not created**: make sure the branch contains commits different from `main`.
-- **Permission issues**: ensure the GitHub bot has access to the repo.
+- **Configuration not found**: Run `air_test init` to set up configuration
+- **Authentication error**: Check your API tokens in environment variables
+- **No tickets found**: Verify your ticketing tool configuration and permissions
+- **PR not created**: Make sure the branch contains commits different from `main`
+- **Permission issues**: Ensure the GitHub bot has access to the repo
 
 ---
 
@@ -142,5 +281,3 @@ GITHUB_BOT_TOKEN=ghp_xxx
 
 **Need an integration example or install script?**  
 Open an issue or contact me!
-
----

data/exe/air_test

@@ -2,65 +2,72 @@
 # frozen_string_literal: true
 
 require "fileutils"
+require_relative "../lib/air_test/cli"
 
+# Color constants
 GREEN = "\e[32m"
 YELLOW = "\e[33m"
 RED = "\e[31m"
 CYAN = "\e[36m"
 RESET = "\e[0m"
 
-puts "#{CYAN}🚀 Initializing AirTest for your Rails project...#{RESET}\n"
+def show_help
+  puts <<~HELP
+    #{CYAN}AirTest CLI - Test Generation Tool#{RESET}
 
-initializer_path = "config/initializers/air_test.rb"
-if File.exist?(initializer_path)
-  puts "#{YELLOW}⚠️  #{initializer_path} already exists. Skipping.#{RESET}"
-else
-  FileUtils.mkdir_p(File.dirname(initializer_path))
-  File.write(initializer_path, <<~RUBY)
-    AirTest.configure do |config|
-      config.notion_token = ENV['NOTION_TOKEN']
-      config.notion_database_id = ENV['NOTION_DATABASE_ID']
-      config.github_token = ENV['GITHUB_BOT_TOKEN']
-      config.repo = 'your-org/your-repo' # format: 'organization/repo_name'
-    end
-  RUBY
-  puts "#{GREEN}✅ Created #{initializer_path}#{RESET}"
-end
+    Usage: air_test [command] [options]
 
-["spec/features", "spec/steps"].each do |dir|
-  if Dir.exist?(dir)
-    puts "#{YELLOW}⚠️  #{dir} already exists. Skipping.#{RESET}"
-  else
-    FileUtils.mkdir_p(dir)
-    puts "#{GREEN}✅ Created #{dir}/#{RESET}"
-  end
-end
+    Commands:
+      init [--silent]           Initialize AirTest configuration
+      generate [options]        Generate specs from tickets
+      create-pr [options]       Create PR for specific ticket
+      help                      Show this help message
 
-example_env = ".env.air_test.example"
-if File.exist?(example_env)
-  puts "#{YELLOW}⚠️  #{example_env} already exists. Skipping.#{RESET}"
-else
-  File.write(example_env, <<~ENV)
-    NOTION_TOKEN=your_notion_token
-    NOTION_DATABASE_ID=your_notion_database_id
-    GITHUB_BOT_TOKEN=your_github_token
-  ENV
-  puts "#{GREEN}✅ Created #{example_env}#{RESET}"
+    Generate Options:
+      --interactive             Interactive ticket selection
+      --search "keyword"        Search tickets by keyword
+      --dry-run                Preview changes without creating files
+      --no-pr                  Disable PR creation
+
+    Create PR Options:
+      --ticket-id ID           Ticket ID to create PR for
+
+    Global Options:
+      --silent                 Run in silent mode (use defaults)
+      --help                   Show this help message
+
+    Examples:
+      air_test init                    # Interactive initialization
+      air_test init --silent           # Silent initialization with defaults
+      air_test generate --interactive  # Interactive ticket selection
+      air_test generate --search "webhook" --dry-run
+      air_test create-pr --ticket-id 3 # Create PR for ticket #3
+      air_test help                    # Show this help
+  HELP
 end
 
-puts "\n🔎 Checking environment variables..."
-missing = []
-%w[NOTION_TOKEN NOTION_DATABASE_ID GITHUB_BOT_TOKEN].each do |var|
-  if ENV[var].nil? || ENV[var].empty?
-    puts "#{YELLOW}⚠️  #{var} is not set!#{RESET}"
-    missing << var
+def main
+  command = ARGV[0]
+  silent = ARGV.include?('--silent')
+
+  case command
+  when 'init'
+    cli = AirTest::CLI.new
+    cli.init(silent: silent)
+  when 'generate'
+    cli = AirTest::CLI.new
+    cli.generate(ARGV[1..-1])
+  when 'create-pr'
+    cli = AirTest::CLI.new
+    cli.create_pr(ARGV[1..-1])
+  when 'help', '--help', '-h', nil
+    show_help
   else
-    puts "#{GREEN}✅ #{var} is set#{RESET}"
+    puts "#{RED}❌ Unknown command: #{command}#{RESET}"
+    puts "Run 'air_test help' for usage information."
+    exit 1
   end
 end
 
-puts "\n✨ All set! Next steps:"
-puts "  1. Fill in your config/initializers/air_test.rb"
-puts "  2. Add your tokens to .env or your environment"
-puts "  3. Run: bundle exec rake air_test:generate_specs_from_notion"
-puts "\nHappy testing! 🎉"
+# Run the CLI
+main