sass-prof 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bdc582c7241e357559c9cb8fe3ca8a9d8ca5eb2
-  data.tar.gz: 5a65fa2fba5c17ddb3f71fc08a3af4bba6ae7c97
+  metadata.gz: 74b54effd751314200217bc6a303bcb28bab0a9d
+  data.tar.gz: 8e72075c8d54289247ab974d5d287e558c7753ac
 SHA512:
-  metadata.gz: f80bd2249c8002050c28609f79de4860e0a679ed321a857d28c78e5d1ef3b5fe556311b69e8febd6363fe3acff61d67549d0fa0569c2263fe50e0d9c0a0c4d39
-  data.tar.gz: 3d9eb5c378eceae90768bd047fd111402b99ad91f0877d39a4753f0f8a1f62c9ec2337770ff8e99f1446e8adda73912a3c57362a40ed9fcf4a59e5d80f6c51b6
+  metadata.gz: a96c52f07b325fdb16fa7f968c622f6a29a409a1a076dc0f3b6416ca77c0f18cb37deb7317096935a34bb7005e5edaa7faf4e840140ae0c2d60aa67b21e2056c
+  data.tar.gz: ffd90ea32e5d162d6d560c3ecc697c60cb0653c522c98fc40151f4f51dbd38d4816cb09a36f5ee4594a98229251a87808552945d9b593a0381bb39c9a906c9bd

data/README.md

@@ -4,7 +4,7 @@
 
 ![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.
+Sass Prof is a code profiler for [Sass](https://github.com/sass/sass). For each `@function`, `@mixin`, `@include` and `$variable`, Sass Prof will show its execution time, which file called it and what arguments were given when it was called. Currently, `@extend` is not supported but it is a planned feature.
 
 ## Requirements
 
@@ -21,7 +21,7 @@ Sass Prof is a code profiler for [Sass](https://github.com/sass/sass). For each
 1. Remove the line `require "sass-prof"` from your `config.rb`
 
 ## Usage
-You may specify a few options within your `config.rb`, such as directing output to a log file.
+You may specify a few options within your `config.rb`, such as ignoring certain actions or directing output to a log file.
 
 ```ruby
 require "sass-prof"
@@ -55,9 +55,22 @@ prof.color = true
 # Execution time floating point precision
 # Default is `15`
 prof.precision = 5
+
+# Ignore certain action types during profile
+# Default is `[]`
+prof.ignore = [
+  :fundef,
+  :fun,
+  :mixdef,
+  :mix.
+  :var,
+]
+
+# Alias for `ignore`
+prof.ignore_actions = []
 ```
 
-_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)._
+_Please note: your compile times **will be slower** due to the overhead of Sass Prof, but I've tried to be as accurate as possible in the measurements. This library was created to help you find potential bottlenecks within your code, so I hope it succeeds in that regard. 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)._
 
 ## Contributing
 

data/lib/sass-prof.rb

@@ -3,17 +3,30 @@
 require "terminal-table"
 
 require "sass-prof/config"
+require "sass-prof/timer"
 require "sass-prof/reporter"
 require "sass-prof/formatter"
 require "sass-prof/profiler"
+require "sass-prof/fundef_profiler"
+require "sass-prof/fun_profiler"
+require "sass-prof/mixdef_profiler"
+require "sass-prof/mix_profiler"
+require "sass-prof/ext_profiler"
+require "sass-prof/var_profiler"
 
 # Monkey patch Sass to utilize Profiler
 module Sass
   class Tree::Visitors::Perform
+
+    #
+    # Function definition
+    #
     alias_method :__visit_function, :visit_function
 
     def visit_function(node)
-      prof = ::SassProf::Profiler.new(node.dup, :function, node.args.dup,
+      return __visit_function node if ::SassProf::Config.ignore.include? :fundef
+
+      prof = ::SassProf::FundefProfiler.new(node.dup, :fundef, node.args.dup,
         @environment)
       prof.start
 
@@ -24,10 +37,15 @@ module Sass
       value
     end
 
+    #
+    # Mixin definition
+    #
     alias_method :__visit_mixindef, :visit_mixindef
 
     def visit_mixindef(node)
-      prof = ::SassProf::Profiler.new(node.dup, :mixin, node.args.dup,
+      return __visit_mixindef node if ::SassProf::Config.ignore.include? :mixdef
+
+      prof = ::SassProf::MixdefProfiler.new(node.dup, :mixdef, node.args.dup,
         @environment)
       prof.start
 
@@ -38,10 +56,15 @@ module Sass
       value
     end
 
+    #
+    # Mixin perform
+    #
     alias_method :__visit_mixin, :visit_mixin
 
     def visit_mixin(node)
-      prof = ::SassProf::Profiler.new(node.dup, :include, node.args.dup,
+      return __visit_mixin node if ::SassProf::Config.ignore.include? :mix
+
+      prof = ::SassProf::MixProfiler.new(node.dup, :mix, node.args.dup,
         @environment)
       prof.start
 
@@ -53,16 +76,108 @@ module Sass
     end
   end
 
+  # class Selector::SimpleSequence
+  #
+  #   #
+  #   # Extend perform
+  #   #
+  #   alias_method :__do_extend, :do_extend
+  #
+  #   def do_extend(extends, parent_directives, replace, seen)
+  #     return __do_extend extends, parent_directives, replace,
+  #       seen if ::SassProf::Config.ignore.include? :ext
+  #
+  #     prof = ::SassProf::ExtProfiler.new(self, :ext, nil,
+  #       self)
+  #     prof.start
+  #
+  #     value = __do_extend extends, parent_directives, replace, seen
+  #
+  #     prof.stop
+  #
+  #     value
+  #   end
+  # end
+
   class Script::Tree::Funcall
+
+    #
+    # Function perform
+    #
     alias_method :__perform_sass_fn, :perform_sass_fn
 
     def perform_sass_fn(function, args, splat, environment)
-      prof = ::SassProf::Profiler.new(function.dup, :invoke, args.dup,
+      return __perform_sass_fn function, args, splat,
+        environment if ::SassProf::Config.ignore.include? :fun
+
+      prof = ::SassProf::FunProfiler.new(function.dup, :fun, args.dup,
         environment.dup)
       prof.start
 
-      value = __perform_sass_fn(
-        function, args, splat, environment)
+      value = __perform_sass_fn function, args, splat, environment
+
+      prof.stop
+
+      value
+    end
+  end
+
+  class Environment
+
+    #
+    # Variable declare
+    #
+    alias_method :__set_var, :set_var
+
+    def set_var(name, value)
+      return __set_var name,
+        value if ::SassProf::Config.ignore.include? :var
+
+      prof = ::SassProf::VarProfiler.new(name.dup, :var, value.dup,
+        self)
+      prof.start
+
+      value = __set_var name, value
+
+      prof.stop
+
+      value
+    end
+
+    #
+    # Global variable declare
+    #
+    alias_method :__set_global_var, :set_global_var
+
+    def set_global_var(name, value)
+      return __set_global_var name,
+        value if ::SassProf::Config.ignore.include? :var
+
+      prof = ::SassProf::VarProfiler.new(name.dup, :var, value.dup,
+        self)
+      prof.start
+
+      value = __set_global_var name, value
+
+      prof.stop
+
+      value
+    end
+
+    #
+    # Local variable declare
+    #
+    alias_method :__set_local_var, :set_local_var
+
+    def set_local_var(name, value)
+      return __set_local_var name,
+        value if ::SassProf::Config.ignore.include? :var
+
+      prof = ::SassProf::VarProfiler.new(name.dup, :var, value.dup,
+        self)
+      prof.start
+
+      value = __set_local_var name, value
 
       prof.stop
 

data/lib/sass-prof/config.rb

@@ -6,9 +6,13 @@ module SassProf
     attr_accessor :quiet
     attr_accessor :color
     attr_accessor :precision
+    attr_accessor :subtotal
+    attr_accessor :ignore
 
     alias_method :max_execution_time=, :t_max=
     alias_method :max_execution_time,  :t_max
+    alias_method :ignore_actions=,     :ignore=
+    alias_method :ignore_actions,      :ignore
 
     @t_max       = 100
     @max_width   = false
@@ -16,6 +20,8 @@ module SassProf
     @quiet       = false
     @color       = true
     @precision   = 15
+    @subtotal    = true
+    @ignore      = []
 
     extend self
   end

data/lib/sass-prof/ext_profiler.rb

@@ -0,0 +1,21 @@
+module SassProf
+  class ExtProfiler < Profiler
+
+    def initialize(subject, action, args = nil, env = nil)
+      super subject, action, args, env
+    end
+
+    def name
+      @env.members.join(", ").tr "\n", ""
+    end
+
+    def args
+      @subject.members.join ", "
+    end
+
+    def signature
+      "#{Formatter.colorize(name, :blue)} < "\
+      "#{Formatter.colorize(args, :purple)}"
+    end
+  end
+end

data/lib/sass-prof/formatter.rb

@@ -1,7 +1,8 @@
 module SassProf
   module Formatter
 
-    COLORS = Hash.new("37").merge({
+    REGEX_ASCII = /\e\[(\d+)(;\d+)*m/
+    COLORS      = Hash.new("37").merge({
       :black  => "30",
       :red    => "31",
       :green  => "32",
@@ -19,26 +20,59 @@ module SassProf
     end
 
     def to_table(rows)
-      pr   = Config.precision / 3 - 5 # 5 is to account for whitespace
-      t_ms = rows.map { |c|
-        c[1].gsub(/\e\[(\d+)(;\d+)*m/, "").to_f }.reduce :+
+      t_ms = Timer.t_total
 
       return if t_ms.nil?
 
       t_ss, t_ms = t_ms.divmod 1000
       t_mm, t_ss = t_ss.divmod 60
 
-      # Add total execution time footer
+      # Add summary for each action type
+      Timer::SUMMARIES.reject { |s| s == :t_total }.each do |summary|
+        break unless Config.subtotal
+
+        case summary
+        when /^(t_)/
+          sum_t_ms = Timer.send summary
+
+          next if sum_t_ms.nil?
+
+          sum_t_ss, sum_t_ms = sum_t_ms.divmod 1000
+          sum_t_mm, sum_t_ss = sum_t_ss.divmod 60
+
+          rows << :separator
+          rows << [
+            "subtotal",
+            "%.0fm %.0fs %.0fms" % [sum_t_mm, sum_t_ss, sum_t_ms],
+            "#{summary}".gsub(/(^(t_)|(_total)$)/, ""),
+            ""
+          ]
+        when /^(cnt_)/
+          count = Timer.send summary
+
+          next if count.nil?
+
+          rows << :separator
+          rows << [
+            "count",
+            "#{count}",
+            "#{summary}".gsub(/(^(cnt_)|(_total)$)/, ""),
+            ""
+          ]
+        end
+      end
+
+      # Add footer containing total execution time
       rows << :separator
       rows << [
-        "Total",
-        "%.#{pr}fm %.#{pr}fs %.#{pr}fms" % [t_mm, t_ss, t_ms],
-        "",
+        "total",
+        "%.0fm %.0fs %.0fms" % [t_mm, t_ss, t_ms],
+        "all",
         ""
       ]
 
       table = Terminal::Table.new({
-        :headings => ["File", "Execution Time", "Action", "Signature"],
+        :headings => ["file", "execution time", "action", "signature"],
         :rows     => rows
       })
 
@@ -50,7 +84,7 @@ module SassProf
       tr_row = []
 
       row.map do |col|
-        clean_width = col.gsub(/\e\[(\d+)(;\d+)*m/, "").length
+        clean_width = col.gsub(REGEX_ASCII, "").length
         diff        = col.length - clean_width
 
         if clean_width > max_width

data/lib/sass-prof/fun_profiler.rb

@@ -0,0 +1,8 @@
+module SassProf
+  class FunProfiler < Profiler
+
+    def initialize(subject, action, args = nil, env = nil)
+      super subject, action, args, env
+    end
+  end
+end

data/lib/sass-prof/fundef_profiler.rb

@@ -0,0 +1,8 @@
+module SassProf
+  class FundefProfiler < Profiler
+
+    def initialize(subject, action, args = nil, env = nil)
+      super subject, action, args, env
+    end
+  end
+end

data/lib/sass-prof/mix_profiler.rb

@@ -0,0 +1,8 @@
+module SassProf
+  class MixProfiler < Profiler
+
+    def initialize(subject, action, args = nil, env = nil)
+      super subject, action, args, env
+    end
+  end
+end

data/lib/sass-prof/mixdef_profiler.rb

@@ -0,0 +1,8 @@
+module SassProf
+  class MixdefProfiler < Profiler
+
+    def initialize(subject, action, args = nil, env = nil)
+      super subject, action, args, env
+    end
+  end
+end

data/lib/sass-prof/profiler.rb

@@ -1,18 +1,16 @@
 module SassProf
   class Profiler
-    attr_accessor :function
-    attr_accessor :action
-    attr_accessor :args
-    attr_accessor :env
-
-    def initialize(function, action, args = nil, env = nil)
-      @function = function
-      @action   = action
-      @args     = args
-      @env      = env
-      @t_total  = 0
-      @t_then   = 0
-      @t_now    = 0
+
+    PERFORMABLE_ACTIONS = [:fun, :mix, :ext]
+
+    def initialize(subject, action, args = nil, env = nil)
+      @subject = subject
+      @action  = action
+      @args    = args
+      @env     = env
+      @t_total = 0
+      @t_then  = 0
+      @t_now   = 0
     end
 
     def start
@@ -24,70 +22,77 @@ module SassProf
       t_delta = (@t_now.to_f - @t_then.to_f) * 1000.0
       @t_then, @t_total = @t_now, t_delta
 
-      create_fn_report
+      # Add to total execution time
+      Timer.add_t_total t_delta
+
+      # Add to action's execution time and count
+      Timer.send "add_t_#{@action}_total",   t_delta
+      Timer.send "add_cnt_#{@action}_total", 1
+
+      create_report
     end
 
     private
 
-    def create_fn_report
-      fn_report = [fn_source, fn_execution_time, fn_action,
-        fn_signature]
+    def create_report
+      report = [source, execution_time, action, signature]
 
-      Reporter.add_row fn_report unless Config.quiet
+      Reporter.add_row report
 
       if @t_total > Config.t_max && is_performable_action?
         raise RuntimeError.new Formatter.colorize(
-          "Max execution time of #{Config.t_max}ms reached for function"\
-          " `#{fn_name}()` (took #{@t_total.round(3)}ms)", :red)
+          "Max execution time of #{Config.t_max}ms reached for #{@action}"\
+          " `#{name}()` (took #{@t_total.round(3)}ms)", :red)
       end
     end
 
-    def fn_execution_time
+    def execution_time
       color  = @t_total > Config.t_max ? :red : :green
       t_exec = "%.#{Config.precision}f" % @t_total
       Formatter.colorize t_exec, color
     end
 
-    def fn_name
+    def name
       case
-      when function.respond_to?(:name)
-        function.name
+      when @subject.respond_to?(:name)
+        @subject.name
       else
         "Unknown function"
       end
     end
 
-    def fn_args
-      return nil if args.nil?
+    def args
+      return nil if @args.nil?
 
-      if args.is_a? Array
-        args.map { |a| a.inspect }.join(", ")
+      if @args.is_a? Array
+        @args.map { |a| a.inspect }.join(", ")
       else
-        args.to_s[1...args.length-2]
+        @args.to_s[1...@args.to_s.length-2]
       end
     end
 
-    def fn_source
-      return Formatter.colorize("Unknown file", :red) unless env
+    def source
+      return Formatter.colorize("Unknown file", :red) unless @env &&
+        @env.respond_to?(:options)
 
-      orig_filename = env.options.fetch :original_filename, "Unknown file"
-      filename      = env.options.fetch :filename, "Unknown file"
+      orig_filename = @env.options.fetch :original_filename, "Unknown file"
+      filename      = @env.options.fetch :filename,          "Unknown file"
 
       Formatter.colorize "#{File.basename(orig_filename)}:"\
         "#{File.basename(filename)}", :yellow
     end
 
-    def fn_action
-      Formatter.colorize action, :yellow
+    def action
+      Formatter.colorize @action, :yellow
     end
 
-    def fn_signature
-      "#{Formatter.colorize(fn_name, :blue)}"\
-      "(#{Formatter.colorize(fn_args, :purple)})"
+    def signature
+      "#{Formatter.colorize(name, :blue)}"\
+      "(#{Formatter.colorize(args, :purple)})"
     end
 
     def is_performable_action?
-      [:invoke, :include, :extend].include? action
+      PERFORMABLE_ACTIONS.include? @action
     end
   end
 end

data/lib/sass-prof/reporter.rb

@@ -15,13 +15,13 @@ module SassProf
 
     def print_report
       log_report if Config.output_file
-      puts Formatter.to_table @rows
+      puts Formatter.to_table @rows unless Config.quiet
     end
 
     def log_report
       File.open(Config.output_file, "a+") do |f|
         f.puts Formatter.to_table @rows.map { |r|
-          r.map { |col| col.gsub /\e\[(\d+)(;\d+)*m/, "" } }
+          r.map { |col| col.gsub Formatter::REGEX_ASCII, "" } }
       end
     end
 

data/lib/sass-prof/timer.rb

@@ -0,0 +1,38 @@
+module SassProf
+  module Timer
+
+    SUMMARIES = [
+      :t_total,
+      # :m_total,
+      :t_var_total,
+      :cnt_var_total,
+      :cnt_var_global_total,
+      :cnt_var_local_total,
+      :t_fundef_total,
+      :cnt_fundef_total,
+      :t_fun_total,
+      :cnt_fun_total,
+      :t_mixdef_total,
+      :cnt_mixdef_total,
+      :t_mix_total,
+      :cnt_mix_total,
+      # :t_ext_total,
+      # :cnt_ext_total,
+    ]
+
+    class << self
+      SUMMARIES.each do |summary|
+        instance_variable_set "@#{summary}", 0
+
+        define_method "add_#{summary}" do |value|
+          prev = instance_variable_get("@#{summary}") || 0
+          instance_variable_set("@#{summary}", prev + value)
+        end
+
+        define_method "#{summary}" do
+          instance_variable_get("@#{summary}")
+        end
+      end
+    end
+  end
+end

data/lib/sass-prof/var_profiler.rb

@@ -0,0 +1,23 @@
+module SassProf
+  class VarProfiler < Profiler
+
+    def initialize(subject, action, args = nil, env = nil)
+      super subject, action, args, env
+    end
+
+    def name
+      @subject
+    end
+
+    def args
+      return nil if @args.nil?
+
+      @args.inspect
+    end
+
+    def signature
+      "#{Formatter.colorize("$#{name}", :blue)} = "\
+      "#{Formatter.colorize(args, :purple)}"
+    end
+  end
+end

data/lib/sass-prof/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module SassProf
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sass-prof
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - ezekg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compass
@@ -96,9 +96,16 @@ files:
 - Rakefile
 - lib/sass-prof.rb
 - lib/sass-prof/config.rb
+- lib/sass-prof/ext_profiler.rb
 - lib/sass-prof/formatter.rb
+- lib/sass-prof/fun_profiler.rb
+- lib/sass-prof/fundef_profiler.rb
+- lib/sass-prof/mix_profiler.rb
+- lib/sass-prof/mixdef_profiler.rb
 - lib/sass-prof/profiler.rb
 - lib/sass-prof/reporter.rb
+- lib/sass-prof/timer.rb
+- lib/sass-prof/var_profiler.rb
 - lib/sass-prof/version.rb
 - sass-prof.gemspec
 - screenshot.jpg