mach5-tools 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cce1bb05727559d4d95becf25542e7d9334bd9fd
-  data.tar.gz: 603d7c169a843c26666d5ce82215819fda09916e
+  metadata.gz: 163872e80d75ee26cc09b5a1dfc6db9c376c683f
+  data.tar.gz: 1bb00f92a1b7dad131528a9a5674477a3efc3f3b
 SHA512:
-  metadata.gz: 1302656407ebbe2177d846c5bc255e93fcc816d59b5d6f4441156cabdaf016bffa1cbda13b352b31a781d8da34fc2f851125a6c396165c108f7ec5bd8da32a5f
-  data.tar.gz: 995d488ad455d579d8a47a7a2cc3fce8a5a388f8144cfee0a1bdd7c36661bf3fb1f9335a7e69bd4a55f42c84f30347bb396638485c24d2afef3ba5976d219955
+  metadata.gz: 64b91ef9ccbba42e13526cdc47dff79d31280befb018a55ab4959369b51e193f83d4bacd72c730431155b3266b279de4a31bfadb16797d65560c42b0f21f2a4a
+  data.tar.gz: 7734d58b73c4e2ab49dc272228a2ca7aee48457954a2d3a7ef7a49db7a0dfd64622abd8bd76ac52470557398afd5554a7d62947ee930a155c7b31560ad613029

data/README.rdoc

@@ -1,10 +1,39 @@
-= Mach 5 Tools
+= Mach5 Tools
 
-It is a beta software!
+Easily manage your Mach5 benchmarks.
 
-Mach 5 Tools is part of Mach 5 project: https://github.com/igorbonadio/mach5
+== Requirements
 
-== Contributing to Mach 5 Tools
+* Mach5 library (https://github.com/igorbonadio/mach5)
+* Ruby 1.9 or 2.0 (http://www.ruby-lang.org)
+* Git (http://git-scm.com)
+* Phantomjs (http://phantomjs.org), if you want to generate charts
+
+== Install
+
+  $ gem install mach5-tools
+
+== Configuration
+
+First you need to configure and to define benchmarks using the Mach5 library. If you want to know how to do it, check this {page}[https://github.com/igorbonadio/mach5].
+
+After that, go to the root of your project and run
+
+  $ mach5 init
+
+It will generate a file called Mach5file that is a template of benchmark and chart definitions. So all you need to do is edit this file.
+
+== Usage
+
+There are 5 available commands:
+
+* benchmark - Run benchmarks
+* chart - Generate charts
+* init - Create an initial Mach5file
+* version - Print the version
+* help - Describe available commands or one specific command
+
+== Contributing to Mach5 Tools
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.

data/TODO

@@ -19,5 +19,8 @@ v0.2.1
 [x] BUG: quando não existe a pasta de output, "mach5 chart" quebra
 
 v0.3.0
-[ ] mach5 init (cria o Mach5file)
-
+[x] mach5 init (cria o Mach5file)
+[x] mach5 --version
+[x] README
+[ ] Site
+[ ] Apresentação

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/bin/mach5

@@ -40,6 +40,22 @@ class App < Thor
     end
   end
 
+  desc "version", "Print the version"
+  def version
+    puts "v#{File.open(File.join(File.dirname(__FILE__), "../VERSION")).readlines.join}"
+  end
+
+  desc "init", "Create an initial Mach5file"
+  def init
+    if File.exists?("Mach5file")
+      puts "There is already a Mach5file. If you want to overwrite it, try to remove it first and then generate a new one."
+    else
+      File.open("Mach5file", "w") do |f|
+        f.write(File.open(File.join(File.dirname(__FILE__), "../lib/templates/Mach5file")).readlines.join.gsub("{{PROJECT_NAME}}", File.basename(Dir.getwd)))
+      end
+    end
+  end
+
   default_task :benchmark
 end
 

data/lib/mach5-tools.rb

@@ -1,5 +1,7 @@
 root_path = File.expand_path(File.dirname(__FILE__))
 
+require File.join(root_path, 'mach5-tools/command/benchmark')
+require File.join(root_path, 'mach5-tools/command/chart')
 require File.join(root_path, 'mach5-tools/benchmark')
 require File.join(root_path, 'mach5-tools/config')
 require File.join(root_path, 'mach5-tools/runner')

data/lib/mach5-tools/command/benchmark.rb

@@ -0,0 +1,88 @@
+module Mach5
+  module Command
+    module Benchmark
+      def run(benchmarks)
+        results = ""
+        @config.run_commands.each do |command|
+          output = IO.popen "#{command} --color --json run #{benchmarks.join(' ')}"
+          results = output.readlines.join
+        end
+        JSON.parse(results)
+      end
+
+      def checkout(commit_id)
+        Kernel.system "git checkout #{commit_id}"
+      end
+
+      def _only_benchmarks(benchmarks)
+        @config.benchmarks.commits.each do |commit|
+          selected_benchmarks = _select_benchmarks(commit, @config.benchmarks.has_tag?(commit), benchmarks)
+          _run_benchmarks(selected_benchmarks, commit) if selected_benchmarks.size > 0
+        end
+      end
+
+      def _select_benchmarks(commit, commit_id, benchmarks)
+        selected_benchmarks = []
+        @config.benchmarks[commit].each do |benchmark|
+          without_tag = "#{commit}.#{benchmark}"
+          with_tag = "#{commit_id}.#{benchmark}"
+          selected_benchmarks << benchmark if benchmarks.include?(without_tag)
+          selected_benchmarks << benchmark if benchmarks.include?(with_tag) and commit_id
+        end
+        selected_benchmarks
+      end
+
+      def _all_benchmarks
+        @config.benchmarks.commits.each do |commit|
+          checkout(commit)
+          before
+          save(run(@config.benchmarks[commit]), commit)
+          after
+        end
+      end
+
+      def _only_new_benchmarks
+        @config.benchmarks.commits.each do |commit|
+          new_benchmarks = find_new_benchmarks(@config.benchmarks[commit], commit)
+          _run_benchmarks(new_benchmarks, commit) if new_benchmarks.size > 0
+        end
+      end
+
+      def _run_benchmarks(benchmarks, commit)
+        checkout(commit)
+        before
+        save(run(benchmarks), commit)
+        after
+      end
+
+      def find_new_benchmarks(benchmarks, commit)
+        new_benchmarks = []
+        benchmarks.each do |benchmark|
+          new_benchmarks << benchmark unless File.exists?(File.join(@config.output_folder, "#{commit}.#{benchmark}.json"))
+        end
+        new_benchmarks
+      end
+
+      def save(json, commit)
+        Dir.mkdir(@config.output_folder) unless Dir.exists?(@config.output_folder)
+        json.each do |key, value|
+          File.open(File.join(@config.output_folder, "#{commit}.#{key}.json"), "w") do |f|
+            f.write(value.to_json)
+          end
+        end
+      end
+
+      def list_benchmarks
+        benchmark_list = []
+        @config.benchmarks.commits.each do |commit|
+          commit_id = @config.benchmarks.has_tag?(commit)
+          commit_id = commit unless commit_id
+          @config.benchmarks[commit].each do |benchmark|
+            benchmark_list << "#{commit_id}.#{benchmark}"
+          end
+        end
+        benchmark_list
+      end
+    end
+  end
+end

data/lib/mach5-tools/command/chart.rb

@@ -0,0 +1,54 @@
+module Mach5
+  module Command
+    module Chart
+      def _all_charts
+        @config.charts.each do |chart|
+          _generate_chart(chart)
+        end
+      end
+
+      def _only_charts(charts)
+        @config.charts.each do |chart|
+          if charts.include? chart.id
+            _generate_chart(chart)
+          end
+        end
+      end
+
+      def _only_new_charts
+        @config.charts.each do |chart|
+          unless File.exists?("#{File.join(@config.output_folder, chart.id)}.png")
+            _generate_chart(chart)
+          end
+        end
+      end
+
+      def _generate_chart(chart)
+        benchmarks = _check_benchmarks(chart)
+        _only_benchmarks(benchmarks) if benchmarks.size > 0
+        Kernel.system "phantomjs #{File.join(File.dirname(__FILE__), "../js/chart.js")} #{File.join(File.dirname(__FILE__), "../js")} \"[#{chart.build.to_json.gsub("\"", "\\\"")}]\" #{File.join(@config.output_folder, chart.id)}.png"
+      end
+
+      def _check_benchmarks(chart)
+        benchmarks = []
+        chart.series.each do |benchmark|
+          filename = _filename(benchmark[:commit_id], benchmark[:benchmark_id])
+          benchmarks << "#{benchmark[:commit_id]}.#{benchmark[:benchmark_id]}" unless File.exists?(filename)
+        end
+        benchmarks
+      end
+
+      def _filename(commit_id, benchmark_id)
+        if @config.benchmarks.tagged[commit_id]
+          "#{File.join(@config.output_folder, @config.benchmarks.tagged[commit_id])}.#{benchmark_id}.json"
+        else
+          "#{File.join(@config.output_folder, commit_id)}.#{benchmark_id}.json"
+        end
+      end
+
+      def list_charts
+        @config.charts.map(&:id)
+      end
+    end
+  end
+end

data/lib/mach5-tools/runner.rb

@@ -2,6 +2,9 @@ require 'json'
 
 module Mach5
   class Runner
+    include Command::Benchmark
+    include Command::Chart
+
     def initialize(config)
       @config = config
     end
@@ -14,15 +17,6 @@ module Mach5
       end
     end
 
-    def run(benchmarks)
-      results = ""
-      @config.run_commands.each do |command|
-        output = IO.popen "#{command} --color --json run #{benchmarks.join(' ')}"
-        results = output.readlines.join
-      end
-      JSON.parse(results)
-    end
-
     %w{benchmark chart}.each do |method|
       define_method(method) do |options|
         if options[:all]
@@ -34,127 +28,5 @@ module Mach5
         end
       end
     end
-
-    def _only_benchmarks(benchmarks)
-      @config.benchmarks.commits.each do |commit|
-        selected_benchmarks = _select_benchmarks(commit, @config.benchmarks.has_tag?(commit), benchmarks)
-        _run_benchmarks(selected_benchmarks, commit) if selected_benchmarks.size > 0
-      end
-    end
-
-    def _select_benchmarks(commit, commit_id, benchmarks)
-      selected_benchmarks = []
-      @config.benchmarks[commit].each do |benchmark|
-        without_tag = "#{commit}.#{benchmark}"
-        with_tag = "#{commit_id}.#{benchmark}"
-        selected_benchmarks << benchmark if benchmarks.include?(without_tag)
-        selected_benchmarks << benchmark if benchmarks.include?(with_tag) and commit_id
-      end
-      selected_benchmarks
-    end
-
-    def _all_benchmarks
-      @config.benchmarks.commits.each do |commit|
-        checkout(commit)
-        before
-        save(run(@config.benchmarks[commit]), commit)
-        after
-      end
-    end
-
-    def _only_new_benchmarks
-      @config.benchmarks.commits.each do |commit|
-        new_benchmarks = find_new_benchmarks(@config.benchmarks[commit], commit)
-        _run_benchmarks(new_benchmarks, commit) if new_benchmarks.size > 0
-      end
-    end
-
-    def _run_benchmarks(benchmarks, commit)
-      checkout(commit)
-      before
-      save(run(benchmarks), commit)
-      after
-    end
-
-    def _all_charts
-      @config.charts.each do |chart|
-        _generate_chart(chart)
-      end
-    end
-
-    def _only_charts(charts)
-      @config.charts.each do |chart|
-        if charts.include? chart.id
-          _generate_chart(chart)
-        end
-      end
-    end
-
-    def _only_new_charts
-      @config.charts.each do |chart|
-        unless File.exists?("#{File.join(@config.output_folder, chart.id)}.png")
-          _generate_chart(chart)
-        end
-      end
-    end
-
-    def _generate_chart(chart)
-      benchmarks = _check_benchmarks(chart)
-      _only_benchmarks(benchmarks) if benchmarks.size > 0
-      Kernel.system "phantomjs #{File.join(File.dirname(__FILE__), "js/chart.js")} #{File.join(File.dirname(__FILE__), "js")} \"[#{chart.build.to_json.gsub("\"", "\\\"")}]\" #{File.join(@config.output_folder, chart.id)}.png"
-    end
-
-    def _check_benchmarks(chart)
-      benchmarks = []
-      chart.series.each do |benchmark|
-        filename = ""
-        if @config.benchmarks.tagged[benchmark[:commit_id]]
-          filename = "#{File.join(@config.output_folder, @config.benchmarks.tagged[benchmark[:commit_id]])}.#{benchmark[:benchmark_id]}.json"
-        else
-          filename = "#{File.join(@config.output_folder, benchmark[:commit_id])}.#{benchmark[:benchmark_id]}.json"
-        end
-        unless File.exists?(filename)
-          benchmarks << "#{benchmark[:commit_id]}.#{benchmark[:benchmark_id]}"
-        end
-      end
-      benchmarks
-    end
-
-    def find_new_benchmarks(benchmarks, commit)
-      new_benchmarks = []
-      benchmarks.each do |benchmark|
-        new_benchmarks << benchmark unless File.exists?(File.join(@config.output_folder, "#{commit}.#{benchmark}.json"))
-      end
-      new_benchmarks
-    end
-
-    def save(json, commit)
-      Dir.mkdir(@config.output_folder) unless Dir.exists?(@config.output_folder)
-      json.each do |key, value|
-        File.open(File.join(@config.output_folder, "#{commit}.#{key}.json"), "w") do |f|
-          f.write(value.to_json)
-        end
-      end
-    end
-
-    def checkout(commit_id)
-      Kernel.system "git checkout #{commit_id}"
-    end
-
-    def list_benchmarks
-      benchmark_list = []
-      @config.benchmarks.commits.each do |commit|
-        commit_id = @config.benchmarks.has_tag?(commit)
-        commit_id = commit unless commit_id
-        @config.benchmarks[commit].each do |benchmark|
-          benchmark_list << "#{commit_id}.#{benchmark}"
-        end
-      end
-      benchmark_list
-    end
-
-    def list_charts
-      @config.charts.map(&:id)
-    end
   end
 end

data/lib/templates/Mach5file

@@ -0,0 +1,34 @@
+# This template was generated by Mach5 Tools.
+# For more information: https://github.com/igorbonadio/mach5-tools
+
+Mach5::configure "{{PROJECT_NAME}}" do
+
+  # benchmark "8327da83b11ccfe9ab7f03426abb5b2c846e4a88" => 'your_tag' do
+  #   add "FixtureName1.BenchmarkName1"
+  #   add "FixtureName2.BenchmarkName2"
+  # end
+
+  # chart "my_chart" do
+  #   title "My Chart"
+  #   add_serie "8327da83b11ccfe9ab7f03426abb5b2c846e4a88" => "FixtureName1.BenchmarkName1"
+  #   add_serie "your_tag"                                 => "FixtureName2.BenchmarkName2"
+  #   x_axis "Something Here"
+  #   y_axis "Other thing here"
+  # end
+
+  # before do
+  #   exec "cd build && cmake .."
+  #   exec "cd build && make"
+  # end
+
+  # run do
+  #   exec "./build/benchmark/benchmark"
+  # end
+
+  # after do
+  #   exec "cd build && make clean"
+  # end
+
+  # output "_benchmark"
+
+end

data/mach5-tools.gemspec

@@ -2,15 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: mach5-tools 0.2.2 ruby lib
+# stub: mach5-tools 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mach5-tools"
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Igor Bonadio"]
-  s.date = "2014-02-18"
+  s.date = "2014-02-19"
   s.description = "Mach 5 is a minimalist C++11 benchmarking framework."
   s.email = "igorbonadio@gmail.com"
   s.executables = ["mach5"]
@@ -33,12 +33,15 @@ Gem::Specification.new do |s|
     "lib/mach5-tools.rb",
     "lib/mach5-tools/benchmark.rb",
     "lib/mach5-tools/chart.rb",
+    "lib/mach5-tools/command/benchmark.rb",
+    "lib/mach5-tools/command/chart.rb",
     "lib/mach5-tools/config.rb",
     "lib/mach5-tools/js/chart.html",
     "lib/mach5-tools/js/chart.js",
     "lib/mach5-tools/js/highcharts.js",
     "lib/mach5-tools/js/jquery.js",
     "lib/mach5-tools/runner.rb",
+    "lib/templates/Mach5file",
     "mach5-tools.gemspec",
     "spec/benchmark_spec.rb",
     "spec/chart_spec.rb",

data/spec/runner_spec.rb

@@ -141,8 +141,9 @@ module Mach5
       chart = double("Chart")
       chart.stub(:build).and_return("chart.build")
       chart.stub(:id).and_return("chart.id")
+      File.stub(:dirname).and_return("")
       @runner.should_receive(:_check_benchmarks).with(chart).and_return([])
-      Kernel.should_receive(:system).with("phantomjs /Users/igorbonadio/Projetos/mach5-tools/lib/mach5-tools/js/chart.js /Users/igorbonadio/Projetos/mach5-tools/lib/mach5-tools/js \"[\\\"chart.build\\\"]\" _benchmark/chart.id.png")
+      Kernel.should_receive(:system).with("phantomjs /../js/chart.js /../js \"[\\\"chart.build\\\"]\" _benchmark/chart.id.png")
       @runner._generate_chart(chart)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mach5-tools
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Igor Bonadio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -117,12 +117,15 @@ files:
 - lib/mach5-tools.rb
 - lib/mach5-tools/benchmark.rb
 - lib/mach5-tools/chart.rb
+- lib/mach5-tools/command/benchmark.rb
+- lib/mach5-tools/command/chart.rb
 - lib/mach5-tools/config.rb
 - lib/mach5-tools/js/chart.html
 - lib/mach5-tools/js/chart.js
 - lib/mach5-tools/js/highcharts.js
 - lib/mach5-tools/js/jquery.js
 - lib/mach5-tools/runner.rb
+- lib/templates/Mach5file
 - mach5-tools.gemspec
 - spec/benchmark_spec.rb
 - spec/chart_spec.rb