nokogiri-plist 0.2.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Casey Howard
+
+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,80 @@
+= Nokogiri-PList
+
+== DESCRIPTION:
+
+Nokogiri-plist provides the functionality for dealing with XML in Apple's property list format.
+
+There is already a plist gem (http://github.com/bleything/plist) that has similar functionality. I didn't realize it until I had written most of this gem. However this gem uses Nokogiri, so the implementation is simpler. The plist gem does it's own XML parsing. I figured since I was already using Nokogiri in my project, it's better to build on top of that. I did get ideas from the original gem. I have benchmarked my gem against that gem and it performs similarly. Once I come up with a little more scientific benchmarks, I'll show them.'
+
+
+== FEATURES:
+
+* Parsers plist files into simple basic Ruby objects
+* Generates plist XML from Ruby objects
+* Uses the awesome Nokogiri gem
+
+
+== USAGE:
+
+  Sample plist (test.plist)
+
+  <plist>
+    <dict>
+      <key>Beers</key>
+      <array>
+        <string>Black Butte</string>
+        <string>Steel Reserve</string>
+        <string>Bass Pale Ale</string>
+      </array>
+      <key>Beer Drinker</key><string>Casey</key>
+      <key>Beers Drank</key><integer>4123</integer>
+    </dict>
+  </plist>
+
+
+  >  require 'nokogiri-plist'
+  
+  >  plist = Nokogiri::PList(open('test.plist'))
+  => { "Beers" => ["Black Butte", "Steel Reserve", "Bass Pale Ale"], "Beers Drank" => 4123, "Beer Drinker" => "Casey"}
+  
+  >  plist["Beers"]
+  => ["Black Butte", "Steel Reserve", "Bass Pale Ale"]
+  
+  >  plist["Beer Drinker"]
+  => "Casey"
+  
+  > puts plist.to_plist_xml
+    <dict>
+      <key>Beers</key>
+      <array>
+        <string>Black Butte</string>
+        <string>Steel Reserve</string>
+        <string>Bass Pale Ale</string>
+      </array>
+      <key>Beers Drank</key><integer>4123</integer>
+      <key>Beer Drinker</key><string>Casey</string>
+    </dict>
+    
+  > "beer".to_plist_xml
+  => "<string>beer</string>" 
+  
+  > puts (1..3).to_a.to_plist_xml
+  <array>
+    <integer>1</integer>
+    <integer>2</integer>
+    <integer>3</integer>
+  </array>
+
+== REQUIREMENTS:
+
+* ruby 1.9 (I'll eventually make sure it works in 1.8, but I'm using 1.9 at the moment)
+* nokogiri
+* shoulda and mocha (only if you want to run the tests)
+
+
+== INSTALL:
+
+I haven't published this gem yet, but once I write tests and more documentation the following will work:
+
+* gem install nokogiri-plist
+

data/lib/nokogiri/plist/generator.rb

@@ -0,0 +1,82 @@
+module Nokogiri
+
+  module PList
+    
+    class Generator
+      
+      def self.indent_size
+        2
+      end
+      
+      def self.to_s(value, current_indent = 0)
+        case value
+          when Array
+            tag("array", nil, current_indent) do
+              value.inject("") do |result, item|             
+                result + item.to_plist_xml_unchomped(current_indent + 1)
+              end
+            end
+          when Hash
+            tag("dict", nil, current_indent) do
+              value.inject("") do |result, (dict_key, dict_value)|
+                result + tag("key", dict_key, current_indent + 1).chomp +
+                dict_value.to_plist_xml_unchomped
+              end
+            end
+          when TrueClass
+            tag("true", nil, current_indent)
+          when FalseClass
+            tag("false", nil, current_indent)
+          when Time
+            tag("date", value.utc.strftime('%Y-%m-%dT%H:%M:%SZ'), current_indent)
+          when Date # also catches DateTime
+            tag("date", value.strftime('%Y-%m-%dT%H:%M:%SZ'), current_indent)
+          when String, Symbol
+            tag("string", value, current_indent)
+          when Fixnum, Bignum, Integer
+            tag("integer", value, current_indent)
+          when Float
+            tag("real", value, current_indent)
+        end
+      end
+      
+      def self.indent(number)
+        " " * (number * indent_size) 
+      end
+      
+      def self.array_or_hash?(item)
+        item.is_a?(Hash) or item.is_a?(Array)
+      end
+      
+      def self.tag(name, content=nil, current_indent=0, &block)
+        if content or block_given?
+          new_line = (["array", "dict"].include? name) ? "\n" : ""
+          closing_tag_indent = (new_line != "\n") ? 0 : current_indent
+          indent(current_indent) + "<#{name}>" + new_line +
+          (block_given? ? yield : content).to_s +
+          indent(closing_tag_indent) + "</#{name}>\n"
+        else
+          indent(current_indent) + "<#{name}/>\n" 
+        end
+      end
+    end
+    
+  end
+  
+end
+
+[String, Symbol, Integer, Float, Date, Time, Hash, Array, TrueClass, FalseClass].each do |klass|
+  
+  klass.class_eval do
+
+    def to_plist_xml(current_indent = 0)
+      self.to_plist_xml_unchomped(current_indent).chomp
+    end
+    
+    def to_plist_xml_unchomped(current_indent = 0)
+      Nokogiri::PList::Generator.to_s(self, current_indent)
+    end
+    
+  end
+
+end

data/lib/nokogiri/plist/parser.rb

@@ -0,0 +1,60 @@
+module Nokogiri
+
+  module PList
+      
+    class Parser
+      
+      def parse(xml)
+        @converters = {
+          'integer' => Proc.new { |node| node.content.to_i },
+          'real'    => Proc.new { |node| node.content.to_f },
+          'string'  => Proc.new { |node| node.content.to_s },
+          'date'    => Proc.new { |node| DateTime.parse(node.content) },
+          'true'    => Proc.new { |node| true },
+          'false'   => Proc.new { |node| false },
+          'dict'    => Proc.new { |node| parse_dict node },
+          'array'   => Proc.new { |node| parse_array node },
+          'data'    => Proc.new { |node| node.content }
+        }
+        plist = xml.xpath('/plist').first
+        parse_value_node next_valid_sibling(plist.children.first)
+      end
+      
+      def parse_value_node(value_node)
+        @converters[value_node.name].call(value_node)
+      end
+      
+      def valid_type?(type)
+        not @converters[type].nil?
+      end
+      
+      def valid_node?(node)
+        valid_type?(node.name) or node.name == "key"
+      end
+      
+      def parse_dict(node)
+        node.xpath('./key').inject({}) do |return_value, key_node|
+          return_value[key_node.content] = parse_value_node(next_valid_sibling key_node)
+          return_value
+        end
+      end
+      
+      def parse_array(node)
+        node.children.inject([]) do |return_value, node|
+          return_value << parse_value_node(node) if valid_node? node
+          return_value
+        end
+      end
+      
+      def next_valid_sibling(node)
+        until node.nil? or valid_type? node.name
+          node = node.next_sibling
+        end
+        node
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/nokogiri/plist.rb

@@ -0,0 +1,11 @@
+module Nokogiri  
+  
+  class << self
+    
+    def PList(xml)
+      Nokogiri::PList::Parser.new.parse(Nokogiri::XML(xml))
+    end 
+    
+  end
+  
+end

data/lib/nokogiri/xml/node.rb

@@ -0,0 +1,15 @@
+module Nokogiri  
+  
+  module XML
+    
+    class Node
+      
+      def to_plist
+        Nokogiri::PList::Parser.new.parse(self)
+      end
+      
+    end
+
+  end
+  
+end

data/lib/nokogiri-plist.rb

@@ -0,0 +1,10 @@
+
+require 'nokogiri'
+require 'date'
+
+# TODO: Do this a not so stupid way
+require File.join(File.dirname(__FILE__), 'string')
+require File.join(File.dirname(__FILE__), 'nokogiri', 'plist', 'generator')
+require File.join(File.dirname(__FILE__), 'nokogiri', 'plist', 'parser')
+require File.join(File.dirname(__FILE__), 'nokogiri', 'plist')
+require File.join(File.dirname(__FILE__), 'nokogiri', 'xml', 'node')

data/lib/string.rb

@@ -0,0 +1,7 @@
+String.class_eval do
+  
+  define_method :to_plist do
+    Nokogiri::PList(self)
+  end
+  
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: nokogiri-plist
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Casey Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Allows Nokogiri objects to be converted to PLists
+email: 
+- caseyhoward@caseyhoward.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/nokogiri-plist.rb
+- lib/string.rb
+- lib/nokogiri/plist/parser.rb
+- lib/nokogiri/plist/generator.rb
+- lib/nokogiri/xml/node.rb
+- lib/nokogiri/plist.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/caseyhoward/nokogiri-plist
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: nokogiri-plist
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: PList parsing capabilities built using Nokogiri
+test_files: []
+