sass-prof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8c7227a6056e4190559289cce3732ac60bd1e77
+  data.tar.gz: 7fd772926246efbb3fabd0860e5ab27029bb3a87
+SHA512:
+  metadata.gz: 0b0e1399f9afb14770220663071b66639bc3dc1d1971d6fe5fbb43b817eec7bb19161d86a5895decef3d5abc75f08bd767e253bbd9e8f24744bf4a2eef53fad6
+  data.tar.gz: 2e69778738c3402045b91e0c652059f6f8277fc9d2a963eb777bf6f757776d50b0dcbabd65891c9d370a072bae815222d25c8aa396857a3f4a9c2cd0c864dd48

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ezekiel Gabrielse
+
+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,55 @@
+# Sass Prof
+
+[![Gem](https://img.shields.io/gem/v/sass-prof.svg?style=flat-square)](https://rubygems.org/gems/sass-prof)
+
+Sass Prof is a code profiler for 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
+
+* Sass ~> `3.4.0`
+
+## Installation
+
+1. Install with `gem install sass-prof`
+2. If you're using Compass, add `require "sass-prof"` to your `config.rb`
+3. Sass Prof will automatically run next time you compile
+4. That's it!
+
+## Uninstall
+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.
+
+```ruby
+require "sass-prof"
+
+# Instance of Sass::Prof's configuration
+prof = Sass::Prof::Config
+
+# Directs all output to a log file
+# Default is `false`
+prof.output_file = "sass-prof.log"
+
+# Mutes all output to stdout
+# Default is `false`
+prof.quiet = true
+
+# Maximum execution time allowed in ms
+# Default is `100`
+prof.t_max = 500
+
+# Enable colored output
+# Default is `true`
+prof.color = true
+```
+
+_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)._
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sass-prof/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sass/prof/version.rb

@@ -0,0 +1,5 @@
+module Sass
+  module Prof
+    VERSION = "0.1.0"
+  end
+end

data/lib/sass/prof.rb

@@ -0,0 +1,150 @@
+require "sass/prof/version"
+
+module Sass
+  module Prof
+
+    class Profiler
+      attr_accessor :config, :function, :action, :args, :env
+
+      @@t_then = Time.now
+      @@t_now  = Time.now
+
+      def initialize(function, action, args = nil, env = nil)
+        @config   = Sass::Prof::Config
+        @function = function
+        @action   = action
+        @args     = args
+        @env      = env
+      end
+
+      def print_report
+        report = to_table [fn_source, fn_execution_time, fn_action,
+          fn_signature]
+
+        puts report unless config.quiet
+
+        if config.output_file
+          File.open(config.output_file, "a+") { |f|
+            f.puts report.gsub /\e\[(\d+)(;\d+)*m/, "" }
+        end
+
+        if @@t_total > config.t_max && action == :execute
+          puts colorize "Max execution time of #{config.t_max}ms reached for"\
+            " function `#{fn_name}` (took #{@@t_total.round(3)}ms)", :red
+          exit
+        end
+      end
+
+      private
+
+      def fn_execution_time
+        @@t_now = Time.now
+
+        t_delta = (@@t_now.to_f - @@t_then.to_f) * 1000.0
+
+        @@t_then, @@t_total = @@t_now, t_delta
+
+        color = @@t_total > config.t_max ? :red : :green
+        colorize t_delta.to_s, color
+      end
+
+      def fn_name
+        case
+        when function.respond_to?(:name)
+          function.name
+        else
+          "unknown function"
+        end
+      end
+
+      def fn_args
+        return nil if args.nil?
+
+        args.to_s[1...args.length-2]
+      end
+
+      def fn_source
+        return colorize("unknown file", :red).ljust 80 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
+      end
+
+      def fn_action
+        colorize action.to_s, :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"
+      end
+
+      def to_table(columns, cs = 12)
+        "[ %s ]" % columns.map { |col| "%#{cs}s" % col }.join(" | ")
+      end
+    end
+
+    module Config
+      attr_accessor :t_max, :output_file, :quiet, :color
+
+      def t_max
+        @t_max ||= 100
+      end
+
+      def output_file
+        @output_file = false if @output_file.nil?
+        @output_file
+      end
+
+      def quiet
+        @quiet = false if @quiet.nil?
+        @quiet
+      end
+
+      def color
+        @color = true if @color.nil?
+        @color
+      end
+
+      extend self
+    end
+  end
+
+  class Tree::Visitors::Perform
+    alias_method :_visit_function, :visit_function
+
+    def visit_function(node)
+      Sass::Prof::Profiler.new(node.dup, :declare).print_report
+      _visit_function node
+    end
+  end
+
+  class Script::Tree::Funcall
+    alias_method :_perform_sass_fn, :perform_sass_fn
+
+    def perform_sass_fn(function, args, splat, environment)
+      Sass::Prof::Profiler.new(function.dup, :execute, args.dup,
+        environment.dup).print_report
+      _perform_sass_fn function, args, splat, environment
+    end
+  end
+end

data/sass-prof.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sass/prof/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sass-prof"
+  spec.version       = Sass::Prof::VERSION
+  spec.authors       = ["ezekg"]
+  spec.email         = ["ezekg@yahoo.com"]
+
+  spec.summary       = %q{Profiler for Sass libraries.}
+  spec.description   = %q{Sass Prof is a code profiler for 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.}
+  spec.homepage      = "https://github.com/ezekg/sass-prof"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "sass", "~> 3.4"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: sass-prof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ezekg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Sass Prof is a code profiler for 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.
+email:
+- ezekg@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sass/prof.rb
+- lib/sass/prof/version.rb
+- sass-prof.gemspec
+homepage: https://github.com/ezekg/sass-prof
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Profiler for Sass libraries.
+test_files: []