iron-extensions 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd65118c887a47d1c3eea243f563344f71102730
-  data.tar.gz: 569fea9ae3ff29abe4c206a5aee390acfae90de1
+  metadata.gz: 2e63fc465ef90d238d07d8d8beedf111d0d6917b
+  data.tar.gz: dbdaf486d2d8d468628bd15b79e3e1a317b9b9dc
 SHA512:
-  metadata.gz: 496bf1300b56b7cc86721a9040079941ad96830ce5be14f36de1e4140ec7f929cde6a169130ba3fbccc52d9de4080ccda55d5cc19a55c4389ff2d348f584eb1b
-  data.tar.gz: 8ae83a13b739d8a94a17ba4161e91579438890be3c9c9f29687fb539971e7c363215eb334d055c01ed4c5f916eb2b4cf93dacfb42a39b63be54004cf7d38b15f
+  metadata.gz: 9e1c8b753c49c5cdaef18ab2600a677a504feadd84e5c2094dc902a7cb00ca73b9f6415e9d898405200cc18c5d5eb2343f0af89edc66f7daad005d3040ee3854
+  data.tar.gz: a363a7c732eeb8494ebd812a508f8fc9dd32b223a1acdeca27124a4007e0cf41940b970ecb4b20517e749485a7a305cf2eb40ecc29f7516ec67fac4dccddffad

data/History.txt

@@ -1,13 +1,17 @@
+== 1.2.2 / 2017-08-22
+
+* Add Class#inspect_only to allow limiting the vars displayed, support methods as well as instance vars
+
 == 1.2.1 / 2015-01-27
 
 * Instant revert - move Enumerable#blank? to Array#blank? and Hash#blank? as enumerables don't support #empty?, #count, etc.
 
 == 1.2.0 / 2015-01-27
 
-* BREAKING CHANGE: removed DslProxy/DslBuilder and the dsl_* accessor helpers and moved them into the iron-dsl gem
-* BREAKING CHANGE: removed deprecated Array#rand and Array#rand! - use #shuffle instead
-* Improved blank? to work on strings containing only whitespace
-* Improved documentation & specs a bit
+* BREAKING CHANGE: Remove DslProxy/DslBuilder and the dsl_* accessor helpers and move them into the iron-dsl gem
+* BREAKING CHANGE: Remove deprecated Array#rand and Array#rand! - use #shuffle instead
+* Improve #blank? to work on strings containing only whitespace
+* Improve documentation & specs
 
 == 1.1.5 / 2014-03-31
 
@@ -33,26 +37,26 @@
 
 == 1.1.1 / 2012-03-13
 
-* Added DslBuilder base class for additional DSL-building goodness, is basically a better blank-slate starter class than BasicObject for working with our DslProxy class
-* Added dsl_accessor class method as a way to easily create DSL-style accessors
-* DslProxy now only copies back instance vars when they change
-* Symbol now supports #starts_with? and #ends_with?
+* Add DslBuilder base class for additional DSL-building goodness, is basically a better blank-slate starter class than BasicObject for working with our DslProxy class
+* Add #dsl_accessor class method as a way to easily create DSL-style accessors
+* Improve DslProxy to only copy back instance vars when they change
+* Add #starts_with? and #ends_with? to Symbol
 
 == 1.1.0 / 2012-03-06
 
-* Added DslProxy class and specs, which enables slim and sexy DSL construction
+* Add DslProxy class and specs, which enables slim and sexy DSL construction
 
 == 1.0.1 / 2012-03-03
 
-* Updated docs, fixed up minor packaging issues
-* Added spec coverage for Kernel extensions
-* Added spec coverage for Numeric extensions
-* Added spec coverage for Symbol extensions
+* Update docs, fixed up minor packaging issues
+* Add spec coverage for Kernel extensions
+* Add spec coverage for Numeric extensions
+* Add spec coverage for Symbol extensions
 * Commit to GitHub, update gem homepage to reflect same
 
 == 1.0.0 / 2012-03-02
 
-* Broke out extensions from older irongaze gem
-* Vastly improved README with listing of extensions added
-* Improved spec coverage
-* Integrated several new extensions
+* Break out extensions from older irongaze gem
+* Integrate several new extensions
+* Improve README with listing of extensions added
+* Improve spec coverage

data/README.rdoc

@@ -23,6 +23,26 @@ have been moved to the iron-dsl gem!
 
     [1,2,3,4,5].delete_unless(&:odd?) # => [1,3,5]
     
+* Class#inspect_only - override #inspect to only show the specified variables or methods
+
+    class User
+      # Limit inspect to these attrs
+      inspect_only :name, :admin?
+      
+      def initialize
+        @name = 'Bob'
+        @password = 'topSECRET!'
+        @something_complex = ValidationEngine.new
+      end
+      
+      def admin?
+        @name == 'Admin'
+      end
+    end
+    
+    # Inspecting instances of this class show only what we need
+    User.new.inspect  # => "<User:1892377440 @name='Bob', :admin?=false>"
+    
 * File.safe_replace - atomic replacement of a file given a block to generate it
 
     # Defers deleting old file until block completes successfully (ie no exceptions), then
@@ -91,7 +111,7 @@ have been moved to the iron-dsl gem!
 
 To use:
 
-    require 'iron/extensions'
+    require 'iron-extensions'
     
 After that, simply write code to make use of the new extensions and helper classes.
 
@@ -108,7 +128,3 @@ To install, simply run:
 RVM users should drop the 'sudo':
 
     gem install iron-extensions
-    
-Then simply require the library:
-
-    require 'iron/extensions'

data/Version.txt

@@ -1 +1 @@
-1.2.1
+1.2.2

data/lib/iron-extensions.rb

@@ -0,0 +1 @@
+require 'iron/extensions'

data/lib/iron/extensions/class.rb

@@ -0,0 +1,30 @@
+class Class
+
+  # Override #inspect to only include the specified
+  def inspect_only(*methods)
+    @inspect_field_set = methods
+    alias_method :original_inspect, :inspect
+    class_eval do
+      def inspect
+        fields = self.class.inspect_field_set
+        vars = instance_variables
+        field_vals = fields.collect do |field|
+          if instance_variables.include?("@#{field}".to_sym)
+            "@#{field}=" + instance_variable_get("@#{field}").inspect
+          elsif respond_to?(field)
+            ":#{field}=" + send(field).inspect
+          end
+        end.compact
+        text = "#<#{self.class.name}:#{self.object_id}"
+        text += (' ' + field_vals.list_join(', ')) if field_vals.any?
+        text += '>'
+        text
+      end
+    end
+  end
+
+  def inspect_field_set
+    @inspect_field_set || []
+  end
+  
+end

data/spec/extensions/class_spec.rb

@@ -0,0 +1,37 @@
+describe Class do
+
+  it 'should inspect normally' do
+    class Tmp1
+      def initialize
+        @foo = 'bar'
+      end
+    end
+    Tmp1.new.inspect.match(/#<Tmp1:0x[a-z0-9]+ @foo="bar">/).should be_true
+  end
+
+  it 'should inspect only what is requested' do
+    class Tmp2
+      inspect_only :bar
+      def initialize
+        @foo = 'bar'
+        @bar = 'wingo'
+      end
+    end
+    Tmp2.new.inspect.match(/#<Tmp2:[a-z0-9]+ @bar="wingo">/).should be_true
+  end
+
+  it 'should inspect methods if requested' do
+    class Tmp3
+      inspect_only :baz
+      def initialize
+        @foo = 'bar'
+        @bar = 'wingo'
+      end
+      def baz
+        @bar + 'zzz'
+      end
+    end
+    Tmp3.new.inspect.match(/#<Tmp3:[a-z0-9]+ :baz="wingozzz">/).should be_true
+  end
+
+end

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'iron',
 RSpec.configure do |config|
   config.color = true
   config.add_formatter 'documentation'
-  config.backtrace_clean_patterns = [/rspec/]
+  config.backtrace_exclusion_patterns = [/rspec/]
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iron-extensions
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Rob Morris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2017-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -36,8 +36,10 @@ files:
 - LICENSE
 - README.rdoc
 - Version.txt
+- lib/iron-extensions.rb
 - lib/iron/extensions.rb
 - lib/iron/extensions/array.rb
+- lib/iron/extensions/class.rb
 - lib/iron/extensions/enumerable.rb
 - lib/iron/extensions/file.rb
 - lib/iron/extensions/fixnum.rb
@@ -52,6 +54,7 @@ files:
 - lib/iron/extensions/string.rb
 - lib/iron/extensions/symbol.rb
 - spec/extensions/array_spec.rb
+- spec/extensions/class_spec.rb
 - spec/extensions/enumerable_spec.rb
 - spec/extensions/kernel_spec.rb
 - spec/extensions/numeric_spec.rb