selective_inspect 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: faf6d9978167dd55099c7dd09fa404b2793084e2
+  data.tar.gz: 724072a56db579c3fae03d8021e37240c6451e9a
+SHA512:
+  metadata.gz: a64b0ddb253889fdfb59420b2060e07561dc6a3d08893c5086babe297efa241fa1b37689df31e580e66e922cb8f84ea352f7defd8e39b2b958fac0fa0b1a5c2a
+  data.tar.gz: 2ef844a20f8113f58b72746750b80ff30533755146965106b8e285e1e22aae0b6d5882c07bfed0544996f9e130475cd8b42e638482e31a27440cf9b1e802f992

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Miguel Camba
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Miguel Camba
+
+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,78 @@
+# Selective Inspect
+
+Simple gem to customize the output of the `#inspect` method.
+
+Ruby's default `#inspect` implementation prints EVERY instance variable in your object objects, which can be really painful sometimes.
+
+This gem allows to define a whitelist of the instance variables you want to output or a blacklist of those you don't.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'selective_inspect'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install selective_inspect
+
+## Usage
+
+```rb
+class Game
+  # ...
+end
+
+game = Game.new(difficulty: 'hard', mode: 'deathmatch')
+
+game.inspect
+# => #<Game:0x70238562842620 @difficulty="hard", @mode="deathmatch"> # Defaults inspect
+
+SelectiveInspect.perform_inspect(game, :mode)
+# => #<Game:0x70238562842620 @mode="deathmatch"> # Custom inspection
+
+# You can also include the module in those classes you want to be inspected
+# in a certain way by default, and add a whitelist or blacklist of variables.
+#
+
+class Player
+  include SelectiveInspect
+  inspectable_vars :id, :nickname, :score, :health, :ip_address
+  # ...
+end
+
+class Weapon
+  include SelectiveInspect
+  uninspectable_vars :range, :damage
+  # ...
+end
+weapon = Weapon.new(type: 'Bazooka', ammo: 3, range: 600, damage: 'max')
+player = Player.new(id: 1, name: 'John', health: 100, weapon: weapon)
+
+player.inspect
+# =>
+
+# Even if you have included the module, you still can pass a whitelist
+# of variables to inspect.
+#
+
+player.inspect(:nickname, :ip_address)
+# =>
+```
+
+## TODOs (by priority)
+1. Allow to pass a list of instance methods to inspect along with the instance variables
+2. Avoid infinite recursion checking for cycles.
+3. Rails environment integration: Only enable it for development and test.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/ruby_selective_inspect.rb

@@ -0,0 +1,81 @@
+require "ruby_selective_inspect/version"
+
+module RubySelectiveInspect
+  module ClassMethods
+    def inspectionable_vars(*vars)
+      @_selective_inspector_whitelist = vars
+    end
+
+    def uninspectionable_vars(*vars)
+      @_selective_inspector_blacklist = vars
+    end
+
+    def get_inspectionable_vars
+      @_selective_inspector_whitelist ||= []
+    end
+
+    def get_uninspectionable_vars
+      @_selective_inspector_blacklist ||= []
+    end
+  end
+
+  module InstanceMethods
+    # Public: Inspects this object in a customizable way.
+    #
+    # whitelist - (optional) The names of the instance variables to be inspected
+    #
+    # Examples
+    #
+    #   player = Player.new(id: 1, name: 'John', health: 100, ip_address: '192.168.1.133')
+    #
+    #   player.inspect # =>
+    #
+    #   player.inspect(:name) # =>
+    #
+    #
+    # Returns the String that describes this object and its internals.
+    def inspect(*whitelist)
+      RubySelectiveInspect.perform_inspect(self, *whitelist)
+    end
+  end
+
+  # Public: Inspects the given object in a customizable way.
+  #
+  # target - The Object to be inspected.
+  # whitelist - The names of the instance variables to output.
+  #
+  # Examples
+  #
+  #   RubySelectiveInspect.inspect(player, :id, :name)
+  #   # =>
+  #
+  # Returns the String that describes the objects and its internals.
+  def self.perform_inspect(target, *whitelist)
+    klass = target.class
+    return target.inspect if !klass.include?(self) && whitelist.size == 0
+
+    whitelist = klass.get_inspectionable_vars if whitelist.size == 0
+    if whitelist.size == 0
+      whitelist = target.instance_variables.map{ |s| s[1..-1] } - klass.get_uninspectionable_vars
+    end
+
+    fields = whitelist.map do |var_name|
+      name = '@' + var_name.to_s
+      var_content = target.instance_variable_get(name)
+      "#{name}=#{var_content.inspect}"
+    end
+
+    string = "#<#{klass.name}:#{target.object_id} "
+    string + fields.join(", ") + ">"
+  end
+
+  # Add to classes that include this module some convenient class mathods to blacklist
+  # or whitelist methods by default.
+  def self.included(base_class)
+    base_class.class_eval do
+      alias_method :default_inspect, :inspect
+    end
+    base_class.extend ClassMethods
+    base_class.include InstanceMethods
+  end
+end

data/lib/selective_inspect.rb

@@ -0,0 +1,81 @@
+require "selective_inspect/version"
+
+module SelectiveInspect
+  module ClassMethods
+    def inspectionable_vars(*vars)
+      @_selective_inspector_whitelist = vars
+    end
+
+    def uninspectionable_vars(*vars)
+      @_selective_inspector_blacklist = vars
+    end
+
+    def get_inspectionable_vars
+      @_selective_inspector_whitelist ||= []
+    end
+
+    def get_uninspectionable_vars
+      @_selective_inspector_blacklist ||= []
+    end
+  end
+
+  module InstanceMethods
+    # Public: Inspects this object in a customizable way.
+    #
+    # whitelist - (optional) The names of the instance variables to be inspected
+    #
+    # Examples
+    #
+    #   Player.new(id: 1, name: 'John', health: 100, ip_address: '192.168.1.133')
+    #   # =>
+    #
+    # Returns the String that describes this object and its internals.
+    def inspect(*whitelist)
+      SelectiveInspect.perform_inspect(self, *whitelist)
+    end
+  end
+
+  # Public: Inspects the given object in a customizable way.
+  #
+  # target - The Object to be inspected.
+  # whitelist - The names of the instance variables to output.
+  #
+  # Examples
+  #
+  #   SelectiveInspect.inspect(player, :id, :name)
+  #   # =>
+  #
+  # Returns the String that describes the objects and its internals.
+  def self.perform_inspect(target, *whitelist)
+    klass = target.class
+    return target.default_inspect if !klass.include?(self) && whitelist.size == 0
+
+
+    whitelist = klass.get_inspectionable_vars.map { |name| '@' + name.to_s }
+    if whitelist.size == 0
+      whitelist = target.instance_variables - klass.get_uninspectionable_vars.map { |name| '@' + name.to_s }
+    end
+
+    fields = whitelist.map do |var_name|
+      var_content = target.instance_variable_get(var_name)
+      "#{var_name}=#{var_content.inspect}"
+    end
+
+    string = "#<#{klass.name}:0x#{target.object_id} "
+    string + fields.join(", ") + ">"
+  end
+
+  # Store a reference to the default implementation
+  alias :default_inspect :inspect
+
+
+  # Add to classes that include this module some convenient class mathods to blacklist
+  # or whitelist methods by default.
+  def self.included(base_class)
+    base_class.class_eval do
+      alias_method :default_inspect, :inspect
+    end
+    base_class.extend ClassMethods
+    base_class.include InstanceMethods
+  end
+end

data/lib/selective_inspect/version.rb

@@ -0,0 +1,3 @@
+module SelectiveInspect
+  VERSION = "0.0.2"
+end

data/selective_inspect.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'selective_inspect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "selective_inspect"
+  spec.version       = SelectiveInspect::VERSION
+  spec.authors       = ["Miguel Camba"]
+  spec.email         = ["miguel.camba@gmail.com"]
+  spec.description   = %q{Simple gem to allow to customize the output of the inspect methods}
+  spec.summary       = %q{Customize the inspect's output of your objects white/black listing instance variables}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: selective_inspect
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Miguel Camba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple gem to allow to customize the output of the inspect methods
+email:
+- miguel.camba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_selective_inspect.rb
+- lib/selective_inspect.rb
+- lib/selective_inspect/version.rb
+- selective_inspect.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Customize the inspect's output of your objects white/black listing instance
+  variables
+test_files: []