benchify 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ab4739b8e35a289ef0bc93d42a07e0de279bbc6811c2a25158ec72755719011
-  data.tar.gz: 2ecbe780019eb29c010a0ea14634a53ae6744fe2c2a1e4efadca368e320c65b3
+  metadata.gz: 939a25dfbd759e26c076183b242de3cddd7eaa43cf3d365ade56ddab627156ac
+  data.tar.gz: 64169340ba3ff5bf3c6d85f9d1f4084a6e2f970465fd355bc3871d3f0baf7ee3
 SHA512:
-  metadata.gz: f44aaf4bbcd2921215a2857bfe85f5dba5942ee5c02de193b1e15dcc792f4ecf0882a99db1f60bfb01665975ac6bd7fd9488213d80aeb863b07fb3a1cadfe998
-  data.tar.gz: a5d0c9d184bfbba77077cf75fdfcecdfcd6893422dbda8f598f75812c9040d971ae63d87fee3d6934b577833ce8fae259b34d3ded489d83234eb7f49b67cbdf5
+  metadata.gz: 285d8eeff1baa8911a1973edc0b4fc3c897e16d686f5f87a6f5aa7a263b14e5a27ca15550d350f7298b413614a6d2f61c1036095ca9a5b198bc6ded409f64507
+  data.tar.gz: 33787391b420b5bdbd71d18945fc91264741f1972d871077aa2a5a66361b66826723bba21b0384bdd5db4e682a25de61743bb91aeb08441f1a892b7641726d26

data/README.md

@@ -1,58 +1,128 @@
+**For 0.2.0 you must call #finish to calculate results**  
+**execution time is saved with #call, and calculated later with #finish**
+
+documentation will be added ...
+
 # Benchify
 
-**Benchmark Source-Code:**
+[![Gem Version](https://badge.fury.io/rb/benchify.svg)](https://badge.fury.io/rb/benchify)
+
+Benchmark measures for different languages. Compare scripts created in Ruby, Python, Bash... or check different methods execution time in Ruby source code.
+Benchify count only a real execution time, in seconds. You can set a default count-type, but anyway you'll be able to access values in seconds, milliseconds, minutes and hours. You can also get a time when operation started/ended. Purpose of this is to get an easy way to count anything you do in terminal, including shell commands like `sudo apt update`.
+
+
+# How to install
+
+Install from [rubygems](https://rubygems.org/gems/benchify):
 
 ```ruby
-# initialize new object
-# accept type (:symbol) and message ('string')
+gem install benchify
 
-  benchmark = Benchify.new :min, 'processed time in minutes:'
-  # or
-  benchmark = Benchmark.new :sec
+# or add to Gemfile, followed by bundle install
+gem 'benchify', '~> 0.1.1'
+```  
+
+Install from source:
 
+```ruby
+git clone https://github.com/decentralizuj/benchify
+cd benchify
+
+# no dependecies needed for production, only bundler and rake for development
+bundle install
+```  
+
+
+# How to use
 
-# measure is alias for call
+**Benchmark Ruby Source-Code:**
 
+Initialize new object with type and message (both are optional). Default type is `:sec`, and message is `processed time`. Here's a list of available symbols for type, anything else would lead to counting in seconds.
+
+```ruby
+hours        => :h, :hour, :hours
+minutes      => :m, :min, :minute, :minutes
+milliseconds => :ms, :milli, :milliseconds
+
+benchmark = Benchify.new(:ms)
+```  
+
+
+You can override default message constant, if you want to
+
+```ruby
+Benchify::MESSAGE = 'Your Message Here'
+
+# or you can add a message with new object
+
+benchmark = Benchify.new( :ms, 'Your Message Here' )
+```  
+
+
+Now you can call method `#call` or it's alias `#measure`
+
+```ruby
   benchmark.call { YOUR CODE HERE }
+  
   # or
+  
   benchmark.measure do
     # YOUR CODE HERE
   end
+  
+  # you can also add a message as parameter
+  
+  benchmark.measure('counting seconds:') do
+    # YOUR CODE HERE
+  end
 ```  
 
+
 **Benchmark Terminal:**
 
-Make sure your script has environment defined ( shebang )
+Make sure your script has shebang (environment defined)
 
 ` #!/usr/bin/env ruby `
 
 ```ruby
+# if script is not executable, you'll be asked for permission (and sudo password)
+
 benchify script_1.rb script_2.py script_3.sh
 ```  
 
-Or use `-e` to benchmark shell command
+Use `-e` to benchmark shell commands (use this if you don't have shebang in script)
 
 ```ruby
-benchify -e 'free -m | head -n 2' 'some other command'
+benchify -e 'sudo apt update' 'gem install moriarty' 'python3 somefile.py'
 ```  
 
-# About
+
+# Example
+
+If you don't like name `Benchify`, you can also use `Benchmark`
 
 ```ruby
-  benchmark = Benchmark.new :ms, ' counted milliseconds:'
+  benchmark = Benchmark.new :sec, ' counted seconds:'
 
   benchmark.call { ... }
   benchmark.measure('change_message:') { ... }
 
   Attributes:
 
+    # after initialization
     benchmark.message     => 'processed time:'
     benchmark.type        => :sec
-    benchmark.start       => Time.now when start
-    benchmark.end         => Time.now when end
-    benchmark.total       => Total seconds - float
-    benchmark.time        => counted time by type (:sec)
+    
+    # after code finished
+    
+    benchmark.start       => Time.now (when started)
+    benchmark.end         => Time.now (when ended)
+    benchmark.total       => Total seconds (float)
+    benchmark.time        => counted time by type (in_seconds)
     benchmark.result      => message + time + type (processed time: 22.124 sec)
+    
+    # available time attributes (after code finished)
+    
     benchmark.in_seconds  => access time in seconds
     benchmark.in_minutes  => access time in minutes
     benchmark.in_hours    => access time in hours

data/benchify.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'benchify'
-  s.version     = '0.1.1'
+  s.version     = '0.2.2'
   s.summary     = 'Benchmark measures for Code and/or Terminal'
   s.description = <<~DESC
     Benchmark Ruby methods from source code, or any script from terminal.
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.metadata['source_code_uri'] = 'https://github.com/decentralizuj/benchify'
   s.metadata['bug_tracker_uri'] = 'https://github.com/decentralizuj/benchify/issues'
 
-  s.files = ['bin/benchify', 'lib/benchify.rb', 'LICENSE', 'README.md', 'benchify.gemspec']
+  s.files = ['bin/benchify', 'lib/benchify.rb', 'lib/benchify/benchmark.rb', 'lib/benchify/result.rb', 'LICENSE', 'README.md', 'benchify.gemspec']
   s.bindir = 'bin'
   s.executables = ['benchify']
   s.require_paths = ['lib']

data/bin/benchify

@@ -2,11 +2,13 @@
 
 require_relative '../lib/benchify'
 
-  if ARGV.empty?
+  if ARGV.empty? or ARGV.include? '-h' or ARGV.include? '--help'
 
     puts
     puts " $ benchify  script_1.rb  script_2.py  script_3.sh"
     puts
+    puts " $ benchify -e 'sudo apt update' 'sudo apt upgrade'"
+    puts
 
   else
 
@@ -18,7 +20,9 @@ require_relative '../lib/benchify'
       if test == :file
 
         if File.executable?(script)
-          benchmark.measure { system "./#{script}" }
+          benchmark.call { system "./#{script}" }
+          benchmark.finish
+          puts
           puts benchmark.result
         else
           puts "[!] NOT EXECUTABLE!"
@@ -30,13 +34,17 @@ require_relative '../lib/benchify'
           else
             system "sudo chmod +x #{script}"
             benchmark.measure { system "./#{script}" }
+            benchmark.finish
+            puts
             puts benchmark.result
           end
         end
 
       else
         next if script == '-e'
-        benchmark.call { system "#{script}" }
+        benchmark.measure { system "#{script}" }
+        benchmark.finish
+        puts
         puts benchmark.result
       end
     end

data/lib/benchify.rb

@@ -1,74 +1,5 @@
-class Benchify
+require_relative 'benchify/benchmark'
 
-  MESSAGE = 'processing time:'
+class Benchify < Benchmark
 
-  attr_reader :time, :message, :type, :total, :data, :start, :end
-  attr_reader :in_seconds, :in_hours, :in_minutes, :in_milliseconds
-
-  alias result    data
-
-  alias in_ms     in_milliseconds
-  alias in_milli  in_milliseconds
-
-  alias in_h      in_hours
-
-  alias in_sec    in_seconds
-
-  alias in_min    in_minutes
-
-
-  def initialize( type = :sec, message = nil )
-
-    case type
-      when :m, :min, :minute, :minutes then :min
-      when :ms, :milli, :milliseconds  then :ms
-      when :h, :hour, :hours           then :h
-      else :sec
-    end
-
-    @type    = type
-    @message = message || MESSAGE
-  end
-
-
-  def call( message = nil, &operation )
-
-    msg    = message || @message
-    @start = Time.now
-
-    yield operation
-
-    @end   = Time.now
-    @total = (@end - @start).to_f
-
-    calculate_time @type
-    @data = "#{msg} #{@time} #{@type}"
-  end
-
-  alias measure call
-
-
-  private
-
-
-  def calculate_time( type )
-    @in_seconds      =  @total.round(4)
-    @in_hours        = (@total / 60).round(2)
-    @in_minutes      = (@total / 360).round(2)
-    @in_milliseconds = (@total * 1000).round(5)
-    return_by_type type
-  end
-
-
-  def return_by_type( type )
-    case type
-      when :sec then time = @in_seconds
-      when :min then time = @in_minutes
-      when :ms  then time = @in_milliseconds
-      when :h   then time = @in_hours
-    end
-    return @time = time.to_s
-  end
 end
-
-class Benchmark < Benchify; end

data/lib/benchify/benchmark.rb

@@ -0,0 +1,51 @@
+require_relative 'result'
+
+class Benchmark
+
+  MESSAGE = 'processing time:'
+
+  attr_reader :type, :msg
+  attr_reader :data, :min, :max, :middle, :result, :results
+
+  alias message msg
+  alias time middle
+
+  def initialize( type = :sec, message = nil )
+    case type
+      when :m, :min, :minute, :minutes then :min
+      when :ms, :milli, :milliseconds  then :ms
+      when :h, :hour, :hours           then :h
+      else :sec
+    end
+    @data = []
+    @type = type
+    @msg  = message || MESSAGE
+  end
+
+  def call( message = nil, &operation )
+    @msg = message unless message.nil?
+    start = Time.now
+    yield operation
+    ends  = Time.now
+    @data << [ start, ends ]
+  end
+
+  alias measure call
+
+  def finish
+    @results = Result.new @type, @msg
+    @data.each do |st, en|
+      @results.add st, en
+    end
+    @results.get
+    @min     =  @results.min
+    @max     =  @results.max
+    @middle  =  @results.middle
+    @result  =  @results.output
+  end
+
+  alias end finish
+
+  # TO-DO
+  # save output
+end

data/lib/benchify/result.rb

@@ -0,0 +1,45 @@
+class Result
+
+  attr_reader :type, :msg, :counter, :output
+  attr_reader :min, :max, :middle, :all
+
+  alias message msg
+
+  def initialize( type, message )
+    @type = type.to_sym
+    @msg  = message
+    @all  = []
+  end
+
+  def add( start, ends )
+    time = ends.to_f - start.to_f
+    @all << time
+  end
+
+  def get
+    @counter = @all.size
+    @min     = get_by_type @all.min
+    @max     = get_by_type @all.max
+    @middle  = get_by_type ( @max - ( (@max - @min) / 2 ) )
+    @output  = create_result_message
+  end
+
+  def create_result_message
+    msg = @msg.to_s
+    msg += " => "
+    msg += "min: #{@min} #{@type} | max: #{@max} #{@type} | middle: #{@middle} #{@type}"
+  end
+
+  private
+
+  def get_by_type( time )
+    case @type
+      when :min then x = (time / 360).round(2)
+      when :ms  then x = (time * 1000).round(5)
+      when :h   then x = (time / 60).round(2)
+      else  x = time.round(4)
+    end
+    return x
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - decentralizuj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,8 @@ files:
 - benchify.gemspec
 - bin/benchify
 - lib/benchify.rb
+- lib/benchify/benchmark.rb
+- lib/benchify/result.rb
 homepage: https://github.com/decentralizuj/benchify
 licenses:
 - MIT