tldr 0.1.0

data/lib/tldr/value/test_result.rb

@@ -0,0 +1,62 @@
+class TLDR
+  TestResult = Struct.new :test, :error, :runtime do
+    attr_reader :type, :error_location
+
+    def initialize(*args)
+      super
+      @type = determine_type
+      @error_location = determine_error_location
+    end
+
+    def passing?
+      success? || skip?
+    end
+
+    def failing?
+      !passing?
+    end
+
+    def success?
+      type == :success
+    end
+
+    def skip?
+      type == :skip
+    end
+
+    def failure?
+      type == :failure
+    end
+
+    def error?
+      type == :error
+    end
+
+    def relevant_location
+      error_location || test.location
+    end
+
+    private
+
+    def determine_type
+      if error.nil?
+        :success
+      elsif error.is_a?(Failure)
+        :failure
+      elsif error.is_a?(Skip)
+        :skip
+      else
+        :error
+      end
+    end
+
+    def determine_error_location
+      return if error.nil?
+
+      raised_at = TLDR.filter_backtrace(error.backtrace).first
+      if (raise_matches = raised_at.match(/^(.*):(\d+):in .*$/))
+        Location.new(raise_matches[1], raise_matches[2].to_i)
+      end
+    end
+  end
+end

data/lib/tldr/value/wip_test.rb

@@ -0,0 +1,3 @@
+class TLDR
+  WIPTest = Struct.new :test, :start_time
+end

data/lib/tldr/value.rb

@@ -0,0 +1,6 @@
+require "tldr/value/config"
+require "tldr/value/plan"
+require "tldr/value/test"
+require "tldr/value/wip_test"
+require "tldr/value/test_result"
+require "tldr/value/location"

data/lib/tldr/version.rb

@@ -0,0 +1,3 @@
+class TLDR
+  VERSION = "0.1.0"
+end

data/lib/tldr.rb

@@ -0,0 +1,41 @@
+require_relative "tldr/version"
+require_relative "tldr/backtrace_filter"
+require_relative "tldr/error"
+require_relative "tldr/value"
+require_relative "tldr/reporters"
+require_relative "tldr/argv_parser"
+require_relative "tldr/planner"
+require_relative "tldr/runner"
+require_relative "tldr/assertions"
+require_relative "tldr/skippable"
+require_relative "tldr/sorbet_compatibility"
+
+class TLDR
+  include Assertions
+  include Skippable
+
+  module Run
+    def self.cli argv
+      config = ArgvParser.new.parse argv
+      tests config
+    end
+
+    def self.tests config = Config.new
+      Runner.new.run config, Planner.new.plan(config)
+    end
+
+    @@at_exit_registered = false
+    def self.at_exit! config = Config.new
+      # Ignore at_exit when running tldr CLI, since that will run any tests
+      return if $PROGRAM_NAME.end_with? "tldr"
+      # Ignore at_exit when we've already registered an at_exit hook
+      return if @@at_exit_registered
+
+      Kernel.at_exit do
+        Run.tests config
+      end
+
+      @@at_exit_registered = true
+    end
+  end
+end

data/script/parse

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "tldr"
+
+pp TLDR::ArgvParser.new.parse(ARGV).to_h

data/script/run

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "tldr"
+
+TLDR::Run.cli(ARGV)

data/script/test

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "tldr"
+
+class FunTest < TLDR
+  def test_passes
+    assert true
+  end
+
+  def test_false
+    assert false
+  end
+
+  def test_hello
+    raise "💥"
+  end
+
+  def test_slow
+    skip
+    sleep 2
+  end
+end
+
+TLDR::Run.run(TLDR::Config.new(paths: []))

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: tldr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Searls
+- Aaron Patterson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description:
+email:
+- searls@gmail.com
+- tenderlove@ruby-lang.org
+executables:
+- tldr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/tldr
+- lib/tldr.rb
+- lib/tldr/argv_parser.rb
+- lib/tldr/assertions.rb
+- lib/tldr/assertions/minitest_compatibility.rb
+- lib/tldr/backtrace_filter.rb
+- lib/tldr/error.rb
+- lib/tldr/planner.rb
+- lib/tldr/reporters.rb
+- lib/tldr/reporters/base.rb
+- lib/tldr/reporters/default.rb
+- lib/tldr/reporters/icon_provider.rb
+- lib/tldr/runner.rb
+- lib/tldr/skippable.rb
+- lib/tldr/sorbet_compatibility.rb
+- lib/tldr/value.rb
+- lib/tldr/value/config.rb
+- lib/tldr/value/location.rb
+- lib/tldr/value/plan.rb
+- lib/tldr/value/test.rb
+- lib/tldr/value/test_result.rb
+- lib/tldr/value/wip_test.rb
+- lib/tldr/version.rb
+- script/parse
+- script/run
+- script/test
+homepage: https://github.com/tenderlove/tldr
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tenderlove/tldr
+  source_code_uri: https://github.com/tenderlove/tldr
+  changelog_uri: https://github.com/tenderlove/tldr/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: TLDR will run your tests, but only for 1.8 seconds.
+test_files: []