but 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 853bfa5259d6c243f2728c71d7dd1575914cb38a29c1b40dcf39b78833fd670f
-  data.tar.gz: b4d65cf498abbc277d1ec5280d6de2542a48810ac20f58f36c449dbf3410f493
+  metadata.gz: 7a401f4f83816e46b9a0a8dd97b84f4da1c1ef3141e20c750d902a98ca7050b5
+  data.tar.gz: bf75f25a1d4f0eca838d60f7b7f21c1db3ad3e18f1398b3387d7b1d414b4e3a4
 SHA512:
-  metadata.gz: b90007c89eaa18486ebae63374caa47c3b32526fc58ac90b48542e0aa0cb67253caaf2336d56331218f84a7e319a023738718c1dc16a61c85ddef6937f93e68b
-  data.tar.gz: 74ea9639c7aaaaf9bf06db499e3031d97b3e48ccf332d9aa699ea18e93b7ad257a5065bf451018dce7672a02e045e75e5d50c488e776ff87b3fe73456e7536ca
+  metadata.gz: f6e61db7075302c71a5ac845aeb85433a75fbe44d90e785a81ebf0025ff80bde37e4436678f2a1d445d5438b73b1cc9905ff3222ae33de9683478e06337c3fa1
+  data.tar.gz: 6b854b4002ec51e9577ab01e0cc0b05280dff03741e1add324d048cad06ce11cae2c036c073ee765c05896e51a622def90f44008f6177145711b63d67f409431

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    but (0.1.2)
+    but (0.1.3)
       colorize
+      ruby-prof
       thor
 
 GEM
@@ -129,6 +130,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (0.0.3)
       parser (>= 2.7.0.1)
+    ruby-prof (1.4.1)
     ruby-progressbar (1.10.1)
     shellany (0.0.1)
     sys-uname (1.2.1)

data/README.md

@@ -95,6 +95,39 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Benchmarking and Profiling
+
+#### Benchmarking
+
+Each subcommand can be benchmarked by
+
+```
+### Garbage collector enabled
+but command subcommand --measure --gc
+
+#or
+
+### Garbage collector disabled
+but command subcommand --measure --nogc
+```
+
+#### Profiling
+
+Each subcommand can be profiled using ruby prof
+
+```
+but command --profile <MEASURING METHOD>
+```
+
+where possible options are
+
+```
+but command --profile WALL_TIME
+but command --profile PROCESS_TIME
+but command --profile ALLOCATIONS
+but command --profile MEMORY
+```
+
 ### Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/but. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/but.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'thor'
   spec.add_dependency 'colorize'
+  spec.add_dependency 'ruby-prof'
 
 
   spec.metadata    = { "source_code_uri" => "https://git.computational.bio.uni-giessen.de/rmueller/bcf_user_tools" }

data/lib/but/cli.rb

@@ -17,6 +17,7 @@ module But
   class How < Thor
     class_option :measure, :type => :boolean, :default => false
     class_option :gc, :type => :boolean, :default => true
+    class_option :profile, :aliases => '-p', required: false, desc: 'create a ruby prof profile; Possible values: MEMORY, ALLOCATIONS, WALL_TIME, PROCESS_TIME'
 
     desc "messy am I?", "How messed up is your home?"
     def messy(*words)
@@ -24,6 +25,10 @@ module But
         measure(options) do
           say But::HomeKeeper.judge
         end
+      elsif options[:profile]
+        profile(options) do
+          say But::HomeKeeper.judge
+        end
       else
         say But::HomeKeeper.judge
       end

data/lib/but/dev_wrapper.rb

@@ -1,5 +1,7 @@
 require "json"
 require "benchmark"
+require "rubygems"
+require "ruby-prof"
 
 #inspired by Ruby Performance Optimization: Alexander Dymo
 def measure(options={}, &block)
@@ -31,3 +33,36 @@ def measure(options={}, &block)
     }
   }.to_json)
 end
+
+
+def profile(options={}, &block)
+  measure_mode = options[:profile].upcase
+  RubyProf.measure_mode = RubyProf.const_get(measure_mode)
+
+  case measure_mode
+  when "WALL_TIME" 
+    GC.disable
+  when "PROCESS_TIME" 
+    GC.disable
+  when "ALLOCATIONS" 
+    #GC.enable_stats
+  when "MEMORY" 
+    #GC.enable_stats
+  else
+  end
+
+  result = RubyProf.profile do
+    yield
+  end
+
+  printer_g = RubyProf::GraphHtmlPrinter.new(result)
+  printer_f = RubyProf::FlatPrinter.new(result)
+  printer_c = RubyProf::CallTreePrinter.new(result)
+  unless measure_mode == "MEMORY"
+    printer_g.print(File.open(measure_mode + "_graph.html","w"))
+    printer_f.print(File.open(measure_mode + "_flat.txt","w"))
+  end
+  printer_c.print(options)
+
+  puts "Profiles written for #{measure_mode}"
+end

data/lib/but/version.rb

@@ -1,3 +1,3 @@
 module But
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: but
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Raphael Müller
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: BCF admins have a hard live. Their user's don't keep their $HOMES and
   other working places clean. It appears that some users don't know that they use
   too much space in their home or don't clean used directories on cluster (or other)