mdub-crack 0.1.4

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.gem

data/History

@@ -0,0 +1,15 @@
+== 0.1.3 2009-06-22
+* 1 minor patch
+  * Parsing a text node with attributes stores them in the attributes method (tamalw)
+
+== 0.1.2 2009-04-21
+* 2 minor patches
+  * Correct unnormalization of attribute values (der-flo)
+  * Fix error in parsing YAML in the case where a hash value ends with backslashes, and there are subsequent values in the hash (deadprogrammer)
+  
+== 0.1.1 2009-03-31
+* 1 minor patch
+  * Parsing empty or blank xml now returns empty hash instead of raising error.
+
+== 0.1.0 2009-03-28
+* Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Nunemaker
+
+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/README.rdoc

@@ -0,0 +1,42 @@
+= crack
+
+Really simple JSON and XML parsing, ripped from Merb and Rails. The XML parser is ripped from Merb and the JSON parser is ripped from Rails. I take no credit, just packaged them for all to enjoy and easily use.
+
+== note on releases
+
+Releases are tagged on github and also released as gems on github and rubyforge. Master is pushed to whenever I add a patch or a new feature. To build from master, you can clone the code, generate the updated gemspec, build the gem and install.
+
+* rake gemspec
+* gem build httparty.gemspec
+* gem install the gem that was built
+
+== note on patches/pull requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== usage
+  
+  gem 'crack'
+  require 'crack' # for xml and json
+  require 'crack/json' # for just json
+  require 'crack/xml' # for just xml
+
+== examples
+  
+  Crack::XML.parse("<tag>This is the contents</tag>")
+    # => {'tag' => 'This is the contents'}
+  
+  Crack::JSON.parse('{"tag":"This is the contents"}')
+    # => {'tag' => 'This is the contents'}
+
+== Copyright
+
+Copyright (c) 2009 John Nunemaker. See LICENSE for details.
+
+== Docs
+
+http://rdoc.info/projects/jnunemaker/crack

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "crack"
+    gem.summary = %Q{Really simple JSON and XML parsing, ripped from Merb and Rails.}
+    gem.email = "nunemaker@gmail.com"
+    gem.homepage = "http://github.com/jnunemaker/crack"
+    gem.authors = ["John Nunemaker"]
+    gem.rubyforge_project = 'crack'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'crack'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 4

data/crack.gemspec

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{crack}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Nunemaker"]
+  s.date = %q{2009-07-19}
+  s.email = %q{nunemaker@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "crack.gemspec",
+     "lib/crack.rb",
+     "lib/crack/core_extensions.rb",
+     "lib/crack/json.rb",
+     "lib/crack/xml.rb",
+     "test/crack_test.rb",
+     "test/data/twittersearch-firefox.json",
+     "test/data/twittersearch-ie.json",
+     "test/hash_test.rb",
+     "test/json_test.rb",
+     "test/string_test.rb",
+     "test/test_helper.rb",
+     "test/xml_test.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/jnunemaker/crack}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{crack}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Really simple JSON and XML parsing, ripped from Merb and Rails.}
+  s.test_files = [
+    "test/crack_test.rb",
+     "test/hash_test.rb",
+     "test/json_test.rb",
+     "test/string_test.rb",
+     "test/test_helper.rb",
+     "test/xml_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/crack.rb

@@ -0,0 +1,7 @@
+module Crack
+  class ParseError < StandardError; end
+end
+
+require 'crack/core_extensions'
+require 'crack/json'
+require 'crack/xml'

data/lib/crack/core_extensions.rb

@@ -0,0 +1,128 @@
+require 'uri'
+
+class Object #:nodoc:
+  # @return <TrueClass, FalseClass>
+  #
+  # @example [].blank?         #=>  true
+  # @example [1].blank?        #=>  false
+  # @example [nil].blank?      #=>  false
+  # 
+  # Returns true if the object is nil or empty (if applicable)
+  def blank?
+    nil? || (respond_to?(:empty?) && empty?)
+  end unless method_defined?(:blank?)
+end # class Object
+
+class Numeric #:nodoc:
+  # @return <TrueClass, FalseClass>
+  # 
+  # Numerics can't be blank
+  def blank?
+    false
+  end unless method_defined?(:blank?)
+end # class Numeric
+
+class NilClass #:nodoc:
+  # @return <TrueClass, FalseClass>
+  # 
+  # Nils are always blank
+  def blank?
+    true
+  end unless method_defined?(:blank?)
+end # class NilClass
+
+class TrueClass #:nodoc:
+  # @return <TrueClass, FalseClass>
+  # 
+  # True is not blank.  
+  def blank?
+    false
+  end unless method_defined?(:blank?)
+end # class TrueClass
+
+class FalseClass #:nodoc:
+  # False is always blank.
+  def blank?
+    true
+  end unless method_defined?(:blank?)
+end # class FalseClass
+
+class String #:nodoc:
+  # @example "".blank?         #=>  true
+  # @example "     ".blank?    #=>  true
+  # @example " hey ho ".blank? #=>  false
+  # 
+  # @return <TrueClass, FalseClass>
+  # 
+  # Strips out whitespace then tests if the string is empty.
+  def blank?
+    strip.empty?
+  end unless method_defined?(:blank?)
+  
+  def snake_case
+    return self.downcase if self =~ /^[A-Z]+$/
+    self.gsub(/([A-Z]+)(?=[A-Z][a-z]?)|\B[A-Z]/, '_\&') =~ /_*(.*)/
+    return $+.downcase
+  end unless method_defined?(:snake_case)
+end # class String
+
+class Hash #:nodoc:
+  # @return <String> This hash as a query string
+  #
+  # @example
+  #   { :name => "Bob",
+  #     :address => {
+  #       :street => '111 Ruby Ave.',
+  #       :city => 'Ruby Central',
+  #       :phones => ['111-111-1111', '222-222-2222']
+  #     }
+  #   }.to_params
+  #     #=> "name=Bob&address[city]=Ruby Central&address[phones][]=111-111-1111&address[phones][]=222-222-2222&address[street]=111 Ruby Ave."
+  def to_params
+    params = self.map { |k,v| normalize_param(k,v) }.join
+    params.chop! # trailing &
+    params
+  end
+
+  # @param key<Object> The key for the param.
+  # @param value<Object> The value for the param.
+  #
+  # @return <String> This key value pair as a param
+  #
+  # @example normalize_param(:name, "Bob Jones") #=> "name=Bob%20Jones&"
+  def normalize_param(key, value)
+    param = ''
+    stack = []
+
+    if value.is_a?(Array)
+      param << value.map { |element| normalize_param("#{key}[]", element) }.join
+    elsif value.is_a?(Hash)
+      stack << [key,value]
+    else
+      param << "#{key}=#{URI.encode(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}&"
+    end
+
+    stack.each do |parent, hash|
+      hash.each do |key, value|
+        if value.is_a?(Hash)
+          stack << ["#{parent}[#{key}]", value]
+        else
+          param << normalize_param("#{parent}[#{key}]", value)
+        end
+      end
+    end
+
+    param
+  end
+  
+  # @return <String> The hash as attributes for an XML tag.
+  #
+  # @example
+  #   { :one => 1, "two"=>"TWO" }.to_xml_attributes
+  #     #=> 'one="1" two="TWO"'
+  def to_xml_attributes
+    map do |k,v|
+      %{#{k.to_s.snake_case.sub(/^(.{1,1})/) { |m| m.downcase }}="#{v}"}
+    end.join(' ')
+  end
+end

data/lib/crack/json.rb

@@ -0,0 +1,68 @@
+# Copyright (c) 2004-2008 David Heinemeier Hansson
+# 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.
+
+require 'yaml'
+require 'strscan'
+
+module Crack
+  class JSON
+    def self.parse(json)
+      YAML.load(unescape(convert_json_to_yaml(json)))
+    rescue ArgumentError => e
+      raise ParseError, "Invalid JSON string"
+    end
+
+    protected
+      def self.unescape(str)
+        str.gsub(/\\u([0-9a-f]{4})/) { [$1.hex].pack("U") }
+      end
+      
+      # matches YAML-formatted dates
+      DATE_REGEX = /^\d{4}-\d{2}-\d{2}|\d{4}-\d{1,2}-\d{1,2}[ \t]+\d{1,2}:\d{2}:\d{2}(\.[0-9]*)?(([ \t]*)Z|[-+]\d{2}?(:\d{2})?)?$/
+
+      # Ensure that ":" and "," are always followed by a space
+      def self.convert_json_to_yaml(json) #:nodoc:
+        scanner, quoting, marks, pos, times = StringScanner.new(json), false, [], nil, []
+        while scanner.scan_until(/(\\['"]|['":,\\]|\\.)/)
+          case char = scanner[1]
+          when '"', "'"
+            if !quoting
+              quoting = char
+              pos = scanner.pos
+            elsif quoting == char
+              if json[pos..scanner.pos-2] =~ DATE_REGEX
+                # found a date, track the exact positions of the quotes so we can remove them later.
+                # oh, and increment them for each current mark, each one is an extra padded space that bumps
+                # the position in the final YAML output
+                total_marks = marks.size
+                times << pos+total_marks << scanner.pos+total_marks
+              end
+              quoting = false
+            end
+          when ":",","
+            marks << scanner.pos - 1 unless quoting
+          when "\\"
+            scanner.skip(/\\/)
+          end          
+        end
+
+        if marks.empty?
+          json.gsub(/\\\//, '/')
+        else
+          left_pos  = [-1].push(*marks)
+          right_pos = marks << json.length
+          output    = []
+          left_pos.each_with_index do |left, i|
+            output << json[left.succ..right_pos[i]]
+          end
+          output = output * " "
+
+          times.each { |i| output[i-1] = ' ' }
+          output.gsub!(/\\\//, '/')
+          output
+        end
+      end
+  end
+end

data/lib/crack/xml.rb

@@ -0,0 +1,229 @@
+require 'rexml/parsers/streamparser'
+require 'rexml/parsers/baseparser'
+require 'rexml/light/node'
+require 'rexml/text'
+require 'date'
+require 'time'
+require 'yaml'
+require 'bigdecimal'
+
+# This is a slighly modified version of the XMLUtilityNode from
+# http://merb.devjavu.com/projects/merb/ticket/95 (has.sox@gmail.com)
+# It's mainly just adding vowels, as I ht cd wth n vwls :)
+# This represents the hard part of the work, all I did was change the
+# underlying parser.
+class REXMLUtilityNode #:nodoc:
+  attr_accessor :name, :attributes, :children, :type
+
+  def self.typecasts
+    @@typecasts
+  end
+
+  def self.typecasts=(obj)
+    @@typecasts = obj
+  end
+
+  def self.available_typecasts
+    @@available_typecasts
+  end
+
+  def self.available_typecasts=(obj)
+    @@available_typecasts = obj
+  end
+
+  self.typecasts = {}
+  self.typecasts["integer"]       = lambda{|v| v.nil? ? nil : v.to_i}
+  self.typecasts["boolean"]       = lambda{|v| v.nil? ? nil : (v.strip != "false")}
+  self.typecasts["datetime"]      = lambda{|v| v.nil? ? nil : Time.parse(v).utc}
+  self.typecasts["date"]          = lambda{|v| v.nil? ? nil : Date.parse(v)}
+  self.typecasts["dateTime"]      = lambda{|v| v.nil? ? nil : Time.parse(v).utc}
+  self.typecasts["decimal"]       = lambda{|v| v.nil? ? nil : BigDecimal(v.to_s)}
+  self.typecasts["double"]        = lambda{|v| v.nil? ? nil : v.to_f}
+  self.typecasts["float"]         = lambda{|v| v.nil? ? nil : v.to_f}
+  self.typecasts["symbol"]        = lambda{|v| v.nil? ? nil : v.to_sym}
+  self.typecasts["string"]        = lambda{|v| v.to_s}
+  self.typecasts["yaml"]          = lambda{|v| v.nil? ? nil : YAML.load(v)}
+  self.typecasts["base64Binary"]  = lambda{|v| v.unpack('m').first }
+
+  self.available_typecasts = self.typecasts.keys
+
+  def initialize(name, normalized_attributes = {})
+    
+    # unnormalize attribute values
+    attributes = Hash[* normalized_attributes.map { |key, value|
+      [ key, unnormalize_xml_entities(value) ]
+    }.flatten]
+    
+    @name         = name.tr("-", "_")
+    # leave the type alone if we don't know what it is
+    @type         = self.class.available_typecasts.include?(attributes["type"]) ? attributes.delete("type") : attributes["type"]
+
+    @nil_element  = attributes.delete("nil") == "true"
+    @attributes   = undasherize_keys(attributes)
+    @children     = []
+    @text         = false
+  end
+
+  def add_node(node)
+    @text = true if node.is_a? String
+    @children << node
+  end
+
+  def to_hash
+    if @type == "file"
+      f = StringIO.new((@children.first || '').unpack('m').first)
+      class << f
+        attr_accessor :original_filename, :content_type
+      end
+      f.original_filename = attributes['name'] || 'untitled'
+      f.content_type = attributes['content_type'] || 'application/octet-stream'
+      return {name => f}
+    end
+
+    if @text
+      t = typecast_value( unnormalize_xml_entities( inner_html ) )
+      begin
+        t.extend(Crack::HasAttributes) 
+        t.attributes = attributes
+      rescue TypeError => e
+      end
+      return { name => t }
+    else
+      #change repeating groups into an array
+      groups = @children.inject({}) { |s,e| (s[e.name] ||= []) << e; s }
+
+      out = nil
+      if @type == "array"
+        out = Crack::Array.new
+        groups.each do |k, v|
+          if v.size == 1
+            out << v.first.to_hash.entries.first.last
+          else
+            out << v.map{|e| e.to_hash[k]}
+          end
+        end
+        out.attributes = attributes.reject { |k,v| k == "type" }
+
+        out = out.flatten
+
+      else # If Hash
+        out = {}
+        groups.each do |k,v|
+          if v.size == 1
+            out.merge!(v.first)
+          else
+            out.merge!( k => v.map{|e| e.to_hash[k]})
+          end
+        end
+        out.merge! attributes unless attributes.empty?
+        out = out.empty? ? nil : out
+      end
+
+      if @type && out.nil?
+        { name => typecast_value(out) }
+      else
+        { name => out }
+      end
+    end
+  end
+
+  # Typecasts a value based upon its type. For instance, if
+  # +node+ has #type == "integer",
+  # {{[node.typecast_value("12") #=> 12]}}
+  #
+  # @param value<String> The value that is being typecast.
+  #
+  # @details [:type options]
+  #   "integer"::
+  #     converts +value+ to an integer with #to_i
+  #   "boolean"::
+  #     checks whether +value+, after removing spaces, is the literal
+  #     "true"
+  #   "datetime"::
+  #     Parses +value+ using Time.parse, and returns a UTC Time
+  #   "date"::
+  #     Parses +value+ using Date.parse
+  #
+  # @return <Integer, TrueClass, FalseClass, Time, Date, Object>
+  #   The result of typecasting +value+.
+  #
+  # @note
+  #   If +self+ does not have a "type" key, or if it's not one of the
+  #   options specified above, the raw +value+ will be returned.
+  def typecast_value(value)
+    return value unless @type
+    proc = self.class.typecasts[@type]
+    proc.nil? ? value : proc.call(value)
+  end
+
+  # Take keys of the form foo-bar and convert them to foo_bar
+  def undasherize_keys(params)
+    params.keys.each do |key, value|
+      params[key.tr("-", "_")] = params.delete(key)
+    end
+    params
+  end
+
+  # Get the inner_html of the REXML node.
+  def inner_html
+    @children.join
+  end
+
+  # Converts the node into a readable HTML node.
+  #
+  # @return <String> The HTML node in text form.
+  def to_html
+    attributes.merge!(:type => @type ) if @type
+    "<#{name}#{attributes.to_xml_attributes}>#{@nil_element ? '' : inner_html}</#{name}>"
+  end
+
+  # @alias #to_html #to_s
+  def to_s
+    to_html
+  end
+  
+  private
+
+  def unnormalize_xml_entities value
+    REXML::Text.unnormalize(value)
+  end
+end
+
+module Crack
+  
+  class XML
+    def self.parse(xml)
+      stack = []
+      parser = REXML::Parsers::BaseParser.new(xml)
+
+      while true
+        event = parser.pull
+        case event[0]
+        when :end_document
+          break
+        when :end_doctype, :start_doctype
+          # do nothing
+        when :start_element
+          stack.push REXMLUtilityNode.new(event[1], event[2])
+        when :end_element
+          if stack.size > 1
+            temp = stack.pop
+            stack.last.add_node(temp)
+          end
+        when :text, :cdata
+          stack.last.add_node(event[1]) unless event[1].strip.length == 0 || stack.empty?
+        end
+      end
+      stack.length > 0 ? stack.pop.to_hash : {}
+    end
+  end
+  
+  module HasAttributes
+    attr_accessor :attributes
+  end
+  
+  class Array < ::Array
+    include HasAttributes
+  end
+  
+end