rgot 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b55640e6b13205e65a7e08765579b3566f43b385
-  data.tar.gz: 2b9727ef0256af4d11d272f2c4aa255ecf91053c
+  metadata.gz: f04145f618564aea3aa444ea1f353bfa61c4982d
+  data.tar.gz: 8559b54a3131721381a1ce6f7e738113864719ee
 SHA512:
-  metadata.gz: ce0a920a44014f5b876382e6091018a1b447d9acd96e460e9077640e07047907221cc4b9946f849b09efcc0cbf65b881b78e8d88b100cf197ac2ebf53eb865c7
-  data.tar.gz: 516c281575d0fa554698adb4cd2e69af664670dba015922c31c7f9dcf67f874715adbd190cf3482e2bd9a08d99a10a50d6e44dcd728cf875ca783516e6bbbfea
+  metadata.gz: f2f74de8444e11d69a91f523d6d2dd66d40d94731c071fd8d584958008e166fbad6b70c625d61ab2ed4cc34dc83b964cff3556f650d16a6a4ac83366a996d0b5
+  data.tar.gz: 640a8bca855cce5e811c23269e5fa315f08dc5e4aab711039c4a617bbf388bfbf737a06ba6f43e390fdb2f2772707ebf01e8d1c5ac522f3fd58e74036a61c96b

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.6
-  - 2.2.2
+  - 2.1.7
+  - 2.2.3
 notifications:
   email: false

data/README.md

@@ -10,6 +10,7 @@ Rgot is a testing package convert from golang testing.
 ### Usage
 
 test/sample.rb
+
 ```ruby
 class Sample
   def sum(i, j)
@@ -19,6 +20,7 @@ end
 ```
 
 test/pass_test.rb
+
 ```ruby
 module SampleTest
   class TypeSum < Struct.new(:left, :right, :expect)
@@ -53,7 +55,7 @@ PASS
 ok	0.001s
 ```
 
-# Feature
+# Features
 
 ## Testing
 
@@ -85,7 +87,7 @@ end
 
 ```
 $ rgot foo_test.rb --bench .
-benchmark_something	14400000	81.392 ns/op
+benchmark_something	14400000	81 ns/op
 ok	FooTest	2.782s
 ```
 
@@ -178,11 +180,12 @@ end
 $ rgot -h
 Usage: rgot [options]
     -v, --verbose                    log all tests
+        --version                    show Rgot version
         --bench [regexp]             benchmark
         --benchtime [sec]            benchmark running time
         --timeout [sec]              set timeout sec to testing
-        --cpu [count,...]            set cpu counts of comma splited
-        --thread [count,...]         set thread counts of comma splited
+        --cpu [count,...]            set cpu counts of comma split
+        --thread [count,...]         set thread counts of comma split
         --require [path]             load some code before running
         --load-path [path]           Specify $LOAD_PATH directory
 ```
@@ -217,7 +220,7 @@ PASS
 ok	0.001s
 ```
 
-Show all log and more detail infomation of testing.
+Show all log and more detail information of testing.
 
 ## Benchmark
 
@@ -235,13 +238,13 @@ Set `someone` if you only run benchmark to match `someone` method.(e.g. benchmar
 
 Benchmark for parallel performance.
 
-`--cpu` option set process counts (default 1).
+`--cpu` option set process counts (default `Etc.nprocessors`).
 
 And `--thread` option set thread counts (default 1).
 
 Benchmark fork, run and report each by process counts.
 
-(**process** and **thread** means ruby/linux process)
+(**process** and **thread** means ruby/linux native process and thread)
 
 ```ruby
 module FooTest
@@ -259,10 +262,10 @@ end
 
 ```
 $ rgot foo_test.rb --bench . --cpu=2,4 --thread=2,4
-benchmark_any_func-2(2)	40	13363604.899 ns/op
-benchmark_any_func-2(4)	160	7125845.113 ns/op
-benchmark_any_func-4(2)	160	7224815.534 ns/op
-benchmark_any_func-4(4)	320	3652431.962 ns/op
+benchmark_any_func-2(2)	40	13363604 ns/op
+benchmark_any_func-2(4)	160	7125845 ns/op
+benchmark_any_func-4(2)	160	7224815 ns/op
+benchmark_any_func-4(4)	320	3652431 ns/op
 ok	FooTest	3.061s
 ```
 
@@ -276,7 +279,30 @@ You can set timeout sec for testing (default 0).
 
 Fail testing and print raised exception message to STDERR if timeout.
 
-# Rgot::M (Main)
+# Methods
+
+## Rgot
+
+### Rgot.benchmark
+
+Run benchmark function without framework.
+
+```ruby
+result = Rgot.benchmark do |b|
+  i = 0
+  while i < b.n
+    some_func()
+    i += 1
+  end
+end
+puts result #=> 100000	100 ns/op
+```
+
+### Rgot.verbose?
+
+Check running with option verbose true/false.
+
+## Rgot::M (Main)
 
 Main method run first on testing.
 
@@ -311,23 +337,31 @@ module TestSomeCode
 end
 ```
 
-# Rgot::Common
+## Rgot::Common
 
 `Rgot::Common` is inherited to `Rgot::T` and `Rgot::B`
 
 `Rgot::Common` have some logging method.
 
-## Rgot::Common#log
+### Rgot::Common#log
 
 ```ruby
-t.log("wooooo")
+t.log("wooooo", 1, 2, 3)
 ```
 
 Write any log message.
 
 But this message to show need -v option.
 
-## Rgot::Common#error
+### Rgot::Common#logf
+
+Write any log message like sprintf.
+
+```ruby
+t.logf("%d-%s", 10, "foo")
+```
+
+### Rgot::Common#error
 
 ```ruby
 t.error("expect #{a} got #{b}")
@@ -335,7 +369,23 @@ t.error("expect #{a} got #{b}")
 
 Test fail and show some error message.
 
-## Rgot::Common#skip
+### Rgot::Common#errorf
+
+Fail loggin same as logf
+
+### Rgot::Common#fatal
+
+Testing stop and fail with log.
+
+```ruby
+t.fatal("fatal error!")
+```
+
+### Rgot::Common#fatalf
+
+Fatal logging same as logf
+
+### Rgot::Common#skip
 
 ```ruby
 t.skip("this method was skipped")
@@ -345,7 +395,11 @@ Skip current testing method.
 
 And run to next testing method.
 
-# Rgot::T (Testing)
+### Rgot::Common#skipf
+
+Skip logging same as logf
+
+## Rgot::T (Testing)
 
 Testing is a main usage of this package.
 
@@ -358,13 +412,13 @@ end
 
 The `t` variable is instance of `Rgot::T` class means Testing.
 
-# Rgot::B (Benchmark)
+## Rgot::B (Benchmark)
 
 For Benchmark class.
 
 Can use log methods same as `Rgot::T` class
 
-## Rgot::B#n
+### Rgot::B#n
 
 Automatic number calculated by running time.
 
@@ -380,7 +434,7 @@ def benchmark_something(b)
 end
 ```
 
-## Rgot::B#reset_timer
+### Rgot::B#reset_timer
 
 Reset benchmark timer
 
@@ -396,15 +450,15 @@ def benchmark_something(b)
 end
 ```
 
-## Rgot::B#start_timer
+### Rgot::B#start_timer
 
 Start benchmark timer
 
-## Rgot::B#stop_timer
+### Rgot::B#stop_timer
 
 Stop benchmark timer
 
-## Rgot::B#run_parallel
+### Rgot::B#run_parallel
 
 Start parallel benchmark using `fork` and `Thread.new`.
 
@@ -412,9 +466,9 @@ This method should be call with block.
 
 The block argument is instance of Rgot::PB.
 
-# Rgot::PB (Parallel Benchmark)
+## Rgot::PB (Parallel Benchmark)
 
-## Rgot::PB#next
+### Rgot::PB#next
 
 Should be call this when parallel benchmark.
 

data/Rakefile

@@ -2,7 +2,7 @@ require "bundler/gem_tasks"
 
 desc "test to rgot"
 task :test do |t|
-  target = "test/rgot_test.rb"
+  target = "test/{rgot_common,rgot}_test.rb"
   ruby "bin/rgot -v #{target}"
 end
 

data/bin/rgot

@@ -2,40 +2,43 @@
 require 'optparse'
 require 'rgot'
 
-opts = {
-  require_paths: []
-}
+opts = Rgot::M::Options.new
+require_paths = []
 parser = OptionParser.new do |o|
   o.on '-v', '--verbose', "log all tests" do |arg|
-    opts[:verbose] = arg
+    Rgot.class_eval{ @chatty = arg }
+  end
+  o.on '--version', "show Rgot version" do |arg|
+    puts "Rgot v#{Rgot::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
+    opts.bench = arg
   end
   o.on '--benchtime [sec]', "benchmark running time" do |arg|
-    opts[:benchtime] = arg
+    opts.benchtime = arg
   end
   o.on '--timeout [sec]', "set timeout sec to testing" do |arg|
-    opts[:timeout] = arg
+    opts.timeout = arg
   end
-  o.on '--cpu [count,...]', "set cpu counts of comma splited" do |arg|
-    opts[:cpu] = arg
+  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 splited" do |arg|
-    opts[:thread] = arg
+  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|
-    opts[:require_paths] << 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)
-opts[:require_paths].each do |path|
+require_paths.each do |path|
   require path
 end
 
@@ -71,59 +74,62 @@ modules = Object.constants.select { |c|
 
 code = 0
 modules.each do |test_module|
-  pid = fork {
-    tests = []
-    benchmarks = []
-    examples = []
-    main = nil
-    methods = test_module.instance_methods.sort
-    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)
+  begin
+    pid = fork {
+      tests = []
+      benchmarks = []
+      examples = []
+      main = nil
+      methods = test_module.instance_methods.sort
+      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
-    end
 
-    methods.grep(/\Abenchmark_/).each do |m|
-      benchmarks << Rgot::InternalBenchmark.new(test_module, m)
-    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
+      methods.grep(/\Aexample_?/).each do |m|
+        examples << Rgot::InternalExample.new(test_module, m)
+      end
 
-    duration = Rgot.now
-    at_exit {
-      template = "%s\t%s\t%.3fs"
+      duration = Rgot.now
+      at_exit {
+        template = "%s\t%s\t%.3fs"
 
-      case $!
-      when SystemExit
-        if $!.success?
-          # exit 0
-          puts sprintf(template, "ok", test_module, Rgot.now - duration)
+        case $!
+        when SystemExit
+          if $!.success?
+            # exit 0
+            puts sprintf(template, "ok", test_module, Rgot.now - duration)
+          else
+            # exit 1
+            puts sprintf(template, "FAIL", test_module, Rgot.now - duration)
+          end
+        when NilClass
+          # not raise, not exit
         else
-          # exit 1
+          # any exception
           puts sprintf(template, "FAIL", test_module, Rgot.now - duration)
         end
-      when NilClass
-        # not raise, not exit
+      }
+      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
-        # any exception
-        puts sprintf(template, "FAIL", test_module, Rgot.now - duration)
+        exit m.run
       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
+  ensure
+    _, status = Process.waitpid2(pid)
+    unless status.success?
+      code = 1
     end
-  }
-  _, status = Process.waitpid2(pid)
-  unless status.success?
-    code = 1
   end
 end
 

data/lib/rgot.rb

@@ -34,8 +34,16 @@ module Rgot
       end
     end
 
-    def benchmark(opts={}, &block)
+    def benchmark(opts_hash={}, &block)
+      opts = B::Options.new
+      opts_hash.each do |k, v|
+        opts[k] = v
+      end
       B.new(nil, nil, opts).run(&block)
     end
+
+    def verbose?
+      @chatty
+    end
   end
 end

data/lib/rgot/b.rb

@@ -1,7 +1,13 @@
 module Rgot
   class B < Common
+    class Options < Struct.new(
+      :procs,
+      :threads,
+      :benchtime
+    ); end
+
     attr_accessor :n
-    def initialize(benchmark_module, name, opts={})
+    def initialize(benchmark_module, name, opts=Options.new)
       super()
       @n = 1
       @module = benchmark_module
@@ -35,25 +41,27 @@ module Rgot
 
     def run(&block)
       n = 1
-      benchtime = @opts.fetch(:benchtime, 1).to_f
-      run_n(n.to_i, block)
-      while !failed? && @duration < benchtime && @n < 1e9
-        if @duration < (benchtime / 100.0)
-          @n *= 100
-        elsif @duration < (benchtime / 10.0)
-          @n *= 10
-        elsif @duration < (benchtime / 5.0)
-          @n *= 5
-        elsif @duration < (benchtime / 2.0)
-          @n *= 2
-        else
-          if @n.to_i == 1
-            break
+      benchtime = (@opts.benchtime || 1).to_f
+      catch(:skip) {
+        run_n(n.to_i, block)
+        while !failed? && @duration < benchtime && @n < 1e9
+          if @duration < (benchtime / 100.0)
+            @n *= 100
+          elsif @duration < (benchtime / 10.0)
+            @n *= 10
+          elsif @duration < (benchtime / 5.0)
+            @n *= 5
+          elsif @duration < (benchtime / 2.0)
+            @n *= 2
+          else
+            if @n.to_i == 1
+              break
+            end
+            @n *= 1.2
           end
-          @n *= 1.2
+          run_n(@n.to_i, block)
         end
-        run_n(@n.to_i, block)
-      end
+      }
 
       BenchmarkResult.new(n: @n, t: @duration)
     end
@@ -61,16 +69,19 @@ module Rgot
     def run_parallel
       raise LocalJumpError, "no block given" unless block_given?
 
-      @opts[:procs].times do
+      procs = (@opts.procs || 1)
+      threads = (@opts.threads || 1)
+
+      procs.times do
         fork {
-          Array.new(@opts[:threads]) {
+          Array.new(threads) {
             Thread.new {
               yield PB.new(bn: @n)
             }.tap { |t| t.abort_on_exception = true }
           }.each(&:join)
         }
       end
-      @n *= @opts[:procs] * @opts[:threads]
+      @n *= procs * threads
       Process.waitall
     end
 
@@ -78,7 +89,6 @@ module Rgot
 
     def run_n(n, block=nil)
       GC.start
-      i = 0
       @n = n
       reset_timer
       start_timer

data/lib/rgot/benchmark_result.rb

@@ -9,7 +9,7 @@ module Rgot
     end
 
     def to_s
-      sprintf("%d\t%.3f ns/op", @n, @t / @n * 1_000_000_000)
+      sprintf("%d\t%d ns/op", @n, @t / @n * 1_000_000_000)
     end
   end
 end

data/lib/rgot/common.rb

@@ -1,62 +1,86 @@
+require 'thread'
+
 module Rgot
   class Common
+    attr_accessor :output
+
     def initialize
       @output = ""
       @failed = false
       @skipped = false
       @finished = false
       @start = Rgot.now
+      @mutex = Mutex.new
     end
 
     def failed?
-      @failed
+      @mutex.synchronize { @failed }
     end
 
     def skipped?
-      @skipped
+      @mutex.synchronize { @skipped }
     end
 
     def finished?
-      @finished
+      @mutex.synchronize { @finished }
     end
 
     def fail!
-      @failed = true
+      @mutex.synchronize { @failed = true }
     end
 
     def skip!
-      @skipped = true
+      @mutex.synchronize { @skipped = true }
     end
 
     def finish!
-      @finished = true
+      @mutex.synchronize { @finished = true }
     end
 
     def log(*args)
-      internal_log(sprintf(*args))
+      internal_log(args.map(&:to_s).join(' '))
     end
 
-    def skip(*args)
+    def logf(*args)
       internal_log(sprintf(*args))
-      skip_now
     end
 
-    def skip_now
-      skip!
-      finish!
-      throw :skip
+    def error(*args)
+      internal_log(args.map(&:to_s).join(' '))
+      fail!
     end
 
-    def error(*args)
+    def errorf(*args)
       internal_log(sprintf(*args))
       fail!
     end
 
-    def fatal(msg)
-      internal_log(msg)
+    def fatal(*args)
+      internal_log(args.map(&:to_s).join(' '))
+      fail_now
+    end
+
+    def fatalf(*args)
+      internal_log(sprintf(*args))
       fail_now
     end
 
+    def skip(*args)
+      internal_log(args.map(&:to_s).join(' '))
+      skip_now
+    end
+
+    def skipf(*args)
+      internal_log(sprintf(*args))
+      skip_now
+    end
+
+    def skip_now
+      skip!
+      finish!
+      throw :skip
+    end
+
     def fail_now
       fail!
       finish!
@@ -74,7 +98,7 @@ module Rgot
     end
 
     def internal_log(msg)
-      @output << decorate(msg)
+      @mutex.synchronize { @output << decorate(msg) }
     end
   end
 end

data/lib/rgot/m.rb

@@ -1,38 +1,42 @@
 require 'stringio'
+require 'etc'
 
 module Rgot
   class M
+    class Options < Struct.new(
+      :bench,
+      :benchtime,
+      :timeout,
+      :cpu,
+      :thread,
+    ); end
+
     # Ruby-2.0.0 wants default value of keyword_argument
-    def initialize(tests: nil, benchmarks: nil, examples: nil, opts: {})
+    def initialize(tests: nil, benchmarks: nil, examples: nil, opts: Options.new)
       raise ArgumentError, "missing keyword: tests" unless tests
       raise ArgumentError, "missing keyword: benchmarks" unless benchmarks
       raise ArgumentError, "missing keyword: examples" unless examples
-
-      @tests = tests
-      @benchmarks = benchmarks
-      @examples = examples
-      @opts = opts
-      @cpu_list = @opts.fetch(:cpu, "1").split(',').map { |i|
+      @cpu_list = (opts.cpu || "#{Etc.nprocessors}").split(',').map { |i|
         j = i.to_i
-        if j == 0
-          raise OptionError, "expect integer string, got #{i.inspect}"
-        end
+        raise Rgot::OptionError, "invalid value #{i.inspect} for --cpu" unless 0 < j
         j
       }
-      @thread_list = @opts.fetch(:thread, "1").split(',').map { |i|
+      @thread_list = (opts.thread || "1").split(',').map { |i|
         j = i.to_i
-        if j == 0
-          raise OptionError, "expect integer string, got #{i.inspect}"
-        end
+        raise Rgot::OptionError, "invalid value #{i.inspect} for --thread" unless 0 < j
         j
       }
+      @tests = tests
+      @benchmarks = benchmarks
+      @examples = examples
+      @opts = opts
     end
 
     def run
       test_ok = false
       example_ok = false
 
-      Timeout.timeout(@opts[:timeout].to_f) {
+      Timeout.timeout(@opts.timeout.to_f) {
         test_ok = run_tests
         example_ok = run_examples
       }
@@ -40,7 +44,7 @@ module Rgot
         puts "FAIL"
         return 1
       end
-      puts "PASS" if @opts[:verbose]
+      puts "PASS" if Rgot.verbose?
       run_benchmarks
       0
     end
@@ -50,8 +54,8 @@ module Rgot
     def run_tests
       ok = true
       @tests.each do |test|
-        t = T.new(test.module, test.name.to_sym, @opts)
-        if @opts[:verbose]
+        t = T.new(test.module, test.name.to_sym)
+        if Rgot.verbose?
           puts "=== RUN #{test.name}"
         end
         t.run
@@ -65,15 +69,16 @@ module Rgot
 
     def run_benchmarks
       ok = true
-      return ok unless @opts[:bench]
+      return ok unless @opts.bench
       @benchmarks.each do |bench|
-        next unless /#{@opts[:bench]}/ =~ bench.name
+        next unless /#{@opts.bench}/ =~ bench.name
 
         @cpu_list.each do |procs|
           @thread_list.each do |threads|
-            opts = @opts.dup
-            opts[:procs] = procs
-            opts[:threads] = threads
+            opts = B::Options.new
+            opts.benchtime = @opts.benchtime
+            opts.procs = procs
+            opts.threads = threads
             b = B.new(bench.module, bench.name.to_sym, opts)
 
             benchname = bench.name.to_s
@@ -81,9 +86,13 @@ module Rgot
             benchname << "(#{threads})" if 1 < threads
             print "#{benchname}\t"
             result = b.run
-            puts result
             if b.failed?
               ok = false
+              next
+            end
+            puts result
+            if 0 < b.output.length
+              printf("--- BENCH: %s\n%s", benchname, b.output)
             end
           end
         end
@@ -94,7 +103,7 @@ module Rgot
     def run_examples
       ok = true
       @examples.each do |example|
-        if @opts[:verbose]
+        if Rgot.verbose?
           puts "=== RUN #{example.name}"
         end
         example.module.extend(example.module)

data/lib/rgot/t.rb

@@ -1,10 +1,9 @@
 module Rgot
   class T < Common
-    def initialize(test_module, name, opts={})
+    def initialize(test_module, name)
       super()
       @module = test_module
       @name = name
-      @opts = opts
       @module.extend @module
     end
 
@@ -24,7 +23,7 @@ module Rgot
       template = "--- %s: %s (%.5fs)\n%s"
       if failed?
         printf template, "FAIL", @name, duration, @output
-      elsif @opts[:verbose]
+      elsif Rgot.verbose?
         if skipped?
           printf template, "SKIP", @name, duration, @output
         else

data/lib/rgot/version.rb

@@ -1,3 +1,3 @@
 module Rgot
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rgot
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - ksss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler