inspectable 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009, 2010 Jordi Bunster <jordi@bunster.org>
+
+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.rdoc

@@ -0,0 +1,22 @@
+= inspectable
+
+Inspectable helps you to customize the output of your Ruby classes's 'inspect'
+method.
+
+More documentation forthcoming.
+
+== Installation instructions
+
+  gem install inspectable
+
+== Example usage
+
+  require 'inspectable'
+
+  class FancyObject
+    include Inspectable
+  end
+
+== Legal
+
+Copyright (c) 2010 Jordi Bunster, released under the MIT license

data/WHATSNEW

@@ -0,0 +1,2 @@
+* 0.0.1 (2010-11-30):
+  - First release. No features, really :P

data/inspectable.gemspec

@@ -0,0 +1,28 @@
+require 'lib/inspectable/version'
+
+Gem::Specification.new do |gem|
+  gem.name    = 'inspectable'
+  gem.version = Inspectable::VERSION
+
+  gem.author, gem.email = 'Jordi Bunster', 'jordi@bunster.org'
+
+  gem.summary     = 'Ruby mixing to aid in customizing the #inspect method'
+  gem.description = %{ Objects that include the Inspectable module can easily
+    customize the fields that appear in their #inspect output, to avoid being
+    too verbose.
+  }.strip!.gsub! /\s+/, ' '
+
+  gem.has_rdoc = false
+
+  gem.date  = Date.today
+  gem.files = %w[
+    MIT-LICENSE
+    README.rdoc
+    WHATSNEW
+    inspectable.gemspec
+    lib
+    lib/inspectable.rb
+    lib/inspectable
+    lib/inspectable/version.rb
+  ]
+end

data/lib/inspectable.rb

@@ -0,0 +1,34 @@
+require 'inspectable/version' # to open the module
+
+module Inspectable
+  module ClassMethods
+    def attr_inspector(*names)
+      @_attr_inspector ||= []
+      @_attr_inspector  |= names.map { |n| n.to_s } if names.any?
+      @_attr_inspector
+    ensure
+      define_method(:inspected_attrs) { self.class.attr_inspector }
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def inspect
+    return super unless respond_to?(:inspected_attrs)
+
+    inspected = inspected_attrs.map do |attr_name|
+      next if attr_name.nil? || attr_name == ''
+      next unless respond_to?(attr_name.to_sym)
+
+      '%s=%s' % [ attr_name.to_s, send(attr_name.to_sym).inspect ]
+    end.compact.join(', ')
+
+    if inspected.any?
+      '#<%s:0x%s %s>' % [ self.class.to_s, object_id.to_s(16), inspected ]
+    else
+      super
+    end
+  end
+end

data/lib/inspectable/version.rb

@@ -0,0 +1,3 @@
+module Inspectable
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: inspectable
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jordi Bunster
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-30 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: "Objects that include the Inspectable module can easily customize the fields that appear in their #inspect output, to avoid being too verbose."
+email: jordi@bunster.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.rdoc
+- WHATSNEW
+- inspectable.gemspec
+- lib/inspectable.rb
+- lib/inspectable/version.rb
+has_rdoc: false
+homepage: 
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "Ruby mixing to aid in customizing the #inspect method"
+test_files: []
+