ruby_raider 1.1.4 → 3.0.0

data/RELEASE_QUICK_GUIDE.md

@@ -0,0 +1,77 @@
+# Quick Release Guide
+
+## TL;DR - One Command Release
+
+```bash
+# Bug fixes: 1.1.4 -> 1.1.5
+bin/release patch
+
+# New features: 1.1.4 -> 1.2.0
+bin/release minor
+
+# Breaking changes: 1.1.4 -> 2.0.0
+bin/release major
+```
+
+**Everything else is automated!**
+
+---
+
+## What Happens
+
+1. ✅ Script validates & tests locally
+2. ✅ Updates version in `lib/version`
+3. ✅ Creates git commit + tag
+4. ✅ Pushes to GitHub
+5. ✅ GitHub Actions automatically:
+   - Runs tests
+   - Builds gem
+   - Publishes to RubyGems
+   - Creates GitHub Release
+
+**Duration:** ~3 minutes total
+
+---
+
+## Before Releasing
+
+Ensure:
+- [ ] All changes merged to master
+- [ ] Tests passing: `bundle exec rspec`
+- [ ] Linters passing: `bundle exec rubocop && bundle exec reek`
+
+---
+
+## Monitor Progress
+
+**GitHub Actions:**
+https://github.com/RubyRaider/ruby_raider/actions
+
+**GitHub Releases:**
+https://github.com/RubyRaider/ruby_raider/releases
+
+**RubyGems:**
+https://rubygems.org/gems/ruby_raider
+
+---
+
+## First-Time Setup
+
+Add RubyGems API key to GitHub Secrets:
+
+1. Get API key:
+   ```bash
+   gem signin
+   # Visit https://rubygems.org/profile/edit
+   # Copy API key
+   ```
+
+2. Add to GitHub:
+   - Go to: Settings → Secrets → Actions
+   - Add `RUBYGEMS_API_KEY` secret
+
+---
+
+## Full Documentation
+
+See [RELEASE.md](RELEASE.md) for complete documentation.

data/Steepfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+
+  # External gem stubs (not typed)
+  library 'yaml'
+  library 'fileutils'
+  library 'erb'
+  library 'open3'
+  library 'timeout'
+  library 'uri'
+  library 'net-http'
+  library 'json'
+  library 'logger'
+  library 'forwardable'
+
+  # Configure strictness — start lenient, tighten over time
+  configure_code_diagnostics(Steep::Diagnostic::Ruby.lenient)
+end

data/assets/ruby_raider_logo.svg

@@ -0,0 +1,51 @@
+<svg width="512" height="512" viewBox="100 100 480 480" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <!-- LEFT HORN -->
+  <polygon points="220,248 218,218 168,155" fill="#d4a017"/>
+  <polygon points="220,248 168,155 205,230" fill="#e8c840" opacity="0.7"/>
+  <polygon points="218,218 168,155 205,230" fill="#b8860b" opacity="0.8"/>
+  <line x1="205" y1="230" x2="168" y2="155" stroke="#f5e680" stroke-width="1" opacity="0.4"/>
+  <polygon points="222,250 218,218 215,218 219,250" fill="#c9960c" opacity="0.6"/>
+  <!-- RIGHT HORN -->
+  <polygon points="460,248 462,218 512,155" fill="#d4a017"/>
+  <polygon points="460,248 512,155 475,230" fill="#e8c840" opacity="0.7"/>
+  <polygon points="462,218 512,155 475,230" fill="#b8860b" opacity="0.8"/>
+  <line x1="475" y1="230" x2="512" y2="155" stroke="#f5e680" stroke-width="1" opacity="0.4"/>
+  <polygon points="458,250 462,218 465,218 461,250" fill="#c9960c" opacity="0.6"/>
+  <!-- PAVILION (chin/jaw) -->
+  <polygon points="340,530 250,380 230,340 450,340 430,380" fill="#4d0c1a"/>
+  <polygon points="340,530 250,380 290,380" fill="#5c1220"/>
+  <polygon points="340,530 290,380 340,370" fill="#6a1525"/>
+  <polygon points="340,530 340,370 390,380" fill="#5c1220"/>
+  <polygon points="340,530 390,380 430,380" fill="#4d0c1a"/>
+  <!-- GIRDLE (visor band) -->
+  <rect x="220" y="330" width="240" height="16" rx="2" fill="#2a2a40" opacity="0.85"/>
+  <rect x="220" y="330" width="240" height="16" rx="2" fill="none" stroke="#555555" stroke-width="0.5" opacity="0.4"/>
+  <g fill="#888888" opacity="0.6">
+    <circle cx="255" cy="338" r="3"/><circle cx="285" cy="338" r="3"/>
+    <circle cx="315" cy="338" r="3"/><circle cx="345" cy="338" r="3"/>
+    <circle cx="375" cy="338" r="3"/><circle cx="405" cy="338" r="3"/>
+  </g>
+  <g fill="#bbbbbb" opacity="0.3">
+    <circle cx="254" cy="337" r="1.3"/><circle cx="284" cy="337" r="1.3"/>
+    <circle cx="314" cy="337" r="1.3"/><circle cx="344" cy="337" r="1.3"/>
+    <circle cx="374" cy="337" r="1.3"/><circle cx="404" cy="337" r="1.3"/>
+  </g>
+  <!-- CROWN FACETS -->
+  <polygon points="340,130 460,250 460,330 220,330 220,250" fill="#7b1c2a"/>
+  <polygon points="340,130 410,195 340,250 270,195" fill="#d4374b"/>
+  <polygon points="340,140 390,190 340,235 290,190" fill="#e85a6e" opacity="0.6"/>
+  <polygon points="220,250 270,195 220,330" fill="#6a1525"/>
+  <polygon points="460,250 410,195 460,330" fill="#6a1525"/>
+  <polygon points="270,195 340,250 220,330 220,250" fill="#8c2234" opacity="0.8"/>
+  <polygon points="410,195 340,250 460,330 460,250" fill="#8c2234" opacity="0.8"/>
+  <!-- TABLE (top facet) -->
+  <polygon points="340,155 385,185 340,215 295,185" fill="#ff7088" opacity="0.45"/>
+  <!-- Crown highlight -->
+  <line x1="280" y1="200" x2="340" y2="140" stroke="#ff9db0" stroke-width="1" opacity="0.3"/>
+  <line x1="340" y1="140" x2="400" y2="200" stroke="#ff9db0" stroke-width="1" opacity="0.2"/>
+  <!-- EYES -->
+  <ellipse cx="300" cy="308" rx="12" ry="8" fill="#1a0a10"/>
+  <circle cx="296" cy="305" r="2" fill="#ffffff" opacity="0.6"/>
+  <ellipse cx="380" cy="308" rx="12" ry="8" fill="#1a0a10"/>
+  <circle cx="376" cy="305" r="2" fill="#ffffff" opacity="0.6"/>
+</svg>

data/bin/release

@@ -0,0 +1,186 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Automated release script for Ruby Raider
+# Usage: bin/release [major|minor|patch]
+
+require 'fileutils'
+
+class ReleaseManager
+  VERSION_FILE = 'lib/version'
+  GEMSPEC_FILE = 'ruby_raider.gemspec'
+
+  def initialize(bump_type)
+    @bump_type = bump_type
+    @current_version = read_version
+  end
+
+  def run
+    validate_clean_repo
+    validate_branch
+    validate_tests
+
+    new_version = calculate_new_version
+    confirm_release(new_version)
+
+    update_version(new_version)
+    commit_and_tag(new_version)
+    push_release
+
+    success_message(new_version)
+  end
+
+  private
+
+  def read_version
+    File.read(VERSION_FILE).strip
+  end
+
+  def validate_clean_repo
+    status = `git status --porcelain`.strip
+    return if status.empty?
+
+    puts '❌ Error: Working directory is not clean'
+    puts 'Please commit or stash your changes first:'
+    puts status
+    exit 1
+  end
+
+  def validate_branch
+    branch = `git branch --show-current`.strip
+    return unless branch != 'master' && branch != 'main'
+
+    puts "⚠️  Warning: You're on branch '#{branch}', not master/main"
+    print 'Continue anyway? [y/N] '
+    exit 1 unless gets.strip.downcase == 'y'
+  end
+
+  def validate_tests
+    puts '🧪 Running tests...'
+
+    # Run unit tests
+    unless system('bundle exec rspec spec/generators/ --format progress')
+      puts '❌ Unit tests failed'
+      exit 1
+    end
+
+    # Run integration tests (skip slow e2e tests)
+    unless system('bundle exec rspec spec/integration/ --tag ~slow --format progress')
+      puts '❌ Integration tests failed'
+      exit 1
+    end
+
+    # Run linters
+    unless system('bundle exec rubocop')
+      puts '❌ RuboCop failed'
+      exit 1
+    end
+
+    unless system('bundle exec reek')
+      puts '❌ Reek failed'
+      exit 1
+    end
+
+    puts '✓ All tests and linters passed'
+  end
+
+  def calculate_new_version
+    major, minor, patch = @current_version.split('.').map(&:to_i)
+
+    case @bump_type
+    when 'major'
+      "#{major + 1}.0.0"
+    when 'minor'
+      "#{major}.#{minor + 1}.0"
+    when 'patch'
+      "#{major}.#{minor}.#{patch + 1}"
+    else
+      puts "❌ Error: Invalid bump type '#{@bump_type}'"
+      puts 'Usage: bin/release [major|minor|patch]'
+      exit 1
+    end
+  end
+
+  def confirm_release(new_version)
+    puts "\n📦 Release Summary"
+    puts "  Current version: #{@current_version}"
+    puts "  New version:     #{new_version}"
+    puts "  Bump type:       #{@bump_type}"
+    puts "\nThis will:"
+    puts "  1. Update lib/version to #{new_version}"
+    puts '  2. Commit changes'
+    puts "  3. Create git tag v#{new_version}"
+    puts '  4. Push to GitHub (triggers automated release)'
+    puts '  5. Publish gem to RubyGems (via GitHub Actions)'
+    puts '  6. Create GitHub release with changelog'
+
+    print "\nProceed with release? [y/N] "
+    exit 0 unless gets.strip.downcase == 'y'
+  end
+
+  def update_version(new_version)
+    puts "\n📝 Updating version to #{new_version}..."
+    File.write(VERSION_FILE, "#{new_version}\n")
+    puts "✓ Updated #{VERSION_FILE}"
+  end
+
+  def commit_and_tag(new_version)
+    puts "\n📌 Creating commit and tag..."
+
+    # Commit version change
+    system("git add #{VERSION_FILE}")
+    system("git commit -m 'Bump version to #{new_version}'")
+
+    # Create annotated tag
+    system("git tag -a v#{new_version} -m 'Release version #{new_version}'")
+
+    puts "✓ Created commit and tag v#{new_version}"
+  end
+
+  def push_release
+    puts "\n🚀 Pushing to GitHub..."
+
+    # Push commit
+    unless system('git push origin HEAD')
+      puts '❌ Failed to push commits'
+      exit 1
+    end
+
+    # Push tag (this triggers the release workflow)
+    unless system('git push origin --tags')
+      puts '❌ Failed to push tags'
+      exit 1
+    end
+
+    puts '✓ Pushed to GitHub'
+  end
+
+  def success_message(new_version)
+    puts "\n#{'=' * 60}"
+    puts "🎉 Release #{new_version} initiated successfully!"
+    puts '=' * 60
+    puts "\nThe GitHub Actions workflow is now:"
+    puts '  1. Running tests'
+    puts '  2. Building the gem'
+    puts '  3. Publishing to RubyGems'
+    puts '  4. Creating GitHub release'
+    puts "\nMonitor progress at:"
+    puts '  https://github.com/RubyRaider/ruby_raider/actions'
+    puts "\nRelease will be available at:"
+    puts "  https://github.com/RubyRaider/ruby_raider/releases/tag/v#{new_version}"
+    puts "  https://rubygems.org/gems/ruby_raider/versions/#{new_version}"
+    puts "\n✨ Thank you for contributing to Ruby Raider!"
+  end
+end
+
+# Main execution
+if ARGV.length != 1
+  puts 'Usage: bin/release [major|minor|patch]'
+  puts "\nExamples:"
+  puts '  bin/release patch   # 1.1.4 -> 1.1.5 (bug fixes)'
+  puts '  bin/release minor   # 1.1.4 -> 1.2.0 (new features)'
+  puts '  bin/release major   # 1.1.4 -> 2.0.0 (breaking changes)'
+  exit 1
+end
+
+ReleaseManager.new(ARGV[0]).run

data/lib/adopter/adopt_menu.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+require_relative 'project_analyzer'
+require_relative 'plan_builder'
+require_relative 'migrator'
+
+module Adopter
+  class AdoptMenu
+    WEB_AUTOMATIONS = %w[selenium capybara watir].freeze
+    TEST_FRAMEWORKS = %w[rspec cucumber minitest].freeze
+    CI_PLATFORMS = %w[github gitlab].freeze
+
+    def initialize
+      @prompt = TTY::Prompt.new
+    end
+
+    def run
+      source_path = ask_source_path
+      detection = preview_detection(source_path)
+      target_automation = ask_target_automation(detection[:automation])
+      target_framework = ask_target_framework(detection[:framework])
+      output_path = ask_output_path
+      ci_platform = ask_ci_platform(detection[:ci_platform])
+
+      execute_adoption(
+        source_path:,
+        output_path:,
+        target_automation:,
+        target_framework:,
+        ci_platform:
+      )
+    end
+
+    # Programmatic entry point for raider_desktop and CLI --parameters
+    def self.adopt(params)
+      validate_params!(params)
+
+      analysis = ProjectAnalyzer.new(params[:source_path]).analyze
+      plan = PlanBuilder.new(analysis, params).build
+      results = Migrator.new(plan).execute
+
+      { plan:, results: }
+    end
+
+    def self.validate_params!(params)
+      raise ArgumentError, 'source_path is required' unless params[:source_path]
+      raise ArgumentError, 'output_path is required' unless params[:output_path]
+      raise ArgumentError, 'target_automation is required' unless params[:target_automation]
+      raise ArgumentError, 'target_framework is required' unless params[:target_framework]
+
+      raise ArgumentError, "target_automation must be one of: #{WEB_AUTOMATIONS.join(', ')}" unless WEB_AUTOMATIONS.include?(params[:target_automation])
+
+      return if TEST_FRAMEWORKS.include?(params[:target_framework])
+
+      raise ArgumentError, "target_framework must be one of: #{TEST_FRAMEWORKS.join(', ')}"
+    end
+
+    private
+
+    def ask_source_path
+      path = @prompt.ask('Enter the path to your existing test project:') do |q|
+        q.required true
+        q.validate ->(input) { Dir.exist?(input) }
+        q.messages[:valid?] = 'Directory does not exist: %<value>s'
+      end
+      File.expand_path(path)
+    end
+
+    def preview_detection(source_path)
+      detection = ProjectDetector.detect(source_path)
+      @prompt.say("\nDetected project settings:")
+      @prompt.say("  Automation: #{detection[:automation] || 'unknown'}")
+      @prompt.say("  Framework:  #{detection[:framework] || 'unknown'}")
+      @prompt.say("  Browser:    #{detection[:browser] || 'not detected'}")
+      @prompt.say("  URL:        #{detection[:url] || 'not detected'}")
+      @prompt.say("  CI:         #{detection[:ci_platform] || 'none'}")
+      @prompt.say('')
+      detection
+    end
+
+    def ask_target_automation(detected)
+      default = WEB_AUTOMATIONS.include?(detected) ? detected : nil
+      @prompt.select('Select target automation framework:', WEB_AUTOMATIONS.map(&:capitalize),
+                     default: default&.capitalize) do |menu|
+        menu.choice :Quit, -> { exit }
+      end.downcase
+    end
+
+    def ask_target_framework(detected)
+      default = TEST_FRAMEWORKS.include?(detected) ? detected : nil
+      @prompt.select('Select target test framework:', TEST_FRAMEWORKS.map(&:capitalize),
+                     default: default&.capitalize) do |menu|
+        menu.choice :Quit, -> { exit }
+      end.downcase
+    end
+
+    def ask_output_path
+      @prompt.ask('Enter the output path for the new Raider project:') do |q|
+        q.required true
+      end
+    end
+
+    def ask_ci_platform(detected)
+      choices = [{ name: 'Github Actions', value: 'github' },
+                 { name: 'Gitlab CI/CD', value: 'gitlab' },
+                 { name: 'No CI', value: nil }]
+      default = case detected
+                when 'github' then 'Github Actions'
+                when 'gitlab' then 'Gitlab CI/CD'
+                end
+      @prompt.select('Configure CI/CD?', choices, default:)
+    end
+
+    def execute_adoption(params)
+      @prompt.say("\nAdopting project...")
+      result = self.class.adopt(params)
+      print_results(result[:plan], result[:results])
+    rescue MobileProjectError => e
+      @prompt.error(e.message)
+    rescue StandardError => e
+      @prompt.error("Adoption failed: #{e.message}")
+    end
+
+    def print_results(plan, results)
+      @prompt.say("\nAdoption complete!")
+      @prompt.say("  Pages converted:    #{results[:pages]}")
+      @prompt.say("  Tests converted:    #{results[:tests]}")
+      @prompt.say("  Features copied:    #{results[:features]}")
+      @prompt.say("  Steps converted:    #{results[:steps]}")
+
+      unless results[:errors].empty?
+        @prompt.warn("\nErrors:")
+        results[:errors].each { |e| @prompt.warn("  - #{e}") }
+      end
+
+      unless plan.warnings.empty?
+        @prompt.warn("\nWarnings:")
+        plan.warnings.each { |w| @prompt.warn("  - #{w}") }
+      end
+
+      @prompt.say("\nOutput: #{plan.output_path}")
+      @prompt.say("Run: cd #{plan.output_path} && bundle install")
+    end
+  end
+end

data/lib/adopter/converters/base_converter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Adopter
+  module Converters
+    class BaseConverter
+      RAIDER_BASE_CLASSES = %w[Page BasePage AbstractPage].freeze
+
+      def convert_page(content, _page_info)
+        content
+      end
+
+      def convert_test(content, _test_info)
+        content
+      end
+
+      private
+
+      def ensure_frozen_string_literal(content)
+        return content if content.include?('frozen_string_literal')
+
+        "# frozen_string_literal: true\n\n#{content}"
+      end
+
+      def update_base_class(content, target_base = 'Page')
+        content.gsub(/class\s+(\w+)\s*<\s*([\w:]+)/) do
+          class_name = ::Regexp.last_match(1)
+          current_base = ::Regexp.last_match(2)
+          if raider_compatible_base?(current_base)
+            "class #{class_name} < #{target_base}"
+          else
+            "class #{class_name} < #{current_base}"
+          end
+        end
+      end
+
+      def raider_compatible_base?(base_class)
+        RAIDER_BASE_CLASSES.include?(base_class) || base_class.include?('Page')
+      end
+
+      def update_require_paths(content, target_automation)
+        result = content.dup
+        result = update_page_requires(result)
+        update_helper_requires(result, target_automation)
+      end
+
+      def update_page_requires(content)
+        content.gsub(%r{require_relative\s+['"]\.*/(?:pages?|page_objects)/(\w+)['"]}) do
+          page_name = ::Regexp.last_match(1)
+          "require_relative '../page_objects/pages/#{page_name}'"
+        end
+      end
+
+      def update_helper_requires(content, target_automation)
+        case target_automation
+        when 'capybara'
+          content.gsub(%r{require_relative\s+['"]\.*/(?:helpers?|support)/(?:driver|browser)_?\w*['"]},
+                       "require_relative '../helpers/capybara_helper'")
+        when 'watir'
+          content.gsub(%r{require_relative\s+['"]\.*/(?:helpers?|support)/(?:driver|capybara)_?\w*['"]},
+                       "require_relative '../helpers/browser_helper'")
+        else
+          content.gsub(%r{require_relative\s+['"]\.*/(?:helpers?|support)/(?:browser|capybara)_?\w*['"]},
+                       "require_relative '../helpers/driver_helper'")
+        end
+      end
+
+      def remove_driver_arg(content)
+        content.gsub(/(\w+)\.new\(\s*(?:driver|browser|page)\s*\)/, '\1.new')
+      end
+
+      def swap_driver_arg(content, target_arg)
+        content.gsub(/(\w+)\.new\(\s*(?:driver|browser|page)\s*\)/, "\\1.new(#{target_arg})")
+      end
+
+      def driver_arg_for(target_automation)
+        case target_automation
+        when 'watir' then 'browser'
+        when 'capybara' then nil
+        else 'driver'
+        end
+      end
+    end
+  end
+end

data/lib/adopter/converters/identity_converter.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'base_converter'
+
+module Adopter
+  module Converters
+    class IdentityConverter < BaseConverter
+      def initialize(target_automation)
+        super()
+        @target_automation = target_automation
+      end
+
+      def convert_page(content, _page_info)
+        result = content.dup
+        result = ensure_frozen_string_literal(result)
+        result = update_base_class(result)
+        result = add_page_require(result)
+        update_page_instantiation(result)
+      end
+
+      def convert_test(content, _test_info)
+        result = content.dup
+        result = ensure_frozen_string_literal(result)
+        result = update_require_paths(result, @target_automation)
+        update_page_instantiation(result)
+      end
+
+      def convert_step(content)
+        result = content.dup
+        result = ensure_frozen_string_literal(result)
+        result = update_require_paths(result, @target_automation)
+        update_page_instantiation(result)
+      end
+
+      private
+
+      def add_page_require(content)
+        return content if content.include?("require_relative '../abstract/page'")
+
+        content.sub(/^(class\s)/, "require_relative '../abstract/page'\n\n\\1")
+      end
+
+      def update_page_instantiation(content)
+        arg = driver_arg_for(@target_automation)
+        if arg
+          swap_driver_arg(content, arg)
+        else
+          remove_driver_arg(content)
+        end
+      end
+    end
+  end
+end

data/lib/adopter/migration_plan.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Adopter
+  class MigrationPlan
+    attr_reader :source_path, :output_path, :target_automation, :target_framework,
+                :ci_platform, :skeleton_structure, :converted_pages, :converted_tests,
+                :converted_features, :converted_steps, :gemfile_additions,
+                :config_overrides, :warnings, :manual_actions
+
+    def initialize(attrs = {})
+      @source_path = attrs[:source_path]
+      @output_path = attrs[:output_path]
+      @target_automation = attrs[:target_automation]
+      @target_framework = attrs[:target_framework]
+      @ci_platform = attrs[:ci_platform]
+      @skeleton_structure = attrs[:skeleton_structure] || {}
+      @converted_pages = attrs[:converted_pages] || []
+      @converted_tests = attrs[:converted_tests] || []
+      @converted_features = attrs[:converted_features] || []
+      @converted_steps = attrs[:converted_steps] || []
+      @gemfile_additions = attrs[:gemfile_additions] || []
+      @config_overrides = attrs[:config_overrides] || {}
+      @warnings = attrs[:warnings] || []
+      @manual_actions = attrs[:manual_actions] || []
+    end
+
+    def to_h
+      {
+        source_path:,
+        output_path:,
+        target_automation:,
+        target_framework:,
+        ci_platform:,
+        skeleton_structure:,
+        converted_pages: converted_pages.map(&:to_h),
+        converted_tests: converted_tests.map(&:to_h),
+        converted_features: converted_features.map(&:to_h),
+        converted_steps: converted_steps.map(&:to_h),
+        gemfile_additions:,
+        config_overrides:,
+        warnings:,
+        manual_actions:
+      }
+    end
+
+    def to_json(*args)
+      require 'json'
+      to_h.to_json(*args)
+    end
+
+    def summary
+      {
+        pages: converted_pages.length,
+        tests: converted_tests.length,
+        features: converted_features.length,
+        steps: converted_steps.length,
+        custom_gems: gemfile_additions.length,
+        warnings: warnings.length,
+        manual_actions: manual_actions.length
+      }
+    end
+  end
+
+  ConvertedFile = Struct.new(:output_path, :content, :source_file, :conversion_notes, keyword_init: true) do
+    def to_h
+      {
+        output_path:,
+        content:,
+        source_file:,
+        conversion_notes:
+      }
+    end
+  end
+end