motion_print 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffac142eccd2d2f73bf506a2dab1bbf90efb2aff
-  data.tar.gz: 12bed335eb67226e364bbb7d6742b009c496d544
+  metadata.gz: 58c6363a17cffb78937db16bff5317262d4cc700
+  data.tar.gz: 213a818bd37fd10de6aa55bf228468ae013c6b0c
 SHA512:
-  metadata.gz: 544a094b259d414701ec119bd9a40ab7e645b5f13ae459cc7069f6281c4fd648153cb51538009a1f102c7f5a3758d68d710b5509449a1547c8d349b69406fabc
-  data.tar.gz: 0f26af35ff66f03b926c32fa4dae2a861817f670c6cfb9376e70fb33dd3222d2f9218b1fe43a9b98ca7fbe4a0b32cd8d9bd846dabde6c872296a71706018f17b
+  metadata.gz: c117eed2673e4d12a4a218f979ceaa3614af27a56b14778950c2037bf96bd212642e2e8f6c5eba570c059a6bfa55e5a45dd4008fbbde5361242b553838c0f713
+  data.tar.gz: bb93fcd5d85beae72ad81fa272e20cfeca0cb2ed842dac97a236661f3f818c737daded4cf301fbbf489e46a586ceef7bfe5fbefcb739ea27d8a78ca551246887

data/README.md

@@ -2,7 +2,9 @@
 
 A RubyMotion pretty printer.
 
-[![Gem Version](https://badge.fury.io/rb/motion_print.svg)](http://badge.fury.io/rb/motion_print) [![Build Status](https://travis-ci.org/OTGApps/motion_print.svg)](https://travis-ci.org/OTGApps/motion_print) [![Code Climate](https://codeclimate.com/github/OTGapps/motion_print.png)](https://codeclimate.com/github/OTGApps/motion_print)
+[![Gem Version](https://badge.fury.io/rb/motion_print.svg)](http://badge.fury.io/rb/motion_print)
+[![Build Status](https://travis-ci.org/OTGApps/motion_print.svg)](https://travis-ci.org/OTGApps/motion_print)
+[![Code Climate](https://codeclimate.com/github/OTGApps/motion_print/badges/gpa.svg)](https://codeclimate.com/github/OTGApps/motion_print)
 
 instead of using `p` or `puts`, use `mp` to log your debug values to the RubyMotion REPL.
 
@@ -65,6 +67,37 @@ And then execute:
 ```bash
 bundle
 ```
+
+## Woah! This is great! How can I make my gem support `motion_print`?
+
+`motion_print` supports other gems (or even your own classes in your project ) with an opt-in feature. All you have to do is implement the `motion_print` method in your class (with option `mp` and `options` arguments). You can see an example implementation of this [in the specs](https://github.com/OTGApps/motion_print/blob/master/spec/opt_in_spec.rb).
+
+### Essentially:
+
+```ruby
+def MyCustomClass
+  def motion_print(mp)
+    # This will output in red!
+    mp.colorize("Some Output Here!", :red)
+  end
+end
+```
+
+Here's CDQ's implementation:
+
+```ruby
+class CDQManagedObject
+  def motion_print(mp, options)
+    if respond_to? :attributes
+      "OID: " + mp.colorize(oid.gsub('"',''), options[:force_color]) + "\n" + mp.l_hash(attributes, options)
+    else
+      # old colorless method, still more informative than nothing
+      log
+    end
+  end
+end
+```
+
 ## Fancy Debugging Tips
 
 Ruby comes with some great methods for method introspection.  These methods look great in motion_print.

data/motion/motion_print/motion_print.rb

@@ -33,7 +33,7 @@ module MotionPrint
       when cdq_object
         l_cdq(object, options)
       else
-        colorize(object, options[:force_color])
+        l_custom(object, options)
       end
     end
 
@@ -52,13 +52,7 @@ module MotionPrint
       out = []
 
       a.each do |arr|
-
-        if arr.is_a?(Array) || arr.is_a?(Hash)
-          v = logger(arr, options.merge({indent_level: options[:indent_level] + 1}))
-        else
-          v = logger(arr, options)
-        end
-        out << (indent_by(options[:indent_level]) << v)
+        out << (indent_by(options[:indent_level]) << array_hash_logger(arr, options))
       end
 
       "[\n" << out.join(",\n") << "\n#{indent_by(options[:indent_level]-1)}]"
@@ -76,17 +70,20 @@ module MotionPrint
       width += indent_by(options[:indent_level]).length
 
       data.each do |key, value|
-        if value.is_a?(Array) || value.is_a?(Hash)
-          v = logger(value, options.merge({indent_level: options[:indent_level] + 1}))
-        else
-          v = logger(value, options)
-        end
-        out << (align(key, width, options[:indent_level]) << hash_rocket(options[:force_color]) << v)
+        out << (align(key, width, options[:indent_level]) << hash_rocket(options[:force_color]) << array_hash_logger(value, options))
       end
 
       "{\n" << out.join(",\n") << "\n#{indent_by(options[:indent_level]-1)}}"
     end
 
+    def array_hash_logger(value, options)
+      if value.is_a?(Array) || value.is_a?(Hash)
+        logger(value, options.merge({indent_level: options[:indent_level] + 1}))
+      else
+        logger(value, options)
+      end
+    end
+
     def l_dir(d, options)
       ls = `ls -alF #{d.path.shellescape}`
       colorize(ls.empty? ? d.inspect : "#{d.inspect}\n#{ls.chop}", options[:force_color])
@@ -96,6 +93,21 @@ module MotionPrint
       colorize(object, options[:force_color])
     end
 
+    def l_custom(object, options)
+      if object.respond_to?(:motion_print)
+        case object.method(:motion_print).arity
+        when 1
+          return object.motion_print(self)
+        when 2
+          return object.motion_print(self, options)
+        else
+          return colorize(object.motion_print, options[:force_color])
+        end
+      end
+
+      colorize(object, options[:force_color])
+    end
+
     def colorize(object, force_color = nil)
       Colorizer.send(force_color || decide_color(object), object.inspect)
     end

data/motion/motion_print/version.rb

@@ -1,3 +1,3 @@
 module MotionPrint
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion_print
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mark Rickert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bacon