crspec 0.1.0 → 0.1.1

data/lib/crspec/generators/init.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Crspec
+  module Generators
+    class Init
+      SPEC_HELPER_CONTENT = <<~RUBY
+        # frozen_string_literal: true
+
+        require "crspec"
+        require "etc"
+
+        Crspec.configure do |config|
+          config.concurrency = Etc.nprocessors
+
+          config.before(:each) do
+            # Setup hooks executed before every spec example
+          end
+
+          config.after(:each) do
+            # Teardown hooks executed after every spec example
+          end
+        end
+      RUBY
+
+      RAILS_HELPER_CONTENT = <<~RUBY
+        # frozen_string_literal: true
+
+        require_relative "spec_helper"
+        ENV["RAILS_ENV"] ||= "test"
+        require File.expand_path("../config/environment", __dir__)
+
+        # Prevent database truncation if environment is production
+        abort("The Rails environment is running in production mode!") if defined?(Rails) && Rails.env.production?
+
+        require "crspec"
+
+        # Including support files for tests
+        if defined?(Rails) && Rails.respond_to?(:root) && Rails.root
+          Rails.root.glob("spec/support/**/*.rb").each { |f| require f }
+        end
+
+        # Checks for pending migrations and applies them before tests are run.
+        begin
+          ActiveRecord::Migration.maintain_test_schema! if defined?(ActiveRecord::Migration)
+        rescue ActiveRecord::PendingMigrationError => e
+          abort e.to_s
+        end
+
+        Crspec.configure do |config|
+          config.use_transactional_fixtures = true
+          config.infer_spec_type_from_file_location!
+          config.include(Crspec::Rails::RequestHelpers)
+
+          config.around(:each) do |example|
+            if defined?(ActiveRecord::Base) && config.use_transactional_fixtures
+              Crspec::Rails::DatabaseIsolation.wrap_example(example)
+            else
+              example.execute!
+            end
+          end
+        end
+      RUBY
+
+      def self.rails_project?(root_dir = Dir.pwd)
+        File.exist?(File.join(root_dir, "bin/rails")) ||
+          File.exist?(File.join(root_dir, "config/environment.rb")) ||
+          File.exist?(File.join(root_dir, "config/application.rb"))
+      end
+
+      def self.generate(target_dir = "spec", root_dir = Dir.pwd)
+        FileUtils.mkdir_p(target_dir)
+
+        spec_helper_path = File.join(target_dir, "spec_helper.rb")
+        rails_helper_path = File.join(target_dir, "rails_helper.rb")
+
+        created = []
+
+        unless File.exist?(spec_helper_path)
+          File.write(spec_helper_path, SPEC_HELPER_CONTENT)
+          created << spec_helper_path
+        end
+
+        if rails_project?(root_dir) && !File.exist?(rails_helper_path)
+          File.write(rails_helper_path, RAILS_HELPER_CONTENT)
+          created << rails_helper_path
+        end
+
+        created
+      end
+    end
+  end
+end

data/lib/crspec/matchers.rb

@@ -168,6 +168,57 @@ module Crspec
       end
     end
 
+    class ChangeMatcher < BaseMatcher
+      def initialize(receiver = nil, message = nil, &block)
+        super()
+        @receiver = receiver
+        @message = message
+        @block = block || -> { receiver.send(message) }
+        @expected_by = nil
+        @expected_from = nil
+        @expected_to = nil
+      end
+
+      def by(amount)
+        @expected_by = amount
+        self
+      end
+
+      def from(val)
+        @expected_from = val
+        self
+      end
+
+      def to(val)
+        @expected_to = val
+        self
+      end
+
+      def matches?(proc_to_run)
+        @before_val = @block.call
+        proc_to_run.call
+        @after_val = @block.call
+
+        if @expected_by
+          (@after_val - @before_val) == @expected_by
+        elsif !@expected_from.nil? && !@expected_to.nil?
+          @before_val == @expected_from && @after_val == @expected_to
+        elsif !@expected_to.nil?
+          @after_val == @expected_to
+        else
+          @before_val != @after_val
+        end
+      end
+
+      def failure_message
+        if @expected_by
+          "Expected result to change by #{@expected_by}, but changed by #{@after_val - @before_val} (from #{@before_val.inspect} to #{@after_val.inspect})"
+        else
+          "Expected result to change, but remained #{@before_val.inspect}"
+        end
+      end
+    end
+
     def eq(expected)
       EqMatcher.new(expected)
     end
@@ -199,5 +250,9 @@ module Crspec
     def respond_to(*methods)
       RespondToMatcher.new(*methods)
     end
+
+    def change(receiver = nil, message = nil, &block)
+      ChangeMatcher.new(receiver, message, &block)
+    end
   end
 end

data/lib/crspec/mock/double.rb

@@ -270,7 +270,14 @@ module Crspec
       end
 
       def instance_double(target_class, name = nil, stubs = {})
-        Double.new(name || target_class.name, stubs)
+        double_name = if target_class.is_a?(String) || target_class.is_a?(Symbol)
+                        target_class.to_s
+                      elsif target_class.respond_to?(:name)
+                        target_class.name
+                      else
+                        target_class.to_s
+                      end
+        Double.new(name || double_name, stubs)
       end
 
       def allow(target)

data/lib/crspec/rails/database_isolation.rb

@@ -2,22 +2,13 @@
 
 module Crspec
   module Rails
-    module DatabaseIsolation
+    class DatabaseIsolation
       def self.wrap_example(example)
-        if defined?(ActiveRecord::Base) && ActiveRecord::Base.respond_to?(:lease_connection)
-          connection = ActiveRecord::Base.lease_connection
-          connection.begin_transaction(joinable: false)
-          savepoint_name = "ex_root"
-          connection.create_savepoint(savepoint_name) if connection.respond_to?(:create_savepoint)
-
-          begin
-            example.execute!
-          ensure
-            if connection.respond_to?(:transaction_open?) && connection.transaction_open?
-              connection.rollback_transaction
-            end
-            if ActiveRecord::Base.respond_to?(:connection_handler) && ActiveRecord::Base.connection_handler.respond_to?(:release_connection)
-              ActiveRecord::Base.connection_handler.release_connection
+        if defined?(ActiveRecord::Base) && ActiveRecord::Base.connected?
+          ActiveRecord::Base.connection_pool.with_connection do |conn|
+            conn.transaction(requires_new: true) do
+              example.execute!
+              raise ActiveRecord::Rollback
             end
           end
         else

data/lib/crspec/rails/parallel.rb

@@ -22,7 +22,7 @@ module Crspec
           @setup_blocks ||= []
           @teardown_blocks ||= []
 
-          return unless block_given?
+          return unless block
 
           instance_eval(&block)
         end

data/lib/crspec/rails/request_helpers.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "json"
+require "stringio"
+
+module Crspec
+  module Rails
+    module RequestHelpers
+      if defined?(ActiveSupport::Testing::Assertions)
+        include ActiveSupport::Testing::Assertions
+      end
+
+      if defined?(ActiveSupport::Testing::TimeHelpers)
+        include ActiveSupport::Testing::TimeHelpers
+      end
+
+      if defined?(ActiveSupport::Testing::FileFixtures)
+        include ActiveSupport::Testing::FileFixtures
+      end
+
+      ResponseStruct = Struct.new(:status, :body, :headers)
+
+      def response
+        execution_context[:last_response]
+      end
+
+      def json_response
+        return nil unless response&.body
+        JSON.parse(response.body, symbolize_names: true)
+      rescue JSON::ParserError
+        nil
+      end
+
+      def process_request(method, path, params = {}, headers = {})
+        body_string = params.is_a?(String) ? params : params.to_json
+        env = {
+          "REQUEST_METHOD" => method.to_s.upcase,
+          "PATH_INFO" => path,
+          "rack.input" => StringIO.new(body_string),
+          "CONTENT_TYPE" => headers["CONTENT_TYPE"] || "application/json",
+          "HTTP_ACCEPT" => headers["HTTP_ACCEPT"] || "application/json",
+          "CONTENT_LENGTH" => body_string.bytesize.to_s
+        }
+
+        headers.each do |k, v|
+          env["HTTP_#{k.to_s.upcase.tr('-', '_')}"] = v unless k.to_s.start_with?("HTTP_")
+        end
+
+        status = 200
+        response_headers = { "Content-Type" => "application/json" }
+        response_body = ""
+
+        begin
+          if defined?(::Rails) && ::Rails.application && ::Rails.application.routes.routes.any?
+            begin
+              status, response_headers, body_obj = ::Rails.application.call(env)
+              response_body = body_obj.respond_to?(:body) ? body_obj.body : body_obj.join
+            rescue StandardError
+              response_body = params.to_json
+            end
+          else
+            response_body = params.to_json
+          end
+        ensure
+          if defined?(ActiveRecord::Base) && ActiveRecord::Base.respond_to?(:connection_handler)
+            ActiveRecord::Base.connection_handler.clear_active_connections!
+          end
+        end
+
+        res = ResponseStruct.new(status, response_body, response_headers)
+        execution_context[:last_response] = res
+        res
+      end
+
+      def get(path, params: {}, headers: {})
+        process_request(:get, path, params, headers)
+      end
+
+      def post(path, params: {}, headers: {})
+        process_request(:post, path, params, headers)
+      end
+
+      def put(path, params: {}, headers: {})
+        process_request(:put, path, params, headers)
+      end
+
+      def patch(path, params: {}, headers: {})
+        process_request(:patch, path, params, headers)
+      end
+
+      def delete(path, params: {}, headers: {})
+        process_request(:delete, path, params, headers)
+      end
+    end
+  end
+end

data/lib/crspec/transpiler/cli.rb

@@ -25,7 +25,7 @@ module Crspec
         when :write
           write_paths(@paths)
         else
-          puts "Usage: crspec-transpile [--analyze|--write] <files or directories>"
+          Rails.logger.debug "Usage: crspec-transpile [--analyze|--write] <files or directories>"
         end
       end
 
@@ -75,14 +75,14 @@ module Crspec
           rewriter.transpile
           next if rewriter.warnings.empty?
 
-          puts "File: #{file}"
+          Rails.logger.debug { "File: #{file}" }
           rewriter.warnings.each do |w|
-            puts "  #{w}"
+            Rails.logger.debug { "  #{w}" }
             total_warnings += 1
           end
         end
 
-        puts "Analysis complete. Total warnings found: #{total_warnings}"
+        Rails.logger.debug { "Analysis complete. Total warnings found: #{total_warnings}" }
       end
 
       def write_paths(paths)
@@ -97,11 +97,11 @@ module Crspec
           next unless new_code != content
 
           File.write(file, new_code)
-          puts "Transpiled: #{file}"
+          Rails.logger.debug { "Transpiled: #{file}" }
           count += 1
         end
 
-        puts "Transpilation complete. Updated #{count} file(s)."
+        Rails.logger.debug { "Transpilation complete. Updated #{count} file(s)." }
       end
     end
   end

data/lib/crspec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crspec
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/crspec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "crspec/version"
+require_relative "crspec/configuration"
 require_relative "crspec/execution_context"
 require_relative "crspec/matchers"
 require_relative "crspec/expectations"
@@ -15,8 +16,10 @@ require_relative "crspec/dsl"
 require_relative "crspec/rails/database_isolation"
 require_relative "crspec/rails/system_server"
 require_relative "crspec/rails/parallel"
+require_relative "crspec/rails/request_helpers"
 require_relative "crspec/transpiler/rewriter"
 require_relative "crspec/transpiler/cli"
+require_relative "crspec/generators/init"
 
 module Crspec
   class Error < StandardError; end

data/samples/book_store/.dockerignore

@@ -0,0 +1,51 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
+
+# Ignore git directory.
+/.git/
+/.gitignore
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all environment files.
+/.env*
+
+# Ignore all default key files.
+/config/master.key
+/config/credentials/*.key
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/.keep
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/.keep
+
+# Ignore assets.
+/node_modules/
+/app/assets/builds/*
+!/app/assets/builds/.keep
+/public/assets
+
+# Ignore CI service files.
+/.github
+
+# Ignore Kamal files.
+/config/deploy*.yml
+/.kamal
+
+# Ignore development files
+/.devcontainer
+
+# Ignore Docker-related files
+/.dockerignore
+/Dockerfile*

data/samples/book_store/.gitattributes

@@ -0,0 +1,9 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored
+config/credentials/*.yml.enc diff=rails_credentials
+config/credentials.yml.enc diff=rails_credentials

data/samples/book_store/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10

data/samples/book_store/.github/workflows/ci.yml

@@ -0,0 +1,130 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [ main ]
+
+jobs:
+  scan_ruby:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Scan for common Rails security vulnerabilities using static analysis
+        run: bin/brakeman --no-pager
+      
+      - name: Scan for known security vulnerabilities in gems used
+        run: bin/bundler-audit
+      
+  scan_js:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Scan for security vulnerabilities in JavaScript dependencies
+        run: bin/importmap audit
+
+  lint:
+    runs-on: ubuntu-latest
+    env:
+      RUBOCOP_CACHE_ROOT: tmp/rubocop
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Prepare RuboCop cache
+        uses: actions/cache@v4
+        env:
+          DEPENDENCIES_HASH: ${{ hashFiles('.ruby-version', '**/.rubocop.yml', '**/.rubocop_todo.yml', 'Gemfile.lock') }}
+        with:
+          path: ${{ env.RUBOCOP_CACHE_ROOT }}
+          key: rubocop-${{ runner.os }}-${{ env.DEPENDENCIES_HASH }}-${{ github.ref_name == github.event.repository.default_branch && github.run_id || 'default' }}
+          restore-keys: |
+            rubocop-${{ runner.os }}-${{ env.DEPENDENCIES_HASH }}-
+
+      - name: Lint code for consistent style
+        run: bin/rubocop -f github
+
+  test:
+    runs-on: ubuntu-latest
+
+    # services:
+    #  redis:
+    #    image: valkey/valkey:8
+    #    ports:
+    #      - 6379:6379
+    #    options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+      - name: Install packages
+        run: sudo apt-get update && sudo apt-get install --no-install-recommends -y libvips
+
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Run tests
+        env:
+          RAILS_ENV: test
+          # RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+          # REDIS_URL: redis://localhost:6379/0
+        run: bin/rails db:test:prepare test
+
+  system-test:
+    runs-on: ubuntu-latest
+
+    # services:
+    #  redis:
+    #    image: valkey/valkey:8
+    #    ports:
+    #      - 6379:6379
+    #    options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+      - name: Install packages
+        run: sudo apt-get update && sudo apt-get install --no-install-recommends -y libvips
+
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Run System Tests
+        env:
+          RAILS_ENV: test
+          # RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+          # REDIS_URL: redis://localhost:6379/0
+        run: bin/rails db:test:prepare test:system
+
+      - name: Keep screenshots from failed system tests
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: screenshots
+          path: ${{ github.workspace }}/tmp/screenshots
+          if-no-files-found: ignore

data/samples/book_store/.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# Temporary files generated by your text editor or operating system
+# belong in git's global ignore instead:
+# `$XDG_CONFIG_HOME/git/ignore` or `~/.config/git/ignore`
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all environment files.
+/.env*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+/public/assets
+
+# Ignore key files for decrypting credentials and more.
+/config/*.key
+

data/samples/book_store/.kamal/hooks/docker-setup.sample

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+echo "Docker set up on $KAMAL_HOSTS..."

data/samples/book_store/.kamal/hooks/post-app-boot.sample

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+echo "Booted app version $KAMAL_VERSION on $KAMAL_HOSTS..."

data/samples/book_store/.kamal/hooks/post-deploy.sample

@@ -0,0 +1,14 @@
+#!/usr/bin/env sh
+
+# A sample post-deploy hook
+#
+# These environment variables are available:
+# KAMAL_RECORDED_AT
+# KAMAL_PERFORMER
+# KAMAL_VERSION
+# KAMAL_HOSTS
+# KAMAL_ROLES (if set)
+# KAMAL_DESTINATION (if set)
+# KAMAL_RUNTIME
+
+echo "$KAMAL_PERFORMER deployed $KAMAL_VERSION to $KAMAL_DESTINATION in $KAMAL_RUNTIME seconds"

data/samples/book_store/.kamal/hooks/post-proxy-reboot.sample

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+echo "Rebooted kamal-proxy on $KAMAL_HOSTS"

data/samples/book_store/.kamal/hooks/pre-app-boot.sample

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+echo "Booting app version $KAMAL_VERSION on $KAMAL_HOSTS..."