ruby_raider 2.0.0 → 3.0.0

data/lib/scaffolding/scaffolding.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'yaml'
+require_relative 'name_normalizer'
+require_relative 'project_detector'
 
 class Scaffolding < Thor::Group
   include Thor::Actions
@@ -8,28 +11,48 @@ class Scaffolding < Thor::Group
   argument :name, optional: true
   argument :path, optional: true
 
+  attr_writer :uses
+
+  OVERRIDE_DIR = '.ruby_raider/templates'
+
   def self.source_root
     "#{File.dirname(__FILE__)}/templates"
   end
 
+  # Check for user template override before using default
+  def template(source, *args, &block)
+    override = File.join(OVERRIDE_DIR, File.basename(source))
+    if File.exist?(override)
+      super(File.expand_path(override), *args, &block)
+    else
+      super
+    end
+  end
+
+  # --- Generation methods ---
+
   def generate_page
-    template('page_object.tt', default_path("page_objects/pages/#{name}.rb", '_page.rb'))
+    template('page_object.tt', default_path("page_objects/pages/#{normalized_name}.rb", '_page.rb'))
   end
 
   def generate_feature
-    template('feature.tt', default_path("features/#{name}.feature", '.feature'))
+    template('feature.tt', default_path("features/#{normalized_name}.feature", '.feature'))
   end
 
   def generate_spec
-    template('spec.tt', default_path("spec/#{name}_page_spec.rb", '_spec.rb'))
+    template('spec.tt', default_path("spec/#{normalized_name}_page_spec.rb", '_spec.rb'))
   end
 
   def generate_helper
-    template('helper.tt', default_path("helpers/#{name}_helper.rb", '_helper.rb'))
+    template('helper.tt', default_path("helpers/#{normalized_name}_helper.rb", '_helper.rb'))
   end
 
   def generate_steps
-    template('steps.tt', default_path("features/step_definitions/#{name}_steps.rb", '_steps.rb'))
+    template('steps.tt', default_path("features/step_definitions/#{normalized_name}_steps.rb", '_steps.rb'))
+  end
+
+  def generate_component
+    template('component.tt', default_path("page_objects/components/#{normalized_name}.rb", '.rb'))
   end
 
   def generate_config
@@ -37,31 +60,155 @@ class Scaffolding < Thor::Group
              default_path('config/config.yml', '.yml'))
   end
 
+  def generate_spec_from_page(source_file, ai: false) # rubocop:disable Naming/MethodParameterName
+    require_relative 'page_introspector'
+    @introspected = PageIntrospector.new(source_file)
+    enrich_with_ai_scenarios if ai
+    template('spec_from_page.tt', "spec/#{normalized_name}_spec.rb")
+  end
+
+  def generate_page_from_url(analysis)
+    @url_data = analysis
+    template('page_from_url.tt', "page_objects/pages/#{normalized_name}.rb")
+  end
+
+  def generate_spec_from_url(analysis)
+    @url_data = analysis
+    template('spec_from_url.tt', "spec/#{normalized_name}_spec.rb")
+  end
+
+  # --- Deletion methods ---
+
   def delete_page
-    remove_file(default_path("page_objects/pages/#{name}.rb", '_page.rb'))
+    remove_file(default_path("page_objects/pages/#{normalized_name}.rb", '_page.rb'))
   end
 
   def delete_feature
-    remove_file(default_path("features/#{name}.feature", '.feature'))
+    remove_file(default_path("features/#{normalized_name}.feature", '.feature'))
   end
 
   def delete_spec
-    remove_file(default_path("spec/#{name}_page_spec.rb", '_spec.rb'))
+    remove_file(default_path("spec/#{normalized_name}_page_spec.rb", '_spec.rb'))
   end
 
   def delete_helper
-    remove_file(default_path("helpers/#{name}_helper.rb", '_helper.rb'))
+    remove_file(default_path("helpers/#{normalized_name}_helper.rb", '_helper.rb'))
   end
 
   def delete_steps
-    remove_file(default_path("features/step_definitions/#{name}_steps.rb", '_steps.rb'))
+    remove_file(default_path("features/step_definitions/#{normalized_name}_steps.rb", '_steps.rb'))
+  end
+
+  def delete_component
+    remove_file(default_path("page_objects/components/#{normalized_name}.rb", '.rb'))
   end
 
   def delete_config
     remove_file(default_path('config/config.yml', '.yml'))
   end
 
+  # --- Path planning (for dry-run) ---
+
+  def self.planned_path(name, type, custom_path = nil)
+    n = NameNormalizer.normalize(name)
+    case type.to_s
+    when 'page' then custom_path ? "#{custom_path}/#{n}_page.rb" : "page_objects/pages/#{n}.rb"
+    when 'spec' then custom_path ? "#{custom_path}/#{n}_spec.rb" : "spec/#{n}_page_spec.rb"
+    when 'feature' then custom_path ? "#{custom_path}/#{n}.feature" : "features/#{n}.feature"
+    when 'steps' then custom_path ? "#{custom_path}/#{n}_steps.rb" : "features/step_definitions/#{n}_steps.rb"
+    when 'helper' then custom_path ? "#{custom_path}/#{n}_helper.rb" : "helpers/#{n}_helper.rb"
+    when 'component' then custom_path ? "#{custom_path}/#{n}.rb" : "page_objects/components/#{n}.rb"
+    when 'model' then "models/data/#{n}.yml"
+    end
+  end
+
+  # --- Template helpers (available in .tt files) ---
+
+  def class_name
+    NameNormalizer.to_class_name(name)
+  end
+
+  def page_class_name
+    NameNormalizer.to_page_class(name)
+  end
+
+  def normalized_name
+    NameNormalizer.normalize(name)
+  end
+
+  def nested?
+    NameNormalizer.nested?(name)
+  end
+
+  def module_parts
+    NameNormalizer.module_parts(name)
+  end
+
+  def leaf_name
+    NameNormalizer.leaf_name(name)
+  end
+
+  def automation_type
+    ScaffoldProjectDetector.detect_automation
+  end
+
+  def framework_type
+    ScaffoldProjectDetector.detect_framework
+  end
+
+  def project_config
+    ScaffoldProjectDetector.config
+  end
+
+  def selenium?
+    automation_type == 'selenium'
+  end
+
+  def capybara?
+    automation_type == 'capybara'
+  end
+
+  def watir?
+    automation_type == 'watir'
+  end
+
+  def uses_list
+    Array(@uses).reject(&:empty?)
+  end
+
+  attr_reader :introspected, :url_data
+
+  def ai_scenarios
+    @ai_scenarios || {}
+  end
+
   def default_path(standard_path, file_type)
-    path ? "#{path}/#{name}#{file_type}" : standard_path
+    path ? "#{path}/#{normalized_name}#{file_type}" : standard_path
+  end
+
+  private
+
+  def enrich_with_ai_scenarios
+    require_relative '../llm/client'
+    require_relative '../llm/prompts'
+    require_relative '../llm/response_parser'
+
+    return unless Llm::Client.available?
+
+    response = Llm::Client.complete(
+      Llm::Prompts.generate_test_scenarios(
+        @introspected.class_name,
+        @introspected.methods,
+        automation_type,
+        framework_type
+      ),
+      system_prompt: Llm::Prompts.system_prompt
+    )
+    scenarios = Llm::ResponseParser.extract_scenarios(response)
+    return unless scenarios
+
+    @ai_scenarios = scenarios.each_with_object({}) do |s, hash|
+      hash[s[:method]] = s
+    end
   end
 end

data/lib/scaffolding/templates/component.tt

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/component'
+
+class <%= class_name %> < Component
+<%- if capybara? -%>
+
+  # Example: find('.selector').text
+<%- elsif selenium? -%>
+
+  def content
+    component.text
+  end
+
+  private
+
+  # Elements
+  # Example: driver.find_element(css: '.selector')
+<%- elsif watir? -%>
+
+  def content
+    component.text
+  end
+
+  private
+
+  # Elements
+  # Example: browser.element(css: '.selector')
+<%- end -%>
+end

data/lib/scaffolding/templates/feature.tt

@@ -1,6 +1,6 @@
-Feature: <%= name.capitalize %>
+Feature: <%= class_name %>
 
 Scenario: Scenario name
-    Given I am
-    When I do
-    Then I see
+    Given I am on the <%= normalized_name.tr('_', ' ') %> page
+    When I perform an action
+    Then I see the expected result

data/lib/scaffolding/templates/helper.tt

@@ -1,3 +1,17 @@
-module <%= name.split('_').map {|word| word.capitalize }.join + 'Helper' %>
+# frozen_string_literal: true
+
+<% if nested? -%>
+<% module_parts.each_with_index do |mod, i| -%>
+<%= '  ' * i %>module <%= mod %>
+<% end -%>
+<%= '  ' * module_parts.size %>module <%= NameNormalizer.to_class_name(leaf_name) %>Helper
+<%= '  ' * module_parts.size %>  # Add your helper code here
+<%= '  ' * module_parts.size %>end
+<% module_parts.each_with_index do |_mod, i| -%>
+<%= '  ' * (module_parts.size - i - 1) %>end
+<% end -%>
+<% else -%>
+module <%= class_name %>Helper
   # Add your helper code here
 end
+<% end -%>

data/lib/scaffolding/templates/page_from_url.tt

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/page'
+
+class <%= page_class_name %> < Page
+  def url(_page)
+    '<%= url_data[:url_path] %>'
+  end
+
+  # Actions
+<%- form_elements = url_data[:elements].select { |e| %i[input textarea select].include?(e[:type]) } -%>
+<%- button_elements = url_data[:elements].select { |e| %i[button submit].include?(e[:type]) } -%>
+<%- unless form_elements.empty? -%>
+
+<%- if capybara? -%>
+  def fill_form(<%= form_elements.map { |e| e[:name] }.join(', ') %>)
+<%- form_elements.each do |el| -%>
+<%- if el[:locator][:type] == :id -%>
+    fill_in '<%= el[:locator][:value] %>', with: <%= el[:name] %>
+<%- elsif el[:locator][:type] == :name -%>
+    fill_in '<%= el[:locator][:value] %>', with: <%= el[:name] %>
+<%- else -%>
+    find('<%= el[:locator][:value] %>').set(<%= el[:name] %>)
+<%- end -%>
+<%- end -%>
+  end
+<%- else -%>
+  def fill_form(<%= form_elements.map { |e| e[:name] }.join(', ') %>)
+<%- form_elements.each do |el| -%>
+    <%= el[:name] %>_field.<%= selenium? ? 'send_keys' : 'set' %> <%= el[:name] %>
+<%- end -%>
+  end
+<%- end -%>
+<%- end -%>
+<%- unless button_elements.empty? -%>
+
+<%- button_elements.each do |el| -%>
+<%- if capybara? -%>
+  def click_<%= el[:name] %>
+    click_button '<%= el[:text] || el[:name] %>'
+  end
+<%- else -%>
+  def click_<%= el[:name] %>
+    <%= el[:name] %>_button.click
+  end
+<%- end -%>
+<%- end -%>
+<%- end -%>
+<%- unless capybara? -%>
+
+  private
+
+  # Elements
+<%- form_elements.each do |el| -%>
+
+  def <%= el[:name] %>_field
+<%- if selenium? -%>
+    driver.find_element(<%= el[:locator][:type] %>: '<%= el[:locator][:value] %>')
+<%- elsif watir? -%>
+    browser.<%= el[:type] == :select ? 'select' : 'text_field' %>(<%= el[:locator][:type] %>: '<%= el[:locator][:value] %>')
+<%- end -%>
+  end
+<%- end -%>
+<%- button_elements.each do |el| -%>
+
+  def <%= el[:name] %>_button
+<%- if selenium? -%>
+    driver.find_element(<%= el[:locator][:type] %>: '<%= el[:locator][:value] %>')
+<%- elsif watir? -%>
+    browser.button(<%= el[:locator][:type] %>: '<%= el[:locator][:value] %>')
+<%- end -%>
+  end
+<%- end -%>
+<%- end -%>
+end

data/lib/scaffolding/templates/page_object.tt

@@ -1,12 +1,61 @@
 # frozen_string_literal: true
 
 require_relative '../abstract/page'
+<%- uses_list.each do |dep| -%>
+require_relative '<%= dep %>'
+<%- end -%>
+<% if nested? -%>
+<% module_parts.each_with_index do |mod, i| -%>
+<%= '  ' * i %>module <%= mod %>
+<% end -%>
+<%= '  ' * module_parts.size %>class <%= NameNormalizer.to_class_name(leaf_name) %>Page < Page
+<%- if project_config['url'] -%>
+<%= '  ' * module_parts.size %>  def url(_page)
+<%= '  ' * module_parts.size %>    '<%= normalized_name %>'
+<%= '  ' * module_parts.size %>  end
+<%- end -%>
 
-class <%= name.split('_').map {|word| word.capitalize }.join %> < Page
+<%= '  ' * module_parts.size %>  # Actions
+<%- if capybara? -%>
+
+<%= '  ' * module_parts.size %>  # Example: fill_in 'field_id', with: value
+<%- else -%>
+
+<%= '  ' * module_parts.size %>  private
+
+<%= '  ' * module_parts.size %>  # Elements
+<%- if selenium? -%>
+<%= '  ' * module_parts.size %>  # Example: driver.find_element(id: 'element_id')
+<%- elsif watir? -%>
+<%= '  ' * module_parts.size %>  # Example: browser.text_field(id: 'element_id')
+<%- end -%>
+<%- end -%>
+<%= '  ' * module_parts.size %>end
+<% module_parts.each_with_index do |_mod, i| -%>
+<%= '  ' * (module_parts.size - i - 1) %>end
+<% end -%>
+<% else -%>
+class <%= page_class_name %> < Page
+<%- if project_config['url'] -%>
+  def url(_page)
+    '<%= normalized_name %>'
+  end
+<%- end -%>
 
   # Actions
+<%- if capybara? -%>
+
+  # Example: fill_in 'field_id', with: value
+<%- else -%>
 
   private
 
   # Elements
+<%- if selenium? -%>
+  # Example: driver.find_element(id: 'element_id')
+<%- elsif watir? -%>
+  # Example: browser.text_field(id: 'element_id')
+<%- end -%>
+<%- end -%>
 end
+<% end -%>

data/lib/scaffolding/templates/spec.tt

@@ -1,4 +1,35 @@
-require_relative '../page_objects/pages/<%= name %>'
+# frozen_string_literal: true
 
-describe '<%= name.split('_').map {|word| word.capitalize }.join %>' do
+require_relative '../page_objects/pages/<%= normalized_name %>'
+<%- uses_list.each do |dep| -%>
+require_relative '../page_objects/pages/<%= dep %>'
+<%- end -%>
+
+describe '<%= page_class_name %>' do
+<%- if selenium? -%>
+  let(:page) { <%= page_class_name %>.new(driver) }
+<%- elsif watir? -%>
+  let(:page) { <%= page_class_name %>.new(browser) }
+<%- elsif capybara? -%>
+  let(:page) { <%= page_class_name %>.new }
+<%- end -%>
+<%- uses_list.each do |dep| -%>
+  let(:<%= dep %>) { <%= NameNormalizer.to_page_class(dep) %>.new<%= selenium? ? '(driver)' : watir? ? '(browser)' : '' %> }
+<%- end -%>
+<%- if project_config['url'] -%>
+
+  before do
+<%- if capybara? -%>
+    visit '<%= normalized_name %>'
+<%- elsif selenium? -%>
+    driver.navigate.to "\#{project_config['url']}/<%= normalized_name %>"
+<%- elsif watir? -%>
+    browser.goto "\#{project_config['url']}/<%= normalized_name %>"
+<%- end -%>
+  end
+<%- end -%>
+
+  it 'loads successfully' do
+    pending 'implement test'
+  end
 end

data/lib/scaffolding/templates/spec_from_page.tt

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../page_objects/pages/<%= normalized_name %>'
+
+describe '<%= introspected.class_name %>' do
+<%- if selenium? -%>
+  let(:page) { <%= introspected.class_name %>.new(driver) }
+<%- elsif watir? -%>
+  let(:page) { <%= introspected.class_name %>.new(browser) }
+<%- elsif capybara? -%>
+  let(:page) { <%= introspected.class_name %>.new }
+<%- end -%>
+<%- introspected.methods.each do |method| -%>
+<%- scenario = ai_scenarios[method[:name]] -%>
+
+  describe '#<%= method[:name] %>' do
+    it '<%= scenario ? scenario[:description] : method[:name].tr("_", " ") %>' do
+<%- if method[:params].empty? -%>
+      page.<%= method[:name] %>
+<%- else -%>
+      page.<%= method[:name] %>(<%= method[:params].map { |p| "'#{p}'" }.join(', ') %>)
+<%- end -%>
+<%- if scenario && scenario[:assertion_hint] -%>
+      pending '<%= scenario[:assertion_hint] %>'
+<%- else -%>
+      pending 'add assertions'
+<%- end -%>
+    end
+  end
+<%- end -%>
+end

data/lib/scaffolding/templates/spec_from_url.tt

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative '../page_objects/pages/<%= normalized_name %>'
+
+describe '<%= page_class_name %>' do
+<%- if selenium? -%>
+  let(:page) { <%= page_class_name %>.new(driver) }
+<%- elsif watir? -%>
+  let(:page) { <%= page_class_name %>.new(browser) }
+<%- elsif capybara? -%>
+  let(:page) { <%= page_class_name %>.new }
+<%- end -%>
+
+  before do
+<%- if capybara? -%>
+    visit '<%= url_data[:url_path] %>'
+<%- elsif selenium? -%>
+    driver.navigate.to '<%= url_data[:url] %>'
+<%- elsif watir? -%>
+    browser.goto '<%= url_data[:url] %>'
+<%- end -%>
+  end
+<%- form_elements = url_data[:elements].select { |e| %i[input textarea select].include?(e[:type]) } -%>
+<%- unless form_elements.empty? -%>
+
+  describe '#fill_form' do
+    it 'fills in the form fields' do
+      page.fill_form(<%= form_elements.map { |e| "'test_#{e[:name]}'" }.join(', ') %>)
+      pending 'add assertions'
+    end
+  end
+<%- end -%>
+<%- url_data[:elements].select { |e| %i[button submit].include?(e[:type]) }.each do |el| -%>
+
+  describe '#click_<%= el[:name] %>' do
+    it 'clicks the <%= el[:name].tr("_", " ") %> button' do
+      page.click_<%= el[:name] %>
+      pending 'add assertions'
+    end
+  end
+<%- end -%>
+
+  it 'loads the page' do
+    pending 'add assertions'
+  end
+end

data/lib/scaffolding/templates/steps.tt

@@ -1,12 +1,24 @@
 # frozen_string_literal: true
 
-require_relative '../../page_objects/pages/<%= name %>'
+require_relative '../../page_objects/pages/<%= normalized_name %>'
+<%- uses_list.each do |dep| -%>
+require_relative '../../page_objects/pages/<%= dep %>'
+<%- end -%>
 
-Given ('') do
+Given('I am on the <%= normalized_name.tr("_", " ") %> page') do
+<%- if selenium? -%>
+  @page = <%= page_class_name %>.new(driver)
+<%- elsif watir? -%>
+  @page = <%= page_class_name %>.new(browser)
+<%- elsif capybara? -%>
+  visit '<%= normalized_name %>'
+<%- end -%>
 end
 
-When ('') do
+When('I perform an action') do
+  pending 'implement step'
 end
 
-Then ('') do
-end
+Then('I see the expected result') do
+  pending 'implement step'
+end