loupe 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c82c36cf7a0a2f22151a36571f568c879b490dd8ffdb1804b00305714059da5
+  data.tar.gz: c2f949d723a8df44fab033ba868475b9f8f61405ad7f0ff729c5fb3ee27c8f3a
+SHA512:
+  metadata.gz: 1053f8e5eac94340b90915e05686a31854cb54d15914e773eb0a8979a0b64b257e7fd706735654395e88f02e148cc4bb3082f5b380e0165b328fbaba8b88aa22
+  data.tar.gz: d6dec0e1c3db33b37cfe4ad5847e6218702e42d93867702d945763b53b45dc925476d34b2103f0f95567a68a43ebcb087f63de22bcf66a54f75038f74cec87d6

data/LICENSE.txt

@@ -0,0 +1,71 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Vinicius Stock
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+Includes portions from the Minitest project
+
+https://github.com/seattlerb/minitest
+(The MIT License)
+
+Copyright © Ryan Davis, seattle.rb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+Includes portions from the rspec-expectations project
+
+https://github.com/rspec/rspec-expectations The MIT License (MIT)
+
+Copyright © 2012 David Chelimsky, Myron Marston Copyright © 2006 David
+Chelimsky, The RSpec Development Team Copyright © 2005 Steven Baker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+<div align="center">
+  <img src="https://user-images.githubusercontent.com/18742907/131183084-82c617d9-b83d-49cd-84f3-447ebb90ca50.png" alt="loupe" height="200px">
+</div>
+
+# Loupe
+
+[Loupe](https://en.wikipedia.org/wiki/Loupe) is a test framework with built in parallel execution supporting Ractor or forked process modes.
+
+## Installation
+
+Add the gem to the `Gemfile`.
+
+```ruby
+gem "loupe"
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Install bundler binstubs in your application.
+
+```shell
+bundle binstub loupe
+```
+
+## Usage
+
+Currently, Loupe only supports writing tests using the test methods syntax. Tests must inherit from `Loupe::Test`, but do not need to explicitly require `test_helper`, like the example below.
+
+```ruby
+# frozen_string_literal: true
+
+class MyTest < Loupe::Test
+  def before
+    @author = Author.create(name: "John")
+    @post = Post.create(author: @author)
+  end
+
+  def after
+    @author.destroy
+    @post.destroy
+  end
+
+  def test_post_is_linked_to_author
+    expect(@post.author.name).to_be_equal_to("John")
+  end
+end
+```
+
+To run the test suite, invoke the executable using the binstub generated by bundler.
+
+```shell
+bin/loupe test/post_test.rb test/author_test.rb
+```
+
+Tests can run in parallel using Ractor or process mode. When using Ractors, the application's code must be Ractor compatible.
+
+```shell
+bin/loupe --ractor            # [default] run tests using Ractor workers
+bin/loupe --process           # run tests using forked processes
+bin/loupe --interactive       # [default] use an interactive reporter to display test results
+bin/loupe --plain             # use a plain reporter to display test results
+bin/loupe --color, --no-color # enable/disable output colors
+bin/loupe --editor=EDITOR     # which editor to use for opening files when using interactive mode. The default is the environment variable $EDITOR
+```
+
+To hook Loupe into Rake, use the provided rake task as in the example below.
+
+```ruby
+# Rakefile
+
+require "loupe/rake_task"
+
+# Instantiate the task and append any desired CLI options
+Loupe::RakeTask.new do |options|
+  options << "--plain"
+end
+
+# Optionally, set the default task to be test
+task default: :test
+```
+
+Then run
+
+```shell
+bundle exec rake test
+```
+
+## Credits
+
+This project draws a lot of inspiration from other Ruby test frameworks, namely
+
+- [Minitest](https://github.com/seattlerb/minitest)
+- [rspec](https://github.com/rspec/rspec)
+
+## Contributing
+
+Please refer to the guidelines in [contributing](https://github.com/vinistock/loupe/blob/master/CONTRIBUTING.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/loupe

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+$LOAD_PATH.unshift(File.expand_path("#{Dir.pwd}/test", __dir__))
+
+require "loupe"
+
+Loupe::Cli.new

data/lib/loupe/cli.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Loupe
+  # Cli
+  #
+  # The Cli class defines all available
+  # commands and their options
+  class Cli
+    # @return [String]
+    USAGE = <<~TEXT
+      Usage: [test_list] [options]
+    TEXT
+
+    # @return [void]
+    def initialize(args = ARGV)
+      @options = {
+        color: true,
+        interactive: true,
+        mode: :ractor
+      }
+
+      parse_options(@options, args)
+      @options.freeze
+
+      @files = args
+      start
+    end
+
+    private
+
+    # @param options [Hash<Symbol, BasicObject>]
+    # @param args [Array<String>]
+    # @return [void]
+    def parse_options(options, args) # rubocop:disable Metrics/AbcSize
+      OptionParser.new do |opts|
+        opts.banner = USAGE
+
+        opts.on("--version", "Print Loupe's version") do
+          warn Loupe::VERSION
+          exit(0)
+        end
+
+        opts.on("--color", "--[no-]color", "Enable or disable color in the output") { |value| options[:color] = value }
+        opts.on("--interactive", "Use interactive output") { options[:interactive] = true }
+        opts.on("--plain", "Use plain non-interactive output") { options[:interactive] = false }
+        opts.on("--process", "Execute in process mode") { @options[:mode] = :process }
+        opts.on("--ractor", "Execute in ractor mode") do
+          raise ArgumentError, "Ractor mode can only be used in Ruby 3.0 and forward" if RUBY_VERSION < "3.0.0"
+
+          @options[:mode] = :ractor
+        end
+
+        opts.on("--editor=EDITOR", "The editor to open test files with in interactive mode") do |value|
+          options[:editor] = value
+        end
+      end.parse!(args)
+    end
+
+    # @return [void]
+    def start
+      require_tests
+      executor = @options[:mode] == :ractor ? RactorExecutor.new(@options) : ProcessExecutor.new(@options)
+      exit(executor.run)
+    end
+
+    # @return [void]
+    def require_tests
+      require "#{Dir.pwd}/test/test_helper"
+
+      if @files.empty?
+        Dir["#{Dir.pwd}/test/**/*_test.rb"].each { |f| require f }
+      else
+        @files.each do |f|
+          file, line_number = f.split(":")
+          require File.expand_path(file)
+          Test.add_line_number(line_number) if line_number
+        end
+      end
+    end
+  end
+end

data/lib/loupe/color.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Loupe
+  # Color
+  #
+  # This class is responsible for coloring
+  # strings.
+  class Color
+    # @return [Hash<Symbol, String>]
+    COLORS = {
+      red: "31",
+      green: "32",
+      yellow: "33"
+    }.freeze
+
+    # @param enabled [Boolean]
+    def initialize(enabled)
+      @enabled = enabled
+    end
+
+    # @param string [String, Symbol]
+    # @param color [Symbol]
+    # @return [String]
+    def p(string, color)
+      return string unless @enabled
+
+      color_code = COLORS[color]
+      "\033[1;#{color_code}m#{string}\033[0m"
+    end
+  end
+end

data/lib/loupe/executor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "etc"
+
+module Loupe
+  # Executor
+  #
+  # This abstract parent class is responsible for providing the basics
+  # for executors. Concrete classes are the process and ractor executors.
+  class Executor
+    # @param options [Hash<Symbol, BasicObject>]
+    # @return [Loupe::Executor]
+    def initialize(options)
+      @options = options
+      @queue = populate_queue
+      @reporter = options[:interactive] ? PagedReporter.new(options) : PlainReporter.new(options)
+    end
+
+    # @return [Integer]
+    def run
+      raise NotImplementedError, "Concrete implementations of executors should implement the run method"
+    end
+
+    private
+
+    # Populate the test queue with entries including
+    # the class and the test method to be executed.
+    # E.g.:
+    #   [[MyTest, :test_something], [AnotherTest, :test_another_thing]]
+    #
+    # @return [Array<Array<Class, Symbol>>]
+    def populate_queue
+      Test.classes.flat_map do |klass, line_numbers|
+        list = klass.test_list
+
+        unless line_numbers.empty?
+          list.select! do |method_name|
+            line_numbers.include?(klass.instance_method(method_name).source_location.last.to_s)
+          end
+        end
+
+        list.map! { |method| [klass, method] }.shuffle!
+      end
+    end
+  end
+end