rgot 0.2.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a4246161e01be60d8f75c374c5411521513b4892
-  data.tar.gz: b72b95bb14e0793b70d613abdb61078defb658d5
+SHA256:
+  metadata.gz: 368b98f9969eee4d2608df53e668eaaed9f06320ecd5b26096ff05c0f81dc16e
+  data.tar.gz: b045a87ffcb3f18338ce0286e2f22b71921b5bab011e4049c203164b9ab7a077
 SHA512:
-  metadata.gz: 865bf93fdc54e99fdb2b17194516f13d694ad84fe2f11372200a4dcc90e3ee895571f2a041700b991749344a4d15b213b91f55172d8c59636afc85b86051d0d4
-  data.tar.gz: c24d7e37e5ac9c1ce61539e27196875b1091e896ca8a512a845e2cb78d56d38407c773a511e317adc2bf9a758a35456adca57a9a18db171107a9ca2ad9b6958f
+  metadata.gz: 7a3d443886aa26702be0720d8bdf8abf38dd938e3707d595ac1bf21b1edd0f3cb52f64f29e4ca11996357d8671bfaaa4edc94500560510b67c393244202a2db3
+  data.tar.gz: 13d8fcdf048c4c82da186f96dc7bfef3eb78a35fb5df04a2f6f17badda63100587df8cd175dc0618d823d613526b9e60aeec8e18cc09075c8bf3c8c218d58841

data/.github/workflows/main.yml

@@ -0,0 +1,29 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '2.7.7'
+          - '3.0.5'
+          - '3.1.3'
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -1,3 +1,2 @@
-Gemfile.lock
 pkg
 tmp

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    rgot (1.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rake
+  rgot!
+
+BUNDLED WITH
+   2.3.26

data/README.md

@@ -1,7 +1,7 @@
 Rgot
 ===
 
-[![Build Status](https://travis-ci.org/ksss/rgot.svg)](https://travis-ci.org/ksss/rgot)
+[![Ruby](https://github.com/ksss/rgot/actions/workflows/main.yml/badge.svg)](https://github.com/ksss/rgot/actions/workflows/main.yml)
 
 Ruby + Golang Testing = Rgot
 
@@ -36,8 +36,8 @@ module SampleTest
     s = Sample.new
     DATA.each do |ts|
       sum = s.sum(ts.left, ts.right)
-      unless sum.kind_of?(Fixnum)
-        t.error("expect Fixnum got #{sum.class}")
+      unless sum.kind_of?(Integer)
+        t.error("expect Integer got #{sum.class}")
       end
       unless sum == ts.expect
         t.error("expect #{ts.expect} got #{sum}")
@@ -131,6 +131,36 @@ end
 
 So, you can notice that the sample code is wrong.
 
+# Table Driven Tests
+
+```rb
+FLAGTESTS = [
+  ["%a", "[%a]"],
+  ["%-a", "[%-a]"],
+  ["%+a", "[%+a]"],
+  ["%#a", "[%#a]"],
+  ["% a", "[% a]"],
+  ["%0a", "[%0a]"],
+  ["%1.2a", "[%1.2a]"],
+  ["%-1.2a", "[%-1.2a]"],
+  ["%+1.2a", "[%+1.2a]"],
+  ["%-+1.2a", "[%+-1.2a]"],
+  ["%-+1.2abc", "[%+-1.2a]bc"],
+  ["%-1.2abc", "[%-1.2a]bc"],
+]
+
+def test_flag_parser(t)
+  FLAGTESTS.each do |input, output|
+    s = Flag.print(input)
+    unless s == output
+      t.errorf("Flag.print(%p) => %p, want %p", input, s, output)
+    end
+  end
+end
+```
+
+see https://github.com/golang/go/wiki/TableDrivenTests
+
 # Naming convention
 
 ## Filename
@@ -311,7 +341,7 @@ And this is default virtual main code.
 ```ruby
 module TestSomeCode
   def test_main(m)
-    exit m.run
+    m.run
   end
 end
 ```
@@ -332,7 +362,7 @@ module TestSomeCode
     the_before_running_some_code
     code = m.run
     the_after_running_some_code
-    exit code
+    code
   end
 end
 ```

data/Rakefile

@@ -2,8 +2,13 @@ require "bundler/gem_tasks"
 
 desc "test to rgot"
 task :test do |t|
-  target = "test/{rgot_common,rgot}_test.rb"
-  ruby "bin/rgot -v #{target}"
+  targets = [
+    "test/rgot_common_test.rb",
+    "test/rgot_test.rb",
+    "test/rgot_benchmark_test.rb",
+    "test/rgot_example_test.rb",
+  ]
+  ruby "bin/rgot -v #{targets.join(' ')}"
 end
 
 task :default => [:test]

data/bin/rgot

@@ -1,138 +1,4 @@
 #! /usr/bin/env ruby
-require 'optparse'
-require 'rgot'
+require 'rgot/cli'
 
-opts = Rgot::M::Options.new
-require_paths = []
-parser = OptionParser.new do |o|
-  o.on '-v', '--verbose', "log all tests" do |arg|
-    Rgot.class_eval { @chatty = arg }
-  end
-  o.on '--version', "show Rgot version" do |arg|
-    puts "rgot #{Rgot::VERSION} (ruby #{RUBY_VERSION})"
-    exit 0
-  end
-  o.on '--bench [regexp]', "benchmark" do |arg|
-    unless arg
-      raise Rgot::OptionError, "missing argument for flag --bench"
-    end
-    opts.bench = arg
-  end
-  o.on '--benchtime [sec]', "benchmark running time" do |arg|
-    opts.benchtime = arg
-  end
-  o.on '--timeout [sec]', "set timeout sec to testing" do |arg|
-    opts.timeout = arg
-  end
-  o.on '--cpu [count,...]', "set cpu counts of comma split" do |arg|
-    opts.cpu = arg
-  end
-  o.on '--thread [count,...]', "set thread counts of comma split" do |arg|
-    opts.thread = arg
-  end
-  o.on '--require [path]', "load some code before running" do |arg|
-    require_paths << arg
-  end
-  o.on '--load-path [path]', "Specify $LOAD_PATH directory" do |arg|
-    $LOAD_PATH.unshift(arg)
-  end
-end
-parser.parse!(ARGV)
-require_paths.each do |path|
-  require path
-end
-
-testing_files = []
-
-if ARGV.empty?
-  Dir.glob("./**/*_test.rb") do |i|
-    testing_files << i
-  end
-else
-  ARGV.each do |target|
-    if File.file?(target)
-      testing_files << File.expand_path(target)
-    elsif File.directory?(target)
-      Dir.glob("./#{target}/**/*_test.rb") do |i|
-        testing_files << i
-      end
-    else
-      puts target
-    end
-  end
-end
-
-code = 0
-testing_files.each do |testing_file|
-  begin
-    pid = fork do
-      require testing_file
-
-      modules = Object.constants.select { |c|
-        next if c == :FileTest
-        /.*Test\z/ =~ c
-      }.map { |c|
-        Object.const_get(c)
-      }
-
-      modules.each do |test_module|
-        tests = []
-        benchmarks = []
-        examples = []
-        main = nil
-        methods = test_module.instance_methods
-        methods.grep(/\Atest_/).each do |m|
-          if m == :test_main && main.nil?
-            main = Rgot::InternalTest.new(test_module, m)
-          else
-            tests << Rgot::InternalTest.new(test_module, m)
-          end
-        end
-
-        methods.grep(/\Abenchmark_/).each do |m|
-          benchmarks << Rgot::InternalBenchmark.new(test_module, m)
-        end
-
-        methods.grep(/\Aexample_?/).each do |m|
-          examples << Rgot::InternalExample.new(test_module, m)
-        end
-
-        duration = Rgot.now
-        at_exit do
-          template = "%s\t%s\t%.3fs"
-
-          case $!
-          when SystemExit
-            if $!.success?
-              # exit 0
-              puts sprintf(template, "ok  ", test_module, Rgot.now - duration)
-            else
-              # exit 1
-              puts "exit status #{$!.status}"
-              puts sprintf(template, "FAIL", test_module, Rgot.now - duration)
-            end
-          when NilClass
-            # not raise, not exit
-          else
-            # any exception
-            puts sprintf(template, "FAIL", test_module, Rgot.now - duration)
-          end
-        end
-        m = Rgot::M.new(tests: tests, benchmarks: benchmarks, examples: examples, opts: opts)
-        if main
-          main.module.extend main.module
-          main.module.instance_method(main.name).bind(main.module).call(m)
-        else
-          exit m.run
-        end
-      end
-    end
-  ensure
-    _, status = Process.waitpid2(pid)
-    unless status.success?
-      code = 1
-    end
-  end
-end
-
-exit code
+exit Rgot::Cli.new(ARGV).run

data/lib/rgot/b.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rgot
   class B < Common
     Options = Struct.new(

data/lib/rgot/benchmark_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rgot
   class BenchmarkResult
     def initialize(n:, t:)

data/lib/rgot/cli.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+require_relative '../rgot'
+
+module Rgot
+  class Cli
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      opts = Rgot::M::Options.new
+      parse_option(opts)
+      main_process(opts)
+    end
+
+    private
+
+    def parse_option(opts)
+      require_paths = []
+      parser = OptionParser.new do |o|
+        o.on '-v', '--verbose', "log all tests" do |arg|
+          Rgot.class_eval { @chatty = arg }
+        end
+        o.on '--version', "show Rgot version" do |arg|
+          puts "rgot #{Rgot::VERSION} (ruby #{RUBY_VERSION})"
+          exit 0
+        end
+        o.on '--bench [regexp]', "benchmark" do |arg|
+          unless arg
+            raise Rgot::OptionError, "missing argument for flag --bench"
+          end
+          opts.bench = arg
+        end
+        o.on '--benchtime [sec]', "benchmark running time" do |arg|
+          opts.benchtime = arg
+        end
+        o.on '--timeout [sec]', "set timeout sec to testing" do |arg|
+          opts.timeout = arg
+        end
+        o.on '--cpu [count,...]', "set cpu counts of comma split" do |arg|
+          opts.cpu = arg
+        end
+        o.on '--thread [count,...]', "set thread counts of comma split" do |arg|
+          opts.thread = arg
+        end
+        o.on '--require [path]', "load some code before running" do |arg|
+          require_paths << arg
+        end
+        o.on '--load-path [path]', "Specify $LOAD_PATH directory" do |arg|
+          $LOAD_PATH.unshift(arg)
+        end
+      end
+      parser.parse!(@argv)
+
+      require_paths.each do |path|
+        require path
+      end
+    end
+
+    def testing_files
+      if @argv.empty?
+        Dir.glob("./**/*_test.rb")
+      else
+        @argv.flat_map do |target|
+          if File.file?(target)
+            File.expand_path(target)
+          elsif File.directory?(target)
+            Dir.glob("./#{target}/**/*_test.rb")
+          else
+            warn "#{target} is not file or directory"
+          end
+        end.compact
+      end
+    end
+
+    def main_process(opts)
+      code = 0
+
+      testing_files.each do |testing_file|
+        result = child_process(opts, testing_file)
+        unless result == 0
+          code = 1
+        end
+      end
+
+      code
+    end
+
+    def child_process(opts, testing_file)
+      node = RubyVM::AbstractSyntaxTree.parse_file(testing_file).children[2]
+      test_module_name = find_toplevel_name(node)
+
+      load testing_file
+
+      test_module = Object.const_get(test_module_name)
+      tests = []
+      benchmarks = []
+      examples = []
+      main = nil
+      methods = test_module.public_instance_methods
+      methods.grep(/\Atest_/).each do |m|
+        if m == :test_main && main.nil?
+          main = Rgot::InternalTest.new(test_module, m)
+        else
+          tests << Rgot::InternalTest.new(test_module, m)
+        end
+      end
+
+      methods.grep(/\Abenchmark_/).each do |m|
+        benchmarks << Rgot::InternalBenchmark.new(test_module, m)
+      end
+
+      methods.grep(/\Aexample_?/).each do |m|
+        examples << Rgot::InternalExample.new(test_module, m)
+      end
+
+      m = Rgot::M.new(test_module: test_module, tests: tests, benchmarks: benchmarks, examples: examples, opts: opts)
+      if main
+        main.module.extend main.module
+        main.module.instance_method(:test_main).bind(main.module).call(m)
+      else
+        m.run
+      end
+    end
+
+    private
+
+    def find_toplevel_name(node)
+      case node.type
+      when :MODULE
+        find_toplevel_name(node.children.first)
+      when :CONST, :COLON3
+        node.children.first
+      when :COLON2
+        case node.children
+        in [nil, sym]
+          # module Foo
+          sym
+        in [namespace, sym]
+          # module Foo::Bar
+          find_toplevel_name(namespace)
+        end
+      when :BLOCK
+        module_node = node.children.find { |c| c.type == :MODULE }
+        unless module_node
+          raise "no module found"
+        end
+        find_toplevel_name(module_node)
+      else
+        raise node.type.to_s
+      end
+    end
+  end
+end

data/lib/rgot/common.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thread'
 require 'pathname'
 
@@ -6,7 +8,7 @@ module Rgot
     attr_accessor :output
 
     def initialize
-      @output = ""
+      @output = "".dup
       @failed = false
       @skipped = false
       @finished = false
@@ -100,7 +102,8 @@ module Rgot
       path = c.sub(/:.*/, '')
       line = c.match(/:(\d+?):/)[1]
       relative_path = Pathname.new(path).relative_path_from(Pathname.new(Dir.pwd)).to_s
-      "\t#{relative_path}:#{line}: #{str}\n"
+      # Every line is indented at least 4 spaces.
+      "    #{relative_path}:#{line}: #{str}\n"
     end
 
     def internal_log(msg)

data/lib/rgot/example_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ripper'
 
 module Rgot
@@ -8,7 +10,7 @@ module Rgot
       @examples = []
       @in_def = false
       @has_output = false
-      @output = ""
+      @output = "".dup
     end
 
     def on_def(method, args, body)

data/lib/rgot/m.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'stringio'
 require 'etc'
 require 'timeout'
@@ -12,43 +14,74 @@ module Rgot
       :thread,
     ); end
 
-    def initialize(tests:, benchmarks:, examples:, opts: Options.new)
-      cpu = opts.cpu || (Etc.respond_to?(:nprocessors) ? Etc.nprocessors : '1').to_s
-      @cpu_list = cpu.split(',').map { |i|
-        j = i.to_i
-        raise Rgot::OptionError, "invalid value #{i.inspect} for --cpu" unless 0 < j
-        j
-      }
-      @thread_list = (opts.thread || "1").split(',').map { |i|
-        j = i.to_i
-        raise Rgot::OptionError, "invalid value #{i.inspect} for --thread" unless 0 < j
-        j
-      }
+    def initialize(tests:, benchmarks:, examples:, test_module: nil, opts: Options.new)
+      unless test_module
+        raise "Require `test_module` keyword" if Gem::Version.new("2.0") <= Gem::Version.new(Rgot::VERSION)
+        warn "`Rgot::M#initialize` will require the `test_module` keyword in the next major version."
+      end
+
       @tests = tests
       @benchmarks = benchmarks
       @examples = examples
+      @test_module = test_module
       @opts = opts
+      @cpu_list = nil
+      @thread_list = nil
     end
 
     def run
+      duration = Rgot.now
       test_ok = false
       example_ok = false
 
+      if @tests.empty? && @benchmarks.empty? && @examples.empty?
+        warn "rgot: warning: no tests to run"
+      end
+
+      begin
+        parse_option
+      rescue Rgot::OptionError
+        puts sprintf("%s\t%s\t%.3fs", "FAIL", @test_module, Rgot.now - duration)
+        raise
+      end
+
       Timeout.timeout(@opts.timeout.to_f) do
         test_ok = run_tests
         example_ok = run_examples
       end
+
       if !test_ok || !example_ok
         puts "FAIL"
-        return 1
+        puts "exit status 1"
+        puts sprintf("%s\t%s\t%.3fs", "FAIL", @test_module, Rgot.now - duration)
+
+        1
+      else
+        puts "PASS"
+        run_benchmarks
+        puts sprintf("%s\t%s\t%.3fs", "ok  ", @test_module, Rgot.now - duration)
+
+        0
       end
-      puts "PASS"
-      run_benchmarks
-      0
     end
 
     private
 
+    def parse_option
+      cpu = @opts.cpu || (Etc.respond_to?(:nprocessors) ? Etc.nprocessors : '1').to_s
+      @cpu_list = cpu.split(',').map { |i|
+        j = i.to_i
+        raise Rgot::OptionError, "invalid value #{i.inspect} for --cpu" unless 0 < j
+        j
+      }
+
+      @thread_list = (@opts.thread || "1").split(',').map { |i|
+        j = i.to_i
+        raise Rgot::OptionError, "invalid value #{i.inspect} for --thread" unless 0 < j
+        j
+      }
+    end
+
     def run_tests
       ok = true
       @tests.each do |test|
@@ -57,7 +90,6 @@ module Rgot
           puts "=== RUN   #{test.name}"
         end
         t.run
-        t.report
         if t.failed?
           ok = false
         end
@@ -108,13 +140,13 @@ module Rgot
         start = Rgot.now
         example.module.extend(example.module)
         method = example.module.instance_method(example.name).bind(example.module)
-        out, err = capture do
+        out, _ = capture do
           method.call
         end
         file = method.source_location[0]
         r = ExampleParser.new(File.read(file))
         r.parse
-        e = r.examples.find { |e| e.name == example.name }
+        e = r.examples.find { |re| re.name == example.name }
 
         duration = Rgot.now - start
         if e && e.output.strip != out.strip

data/lib/rgot/pb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rgot
   class PB
     attr_accessor :bn

data/lib/rgot/t.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rgot
   class T < Common
     def initialize(test_module, name)
@@ -10,6 +12,7 @@ module Rgot
     def run
       catch(:skip) { call }
       finish!
+      report
     rescue => e
       fail!
       report
@@ -17,15 +20,16 @@ module Rgot
     end
 
     def report
+      puts @output if Rgot.verbose? && !@output.empty?
       duration = Rgot.now - @start
-      template = "--- %s: %s (%.2fs)\n%s"
+      template = "--- \e[%sm%s\e[m: %s (%.2fs)\n"
       if failed?
-        printf template, "FAIL", @name, duration, @output
+        printf template, [41, 1].join(';'), "FAIL", @name, duration
       elsif Rgot.verbose?
         if skipped?
-          printf template, "SKIP", @name, duration, @output
+          printf template, [44, 1].join(';'), "SKIP", @name, duration
         else
-          printf template, "PASS", @name, duration, @output
+          printf template, [42, 1].join(';'), "PASS", @name, duration
         end
       end
     end

data/lib/rgot/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rgot
-  VERSION = "0.2.0"
+  VERSION = "1.2.0"
 end

data/lib/rgot.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Rgot
-  require 'rgot/version'
-  require 'rgot/common'
-  require 'rgot/m'
-  require 'rgot/t'
-  require 'rgot/b'
-  require 'rgot/pb'
-  require 'rgot/benchmark_result'
-  require 'rgot/example_parser'
+  autoload :VERSION, 'rgot/version'
+  autoload :Common, 'rgot/common'
+  autoload :M, 'rgot/m'
+  autoload :T, 'rgot/t'
+  autoload :B, 'rgot/b'
+  autoload :PB, 'rgot/pb'
+  autoload :BenchmarkResult, 'rgot/benchmark_result'
+  autoload :ExampleParser, 'rgot/example_parser'
 
   OptionError = Class.new(StandardError)
   InternalTest = Struct.new(:module, :name)

data/rgot.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/ksss/rgot"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|go)/}) }
   spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rgot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.2.0
 platform: ruby
 authors:
 - ksss
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2022-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,9 +46,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -56,6 +57,7 @@ files:
 - lib/rgot.rb
 - lib/rgot/b.rb
 - lib/rgot/benchmark_result.rb
+- lib/rgot/cli.rb
 - lib/rgot/common.rb
 - lib/rgot/example_parser.rb
 - lib/rgot/m.rb
@@ -67,7 +69,7 @@ homepage: https://github.com/ksss/rgot
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,9 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Ruby + Golang Testing = Rgot
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.10
-  - 2.2.4
-  - 2.3.0
-notifications:
-  email: false