pizzazz 0.1.0 → 0.1.1

data/Readme.markdown

@@ -2,6 +2,8 @@
 
 Pizzazz is a simple pure Ruby implementation of code coloring, but just for JSON. Basically, if you have a ruby object and want to show it converted to JSON and add HTML around it so you can color it.
 
+[Cheddar](http://cheddarapp.com) uses this to show example output of it's API calls. [Check it out](https://cheddarapp.com/developer/lists).
+
 ## Usage
 
 Pizzazzifing an object is simple:
@@ -25,41 +27,22 @@ This will add an ellipses after the first element.
 Spans are added around various elements. Here's the classes:
 
 * `string`
-* `constant` (for `true` or `false`
+* `constant` (`true` or `false`)
 * `null`
 * `number`
 
-Everything else is left alone. It is recommended to wrap the output like this:
+Everything else is left alone.
 
-``` html
-<pre><%= Pizzazz.ify(object).html_safe %></pre>
-```
+If you want it wrapped in `<pre class="pizzazz">` (and call `html_safe` if possible), do the following:
 
-Here's my stylesheet if you're interested:
-
-``` css
-pre {
-  border-radius: 5px;
-  background: #f7f7f7;
-  padding: 0.5em;
-  margin-bottom: 2em;
-  border: 1px solid #ddd;
-}
-
-.string {
-  color: #ee6132;
-}
-
-.null, .number, .constant {
-  color: #8e75c3;
-}
-
-.comment {
-  color: #999;
-  font-style: italic;
-}
+``` ruby
+Pizzazz.ify_html(object)
 ```
 
+### Stylesheet
+
+If you're using the asset pipeline, you can simply require `pizzazz` to get my stylesheet. Be sure your `<pre>` has the `pizzazz` class. If you use `ify_html` it will automatically do this.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/app/assets/stylesheets/pizzazz.css

@@ -0,0 +1,22 @@
+pre.pizzazz {
+  border-radius: 5px;
+  background: #f7f7f7;
+  padding: 0.5em;
+  margin-bottom: 2em;
+  border: 1px solid #ddd;
+}
+
+pre.pizzazz span.string {
+  color: #ee6132;
+}
+
+pre.pizzazz span.null, 
+pre.pizzazz span.number, 
+pre.pizzazz span.constant {
+  color: #8e75c3;
+}
+
+pre.pizzazz span.comment {
+  color: #999;
+  font-style: italic;
+}

data/lib/pizzazz.rb

@@ -1,11 +1,13 @@
 require 'pizzazz/colorer'
+require 'pizzazz/html'
+require 'pizzazz/engine'
 require 'pizzazz/version'
 
 module Pizzazz
   TAB_SIZE = 2
   
   def self.ify(object, options = nil)
-    p = Pizzazz::Colorer.new(object, options)
+    p = Colorer.new(object, options)
     p.ify
   end
 end

data/lib/pizzazz/colorer.rb

@@ -1,70 +1,72 @@
 # encoding: UTF-8
 require 'erb'
 
-class Pizzazz::Colorer
-  def initialize(object, options = nil)
-    options ||= {}
-    @object = object
-    @indent = 0
-    @limit = (options[:limit] or 0)
-  end
-
-  def ify
-    node(@object, @limit)
-  end
-
-private
-
-  def tab
-    " " * @indent * Pizzazz::TAB_SIZE
-  end
-
-  def node(object, limit = 0)
-    case object
-    when String
-      %Q{<span class="string">"#{::ERB::Util.h(object)}"</span>}
-    when Time
-      %Q{<span class="string">#{object.to_json}</span>}
-    when TrueClass
-      %Q{<span class="constant">true</span>}
-    when FalseClass
-      %Q{<span class="constant">false</span>}
-    when NilClass
-      %Q{<span class="null">null</span>}
-    when Numeric
-      %Q{<span class="number">#{object}</span>}
-    when Hash
-      s = "{\n"
-      @indent += 1
-      rows = []
-      object.keys.collect(&:to_s).sort.each do |key|
-        value = (object[key] != nil ? object[key] : object[key.to_sym])
-        rows << %Q{#{tab}<span class="string">"#{key}"</span>: #{node(value)}}
-      end
-      s << rows.join(",\n") + "\n"
-      @indent -= 1
-      s << "#{tab}}"      
-      s
-    when Array
-      if object.length == 0
-        "[]"
-      else
-        s = "[\n"
+module Pizzazz
+  class Colorer
+    def initialize(object, options = nil)
+      options ||= {}
+      @object = object
+      @indent = 0
+      @limit = (options[:limit] or 0)
+    end
+  
+    def ify
+      node(@object, @limit)
+    end
+  
+  private
+  
+    def tab
+      " " * @indent * Pizzazz::TAB_SIZE
+    end
+  
+    def node(object, limit = 0)
+      case object
+      when String
+        %Q{<span class="string">"#{::ERB::Util.h(object)}"</span>}
+      when Time
+        %Q{<span class="string">#{object.to_json}</span>}
+      when TrueClass
+        %Q{<span class="constant">true</span>}
+      when FalseClass
+        %Q{<span class="constant">false</span>}
+      when NilClass
+        %Q{<span class="null">null</span>}
+      when Numeric
+        %Q{<span class="number">#{object}</span>}
+      when Hash
+        s = "{\n"
         @indent += 1
         rows = []
-        array = @limit > 0 ? object[0...limit] : object
-        array.each do |value|
-          rows << tab + node(value)
+        object.keys.collect(&:to_s).sort.each do |key|
+          value = (object[key] != nil ? object[key] : object[key.to_sym])
+          rows << %Q{#{tab}<span class="string">"#{key}"</span>: #{node(value)}}
         end
-
-        if limit > 0 and object.length > limit
-          rows << tab + (object[0].is_a?(Hash) ? '{ … }' : '…')
-        end
-
         s << rows.join(",\n") + "\n"
         @indent -= 1
-        s << "#{tab}]"
+        s << "#{tab}}"      
         s
+      when Array
+        if object.length == 0
+          "[]"
+        else
+          s = "[\n"
+          @indent += 1
+          rows = []
+          array = @limit > 0 ? object[0...limit] : object
+          array.each do |value|
+            rows << tab + node(value)
+          end
+  
+          if limit > 0 and object.length > limit
+            rows << tab + (object[0].is_a?(Hash) ? '{ … }' : '…')
+          end
+  
+          s << rows.join(",\n") + "\n"
+          @indent -= 1
+          s << "#{tab}]"
+          s
+        end
       end
     end
   end

data/lib/pizzazz/engine.rb

@@ -0,0 +1,4 @@
+module Pizzazz
+  class Engine < Rails::Engine
+  end
+end

data/lib/pizzazz/html.rb

@@ -0,0 +1,8 @@
+module Pizzazz
+  def self.ify_html(object, options = nil)
+    p = Colorer.new(object, options)
+    html = %Q{<pre class="pizzazz">#{p.ify}</pre>}
+    html.html_safe if html.respond_to?(:html_safe)
+    html
+  end
+end

data/lib/pizzazz/version.rb

@@ -1,3 +1,3 @@
 module Pizzazz
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pizzazz
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -23,8 +23,11 @@ files:
 - LICENSE
 - Rakefile
 - Readme.markdown
+- app/assets/stylesheets/pizzazz.css
 - lib/pizzazz.rb
 - lib/pizzazz/colorer.rb
+- lib/pizzazz/engine.rb
+- lib/pizzazz/html.rb
 - lib/pizzazz/version.rb
 - pizzazz.gemspec
 - test/test_helper.rb
@@ -43,7 +46,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3216687736282638724
+      hash: 3758001213674931689
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -52,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3216687736282638724
+      hash: 3758001213674931689
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23