rgot 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b420828d0e0801d5f766faa6ef3c57c67ae81a6b
-  data.tar.gz: 49271b8268fc5eb3b61da0350a2ac12adb5b91c3
+  metadata.gz: 8f276d8ac23961aa00103a1217c57b1ef513b7d1
+  data.tar.gz: f742e18e1815dde34451f3566a303dc2239b9433
 SHA512:
-  metadata.gz: 384ccc588fe79b31c639d8e4aaa6ada76ba283ab9082ddc113b84362277142616dcb54fba6c4250827bafc3443f90de7a1284b2ebda61e6bab1573b8f5ef39ea
-  data.tar.gz: 39490b59b9baf6c883b6beafce640ddd5301aa34ee2f0e3f199db0daead6932463c74c3408576638fc63ee5275f083d49b6b73f9bb05fdbb15e690c01e86a27d
+  metadata.gz: 7be4569af2fdd700a3df4ed304a7e53d00d23d73d40153b555eb05b132640d2cea8990b89a2db5a73d0d91cea67b6f149de405f14e277f8f39bc02919df44f84
+  data.tar.gz: a89b569ed19bac5b3a26d650fa6262f84daf7a0a65d1ce304d3943fbee7bef1abeada4a24023f317d53f8c11bf8a9590957387c473eef7ef37e67c42c032c09e

data/README.md

@@ -3,7 +3,9 @@ rgot
 
 [![Build Status](https://travis-ci.org/ksss/rgot.svg)](https://travis-ci.org/ksss/rgot)
 
-RGOT is a Ruby Golang like Testing package.
+Ruby + Golang Testing = Rgot
+
+Rgot is a testing package convert from golang testing.
 
 ### usage
 
@@ -52,3 +54,275 @@ $ rgot -v test/pass_test.rb
 PASS
 ok	0.001s
 ```
+
+# Feature
+
+## Testing
+
+I provide a very simple testing feature to you.
+
+**Rgot** testing is quite different from *RSpec* and *MiniTest* etc.
+
+Rgot carve out a new world of testing.
+
+So, You check only bad case in testing.
+
+## Benchmark
+
+You can write simple benchmark script with testing.
+
+This benchmark to adjust the time automatically.
+
+```ruby
+module FooTest
+  def benchmark_something(b)
+    i = 0
+    while i < b.n
+      something(1)
+      i += 1
+    end
+  end
+end
+```
+
+`b.n` is automatically adjusted.
+
+## Example
+
+Rgot's example feature is the best and if you want to write the sample code of your library.
+
+While presenting the sample code, it will be able to test whether the display results match at the same time.
+
+```ruby
+module FooTest
+  class User
+    def initialize(name)
+      @name = name
+    end
+
+    def hello
+      "Hello #{@name}"
+    end
+  end
+
+  def example_something
+    user = User.new('ksss')
+    puts user.hello
+    # Output:
+    # Hello ksss
+  end
+
+  def example_fail
+    user = User.new('ksss')
+    puts user.hello
+    # Output:
+    # Hi ksss
+  end
+end
+```
+
+`example_fail` fail since output is different.
+
+So, you can notice that the sample code is wrong.
+
+# Naming convention
+
+## Filename
+
+Filename should be set '*_test.rb'
+
+## Module name
+
+Module name should be set 'XxxTest'
+
+'Xxx' can replace any string (in range of ruby module)
+
+Testing code file can split any number.
+
+But all file should be have one module (like golang package name).
+
+```ruby
+module XxxTest
+end
+```
+
+## Method name
+
+Method name should be set 'test_*' for testing.
+
+And benchmark method should be set 'benchmark_*'.
+
+```ruby
+module XxxTest
+  def test_any_name(t)
+  end
+
+  def benchmark_any_name(b)
+  end
+end
+```
+
+# Command
+
+```
+$ rgot -h
+Usage: rgot [options]
+    -v, --verbose                    log all tests
+    -b, --bench [regexp]             benchmark
+        --benchtime [sec]            benchmark running time
+        --timeout [sec]              set timeout sec to testing
+```
+
+## Basic
+
+```
+$ rgot file_of_test.rb
+PASS
+ok	0.001s
+```
+
+Set filename to argument.
+
+Just only start testing file_of_test.rb.
+
+```
+$ rgot sample
+PASS
+ok	0.002s
+```
+
+And set dirname to argument, run all case of testing under this dir.
+
+## Verbose
+
+```
+$ rgot -v target_file_test.rb
+=== RUN test_pass
+--- PASS: test_pass (0.00005s)
+PASS
+ok	0.001s
+```
+
+Show all log and more detail infomation of testing.
+
+## Benchmark
+
+```
+$ rgot target_file_test.rb -b .
+```
+
+Run testing with benchmark.
+
+`.` means match all string for regexp.
+
+Set `someone` if you only run benchmark to match `someone` method.(e.g. benchmark_someone_1)
+
+## Timeout
+
+```
+$ rgot target_file_test.rb --timeout 3
+```
+
+You can set timeout sec for testing (default 0).
+
+Fail testing and print raised exception message to STDERR if timeout.
+
+# Rgot::M (Main)
+
+Main method run first on testing.
+
+And this is default virtual main code.
+
+```ruby
+module TestSomeCode
+  def test_main(m)
+    exit m.run
+  end
+end
+```
+
+Main method should be set 'test_main' only.
+
+variable `m` is a instance of `Rgot::M` class means Main.
+
+`Rgot::M#run` start all testing methods.
+
+And return code of process end status.
+
+If you want to run before/after all testing method, You can write like this.
+
+```ruby
+module TestSomeCode
+  def test_main(m)
+    the_before_running_some_code
+    code = m.run
+    the_after_running_some_code
+    exit code
+  end
+end
+```
+
+# Rgot::Common
+
+`Rgot::Common` is inherited to `Rgot::T` and `Rgot::B`
+
+`Rgot::Common` have some logging method.
+
+## Rgot::Common#log
+
+```ruby
+t.log("wooooo")
+```
+
+Write any log message.
+
+But this message to show need -v option.
+
+## Rgot::Common#error
+
+```ruby
+t.error("expect #{a} got #{b}")
+```
+
+Test fail and show some error message.
+
+## Rgot::Common#skip
+
+```ruby
+t.skip("this method was skipped")
+```
+
+Skip current testing method.
+
+And run to next testing method.
+
+# Rgot::T (Testing)
+
+Testing is a main usage of this package.
+
+```ruby
+module TestSomeCode
+  def test_some_1(t)
+  end
+end
+```
+
+The `t` variable is instance of `Rgot::T` class means Testing.
+
+# Rgot::B (Benchmark)
+
+For Benchmark class.
+
+Can use log methods same as `Rgot::T` class
+
+## Rgot::B#reset_timer
+
+Reset benchmark timer
+
+## Rgot::B#start_timer
+
+Start benchmark timer
+
+## Rgot::B#stop_timer
+
+Stop benchmark timer

data/bin/rgot

@@ -16,6 +16,9 @@ parser = OptionParser.new do |o|
   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
 end
 parser.parse!(ARGV)
 
@@ -49,12 +52,13 @@ end
 
 tests = []
 benchmarks = []
+examples = []
 main = nil
 c = modules.first
 
 test_module = Object.const_get(c)
-methods = test_module.instance_methods
-methods.grep(/\Atest_.*/).sort.each do |m|
+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
@@ -62,14 +66,20 @@ methods.grep(/\Atest_.*/).sort.each do |m|
   end
 end
 
-methods.grep(/\Abenchmark_.*/).sort.each do |m|
+methods.grep(/\Abenchmark_/).each do |m|
   benchmarks << Rgot::InternalBenchmark.new(test_module, m)
 end
 
-m = Rgot::M.new(tests: tests, benchmarks: benchmarks, opts: opts)
+methods.grep(/\Aexample_?/).each do |m|
+  examples << Rgot::InternalExample.new(test_module, m)
+end
+
+m = Rgot::M.new(tests: tests, benchmarks: benchmarks, examples: examples, opts: opts)
 duration = Rgot.now
 at_exit {
-  puts sprintf("ok\t%.3fs", Rgot.now - duration)
+  if !$!
+    puts sprintf("ok\t%.3fs", Rgot.now - duration)
+  end
 }
 if main
   main.module.extend main.module

data/lib/rgot.rb

@@ -1,9 +1,10 @@
 module Rgot
-  autoload :VERSION, 'rgot/version'
-  autoload :Common, 'rgot/common'
-  autoload :M, 'rgot/m'
-  autoload :T, 'rgot/t'
-  autoload :B, 'rgot/b'
+  require 'rgot/version'
+  require 'rgot/common'
+  require 'rgot/m'
+  require 'rgot/t'
+  require 'rgot/b'
+  require 'rgot/example_parser'
 
   class OptionError < StandardError
   end
@@ -14,6 +15,12 @@ module Rgot
   class InternalBenchmark < Struct.new(:module, :name)
   end
 
+  class InternalExample < Struct.new(:module, :name)
+  end
+
+  class ExampleOutput < Struct.new(:name, :output)
+  end
+
   class << self
     if "2.0.0" < RUBY_VERSION
       def now

data/lib/rgot/b.rb

@@ -9,7 +9,6 @@ module Rgot
       @opts = opts
       @benchtime = @opts.fetch(:benchtime, 1).to_f
       @timer_on = false
-      @start = Rgot.now
       @duration = 0
       @module.extend @module
     end
@@ -37,7 +36,6 @@ module Rgot
 
     def run
       n = 1
-      a = Rgot.now
       run_n(n)
       while !failed? && @duration < @benchtime && @n < 1e9
         if @duration < (@benchtime / 100.0)

data/lib/rgot/common.rb

@@ -28,7 +28,7 @@ module Rgot
       @skipped = true
     end
 
-    def finished!
+    def finish!
       @finished = true
     end
 
@@ -36,6 +36,17 @@ module Rgot
       internal_log(sprintf(*args))
     end
 
+    def skip(*args)
+      internal_log(sprintf(*args))
+      skip_now
+    end
+
+    def skip_now
+      skip!
+      finish!
+      throw :skip
+    end
+
     def error(*args)
       internal_log(sprintf(*args))
       fail!
@@ -43,13 +54,13 @@ module Rgot
 
     def fatal(msg)
       internal_log(msg)
-      fail_now!
+      fail_now
     end
 
-    def fail_now!
+    def fail_now
       fail!
-      @finished = true
-      exit 1
+      finish!
+      throw :skip
     end
 
     private

data/lib/rgot/example_parser.rb

@@ -0,0 +1,46 @@
+require 'ripper'
+
+module Rgot
+  class ExampleParser < Ripper
+    attr_accessor :examples
+    def initialize(code)
+      super
+      @examples = []
+      @in_def = false
+      @has_output = false
+      @output = ""
+    end
+
+    def on_def(method, args, body)
+      @examples << ExampleOutput.new(method.to_sym, @output.dup)
+      @output.clear
+      @has_output = false
+      @in_def = false
+    end
+
+    def on_comment(a)
+      if @in_def
+        if @has_output
+          @output << a.sub(/\A#\s*/, '')
+        else
+          if /#\s*Output:\s*(.*?\n)/ =~ a
+            text = $1
+            if 0 < text.length || text[0] != "\n"
+              @output << text
+            end
+            @has_output = true
+          end
+        end
+      end
+    end
+
+    def on_kw(a)
+      case a
+      when "def"
+        @in_def = true
+      when "end"
+        @in_def = false
+      end
+    end
+  end
+end

data/lib/rgot/m.rb

@@ -1,22 +1,30 @@
+require 'stringio'
+
 module Rgot
   class M
     # Ruby-2.0.0 wants default value of keyword_argument
-    def initialize(tests: [], benchmarks: [], opts: {})
+    def initialize(tests: [], benchmarks: [], examples: [], opts: {})
       @tests = tests
       @benchmarks = benchmarks
+      @examples = examples
       @opts = opts
     end
 
     def run
-      test_ok = run_tests
-      benchmark_ok = run_benchmarks
-      if !test_ok || !benchmark_ok
+      test_ok = false
+      example_ok = false
+      Timeout.timeout(@opts[:timeout].to_f) {
+        test_ok = run_tests
+        example_ok = run_examples
+      }
+      if !test_ok || !example_ok
         puts "FAIL"
         1
       else
         puts "PASS"
         0
       end
+      run_benchmarks
     end
 
     private
@@ -26,7 +34,7 @@ module Rgot
       @tests.each do |test|
         t = T.new(test.module, test.name.to_sym, @opts)
         if @opts[:verbose]
-          puts "=== RUN #{test.name}\n"
+          puts "=== RUN #{test.name}"
         end
         t.run
         t.report
@@ -52,5 +60,43 @@ module Rgot
       end
       ok
     end
+
+    def run_examples
+      ok = true
+      @examples.each do |example|
+        if @opts[:verbose]
+          puts "=== RUN #{example.name}"
+        end
+        example.module.extend(example.module)
+        method = example.module.instance_method(example.name).bind(example.module)
+        out, err = 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}
+        if e && e.output.strip != out.strip
+          ok = false
+          puts "got:"
+          puts out.strip
+          puts "want:"
+          puts e.output.strip
+        end
+      end
+      ok
+    end
+
+    private
+
+    def capture
+      orig_out, orig_err = $stdout, $stderr
+      out, err = StringIO.new, StringIO.new
+      $stdout, $stderr = out, err
+      yield
+      [out.string, err.string]
+    ensure
+      $stdout, $stderr = orig_out, orig_err
+    end
   end
 end

data/lib/rgot/t.rb

@@ -10,8 +10,8 @@ module Rgot
 
     def run
       begin
-        call
-        finished!
+        catch(:skip) { call }
+        finish!
       rescue => e
         fail!
         report

data/lib/rgot/version.rb

@@ -1,3 +1,3 @@
 module Rgot
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/rgot.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["ksss"]
   spec.email         = ["co000ri@gmail.com"]
 
-  spec.summary       = %q{The Ruby GOlang like Testing module}
-  spec.description   = %q{rgot is golang like testing module in ruby}
+  spec.summary       = %q{Ruby + Golang Testing = Rgot}
+  spec.description   = %q{Rgot is a testing package convert from golang testing}
   spec.homepage      = "https://github.com/ksss/rgot"
   spec.license       = "MIT"
 

metadata

@@ -1,44 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: rgot
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - ksss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-02 00:00:00.000000000 Z
+date: 2015-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: rgot is golang like testing module in ruby
+description: Rgot is a testing package convert from golang testing
 email:
 - co000ri@gmail.com
 executables:
@@ -46,8 +46,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,6 +56,7 @@ files:
 - lib/rgot.rb
 - lib/rgot/b.rb
 - lib/rgot/common.rb
+- lib/rgot/example_parser.rb
 - lib/rgot/m.rb
 - lib/rgot/t.rb
 - lib/rgot/version.rb
@@ -70,18 +71,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: The Ruby GOlang like Testing module
+summary: Ruby + Golang Testing = Rgot
 test_files: []