short_inspect 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in short_inspect.gemspec
+gemspec
+
+gem 'guard'

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+end
+

data/README.md

@@ -0,0 +1,26 @@
+# short_inspect
+
+Prevent `#inspect` to include unlimited nested instance variables.
+
+## Usage:
+
+```ruby
+require 'short_inspect'
+ShortInspect.apply_to(ActionDispatch::Routing::RouteSet, ActionController::Base)
+```
+
+For auto inclusion in common rails classes:
+
+```ruby
+require 'short_inspect/rails'
+```
+
+For auto inclusion in all ruby classes:
+
+```ruby
+require 'short_inspect/all'
+```
+
+You probably shouldn't apply it to all classes.
+
+It's ~450% slower than the built-in `#inspect` method.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/benchmark/benchmark.rb

@@ -0,0 +1,24 @@
+require 'benchmark'
+include Benchmark
+
+$: << './lib'
+
+class TwoVariables
+  def initialize color, size
+    @color = color
+    @size = size
+  end
+end
+obj = TwoVariables.new(:red, 60)
+
+n = 100000
+Benchmark.bm(10) do |x|
+
+  x.report("original")   { n.times do; obj.inspect; end }
+
+  require 'short_inspect/all'
+
+  x.report("new")        { n.times do; obj.inspect; end }
+
+end
+

data/lib/short_inspect/all.rb

@@ -0,0 +1,3 @@
+require 'short_inspect'
+ShortInspect.apply_to(Object)
+

data/lib/short_inspect/rails.rb

@@ -0,0 +1,5 @@
+require 'short_inspect'
+ShortInspect.apply_minimal_to(
+  ActionDispatch::Routing::RouteSet,
+  ActionDispatch::Request
+)

data/lib/short_inspect/version.rb

@@ -0,0 +1,3 @@
+module ShortInspect
+  VERSION = "0.0.1"
+end

data/lib/short_inspect.rb

@@ -0,0 +1,78 @@
+require "short_inspect/version"
+
+module ShortInspect
+  class << self
+    attr_accessor :max_nested_inspected_value_length
+  end
+  self.max_nested_inspected_value_length = 50
+
+  def self.included(base)
+    base.class_eval do
+      alias inspect_without_shortening inspect
+
+      def inspect
+        s = to_s
+        if s[0..1] == '#<' && s[-1..-1] == '>'
+          "#{s[0..-2]}#{instance_variables_for_inspection}#{s[-1..-1]}"
+        else
+          s
+        end
+      end
+
+      def instance_variables_for_inspection
+        s = instance_variables.map do |name|
+          "#{name}=#{ShortInspect.limit_inspected_value(instance_variable_get(name).inspect)}"
+        end.join(", ")
+        s = " #{s}" if s.length != 0
+        s
+      end
+    end
+  end
+
+  def self.limit_inspected_value(long)
+    if long.length > max_nested_inspected_value_length
+      c3 = 5 # chars to keep at end
+      c2 = 3 # "..."
+      c1 = max_nested_inspected_value_length - c2 - c3
+      "#{long[0..c1-1]}...#{long[-c3..-1]}"
+    else
+      long
+    end
+  end
+
+  def self.apply_to *klasses
+    Array(klasses).each do |klass|
+      klass.send(:include, ShortInspect)
+    end
+  end
+
+  def self.apply_minimal_to *klasses
+    Array(klasses).each do |klass|
+      klass.send(:include, ShortInspect::Minimal)
+    end
+  end
+
+  def self.remove_from *klasses
+    Array(klasses).each do |klass|
+      klass.class_eval do
+        alias inspect inspect_without_shortening
+        remove_method :inspect_without_shortening
+      end
+    end
+  end
+
+  module Minimal
+    def self.included(base)
+      base.class_eval do
+        alias inspect_without_shortening inspect
+
+        def inspect
+          "#<%s:0x%x>" % [ self.class.name, object_id << 1 ]
+        end
+      end
+    end
+  end
+
+end
+
+

data/short_inspect.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "short_inspect/version"
+
+Gem::Specification.new do |s|
+  s.name        = "short_inspect"
+  s.version     = ShortInspect::VERSION
+  s.authors     = ["Levente Bagi"]
+  s.email       = ["levente@picklive.com"]
+  s.homepage    = "https://github.com/Picklive/short_inspect"
+  s.summary     = %q{Make the inspect method result more concise}
+  s.description = %q{Limit the length of the result of the inspect method}
+
+  s.rubyforge_project = "short_inspect"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+end

data/spec/short_inspect_spec.rb

@@ -0,0 +1,70 @@
+require 'short_inspect'
+
+describe ShortInspect do
+  describe "inspect" do
+
+    it "doesn't apply automatically" do
+      object = TwoVariables.new(:red, TwoVariables.new(:blue, "extra " * 200))
+      object.inspect.length.should > 100
+    end
+
+    context "when applied" do
+      before(:each){ ShortInspect.apply_to(Object) }
+      after(:each){ ShortInspect.remove_from(Object) }
+
+      it "it limits the size of long instance variables" do
+        object = TwoVariables.new(:red, TwoVariables.new(:blue, "extra " * 200))
+        object.inspect.length.should < 100
+        object = TwoVariables.new(:red, "extra " * 20)
+        object.inspect.length.should < 100
+      end
+
+      it "is the same as the original when it's short" do
+        object = NoVariables.new
+        object.inspect.should == object.inspect_without_shortening
+
+        object = TwoVariables.new(:red, :medium)
+        object.inspect.should == object.inspect_without_shortening
+      end
+    end
+
+  end
+
+  describe ShortInspect::Minimal do
+    describe "inspect" do
+
+      context "when applied" do
+        before(:each){ ShortInspect.apply_minimal_to(Object) }
+        after(:each){ ShortInspect.remove_from(Object) }
+
+        it "is the same as the original when it's short" do
+          object = NoVariables.new
+          object.inspect.should == object.inspect_without_shortening
+        end
+
+        it "includes class name" do
+          object = TwoVariables.new(:red, 'large')
+          object.inspect.should include 'TwoVariables'
+        end
+
+        it "does not include instance variables at all" do
+          object = TwoVariables.new(:red, 'large')
+          object.inspect.should_not include 'red'
+          object.inspect.should_not include 'large'
+        end
+      end
+    end
+  end
+end
+
+
+class NoVariables
+end
+
+class TwoVariables
+  def initialize color, size
+    @color = color
+    @size = size
+  end
+end
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: short_inspect
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Levente Bagi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-23 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Limit the length of the result of the inspect method
+email: 
+- levente@picklive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- benchmark/benchmark.rb
+- lib/short_inspect.rb
+- lib/short_inspect/all.rb
+- lib/short_inspect/rails.rb
+- lib/short_inspect/version.rb
+- short_inspect.gemspec
+- spec/short_inspect_spec.rb
+has_rdoc: true
+homepage: https://github.com/Picklive/short_inspect
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: short_inspect
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Make the inspect method result more concise
+test_files: 
+- spec/short_inspect_spec.rb