easytest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 402f9f4048f129fbd845bc46cd92eb06e9345dff23355ffa9003bd59b88f6e0e
+  data.tar.gz: 1f59c66816c8fbbabb77c36a0bf6f0ec2114aad792e3aa7fa69c3b1517e314c1
+SHA512:
+  metadata.gz: 320e1266f83153d7695b216d6d9f13832bdcd3e373c35297efb778e9fd75c0471eeeb484ad07b418771b528b1db91b8579f826099fa10550c80b10b2614e5f66
+  data.tar.gz: ec873b3bfb646766acaebfbb44fe866227491b3653a86fe85e402b156314306491ea0ffd37a3d5141b16a1e022dca77d046b4a68f9b5f7b3812adde5501cbc7a

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 0.1.0
+
+Initial release.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Masafumi Koba
+
+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,71 @@
+# Easytest
+
+> makes you write tests easily
+
+Easytest is a tiny testing framework with a familiar DSL.
+
+## Installation
+
+via Bundler:
+
+```shell
+bundle add easytest
+```
+
+via gem:
+
+```shell
+gem install easytest
+```
+
+## Usage
+
+Here is a very easy example.
+
+First, put `test/addition_test.rb` as below:
+
+```ruby
+require "easytest"
+
+using Easytest::DSL
+
+test "addition" do
+  expect(1 + 2).to_eq 2
+end
+```
+
+Then, run `easytest`:
+
+```console
+$ bundle exec easytest
+ FAIL  test/addition_test.rb
+  ● addition  (should equal)
+
+    Expected: 2
+    Received: 3
+
+    at test/addition_test.rb:6:in `block in <top (required)>'
+
+
+ Tests:  1 failed, 0 passed, 1 total (1 files)
+ Time:   0.00087 seconds
+```
+
+Oops. Let's fix the failure:
+
+```diff
+- expect(1 + 2).to_eq 2
++ expect(1 + 2).to_eq 3
+```
+
+Then, run it again:
+
+```console
+$ bundle exec easytest
+ PASS  test/addition_test.rb
+
+ Tests:  1 passed, 1 total (1 files)
+ Time:   0.00077 seconds
+```
+
+The test passes! 🎉

data/exe/easytest

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../lib", __dir__)
+$LOAD_PATH << File.join(Dir.pwd, "test")
+
+require "easytest"
+
+test_files = Dir.glob("test/**/*_test.rb").filter do |file|
+  ARGV.empty? || ARGV.any? { |pattern| file.include?(pattern) }
+end
+test_files.each { |file| load file }

data/lib/easytest/case.rb

@@ -0,0 +1,24 @@
+module Easytest
+  class Case
+    attr_reader :name
+    attr_reader :file
+    attr_reader :block
+    attr_accessor :report
+
+    def initialize(name:, file:, &block)
+      @name = name
+      @file = file
+      @block = block
+      @report = nil
+    end
+
+    def run
+      block.call
+      true
+    rescue UnmatchedError => error
+      loc = error.backtrace_locations[2]
+      self.report = Reporter.new(error: error, file: loc.absolute_path, location: loc.to_s).report(name)
+      false
+    end
+  end
+end

data/lib/easytest/dsl.rb

@@ -0,0 +1,14 @@
+module Easytest
+  module DSL
+    refine Kernel do
+      def test(name, &block)
+        file = caller_locations(1, 1).first.absolute_path
+        Easytest.add_case Case.new(name: name, file: file, &block)
+      end
+
+      def expect(actual)
+        Expectation.new(actual)
+      end
+    end
+  end
+end

data/lib/easytest/errors.rb

@@ -0,0 +1,14 @@
+module Easytest
+  class Error < StandardError; end
+
+  class UnmatchedError < Error
+    attr_reader :actual
+    attr_reader :expected
+
+    def initialize(message:, actual:, expected:)
+      super(message)
+      @actual = actual
+      @expected = expected
+    end
+  end
+end

data/lib/easytest/expectation.rb

@@ -0,0 +1,19 @@
+module Easytest
+  class Expectation
+    def initialize(actual)
+      @actual = actual
+    end
+
+    def to_eq(expected)
+      Matcher::Equal.new(actual: @actual, expected: expected).match!
+    end
+
+    def to_be(expected)
+      Matcher::Be.new(actual: @actual, expected: expected).match!
+    end
+
+    def to_be_nil
+      Matcher::BeNil.new(actual: @actual).match!
+    end
+  end
+end

data/lib/easytest/matcher/base.rb

@@ -0,0 +1,19 @@
+module Easytest
+  module Matcher
+    class Base
+      attr_reader :actual
+
+      def initialize(actual:)
+        @actual = actual
+      end
+
+      def match?
+        raise NotImplementedError
+      end
+
+      def match!
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/easytest/matcher/be.rb

@@ -0,0 +1,22 @@
+module Easytest
+  module Matcher
+    class Be < Base
+      attr_reader :expected
+
+      def initialize(actual:, expected:)
+        super(actual: actual)
+        @expected = expected
+      end
+
+      def match?
+        actual.equal? expected
+      end
+
+      def match!
+        unless match?
+          raise UnmatchedError.new(message: "should be same", actual: actual, expected: expected)
+        end
+      end
+    end
+  end
+end

data/lib/easytest/matcher/be_nil.rb

@@ -0,0 +1,15 @@
+module Easytest
+  module Matcher
+    class BeNil < Base
+      def match?
+        actual.nil?
+      end
+
+      def match!
+        unless match?
+          raise UnmatchedError.new(message: "should be `nil`", actual: actual, expected: nil)
+        end
+      end
+    end
+  end
+end

data/lib/easytest/matcher/equal.rb

@@ -0,0 +1,22 @@
+module Easytest
+  module Matcher
+    class Equal < Base
+      attr_reader :expected
+
+      def initialize(actual:, expected:)
+        super(actual: actual)
+        @expected = expected
+      end
+
+      def match?
+        actual == expected
+      end
+
+      def match!
+        unless match?
+          raise UnmatchedError.new(message: "should equal", actual: actual, expected: expected)
+        end
+      end
+    end
+  end
+end

data/lib/easytest/reporter.rb

@@ -0,0 +1,20 @@
+module Easytest
+  class Reporter
+    def initialize(error:, file:, location:)
+      @error = error
+      @file = file
+      @location = location
+    end
+
+    def report(test_name)
+      <<~MSG
+        #{Rainbow("● #{test_name}").red.bright}  #{Rainbow("(#{@error.message})").dimgray}
+
+          #{Rainbow("Expected: #{@error.expected.inspect}").green}
+          #{Rainbow("Received: #{@error.actual.inspect}").red}
+
+          #{Rainbow("at #{@location}").dimgray}
+      MSG
+    end
+  end
+end

data/lib/easytest/utils.rb

@@ -0,0 +1,14 @@
+module Easytest
+  module Utils
+    module_function
+
+    def terminal_hyperlink(absolute_path)
+      path = Pathname(absolute_path)
+      dir = path.relative_path_from(Dir.pwd).dirname.to_s + File::SEPARATOR
+      base = path.basename
+
+      # https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
+      "\e]8;;file://#{path}\e\\#{Rainbow(dir).dimgray}#{base}\e]8;;\e\\"
+    end
+  end
+end

data/lib/easytest/version.rb

@@ -0,0 +1,3 @@
+module Easytest
+  VERSION = "0.1.0"
+end

data/lib/easytest.rb

@@ -0,0 +1,86 @@
+require "pathname"
+require "rainbow"
+
+require_relative "easytest/version"
+
+require_relative "easytest/case"
+require_relative "easytest/dsl"
+require_relative "easytest/errors"
+require_relative "easytest/expectation"
+require_relative "easytest/matcher/base"
+require_relative "easytest/matcher/be"
+require_relative "easytest/matcher/be_nil"
+require_relative "easytest/matcher/equal"
+require_relative "easytest/reporter"
+require_relative "easytest/utils"
+
+module Easytest
+  def self.run
+    passed_count = 0
+    failed_count = 0
+    file_count = 0
+
+    cases_by_file = cases.group_by { |c| c.file }
+    cases_by_file.each do |file, cases|
+      file_count += 1
+      reports = []
+
+      cases.each do |c|
+        passed = c.run
+
+        if passed
+          passed_count += 1
+        else
+          failed_count += 1
+          reports << c.report.gsub(/^/, "  ")
+        end
+      end
+
+      link = Utils.terminal_hyperlink(file)
+      if reports.empty?
+        puts "#{Rainbow(" PASS ").bright.bg(:green)} #{link}"
+      else
+        puts "#{Rainbow(" FAIL ").bright.bg(:red)} #{link}"
+        reports.each { |report| puts report ; puts "" }
+      end
+    end
+
+    [passed_count, failed_count, file_count]
+  end
+
+  def self.cases
+    @cases ||= []
+  end
+
+  def self.add_case(new_case)
+    cases << new_case
+  end
+end
+
+start_time = Time.now
+
+at_exit do
+  passed_count, failed_count, file_count = Easytest.run
+  total_count = passed_count + failed_count
+
+  time = Time.now - start_time
+
+  if total_count == 0
+    puts Rainbow("A test suite should have at least one test case!").red.bright
+    puts ""
+    puts "Please put `test/**/*_test.rb` files or specify valid patterns to the `easytest` command."
+  else
+    summary = ""
+    if failed_count == 0
+      summary << Rainbow("#{passed_count} passed").green.bright
+    else
+      summary << Rainbow("#{failed_count} failed").red.bright
+      summary << ", #{Rainbow("#{passed_count} passed").green.bright}"
+    end
+    summary << ", #{total_count} total #{Rainbow("(#{file_count} files)").dimgray}"
+
+    puts ""
+    puts " #{Rainbow('Tests:').bright}  #{summary}"
+    puts " #{Rainbow('Time:').bright}   #{time.round(5)} seconds"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: easytest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masafumi Koba
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Easytest is a tiny testing framework for Ruby with a familiar DSL.
+email:
+- ybiquitous@gmail.com
+executables:
+- easytest
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- exe/easytest
+- lib/easytest.rb
+- lib/easytest/case.rb
+- lib/easytest/dsl.rb
+- lib/easytest/errors.rb
+- lib/easytest/expectation.rb
+- lib/easytest/matcher/base.rb
+- lib/easytest/matcher/be.rb
+- lib/easytest/matcher/be_nil.rb
+- lib/easytest/matcher/equal.rb
+- lib/easytest/reporter.rb
+- lib/easytest/utils.rb
+- lib/easytest/version.rb
+homepage: https://github.com/ybiquitous/easytest
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ybiquitous/easytest
+  source_code_uri: https://github.com/ybiquitous/easytest
+  changelog_uri: https://github.com/ybiquitous/easytest/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Easy testing for Ruby.
+test_files: []