critique 0.1

data/.gemset

@@ -0,0 +1 @@
+RVM_GEMSET="ruby-1.9.3@critique"

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1,11 @@
+source .gemset
+export USE_BUNDLER=force
+
+rvm use --create --install $RVM_GEMSET
+
+if [[ -s "./bootstrap.gems" ]]; then
+  if ! rvm gemset import bootstrap.gems > /dev/null 2>&1; then
+    echo "ERROR: Unable to bootstrap the gems" >&2
+  fi
+fi
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Corey Innis
+
+MIT License
+
+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 @@
+# Critique
+
+**WIP**
+
+critiques your code... simple memory profiling with easy setup (e.g., no need to patch ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'critique'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install critique
+
+## Usage
+
+given your code:
+
+    class ExampleClass
+      include Critique
+
+      def method
+        critique do
+          # code
+        end
+      end
+    end
+
+enable Critique:
+
+    Critique.enable! # e.g., in a Rails initializer
+    Critique.logger = $stdout
+    # or...
+    # Critique.logger = 'path/to/log'
+    # Critique.logger = Rails.logger
+
+run & view logs:
+
+    X  ExampleClass#method --> ... used: 6.60 GB free: 1.59 GB
+    X  ExampleClass#method <-- ... used: 6.62 GB free: 1.57 GB delta: +0.32%
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '-Ispec'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rspec_opts = '-Ispec'
+  spec.rcov       = true
+end
+
+task :default => :spec

data/bootstrap.gems

@@ -0,0 +1,2 @@
+bundler -v 1.1.3
+

data/critique.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/critique/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Corey Innis"]
+  gem.email         = ["corey@coolerator.net"]
+  gem.description   = %q{critiques your code}
+  gem.summary       = %q{critiques your code}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "critique"
+  gem.require_paths = ["lib"]
+  gem.version       = Critique::VERSION
+
+  gem.required_ruby_version = ">= 1.9"
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rr"
+  gem.add_development_dependency "simplecov"
+end

data/lib/critique/profiling.rb

@@ -0,0 +1,114 @@
+module Critique
+  module Profiling
+    def self.profile(base, caller_offset = 0)
+      method_name = caller[caller_offset] =~ /`([^']*)'/ && $1
+      method_text = label_for(base, method_name)
+
+      Profiler.enter(method_text)
+      result = yield # (Profiler)
+      Profiler.leave(method_text)
+
+      result
+    end
+
+    class Profiler
+      class << self
+        def info(message)
+          Critique.logger.info(['X', padding, message].join)
+        end
+
+        def enter(label)
+          padding(:+)
+          before = stack.push(system_usage.push(label)).last
+
+          info(([label, '-->', filler(label)] + pretty(before)).join(' '))
+        end
+
+        def leave(label)
+          before = stack.pop
+          after  = system_usage
+
+          info(([label, '<--', filler(label)] + pretty(after, before)).join(' '))
+
+          padding(:-)
+        end
+
+        private
+
+          def pretty(pair, diff_with = nil)
+            used   = pair[0]
+            free   = pair[1]
+            result = [
+              sprintf("used: %.2f GB", used / conversion_gb),
+              sprintf("free: %.2f GB", free / conversion_gb)
+            ]
+
+            if diff_with
+              current  = used
+              previous = diff_with[0]
+              bytes    = (current - previous).to_f
+              percent  = (bytes / previous) * 100
+
+              result.push(sprintf("delta: %+.2f%", percent))
+            end
+
+            result
+          end
+
+          def padding(direction = nil)
+            @_padding ||= 0
+            @_padding = @_padding.send(direction, 2) if direction
+            @_padding = 0 if @_padding < 0
+            (' ' * @_padding)
+          end
+
+          def filler(text)
+            '.' * (73 - text.length - @_padding) # data starting at column 80
+          end
+
+          def system_usage
+            # installed = `sysctl -n hw.memsize`.to_i / conversion_gb
+
+            stats = `vm_stat`.split("\n")
+            used  = add_stats(stats, 'wired down', 'active', 'inactive')
+            free  = add_stats(stats, 'free', 'speculative')
+
+            [used, free]
+          end
+
+          def add_stats(*args)
+            stats   = args.shift
+            keys    = args
+            matches = stats.select { |s| keys.any? { |k| s =~ /Pages #{k}:/ } }
+            values  = matches.map  { |m| m.split(/\s+/).last.to_i * conversion_paging }.inject(0, :+)
+          end
+
+          def conversion_paging
+            4096
+          end
+
+          def conversion_gb
+            (1024 * 1024 * 1000.0)
+          end
+
+          def stack
+            @_stack ||= []
+          end
+      end
+    end
+
+    private
+
+      def self.label_for(base, method_name)
+        [label_class(base), label_sep(base), method_name].join
+      end
+
+      def self.label_class(base)
+        base.is_a?(Class) ? base.name : base.class.name
+      end
+
+      def self.label_sep(base)
+        base.is_a?(Class) ? '.' : '#'
+      end
+  end
+end

data/lib/critique/version.rb

@@ -0,0 +1,3 @@
+module Critique
+  VERSION = "0.1"
+end

data/lib/critique.rb

@@ -0,0 +1,51 @@
+require "critique/version"
+require "logger"
+
+module Critique
+  autoload :Profiling, 'critique/profiling'
+
+  class << self
+    def included(base)
+      base.extend(ClassMethods)
+    end
+
+    def profile(base)
+      yield
+    end
+
+    def disable!
+      module_eval("def self.profile(base) ; yield ; end")
+    end
+
+    def enable!
+      module_eval("def self.profile(base, &block) ; Profiling.profile(base, 2, &block) ; end")
+      @_enabled = true
+    end
+
+    def enabled?
+      @_enabled || false
+    end
+
+    def logger=(logger)
+      if logger.is_a?(IO) || logger.is_a?(String)
+        @_logger = Logger.new(logger)
+      else
+        @_logger = logger
+      end
+    end
+
+    def logger
+      @_logger ||= Logger.new($stdout)
+    end
+  end
+
+  module ClassMethods
+    def critique(&block)
+      Critique.profile(self, &block)
+    end
+  end
+
+  def critique(&block)
+    Critique.profile(self, &block)
+  end
+end

data/spec/critique_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Critique do
+  class ExampleClass
+    include Critique
+  end
+
+  before do
+    Critique.disable!
+    # Critique.logger = '/dev/null'
+  end
+
+  it "is defined" do
+    Critique.should be_a(Module)
+  end
+
+  context "when included" do
+    it "defines .critique on the base class" do
+      ExampleClass.should respond_to(:critique)
+    end
+
+    it "defines #critique on the base class" do
+      ExampleClass.new.should respond_to(:critique)
+    end
+  end
+
+  describe ".enabled?" do
+    context "in the default state" do
+      it "returns false" do
+        Critique.should_not be_enabled
+      end
+    end
+
+    context "when enabled" do
+      before do
+        Critique.enable!
+      end
+
+      it "returns true" do
+        Critique.should be_enabled
+      end
+    end
+  end
+
+  describe ".critique" do
+    let(:code) { 1 + 2 }
+
+    context "when disabled" do
+      it "does not execute profiling" do
+        dont_allow(Critique::Profiling).profile
+        ExampleClass.critique { code }
+      end
+
+      it "executes the code block" do
+        result = ExampleClass.critique { code }
+        result.should == 3
+      end
+    end
+
+    context "when enabled" do
+      before do
+        Critique.enable!
+      end
+
+      it "executes profiling" do
+        mock(Critique::Profiling).profile(ExampleClass, 2)
+        ExampleClass.critique { code }
+      end
+
+      it "executes the code block" do
+        ExampleClass.critique { code }.should == 3
+      end
+    end
+
+    context "in the default (disabled) state" do
+      it "does not run profiling" do
+        dont_allow(Critique::Profiling).profile
+        ExampleClass.critique { code }
+      end
+    end
+  end
+end

data/spec/process.rb

@@ -0,0 +1,83 @@
+require 'profiling'
+
+unless ARGV.size == 2
+  puts "usage: ruby process.rb <filename.ext> <config>"
+  puts "  e.g.,"
+  puts "    ruby process.rb video.mov all"
+  puts "    ruby process.rb video.mov 8k"
+  puts "    ruby process.rb video.mov 10m"
+end
+
+filename = ARGV[0]
+config   = ARGV[1]
+
+unless filename && File.exists?(filename)
+  puts "\n\nfile does not exist."
+  exit 1
+end
+
+class Processor
+  extend  Profiling
+  include Profiling
+
+  attr_reader :path, :size
+
+  def initialize(path)
+    @path = path
+    @size = File.size(path)
+  end
+
+  def read_all
+    heading(:all)
+
+    profile do |p|
+      File.read(path) # NOTE: doing nothing with it
+    end
+  end
+
+  def read_bytes(num)
+    bytes = num.to_i
+    bytes = (bytes * 1024)        if num =~ /.*k$/i
+    bytes = (bytes * 1024 * 1024) if num =~ /.*m$/i
+
+    heading(:part, bytes)
+
+    profile do |p|
+      offset = 0
+      length = bytes
+
+      while offset < size
+        remain = size - offset
+        amount = (remain < length) ? remain : length
+
+        $stdout.print '.' # TODO: move to Profiling
+        $stdout.flush
+
+        File.read(path, amount, offset) # NOTE: doing nothing with it
+        offset += amount
+      end
+
+      $stdout.puts
+    end
+  end
+
+  def heading(mode, length = nil)
+    puts ['   ', ('-' * 76)].join
+    puts "   process.rb... reading #{size} bytes (#{[mode, length].compact.join(' ')})"
+    puts ['   ', ('-' * 76)].join
+  end
+
+  # def self.cls_method
+  #   profile do |p|
+  #     # p.info("method body")
+  #     "return value"
+  #   end
+  # end
+end
+
+if config == 'all'
+  Processor.new(filename).read_all
+else
+  Processor.new(filename).read_bytes(config)
+end
+# Processor.cls_method

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'critique'
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each do
+  |f| require f
+end
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: critique
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Corey Innis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70336553333680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336553333680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70336553333200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336553333200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70336553332760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336553332760
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70336553332340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336553332340
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70336553317820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336553317820
+description: critiques your code
+email:
+- corey@coolerator.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemset
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bootstrap.gems
+- critique.gemspec
+- lib/critique.rb
+- lib/critique/profiling.rb
+- lib/critique/version.rb
+- spec/critique_spec.rb
+- spec/process.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4008275762118213474
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: critiques your code
+test_files:
+- spec/critique_spec.rb
+- spec/process.rb
+- spec/spec_helper.rb