fiddlesticks 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cbd9cdeeef5937f37d6670e4dd0e37fc6c88805
-  data.tar.gz: 94edd386365c99ae373dc1b4e1e43a2a02764a99
+  metadata.gz: 40b1caf285de1c64e0b825ef56e639243df97315
+  data.tar.gz: 6a9b3bbaaaaa9535fc061aed902a5465416e1799
 SHA512:
-  metadata.gz: 0b9113ea6d453abfefe2a2e37acef74474f7bab576f506e05158ba6b14812a8935230e862e23a8ad1509d32612f31049dd19438e951fbe7ab3c6c53c1e0fe1d1
-  data.tar.gz: ce15bc2e4b0674f265ba67912d2ea2f60291514211c8fd8698ad5266c330d7016b903f65f2424a4ef7017097ec968a9b3861b75ab094f2bd0f8116dcb50e6444
+  metadata.gz: 7041642fbaea7929c055fdd6f197ec2d4490f3138a47189e189f01a1706ebeb4a261b2e46472c0bf666d19dca593766a69787c4cc3bf0276b1bac166519c85d6
+  data.tar.gz: ba974eff589d9037db4c35a4f4f46b71541e50ee717c6be76d226c844463956a2b5d667d3ad1a170458ed9fa094f4fb3d0a48af20a7eea73866ea5f737841946

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Björn Grunde
+
+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,49 @@
+# fiddlesticks
+
+Simple wrapper to measure optimization or to find bottlenecks in your codebase.
+
+As for now: 
+ Works on Mac.
+ Not yet tested in Linux distributions.
+ Not yet implemented support for Windows.
+
+Install
+```
+gem install fiddlesticks
+```
+Use
+```
+optimize = Fiddlesticks::Core.new
+
+optimize.measure do
+  100000.times do
+    "SOME STRING".downcase
+  end
+ end
+ ```
+ The ***measure*** method will accept a block and print a table with usefull information that may help when optimizing your code.
+ 
+ ```
++--------------+---------+-----------+--------------+-------------+--------------+
+| Ruby Version | GC      | GC Sweeps | Total Memory | Memory Used | Time         |
++--------------+---------+-----------+--------------+-------------+--------------+
+| 2.4.0        | enabled |        32 | 16.00 GB     | 1936.08 MB  | 1.37 Seconds |
++--------------+---------+-----------+--------------+-------------+--------------+
+
+```
+
+If you want to print out memory in different formats user ***configure*** method. It accepts a Hash  with the keys:
+ 1. total_memory: [Symbol] format: ':kb', ':mb', ':gb', standard ':gb'
+ 2. used_memory: [Symbol] format: ':kb', ':mb', ':gb', standard ':mb'
+ 3. gc_enabled: [Boolean] format: 'true, 'false', standard 'true'
+ 
+```
+optimize = Fiddlesticks::Core.new
+
+optimize.configure({total_memory: :mb, used_memory: :kb, gc_enabled: false })
+
+optimize.measure do
+ #run a block of code
+end
+```
+Will support Mac, Linux and Windows once the project is completed.

data/lib/fiddlesticks.rb

@@ -1,46 +1 @@
-require "benchmark"
-require "color-console"
-require "fiddlesticks/os"
-
-class Fiddlesticks
-
-  def measure(&block)
-    no_gc = (ARGV[0] == "--no-gc")
-    no_gc ? GC.disable : GC.start
-
-    memory_before   = `ps -o rss= -p #{Process.pid}`.to_i/1024
-    gc_stat_before  = GC.stat
-
-    time = Benchmark.realtime do
-      yield
-    end
-
-    unless no_gc
-      GC.start(full_mark: true, immediate_sweep: true, immediate_mark: false)
-    end
-
-    gc_stat_after = GC.stat
-    memory_after  = `ps -o rss= -p #{Process.pid}`.to_i/1024
-
-    if OS.windows?
-      total_memory = "Support coming soon"
-    elsif OS.mac?
-      total_memory = "%d GB" % (`sysctl hw.memsize`.split(" ").last.to_i/1024/1024/1000)
-    elsif OS.linux?
-      total_memory = %x(free).split(" ")[7].to_i/1024
-    else
-      total_memory = "OS Not Found!"
-    end
-
-    memory_used = "%d MB" % (memory_after - memory_before)
-
-    gc = no_gc ? "disabled" : "enabled"
-    gc_count = gc_stat_after[:count] - gc_stat_before[:count]
-
-
-    header = ["Ruby Version", "GC", "GC Sweeps", "Total Memory", "Memory Used", "Time"]
-    data   = [ RUBY_VERSION, gc, gc_count, total_memory, memory_used, time.round(2)]
-
-    Console.display_table([header, data], width: 100, col_sep: "|", row_sep: "-")
-  end
-end
+require 'fiddlesticks/core.rb'

data/lib/fiddlesticks/core.rb

@@ -0,0 +1,65 @@
+require "benchmark"
+require "color-console"
+require "fiddlesticks/os"
+require "fiddlesticks/memory"
+
+# Fiddlesticks runs a block of code and measures memory usage and execution time.
+# @author Björn Grunde
+module Fiddlesticks
+  class Core
+    include OS
+    include Memory
+
+
+    def initialize(total_memory: :gb, used_memory: :mb, gc_enabled: true)
+      @config = {
+        total_memory: total_memory,
+        used_memory: used_memory,
+        gc_enabled: gc_enabled
+      }
+      @valid_keys = @config.keys
+    end
+
+    def configure(opt = {})
+      #@params opt [Hash]
+      #@description Accepts a [Hash] with the keys:
+      #   total_memory [Symbol] format type ':kb', ':mb', 'gb' standard: ':gb',
+      #   used_memory [Symbol] format type ':kb', ':mb', 'gb' standard: ':mb',
+      #   gc_enabled [Boolean] format type 'true', 'false' standard: 'true'
+      opt.each { |k, v| @config[k.to_sym] = v if @valid_keys.include? k.to_sym }
+    end
+
+    def measure(&block)
+      total_memory_type = @config.fetch(:total_memory)
+      used_memory_type  = @config.fetch(:used_memory)
+      gc_enabled   = @config.fetch(:gc_enabled)
+
+      gc_enabled ? GC.start : GC.disable
+      memory_before = get_memory(used_memory_type)
+      gc_stat_before  = GC.stat
+
+      time = Benchmark.realtime do
+        yield
+      end
+
+      if gc_enabled
+        GC.start(full_mark: true, immediate_sweep: true, immediate_mark: false)
+      end
+
+      gc_stat_after = GC.stat
+      memory_after  = get_memory(used_memory_type)
+      memory_total = total_memory(total_memory_type)
+      memory_used = calculate_memory(memory_before, memory_after, used_memory_type)
+
+      gc = gc_enabled ? "enabled" : "disabled"
+
+      gc_count = gc_stat_after[:count] - gc_stat_before[:count]
+
+
+      header = ["Ruby Version", "GC", "GC Sweeps", "Total Memory", "Memory Used", "Time"]
+      data   = [ RUBY_VERSION, gc, gc_count, memory_total, memory_used, "#{time.round(2)} Seconds"]
+
+      Console.display_table([header, data], width: 100, col_sep: "|", row_sep: "-")
+    end
+  end
+end

data/lib/fiddlesticks/memory.rb

@@ -0,0 +1,56 @@
+module Fiddlesticks
+  module Memory
+
+    def get_memory type
+      type.to_sym
+      memory = `ps -o rss= -p #{Process.pid}`.to_f
+
+      case type
+      when :mb then memory = memory/1024
+      when :gb then memory = memory/1024/1024
+      when :kb then memory
+      end
+
+      return memory if [:kb, :mb, :gb].include?(type)
+      raise ArgumentError.new("Argument is not of type Symbol, expected one of(:kb, :mb, :gb)")
+    end
+
+    def total_memory type
+      type.to_sym
+      os = ""
+
+      if OS.windows?
+        total_memory = ""
+        os = "Windows"
+      elsif OS.mac?
+        total_memory = `sysctl hw.memsize`.split(" ").last.to_i
+        os = "Mac"
+      elsif OS.linux?
+        total_memory = %x(free).split(" ")[7].to_i
+        os = "Linux"
+      else
+        total_memory = ""
+        os = "Unkown OS"
+      end
+
+      case type
+      when :kb then total_memory
+      when :mb then total_memory = total_memory/1024
+      when :gb then total_memory = total_memory/1024/1024/1000
+      end
+
+      return "%.2f #{type.upcase}" % total_memory if [:kb, :mb, :gb].include?(type) && total_memory.is_a?(Integer)
+
+      raise ArgumentError.new("Argument is not of type Symbol, expected one of(:kb, :mb, :gb)")
+      raise NotImplementedError.new("Fiddlesticks either lack support or could not figure out the os: #{os}") if ["Windows", "Unkown OS"].include?(os)
+    end
+
+    def calculate_memory before, after, type
+      before.to_f && after.to_f && type.to_sym
+
+      memory_used = after - before
+      return memory_used = "%g #{type.upcase}" % ("%.4f" % memory_used) unless memory_used == 0
+      "Less than 1 MB"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fiddlesticks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Björn Grunde
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: color-console
@@ -29,11 +29,17 @@ description: Fiddlesticks accepts a block of code and willl show the memory used
 email: bjorngrunde@live.se
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
+- LICENSE
+- README.md
 - lib/fiddlesticks.rb
+- lib/fiddlesticks/core.rb
+- lib/fiddlesticks/memory.rb
 - lib/fiddlesticks/os.rb
-homepage: 
+homepage: https://github.com/bjorngrunde/fiddlesticks
 licenses:
 - MIT
 metadata: {}