Add RuboCop linting and newline enforcement

.github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: Lint
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+        bundler-cache: true
+
+    - name: Run RuboCop
+      run: bundle exec rubocop
+
+    - name: Check for files missing newlines
+      run: bundle exec rake check_newlines

.rubocop.yml

@@ -0,0 +1,76 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - 'pkg/**/*'
+    - 'node_modules/**/*'
+    - 'specs_e2e/**/*'
+    - 'e2e/**/*'
+
+# Ensure all files end with a newline
+Layout/TrailingEmptyLines:
+  Enabled: true
+  EnforcedStyle: final_newline
+
+# Ensure no trailing whitespace
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Line length - be reasonable but not too strict
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/generators/**/*'
+
+# Allow longer blocks in specs and rake tasks
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '**/*.rake'
+    - 'Rakefile'
+    - '*.gemspec'
+
+# Allow longer methods in rake tasks
+Metrics/MethodLength:
+  Exclude:
+    - '**/*.rake'
+    - 'Rakefile'
+
+# String literals
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+  ConsistentQuotesInMultiline: true
+
+# Frozen string literal pragma
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+  Exclude:
+    - 'spec/**/*'
+
+# Documentation
+Style/Documentation:
+  Enabled: false
+
+# Allow compact module/class definitions
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# RSpec specific
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/NestedGroups:
+  Max: 4

Rakefile

@@ -5,4 +5,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/cypress_on_rails/*_spec.rb'
 end
 
+desc 'Run all CI checks (specs, linting, newlines)'
+task ci: %i[spec lint check_newlines]
+
 task default: %w[spec build]

bin/install-hooks

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fileutils'
+
+hooks_dir = File.expand_path('../.git/hooks', __dir__)
+pre_commit_hook = File.join(hooks_dir, 'pre-commit')
+
+# Create pre-commit hook content
+hook_content = <<~HOOK
+  #!/bin/sh
+  # Pre-commit hook to run linters and check for newlines
+
+  # Check for files missing newlines
+  echo "Checking for files missing newlines..."
+  bundle exec rake check_newlines
+  if [ $? -ne 0 ]; then
+    echo "❌ Some files are missing final newlines. Run 'bundle exec rake fix_newlines' to fix."
+    exit 1
+  fi
+
+  # Run RuboCop on staged Ruby files
+  echo "Running RuboCop on staged files..."
+  files=$(git diff --cached --name-only --diff-filter=ACM | grep -E '\\.(rb|rake)$')
+  if [ -n "$files" ]; then
+    bundle exec rubocop $files
+    if [ $? -ne 0 ]; then
+      echo "❌ RuboCop failed. Fix issues or run 'bundle exec rake lint:fix'"
+      exit 1
+    fi
+  fi
+
+  echo "✅ All checks passed!"
+HOOK
+
+# Create hooks directory if it doesn't exist
+FileUtils.mkdir_p(hooks_dir)
+
+# Write the pre-commit hook
+File.write(pre_commit_hook, hook_content)
+
+# Make it executable
+File.chmod(0o755, pre_commit_hook)
+
+puts '✅ Pre-commit hook installed successfully!'
+puts 'The hook will:'
+puts '  - Check that all files end with a newline'
+puts '  - Run RuboCop on staged Ruby files'
+puts ''
+puts 'To skip the hook temporarily, use: git commit --no-verify'

cypress-on-rails.gemspec

@@ -22,6 +22,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'factory_bot', '!= 6.4.5'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'gem-release'
+  s.add_development_dependency 'rubocop', '~> 1.81'
+  s.add_development_dependency 'rubocop-rake', '~> 0.7'
+  s.add_development_dependency 'rubocop-rspec', '~> 3.7'
+
+  s.required_ruby_version = '>= 3.0.0'
+
   s.metadata = {
     "bug_tracker_uri"   => "https://github.com/shakacode/cypress-on-rails/issues",
     "changelog_uri"     => "https://github.com/shakacode/cypress-on-rails/blob/master/CHANGELOG.md",

rakelib/lint.rake

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+desc 'Run RuboCop'
+task :rubocop do
+  sh 'bundle exec rubocop'
+end
+
+desc 'Run RuboCop with auto-correct'
+task 'rubocop:auto_correct' do
+  sh 'bundle exec rubocop -A'
+end
+
+desc 'Run all linters'
+task lint: :rubocop
+
+desc 'Auto-fix all linting issues'
+task 'lint:fix' => 'rubocop:auto_correct'
+
+desc 'Ensure all files end with newline'
+task :check_newlines do
+  files_without_newline = []
+
+  Dir.glob('**/*.{rb,rake,yml,yaml,md,gemspec,ru,erb,js,json}').each do |file|
+    next if file.include?('vendor/') || file.include?('node_modules/') || file.include?('.git/')
+    next if file.include?('pkg/') || file.include?('tmp/') || file.include?('coverage/')
+    next unless File.file?(file)
+
+    content = File.read(file)
+    files_without_newline << file unless content.empty? || content.end_with?("\n")
+  end
+
+  if files_without_newline.any?
+    puts 'Files missing final newline:'
+    files_without_newline.each { |f| puts "  #{f}" }
+    exit 1
+  else
+    puts '✓ All files end with newline'
+  end
+end
+
+desc 'Fix files missing final newline'
+task :fix_newlines do
+  fixed_files = []
+
+  Dir.glob('**/*.{rb,rake,yml,yaml,md,gemspec,ru,erb,js,json}').each do |file|
+    next if file.include?('vendor/') || file.include?('node_modules/') || file.include?('.git/')
+    next if file.include?('pkg/') || file.include?('tmp/') || file.include?('coverage/')
+    next unless File.file?(file)
+
+    content = File.read(file)
+    unless content.empty? || content.end_with?("\n")
+      File.write(file, content + "\n")
+      fixed_files << file
+    end
+  end
+
+  if fixed_files.any?
+    puts "Fixed #{fixed_files.length} files:"
+    fixed_files.each { |f| puts "  #{f}" }
+  else
+    puts '✓ All files already end with newline'
+  end
+end