carmine 0.1.2 → 0.2.0

data/Gemfile

@@ -1,6 +1,7 @@
 source :gemcutter
 
 gem 'httparty'
+gem 'json'
 
 group :development do
   gem 'rake'

data/Gemfile.lock

@@ -41,5 +41,6 @@ DEPENDENCIES
   guard-rspec
   httparty
   jeweler
+  json
   rake
   rspec

data/Guardfile

@@ -1,4 +1,4 @@
-guard :rspec, :cli => '-f doc -r "spec_helper" -c' do
+guard :rspec, :cli => '--format documentation --require "spec_helper" --color' do
   watch(%r{^lib/(.+)\.rb$})  { 'spec' }
   watch(%r{^spec/(.+)\.rb$}) { 'spec' }
 end

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/carmine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "carmine"
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Genadi Samokovarov"]
-  s.date = "2012-03-01"
+  s.date = "2012-03-04"
   s.description = "Ruby client for pygmentize.me"
   s.email = "gsamokovarov@gmail.com"
   s.extra_rdoc_files = [
@@ -25,7 +25,9 @@ Gem::Specification.new do |s|
     "VERSION",
     "carmine.gemspec",
     "lib/carmine.rb",
+    "lib/carmine/conversion.rb",
     "lib/carmine/version.rb",
+    "spec/carmine/conversion_spec.rb",
     "spec/carmine/version_spec.rb",
     "spec/carmine_spec.rb",
     "spec/spec_helper.rb",
@@ -42,6 +44,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<guard>, [">= 0"])
@@ -50,6 +53,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<httparty>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<guard>, [">= 0"])
@@ -59,6 +63,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<guard>, [">= 0"])

data/lib/carmine.rb

@@ -1,11 +1,12 @@
+require 'json'
 require 'httparty'
 
 class Carmine
   include HTTParty
 
-  # Public: The base error for the library.
+  # Public: The base error for the client.
   #
-  # Raised when there is something wrong with the colorization request. 
+  # Raised when there is something wrong with the colorization request.
   class Error < StandardError
     attr_reader :response
 
@@ -25,7 +26,12 @@ class Carmine
     # Examples
     #
     #   Carmine.colorize "puts 'Hello World!'", :lexer => :ruby
+    #   # Calls `Colorize.send(:instance).colorize(*args)`.
+    #
     #   Carmine.pygmentize "puts 'Hello World!'", :lexer => :ruby
+    #   # Calls `Colorize.send(:pygmentize).colorize(*args)`.
+    #
+    # Returns the delegated method call result.
     def method_missing(name, *args, &block)
       if instance.respond_to? name
         instance.send name, *args, &block
@@ -41,6 +47,7 @@ class Carmine
     end
   end
 
+  # Public: Sets the default server uri (default: 'pygmentize me').
   base_uri 'pygmentize.me'
 
   # Public: Gets/Sets the client default options.
@@ -67,7 +74,7 @@ class Carmine
   #           :formatter - The name of the formatter to use (optional).
   #           :lexer     - The name of the lexer to use (optiona).
   #
-  # Examples 
+  # Examples
   #
   #   colorize "puts 'Hello World!'", :lexer => :ruby, :formatter => :text
   #   # => "puts 'Hello World!'"
@@ -83,7 +90,7 @@ class Carmine
 
     raise ArgumentError, "Argument or option :code missing" if params[:code].nil?
 
-    response = post "/api/formatter/#{options[:formatter]}", :query => params
+    response = post "/api/formatter/#{params.delete :formatter}", :query => params
 
     raise Error, response unless response.success?
 
@@ -99,8 +106,11 @@ class Carmine
   private
 
   def post(path, options = {})
+    options[:query_string_normalizer] ||= Conversion.method :to_params
+
     self.class.post path, @defaults.merge(options)
   end
 end
 
 require 'carmine/version'
+require 'carmine/conversion'

data/lib/carmine/conversion.rb

@@ -0,0 +1,27 @@
+class Carmine
+  # Internal: Query string conversion utilities.
+  module Conversion
+    extend self
+
+    # Public: Jsonifies the request :query values to a query string.
+    #
+    # Examples
+    #
+    #   Converter.to_param :options => { :cssclass => :color }
+    #   # => options=%7B%22cssclass%22%3A%22color%22%7D
+    #
+    # Returns the uri encoded query string.
+    def to_params(query)
+      params = query.map { |key, value| normalize_param key, value }.join
+      params.chop!
+      params
+    end
+
+    private
+
+    def normalize_param(key, value)
+      [Array, Hash].each { |kind| value = value.to_json if value.is_a? kind }
+      HTTParty::HashConversions.normalize_param key, value
+    end
+  end
+end

data/spec/carmine/conversion_spec.rb

@@ -0,0 +1,16 @@
+describe Carmine::Conversion do
+  it 'converts the Hash query values to JSON' do
+    query = Carmine::Conversion.to_params :options => { :cssclass => :color }
+    query.should eq("options=%7B%22cssclass%22%3A%22color%22%7D")
+  end
+
+  it 'converts the Array query values to JSON' do
+    query = Carmine::Conversion.to_params :styles => [:monokai]
+    query.should eq("styles=%5B%22monokai%22%5D")
+  end
+
+  it 'should url encode the strings and symbols' do
+    query = Carmine::Conversion.to_params :styles => " "
+    query.should eq("styles=%20")
+  end
+end

data/spec/carmine_spec.rb

@@ -31,10 +31,15 @@ describe Carmine do
       let(:carmine) { access == '::' ? Carmine : Carmine.new }
 
       it 'should colorize code :lexer and :formatter' do
-        carmine.colorize('puts "Hello World!"', :lexer => :ruby, :formatter => 'html').should ==
+        carmine.colorize('puts "Hello World!"', :lexer => :ruby, :formatter => :html).should ==
           %Q{<div class="highlight"><pre><span class="nb">puts</span> <span class="s2">&quot;Hello World!&quot;</span>\n</pre></div>\n}
       end
 
+      it 'should convert arrays and hashes to JSON' do
+        carmine.colorize('puts "Hello World!"', :lexer => :ruby, :options => { :cssclass => :color }).should ==
+          %Q{<div class="color"><pre><span class="nb">puts</span> <span class="s2">&quot;Hello World!&quot;</span>\n</pre></div>\n}
+      end
+
       it 'should throw Carmine::Error on server side errors' do
         colorization = proc do
           carmine.colorize 'pass', :lexer => :python, :formatter => :invalid

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carmine
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-01 00:00:00.000000000Z
+date: 2012-03-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &16903100 !ruby/object:Gem::Requirement
+  requirement: &11995760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16903100
+  version_requirements: *11995760
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &11995220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11995220
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16902580 !ruby/object:Gem::Requirement
+  requirement: &11994700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16902580
+  version_requirements: *11994700
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16902080 !ruby/object:Gem::Requirement
+  requirement: &11994180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16902080
+  version_requirements: *11994180
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &16901600 !ruby/object:Gem::Requirement
+  requirement: &11993680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16901600
+  version_requirements: *11993680
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &16901120 !ruby/object:Gem::Requirement
+  requirement: &11993120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16901120
+  version_requirements: *11993120
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &16900600 !ruby/object:Gem::Requirement
+  requirement: &11990140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16900600
+  version_requirements: *11990140
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &16900060 !ruby/object:Gem::Requirement
+  requirement: &11989660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +98,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16900060
+  version_requirements: *11989660
 description: Ruby client for pygmentize.me
 email: gsamokovarov@gmail.com
 executables: []
@@ -104,7 +115,9 @@ files:
 - VERSION
 - carmine.gemspec
 - lib/carmine.rb
+- lib/carmine/conversion.rb
 - lib/carmine/version.rb
+- spec/carmine/conversion_spec.rb
 - spec/carmine/version_spec.rb
 - spec/carmine_spec.rb
 - spec/spec_helper.rb