pizzazz 0.1.0

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,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pizzazz.gemspec
+gemspec
+
+gem 'rake'
+gem 'minitest'
+gem 'minitest-wscolor'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sam Soffes
+
+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/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+task default: :test

data/Readme.markdown

@@ -0,0 +1,79 @@
+# Pizzazz
+
+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.
+
+## Usage
+
+Pizzazzifing an object is simple:
+
+``` ruby
+object = { name: 'Sam Soffes', website: 'http://samsoff.es' }
+Pizzazz.ify(object)
+#=> "{\n  <span class=\"string\">\"name\"</span>: <span class=\"string\">\"Sam Soffes\"</span>,\n  <span class=\"string\">\"website\"</span>: <span class=\"string\">\"http://samsoff.es\"</span>\n}"
+```
+
+You can optionally limit arrays as well:
+
+``` ruby
+Pizzazz.ify(all_of_the_things, limit: 1)
+```
+
+This will add an ellipses after the first element.
+
+### HTML
+
+Spans are added around various elements. Here's the classes:
+
+* `string`
+* `constant` (for `true` or `false`
+* `null`
+* `number`
+
+Everything else is left alone. It is recommended to wrap the output like this:
+
+``` html
+<pre><%= Pizzazz.ify(object).html_safe %></pre>
+```
+
+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;
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'pizzazz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pizzazz
+
+Simple as that. Enjoy.

data/lib/pizzazz.rb

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

data/lib/pizzazz/colorer.rb

@@ -0,0 +1,71 @@
+# 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"
+        @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/version.rb

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

data/pizzazz.gemspec

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+require File.expand_path('../lib/pizzazz/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Sam Soffes']
+  gem.email         = ['sam@samsoff.es']
+  gem.description   = %q{Add some pizzazz to your documentation}
+  gem.summary       = %q{A simple gem to code color documentation}
+  gem.homepage      = 'http://github.com/samsoffes/pizzazz'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'pizzazz'
+  gem.require_paths = ['lib']
+  gem.version       = Pizzazz::VERSION
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+gem 'minitest'
+require 'minitest/wscolor'
+require 'minitest/autorun'
+
+require 'pizzazz'

data/test/units/colorer_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class TestColorer < MiniTest::Unit::TestCase
+  def test_that_it_colors_hashes
+    assert_equal Pizzazz.ify({foo: 'bar'}), %Q{{\n  <span class="string">"foo"</span>: <span class="string">"bar"</span>\n}}
+  end
+  
+  # These need to be expanded
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: pizzazz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sam Soffes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-10 00:00:00.000000000 Z
+dependencies: []
+description: Add some pizzazz to your documentation
+email:
+- sam@samsoff.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- Readme.markdown
+- lib/pizzazz.rb
+- lib/pizzazz/colorer.rb
+- lib/pizzazz/version.rb
+- pizzazz.gemspec
+- test/test_helper.rb
+- test/units/colorer_test.rb
+homepage: http://github.com/samsoffes/pizzazz
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3216687736282638724
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3216687736282638724
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple gem to code color documentation
+test_files:
+- test/test_helper.rb
+- test/units/colorer_test.rb