pizzazz 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0961913fc899205e876785cf1aa81ea6c1137e38
-  data.tar.gz: 6bcfa09b8e0774480849ac4bb6af84ef36aaf21b
+  metadata.gz: 138168cc911964bb74660a9273a20e99d6760f1e
+  data.tar.gz: fdb1837bba298c759319428b083cddfba5d5f253
 SHA512:
-  metadata.gz: fd66e244b9c80feb551f54485250b599cce7c5c5f8e38cf9b0ebba3b6ebeabc24292141700897164bb790a603e9b8b624362708133c37bf56395f77b27a9c9b7
-  data.tar.gz: 3f328fd9ea78df738ed957ecbbc8a7f66e86c63494b6b70f6a983a345e7fc433d776f25dd4805101a322e69da1d9f4440ea04befddca75cc416a05f0b9efdc69
+  metadata.gz: 0b29436243f29a1f9e7506c2cb6e3e280f54aeb325380c5172aa86c7cbc0de51e4cc25036bde4a0ba1b83536ccfaeac4ef50a08b4aa7dc84a0e001e0b25602d8
+  data.tar.gz: e44e8d3a143237c4f72209b31b688f162be7c61e02d5121f129e1f42affa95dcded30baeddbe1d4349248c6008394fff1f3a3f097523257d0637bd6783b87e53

data/.coveralls.yml

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Contributing.markdown

@@ -0,0 +1,19 @@
+## Submitting a Pull Request
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add tests for your unimplemented feature or bug fix.
+4. Run `bundle exec rake`. If your tests pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your tests fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake doc`. If your changes are not 100% documented, go
+   back to step 8.
+10. Add, commit, and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -6,6 +6,6 @@ gem 'rake', :group => [:development, :test]
 
 group :test do
   gem 'minitest'
-  gem 'minitest-wscolor' if RUBY_VERSION >= '1.9.3'
   gem 'simplecov', :require => false
+  gem 'coveralls', :require => false
 end

data/Readme.markdown

@@ -1,9 +1,30 @@
 # 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)
+
 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
+
+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.
+
+
 ## Usage
 
 Pizzazzifing an object is simple:
@@ -14,13 +35,18 @@ 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:
+You can optionally limit arrays or values as well:
 
 ``` ruby
-Pizzazz.ify(all_of_the_things, limit: 1)
+Pizzazz.ify(all_of_the_things, array_limit: 1, value_limit: 100)
+```
+
+This will add an ellipses after the first element and truncate values longer than 100 characters. You can replace the ellipses by setting the `array_omission` and then `value_omission` options:
+
+``` ruby
+Pizzazz.ify(all_of_the_things, array_limit: 'etc', value_omission: '... (continued)')
 ```
 
-This will add an ellipses after the first element.
 
 ### HTML
 
@@ -43,20 +69,12 @@ Pizzazz.ify_html(object)
 
 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:
+## Supported Ruby Versions
 
-``` ruby
-gem 'pizzazz'
-```
-
-And then execute:
+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).
 
-    $ bundle
-
-Or install it yourself as:
 
-    $ gem install pizzazz
+## Contributing
 
-Simple as that. Enjoy.
+See the [contributing guide](Contributing.markdown).

data/lib/pizzazz.rb

@@ -1,6 +1,4 @@
 module Pizzazz
-  TAB_SIZE = 2
-
   def self.ify(object, options = nil)
     p = Colorer.new(object, options)
     p.ify

data/lib/pizzazz/colorer.rb

@@ -7,24 +7,35 @@ module Pizzazz
       options ||= {}
       @object = object
       @indent = 0
-      @limit = (options[:limit] or 0)
+      @array_limit = options[:array_limit] || options[:limit] || 0
+      @array_omission = options[:array_omission] || '…'
+      @value_limit = options[:value_limit] || 0
+      @value_omission = options[:value_omission] || '…'
+      @tab = options[:tab] || '  '
     end
-  
+
     def ify
       return '' unless @object
-      node(@object, @limit)
+      node(@object)
     end
-  
+
   private
-  
+
     def tab
-      " " * @indent * Pizzazz::TAB_SIZE
+      @tab * @indent
+    end
+
+    def truncate(string)
+      return string if @value_limit < 1
+      text = string.dup
+      stop = @value_limit - @value_omission.length
+      (text.length > @value_limit ? text[0...stop] + @value_omission : text).to_s
     end
-  
-    def node(object, limit = 0)
+
+    def node(object)
       case object
       when String
-        %Q{<span class="string">"#{::ERB::Util.h(object)}"</span>}
+        %Q{<span class="string">"#{truncate(::ERB::Util.h(object))}"</span>}
       when Time
         %Q{<span class="string">#{object.to_json}</span>}
       when TrueClass
@@ -41,11 +52,11 @@ module Pizzazz
         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)}}
+          rows << %Q{#{tab}<span class="string key">"#{key}"</span>: #{node(value)}}
         end
         s << rows.join(",\n") + "\n"
         @indent -= 1
-        s << "#{tab}}"      
+        s << "#{tab}}"
         s
       when Array
         if object.length == 0
@@ -54,15 +65,15 @@ module Pizzazz
           s = "[\n"
           @indent += 1
           rows = []
-          array = @limit > 0 ? object[0...limit] : object
+          array = @array_limit > 0 ? object[0...@array_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) ? '{ … }' : '…')
+
+          if @array_limit > 0 and object.length > @array_limit
+            rows << tab + (object[0].is_a?(Hash) ? "{ #{@array_omission} }" : @array_omission)
           end
-  
+
           s << rows.join(",\n") + "\n"
           @indent -= 1
           s << "#{tab}]"

data/lib/pizzazz/version.rb

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

data/pizzazz.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Pizzazz::VERSION
 
-  gem.required_ruby_version = '>= 1.8.7'
+  gem.required_ruby_version = '>= 1.9.2'
 end

data/test/test_helper.rb

@@ -2,6 +2,9 @@ require 'rubygems'
 require 'bundler'
 Bundler.require :test
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'simplecov'
 SimpleCov.start
 
@@ -13,5 +16,5 @@ Dir["#{File.expand_path(File.dirname(__FILE__))}/support/*.rb"].each do |file|
   require file
 end
 
-class Pizzazz::TestCase < MiniTest::Unit::TestCase
+class Pizzazz::TestCase < Minitest::Test
 end

data/test/units/colorer_test.rb

@@ -1,9 +1,49 @@
+# encoding: UTF-8
 require 'test_helper'
 
 class TestColorer < Pizzazz::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}}
+    colored = Pizzazz.ify({:foo => 'bar'})
+    assert_equal colored, %Q{{
+  <span class="string key">"foo"</span>: <span class="string">"bar"</span>
+}}
   end
 
-  # TODO: These need to be expanded
+  def test_tabs
+    colored = Pizzazz.ify({:foo => 'bar'}, tab: '||||')
+    assert_equal colored, %Q{{
+||||<span class="string key">"foo"</span>: <span class="string">"bar"</span>
+}}
+  end
+
+  def test_that_it_truncates_arrays
+    colored = Pizzazz.ify({:numbers => [1, 2, 3]}, :array_limit => 2)
+    assert_equal colored, %Q{{
+  <span class=\"string key\">\"numbers\"</span>: [
+    <span class=\"number\">1</span>,
+    <span class=\"number\">2</span>,
+    …
+  ]
+}}
+
+    colored = Pizzazz.ify({:numbers => [1, 2, 3]}, :array_limit => 1, :array_omission => 'hello')
+    assert_equal colored, %Q{{
+  <span class=\"string key\">\"numbers\"</span>: [
+    <span class=\"number\">1</span>,
+    hello
+  ]
+}}
+  end
+
+  def test_that_it_truncates_values
+    colored = Pizzazz.ify({:wooden => 'baseball bat'}, :value_limit => 5)
+    assert_equal colored, %Q{{
+  <span class="string key">"wooden"</span>: <span class="string">"base…"</span>
+}}
+
+    colored = Pizzazz.ify({:wooden => 'baseball bat'}, :value_limit => 9, :value_omission => '!')
+    assert_equal colored, %Q{{
+  <span class="string key">"wooden"</span>: <span class="string">"baseball!"</span>
+}}
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pizzazz
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Sam Soffes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies: []
 description: Add some pizzazz to your documentation
 email:
@@ -17,7 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
+- .travis.yml
+- Contributing.markdown
 - Gemfile
 - LICENSE
 - Rakefile
@@ -43,7 +46,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -51,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: A simple gem to code color documentation