pizzazz 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 138168cc911964bb74660a9273a20e99d6760f1e
-  data.tar.gz: fdb1837bba298c759319428b083cddfba5d5f253
+  metadata.gz: 911b76d39b0db46706802fa1e1d0ef2448d3eedb
+  data.tar.gz: 180cefc3ed5d5fabf486222e198b91ebb877c45f
 SHA512:
-  metadata.gz: 0b29436243f29a1f9e7506c2cb6e3e280f54aeb325380c5172aa86c7cbc0de51e4cc25036bde4a0ba1b83536ccfaeac4ef50a08b4aa7dc84a0e001e0b25602d8
-  data.tar.gz: e44e8d3a143237c4f72209b31b688f162be7c61e02d5121f129e1f42affa95dcded30baeddbe1d4349248c6008394fff1f3a3f097523257d0637bd6783b87e53
+  metadata.gz: 3ad86b100a133cdb265a492204c28f6bd50e7bd9b9f0fdb50bd6a6ad8cab2ce2617b7b27a14a6254641599522658461c3bd17fe8f5c3e7c1c573dc82ed92ab99
+  data.tar.gz: b9375ff39aa354c3c33e648fbf76e4ad9c43f73f4656ece4567f42c8ade06a80295a243dd0cbbe81dca38f77da9776344198e0386b49920fdf3886c0994a7afd

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 bundler_args: --without development
 rvm:
   - 1.9.2
-  - 1.9.3
   - 2.0.0
+  - 2.2.4
   - jruby-19mode
   - rbx-19mode

data/Gemfile

@@ -2,10 +2,11 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake', :group => [:development, :test]
+gem 'rake', group: [:development, :test]
 
 group :test do
   gem 'minitest'
-  gem 'simplecov', :require => false
-  gem 'coveralls', :require => false
+  gem 'minitest-reporters', require: 'minitest/reporters'
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter'
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2013 Sam Soffes
+Copyright (c) 2012-2016 Sam Soffes
 
 MIT License
 

data/Readme.markdown

@@ -1,10 +1,9 @@
 # Pizzazz
 
-[![Build Status](https://travis-ci.org/soffes/pizzazz.png?branch=master)](https://travis-ci.org/soffes/pizzazz) [![Coverage Status](https://coveralls.io/repos/soffes/pizzazz/badge.png?branch=master)](https://coveralls.io/r/soffes/pizzazz) [![Code Climate](https://codeclimate.com/github/soffes/pizzazz.png)](https://codeclimate.com/github/soffes/pizzazz) [![Dependency Status](https://gemnasium.com/soffes/pizzazz.png)](https://gemnasium.com/soffes/pizzazz) [![Gem Version](https://badge.fury.io/rb/pizzazz.png)](http://badge.fury.io/rb/pizzazz)
+[![Build Status](https://travis-ci.org/soffes/pizzazz.png?branch=master)](https://travis-ci.org/soffes/pizzazz) [![Test Coverage](https://codeclimate.com/github/soffes/pizzazz/badges/coverage.svg)](https://codeclimate.com/github/soffes/pizzazz/coverage) [![Code Climate](https://codeclimate.com/github/soffes/pizzazz.png)](https://codeclimate.com/github/soffes/pizzazz) [![Dependency Status](https://gemnasium.com/soffes/pizzazz.png)](https://gemnasium.com/soffes/pizzazz) [![Gem Version](https://badge.fury.io/rb/pizzazz.png)](http://badge.fury.io/rb/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.
 
-[Cheddar](http://cheddarapp.com) uses this to show example output of it's API calls. [Check it out](https://cheddarapp.com/developer/lists).
 
 ## Installation
 
@@ -30,9 +29,9 @@ Simple as that.
 Pizzazzifing an object is simple:
 
 ``` ruby
-object = { name: 'Sam Soffes', website: 'http://samsoff.es' }
+object = { name: 'Sam Soffes', website: 'http://soff.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}"
+#=> "{\n  <span class=\"string key\">\"name\"</span>: <span class=\"string\">\"Sam Soffes\"</span>,\n  <span class=\"string key\">\"website\"</span>: <span class=\"string\">\"http://soff.es\"</span>\n}"
 ```
 
 You can optionally limit arrays or values as well:
@@ -47,6 +46,8 @@ This will add an ellipses after the first element and truncate values longer tha
 Pizzazz.ify(all_of_the_things, array_limit: 'etc', value_omission: '... (continued)')
 ```
 
+You can also supply `omit_root_container` and `prefix`, a string that's added to the beginning of each line of the output, is really nice for doing custom things. Both options can be used independently as well.
+
 
 ### HTML
 
@@ -72,7 +73,7 @@ If you're using the asset pipeline, you can simply require `pizzazz` to get my s
 
 ## Supported Ruby Versions
 
-Pizzazz is tested under 1.9.2, 1.9.3, 2.0.0, JRuby 1.7.2 (1.9 mode), and Rubinius 2.0.0 (1.9 mode).
+Pizzazz is tested under 1.9.2, 2.0.0, 2.2.4, JRuby 1.7.2 (1.9 mode), and Rubinius 2.0.0 (1.9 mode).
 
 
 ## Contributing

data/lib/pizzazz.rb

@@ -1,19 +1,18 @@
 module Pizzazz
+  RAILS_AVAILABLE = begin
+    require 'rails'
+    require 'pizzazz/engine'
+    true
+  rescue LoadError
+    false
+  end
+
   def self.ify(object, options = nil)
     p = Colorer.new(object, options)
     p.ify
   end
 end
 
-# TODO: This is ugly. I'd love a better solution.
-begin
-  require 'rails'
-  require 'pizzazz/engine'
-  Pizzazz::RAILS_AVAILABLE = true
-rescue LoadError
-  Pizzazz::RAILS_AVAILABLE = false
-end
-
 require 'pizzazz/colorer'
 require 'pizzazz/html'
 require 'pizzazz/version'

data/lib/pizzazz/colorer.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+
 require 'erb'
 
 module Pizzazz
@@ -12,11 +13,20 @@ module Pizzazz
       @value_limit = options[:value_limit] || 0
       @value_omission = options[:value_omission] || '…'
       @tab = options[:tab] || '  '
+      @prefix = options[:prefix]
+      @omit_root_container = options[:omit_root_container] || false
     end
 
     def ify
       return '' unless @object
-      node(@object)
+
+      # Parse
+      output = node(@object, true)
+      return output unless @prefix
+
+      # Add prefix
+      lines = output.split("\n")
+      @prefix + lines.join("\n#{@prefix}")
     end
 
   private
@@ -32,53 +42,79 @@ module Pizzazz
       (text.length > @value_limit ? text[0...stop] + @value_omission : text).to_s
     end
 
-    def node(object)
+    def node(object, root = false)
+      omit_container = root && @omit_root_container
+
       case object
       when String
         %Q{<span class="string">"#{truncate(::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
+        return omit_container ? '' : '{}' if object.length == 0
+
+        string = if omit_container
+          ''
+        else
+          @indent += 1
+          "{\n"
+        end
+
         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">"#{key}"</span>: #{node(value)}}
         end
-        s << rows.join(",\n") + "\n"
-        @indent -= 1
-        s << "#{tab}}"
-        s
+        string << rows.join(",\n")
+
+        unless omit_container
+          @indent -= 1
+          string << "\n#{tab}}"
+        end
+
+        string
+
       when Array
-        if object.length == 0
-          "[]"
+        return omit_container ? '' : '[]' if object.length == 0
+        string = if omit_container
+          ''
         else
-          s = "[\n"
           @indent += 1
-          rows = []
-          array = @array_limit > 0 ? object[0...@array_limit] : object
-          array.each do |value|
-            rows << tab + node(value)
-          end
+          "[\n"
+        end
 
-          if @array_limit > 0 and object.length > @array_limit
-            rows << tab + (object[0].is_a?(Hash) ? "{ #{@array_omission} }" : @array_omission)
-          end
+        rows = []
+        array = @array_limit > 0 ? object[0...@array_limit] : object
+        array.each do |value|
+          rows << tab + node(value)
+        end
+
+        if @array_limit > 0 and object.length > @array_limit
+          rows << tab + (object[0].is_a?(Hash) ? "{ #{@array_omission} }" : @array_omission)
+        end
+
+        string << rows.join(",\n")
 
-          s << rows.join(",\n") + "\n"
+        unless omit_container
           @indent -= 1
-          s << "#{tab}]"
-          s
+          string << "\n#{tab}]"
         end
+
+        string
       end
     end
   end

data/lib/pizzazz/version.rb

@@ -1,3 +1,3 @@
 module Pizzazz
-  VERSION = '0.1.5'
+  VERSION = '0.2.0'
 end

data/pizzazz.gemspec

@@ -1,12 +1,13 @@
 # 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.email         = ['sam@soff.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.homepage      = 'http://github.com/soffes/pizzazz'
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($\)

data/test/test_helper.rb

@@ -2,12 +2,11 @@ require 'rubygems'
 require 'bundler'
 Bundler.require :test
 
-require 'coveralls'
-Coveralls.wear!
-
-require 'simplecov'
+CodeClimate::TestReporter.start
 SimpleCov.start
 
+Minitest::Reporters.use! Minitest::Reporters::DefaultReporter.new
+
 require 'minitest/autorun'
 require 'pizzazz'
 

data/test/units/colorer_test.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+
 require 'test_helper'
 
 class TestColorer < Pizzazz::TestCase
@@ -16,6 +17,21 @@ class TestColorer < Pizzazz::TestCase
 }}
   end
 
+  def test_prefix
+    colored = Pizzazz.ify({:foo => 'bar'}, prefix: '**')
+    assert_equal colored, %Q{**{
+**  <span class="string key">"foo"</span>: <span class="string">"bar"</span>
+**}}
+  end
+
+  def test_omit_root_container
+    colored = Pizzazz.ify({:foo => 'bar'}, omit_root_container: true)
+    assert_equal colored, %Q{<span class="string key">"foo"</span>: <span class="string">"bar"</span>}
+
+    colored = Pizzazz.ify([1, 2], omit_root_container: true)
+    assert_equal colored, %Q{<span class="number">1</span>,\n<span class="number">2</span>}
+  end
+
   def test_that_it_truncates_arrays
     colored = Pizzazz.ify({:numbers => [1, 2, 3]}, :array_limit => 2)
     assert_equal colored, %Q{{

metadata

@@ -1,25 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: pizzazz
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Soffes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies: []
 description: Add some pizzazz to your documentation
 email:
-- sam@samsoff.es
+- sam@soff.es
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Contributing.markdown
 - Gemfile
 - LICENSE
@@ -34,7 +33,7 @@ files:
 - pizzazz.gemspec
 - test/test_helper.rb
 - test/units/colorer_test.rb
-homepage: http://github.com/samsoffes/pizzazz
+homepage: http://github.com/soffes/pizzazz
 licenses:
 - MIT
 metadata: {}
@@ -44,17 +43,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple gem to code color documentation

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci