benchmarker 0.1.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4db8de6cac8784ee9b81df579b14f1cefc4b00435e552f15daf20b80d9ec4d6
+  data.tar.gz: eebde6574d665a1db773ba96a246813594e3b2c169dfc3a425c084bc40a13a26
+SHA512:
+  metadata.gz: 22c6df70a7b7dcbc27012a6b698106d170346c4c58e1bd8d16d194b05a94105b16fa7cb1e72d38c5cea20ae1a8dc07ef7dd1fa3b547a992cffe5a9a646ed6a70
+  data.tar.gz: 82f38ebb748596137984a4aa59cccb7f115bfd191e166cf8a72722fd3dcb073ee867d2b6aca540e465d387fc38018524d73b7804088d8725f7c3d9d45d864026

data/CHANGES.md

@@ -0,0 +1,9 @@
+ChangeLog
+=========
+
+
+
+Release 1.0.0
+-------------
+
+* Public release.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2010-2021 kuwata-lab.com all rights reserved
+
+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,26 @@
+Benchamrker.rb README
+=====================
+
+Benchmarker.rb is an awesome benchmarking tool for Ruby.
+
+* Easy to use
+* Pretty good output (including JSON format)
+* Rich features compared to ``benchmark.rb`` (standard library)
+  * Iterate benchmarks and calculate average of resutls (optional)
+  * Remove min and max results to exclude abnormal values (optional)
+  * Remove loop times from each benchmark results (optional)
+  * Save benchmark results into JSON file (optional)
+  * Change loop times, number of iteration, etc by command-line option
+  * Print platform information automatically
+  * Print ranking graph and ratio matrix automatically
+
+See <https://kwatch.github.io/benchmarker/> for details.
+
+
+
+License and Copyright
+---------------------
+
+$License: MIT License $
+
+$Copyright: copyright(c) 2010-2021 kuwata-lab.com all rights reserved $

data/Rakefile

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+project   = "benchmarker"
+release   = "$Release: 1.0.0 $".split()[1]
+copyright = "copyright(c) 2010-2021 kuwata-lab.com all rights reserved"
+license   = "MIT License"
+
+require 'fileutils'
+include FileUtils
+
+require 'rake/clean'
+CLEAN.include("build/#{project}-#{release}")
+CLOBBER.include("build")
+
+
+task :default => :test
+
+def _do_test(ruby="ruby")
+  sh "#{ruby} -r oktest -e 'Oktest.main' -- test -sc"
+end
+
+desc "do test"
+task :test do
+  _do_test("ruby")
+end
+
+ruby_vers = %w[2.0.0-p648 2.1.10 2.2.10 2.3.8 2.4.10 2.5.8 2.6.2 2.7.1 3.0.2]
+
+desc "do test on multiple ruby versions"
+task :'test:all' do
+  ruby_vers.each do |ruby_ver|
+    puts "========== ruby #{ruby_ver} =========="
+    ruby = "#{ENV['VS_HOME']}/ruby/#{ruby_ver}/bin/ruby"
+    _do_test(ruby)
+  end
+end
+
+
+def copy_into(*args)
+  args = args.flatten
+  dir = args.pop
+  mkdir_p dir unless File.exists?(dir)
+  cp_r args, dir
+end
+
+
+def edit_files(*filenames, &block)
+  filenames.flatten.each do |fname|
+    Dir.glob(fname).each do |fpath|
+      next unless File.file?(fpath)
+      s = File.open(fpath, 'rb') {|f| f.read() }
+      s = block.arity == 2 ? yield(s, fpath) : yield(s)
+      File.open(fpath, 'wb') {|f| f.write(s) }
+    end
+  end
+end
+
+
+desc "create 'build/#{project}-#{release}/' and copy files to it"
+task :build do
+  release = ENV['rel']  or
+    raise "rake: requires 'rel=X.X.X'"
+  dir = "build/#{project}-#{release}"
+  #rm_rf dir if File.exist?(dir)
+  fnames = Dir.glob("#{dir}*")
+  rm_rf fnames unless fnames.empty?
+  mkdir_p dir
+  ## store
+  cp_r %W[README.md CHANGES.md Rakefile MIT-LICENSE #{project}.gemspec setup.rb], dir
+  copy_into Dir.glob("lib/*.rb"),      "#{dir}/lib"
+  copy_into Dir.glob("test/*test.rb"), "#{dir}/test"
+  #copy_into Dir.glob("examples/*.rb"), "#{dir}/examples"
+  ## edit
+  edit_files("#{dir}/**/*") do |content, filename|
+    if ! %w[setup.rb].include?(File.basename(filename))
+      content.gsub! /[\$]Release:.*?\$/,   "$""Release: #{release} $"
+      content.gsub! /[\$]Copyright:.*?\$/, "$""Copyright: #{copyright} $"
+      content.gsub! /[\$]License:.*?\$/,   "$""License: #{license} $"
+      content.gsub! /[\$]Release\$/,   release
+      content.gsub! /[\$]Copyright\$/, copyright
+      content.gsub! /[\$]License\$/,   license
+    end
+    content
+  end
+end
+
+
+desc "create gem package"
+task :package => :build do
+  release = ENV['rel']  or
+    raise "rake package: requires 'rel=X.X.X'"
+  base = "#{project}-#{release}"
+  #chdir "build" do
+  #  sh "tar cf #{base}.tar.gz #{base}"
+  #end
+  chdir "build/#{base}" do
+    sh "gem build #{project}.gemspec"
+    mv Dir.glob("#{project}-*.gem"), ".."
+  end
+end
+
+desc "upload gem package"
+task :publish do
+  release = ENV['rel']  or
+    raise "rake publish: requires 'rel=X.X.X'"
+  gem = "build/#{project}-#{release}"
+  sh "gem push #{gem}"
+end

data/benchmarker.gemspec

@@ -1,57 +1,43 @@
 #!/usr/bin/ruby
 
 ###
-### $Release: 0.1.0 $
-### $Copyright: copyright(c) 2010-2011 kuwata-lab.com all rights reserved $
-### $License: Public Domain $
+### $Release: 1.0.0 $
+### $Copyright: copyright(c) 2010-2021 kuwata-lab.com all rights reserved $
+### $License: MIT License $
 ###
 
 require 'rubygems'
 
 spec = Gem::Specification.new do |s|
-  ## package information
   s.name        = "benchmarker"
-  s.author      = "makoto kuwata"
-  s.email       = "kwa(at)kuwata-lab.com"
-  s.rubyforge_project = 'benchmarker'
-  s.version     = "$Release: 0.1.0 $".split(/ /)[1]
+  s.author      = "kwatch"
+  s.email       = "kwatch@gmail.com"
+  #s.rubyforge_project = 'benchmarker'
+  s.version     = "$Release: 1.0.0 $".split()[1]
   s.platform    = Gem::Platform::RUBY
-  #s.homepage    = "http://www.kuwata-lab.com/benchmarker/"
-  s.homepage    = "http://github.com/kwatch/benchmarker/"
-  s.summary     = "a small utility for benchmarking"
+  s.license     = 'MIT'
+  #s.license     = 'CC-PDDC'  # public domain
+  #s.homepage    = "https://github.com/kwatch/benchmarker/"
+  s.homepage    = "https://kwatch.github.io/benchmarker/ruby.html"
+  s.summary     = "pretty good benchmark library"
   s.description = <<-'END'
-Benchmarker is a small utility for benchmarking.
-
-Quick Example (ex0.rb):
-
-    require 'rubygems'
-    require 'benchmarker'
-
-    Benchmarker.new(:width=>20, :loop=>100*1000, :cycle=>5, :extra=>1) do |bm|
-      range = 1..1000
-      bm.task("each") do
-        arr = []
-        range.each {|n| arr << n }
-      end
-      bm.task("collect") do
-        arr = range.collect {|n| n }
-      end
-      bm.task("inject") do
-        arr = range.inject([]) {|a, n| a << n; a }
-      end
-    end
+Benchmarker is a pretty good benchmark tool for Ruby.
+Compared to `benchmark.rb` (standard library), Benchmarker has a lot of useful features.
+See: https://kwatch.github.io/benchmarker/ruby.html
 END
 
   ## files
   files = [
-    'benchmarker.rb',
+    'lib/benchmarker.rb',
     'test/**/*',
-    'examples/**/*',
-    'REAMDE.txt', 'CHANGES.txt',
+    #'examples/**/*',
+    'README.md', 'CHANGES.md', 'Rakefile', 'MIT-LICENSE',
     'setup.rb', 'benchmarker.gemspec',
   ]
   s.files       = files.collect {|pat| Dir.glob(pat) }.flatten
   s.test_file   = 'test/benchmarker_test.rb'
+  s.required_ruby_version = '>= 2.0'
+  s.add_development_dependency "oktest", '~> 1.0'
 end
 
 # Quick fix for Ruby 1.8.3 / YAML bug   (thanks to Ross Bamford)