sass-prof 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3a7b66c13e0f95d8d4bb9f8ca928986b6ef4fdc
-  data.tar.gz: 2e1448e78d71372901d3903fc074e55fbf34f4fb
+  metadata.gz: 082e6bb8340e42960e64ca08611143d7674c3eb9
+  data.tar.gz: d09299a30a5afa8c6135a2720ce555f80f427663
 SHA512:
-  metadata.gz: 063bbc7b1336ea3c2522c7083b5ed0d06f7edd13b45b264851699e70353cee38f46671af5a6d404bc9d00f1ded01284ee1b20741874f0f7aa643749e8c0592db
-  data.tar.gz: b39122ed3ea99174aee1d0d48602ed6b55f973d40d015be155351ab672a1dc85d5deae99042814035bbb0bbeaa017a869d086d07e3c572bbfc46cd60d090885f
+  metadata.gz: 493f298da828e6533cd86bbe7a24b9b5667ecfca8a1e7760f764b424dd69daf7dd055bb64caca7778a54d5292e2070e9828a6e0221162f00c93aa36c3c9a69eb
+  data.tar.gz: 74a7821bd4ac37cbcc0789884bf534034ad7cf3aac55247173f0257f98d73e804ede70888072eba9e6f86f9485f991fdc3f2d69463505519eb407ad2100e586b

data/.gitignore

@@ -1,3 +1,4 @@
+*.log
 .sass-cache/
 /spec/stylesheets/
 /.bundle/

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in sass-prof.gemspec
 gemspec

data/README.md

@@ -2,6 +2,8 @@
 
 [![Gem](https://img.shields.io/gem/v/sass-prof.svg?style=flat-square)](https://rubygems.org/gems/sass-prof)
 
+![Sass Prof](screenshot.jpg)
+
 Sass Prof is a code profiler for [Sass](https://github.com/sass/sass). For each function, Sass Prof will show the execution time for the function, which file called it and what arguments were given when the function was called.
 
 ## Requirements
@@ -31,9 +33,9 @@ prof = Sass::Prof::Config
 # Default is `false`
 prof.output_file = "sass-prof.log"
 
-# Adjust output table column width
-# Default is `20`
-prof.col_width = 40
+# Adjust max column width
+# Default is `false`
+prof.max_width = 40
 
 # Mutes all output to stdout
 # Default is `false`
@@ -43,9 +45,16 @@ prof.quiet = true
 # Default is `100`
 prof.t_max = 500
 
+# Alias for `t_max`
+prof.max_execution_time = 15
+
 # Enable colored output
 # Default is `true`
 prof.color = true
+
+# Execution time precision
+# Default is `15`
+prof.precision = 5
 ```
 
 _Please note: your compile times **will be slower** due to the overhead of **Sass Prof**. This library was created to help you find potential bottlenecks within your code. If you find any bugs or inconsistencies, please file an [issue](https://github.com/ezekg/sass-prof/issues) or [pull request](https://github.com/ezekg/sass-prof/pulls)._

data/lib/sass-prof/version.rb

@@ -2,6 +2,6 @@
 
 module Sass
   module Prof
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/sass-prof.rb

@@ -1,66 +1,124 @@
 # encoding: UTF-8
 
+require "terminal-table"
+
 module Sass
   module Prof
 
     module Config
-      attr_accessor :t_max, :col_width, :output_file, :quiet, :color
+      attr_accessor :t_max
+      attr_accessor :max_width
+      attr_accessor :output_file
+      attr_accessor :quiet
+      attr_accessor :color
+      attr_accessor :precision
+
+      alias_method :max_execution_time=, :t_max=
+      alias_method :max_execution_time,  :t_max
 
       @t_max       = 100
-      @col_width   = 20
+      @max_width   = false
       @output_file = false
       @quiet       = false
       @color       = true
+      @precision   = 15
 
       extend self
     end
 
     module Report
-      attr_accessor :report
+      attr_accessor :rows
 
-      @report = [
-        ["File", "Execution Time", "Action", "Signature"]
-      ]
+      @rows = []
 
-      def add(value)
-        @report << value
+      def add_row(row)
+        row = Prof::Formatter.truncate_row row if Prof::Config.max_width
+        @rows << row
+      end
+
+      def reset_report
+        @rows = []
       end
 
       def print_report
-        puts to_table @report
+        log_report if Prof::Config.output_file
+        puts Prof::Formatter.to_table @rows
       end
 
-      def reset_report
-        @report = [
-          ["File", "Execution Time", "Action", "Signature"]
-        ]
+      def log_report
+        File.open(Prof::Config.output_file, "a+") do |f|
+          f.puts Prof::Formatter.to_table @rows.map { |r|
+            r.map { |col| col.gsub /\e\[(\d+)(;\d+)*m/, "" } }
+        end
+      end
+
+      extend self
+    end
+
+    module Formatter
+
+      def colorize(string, color)
+        return string.to_s unless Prof::Config.color
+
+        colors = Hash.new("37").merge({
+          :black  => "30",
+          :red    => "31",
+          :green  => "32",
+          :yellow => "33",
+          :blue   => "34",
+          :purple => "35",
+          :cyan   => "36",
+          :white  => "37",
+        })
+
+        "\e[0;#{colors.fetch(color)}m#{string}\e[0m"
       end
 
-      def to_table(report)
-        return unless report
+      def to_table(rows)
+        t_total_in_seconds = rows.map { |c|
+          c[1].gsub(/\e\[(\d+)(;\d+)*m/, "").to_f }.reduce(:+) / 1000 % 60
 
-        table = report.map do |row|
-          "[ %s ]" % row.map { |col|
-            diff = col.length - col.gsub(/\e\[(\d+)(;\d+)*m/, "").length
-            "%-#{Sass::Prof::Config.col_width + diff}s" % col }.join(" | ")
+        # Add total execution time footer
+        rows << :separator
+        rows << ["Total Execution Time", t_total_in_seconds]
+
+        table = Terminal::Table.new({
+          :headings => ["File", "Execution Time", "Action", "Signature"],
+          :rows     => rows
+        })
+
+        table
+      end
+
+      def truncate_row(row)
+        max_width = Prof::Config.max_width
+        tr_row = []
+
+        row.map do |col|
+          clean_width = col.gsub(/\e\[(\d+)(;\d+)*m/, "").length
+          diff        = col.length - clean_width
+
+          if clean_width > max_width
+            tr_row << (col[0..max_width + diff] << "\e[0m...")
+          else
+            tr_row << col
+          end
         end
 
-        table.join "\n"
+        tr_row
       end
 
       extend self
     end
 
     class Profiler
-      attr_accessor :config, :function, :action, :args, :env
+      attr_accessor :function, :action, :args, :env
 
       @@t_total = 0
       @@t_then  = 0
       @@t_now   = 0
 
       def initialize(function, action, args = nil, env = nil)
-        @config   = Sass::Prof::Config
-        @report   = Sass::Prof::Report
         @function = function
         @action   = action
         @args     = args
@@ -76,34 +134,28 @@ module Sass
         t_delta = (@@t_now.to_f - @@t_then.to_f) * 1000.0
         @@t_then, @@t_total = @@t_now, t_delta
 
-        prep_fn_report
+        create_fn_report
       end
 
       private
 
-      def prep_fn_report
+      def create_fn_report
         fn_report = [fn_source, fn_execution_time, fn_action,
           fn_signature]
 
-        @report.add fn_report unless config.quiet
-
-        if config.output_file
-          File.open(config.output_file, "a+") do |f|
-            f.puts @report.to_table [fn_report.map { |col|
-              col.gsub /\e\[(\d+)(;\d+)*m/, "" }]
-          end
-        end
+        Prof::Report.add_row fn_report unless Prof::Config.quiet
 
-        if @@t_total > config.t_max && action == :execute
-          raise RuntimeError.new colorize(
-            "Max execution time of #{config.t_max}ms reached for function"\
-            " `#{fn_name}` (took #{@@t_total.round(3)}ms)", :red)
+        if @@t_total > Prof::Config.t_max && action == :execute
+          raise RuntimeError.new Prof::Formatter.colorize(
+            "Max execution time of #{Prof::Config.t_max}ms reached for function"\
+            " `#{fn_name}()` (took #{@@t_total.round(3)}ms)", :red)
         end
       end
 
       def fn_execution_time
-        color = @@t_total > config.t_max ? :red : :green
-        colorize @@t_total.to_s, color
+        color = @@t_total > Prof::Config.t_max ? :red : :green
+        Prof::Formatter.colorize @@t_total.round(
+          Prof::Config.precision).to_s, color
       end
 
       def fn_name
@@ -126,47 +178,32 @@ module Sass
       end
 
       def fn_source
-        return colorize("Unknown file", :red) unless env
+        return Prof::Formatter.colorize("Unknown file", :red) unless env
 
         orig_filename = env.options.fetch :original_filename, "Unknown file"
         filename      = env.options.fetch :filename, "Unknown file"
 
-        colorize "#{File.basename(orig_filename)}:#{File.basename(filename)}",
-          :yellow
+        Prof::Formatter.colorize "#{File.basename(orig_filename)}:"\
+          "#{File.basename(filename)}", :yellow
       end
 
       def fn_action
-        colorize action.to_s, :yellow
+        Prof::Formatter.colorize action.capitalize, :yellow
       end
 
       def fn_signature
-        colorize(fn_name, :blue) << "(" << colorize(fn_args, :purple) << ")"
-      end
-
-      def colorize(string, color)
-        return string unless config.color
-
-        colors = Hash.new("37").merge({
-          :black  => "30",
-          :red    => "31",
-          :green  => "32",
-          :yellow => "33",
-          :blue   => "34",
-          :purple => "35",
-          :cyan   => "36",
-          :white  => "37",
-        })
-
-        "\e[0;#{colors.fetch(color)}m#{string}\e[0m"
+        "#{Prof::Formatter.colorize(fn_name, :blue)}"\
+        "(#{Prof::Formatter.colorize(fn_args, :purple)})"
       end
     end
   end
 
+  # Monkey patch Sass to utilize Profiler
   class Tree::Visitors::Perform
     alias_method :__visit_function, :visit_function
 
     def visit_function(node)
-      prof = Sass::Prof::Profiler.new(node.dup, :allocate)
+      prof = Prof::Profiler.new(node.dup, :allocate)
       prof.start
 
       value = __visit_function node
@@ -181,7 +218,7 @@ module Sass
     alias_method :__perform_sass_fn, :perform_sass_fn
 
     def perform_sass_fn(function, args, splat, environment)
-      prof = Sass::Prof::Profiler.new(function.dup, :execute, args.dup,
+      prof = Prof::Profiler.new(function.dup, :execute, args.dup,
         environment.dup)
       prof.start
 

data/sass-prof.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "compass", "~> 1.0"
   spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "sass", "~> 3.4"
+  spec.add_development_dependency "rake",    "~> 10.0"
+
+  spec.add_dependency "terminal-table", "~> 1.5"
+  spec.add_dependency "sass",           "~> 3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sass-prof
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - ezekg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compass
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +97,7 @@ files:
 - lib/sass-prof.rb
 - lib/sass-prof/version.rb
 - sass-prof.gemspec
+- screenshot.jpg
 homepage: https://github.com/ezekg/sass-prof
 licenses:
 - MIT