plist4r 0.2.2 → 1.0.0

data/lib/plist4r/backend/test/harness.rb

@@ -0,0 +1,255 @@
+
+require 'plist4r/backend/test/data_types'
+require 'benchmark'
+require 'plist4r/mixin/ruby_stdlib'
+require 'plist4r/mixin/haml4r/table'
+
+module Plist4r
+
+  class Backend
+    module Test
+
+      class Harness < Plist4r::Backend
+        def initialize *args, &blk
+
+          @backends = Dir.glob(File.dirname(__FILE__) + "/../../backend/*.rb").collect {|b| File.basename(b,".rb") }
+          @backends.flatten!
+          @backends.uniq!
+          @backends = @backends - ["example"]
+
+          @data_types = DataTypes.new
+        end
+
+        ReferenceBackends = {
+          :from_xml => :libxml4r,
+          :to_xml   => :haml,
+          :from_binary => :c_f_property_list,
+          :to_binary   => :c_f_property_list,
+          # :from_binary => :ruby_cocoa,
+          # :to_binary   => :ruby_cocoa,
+          :from_binary => :osx_plist,
+          :to_binary   => :osx_plist,
+        }
+
+        def reference_backend_for meth
+          ReferenceBackends[meth]
+        end
+
+        def results
+          @results
+        end
+
+        def run_tests
+
+          ref_strings = {}
+          ref_string_1024 = {}
+
+          cols = [:from, :to].size + [:xml, :binary].size
+          rows = @backends.size
+
+          t = Haml4r::Table.new :size => [0..cols-1, 0..rows-1]
+
+          t.col_header.size [0..cols-1, 0]
+          t.row_header.size [0, 0..rows-1]
+
+          # t.css_style = "border-spacing: 5px;"
+          c2 = "#F5F5FF"
+          c1 = "#FAFAFA"
+          cpv = 5
+          cph = 15
+          t.cells.css_style            = "padding: #{cpv}px; padding-left: #{cph}px; padding-right: #{cph}px; background-color: #{c1}; text-align: center"
+          t.col_header.cells.css_style = "padding: #{cpv}px; padding-left: #{cph}px; padding-right: #{cph}px; background-color: #{c2}; text-align: center"
+          t.row_header.cells.css_style = "padding: #{cpv}px; padding-left: #{cph}px; padding-right: #{cph}px; background-color: #{c2}; text-align: right"
+
+          bhi = 0
+          @backends.each do |b_sym|
+            t.row_header.cell(0, bhi).content = "#{b_sym}"
+            bhi += 1
+          end
+
+          chi = 0
+          [:xml, :binary].each do |fmt|
+            [:from, :to].each do |op|
+              t.col_header.cell(chi, 0).content = ":#{op}_#{fmt}"
+              chi += 1
+            end
+          end
+
+          cgi = 0
+          [:xml, :binary].each do |fmt|
+            puts ""
+            puts fmt.inspect
+            puts ""
+            # setup reference test data
+            api_sym = "to_#{fmt}".to_sym
+            ref_strings[fmt] = Plist4r::OrderedHash.new
+            @data_types.plists.each_pair do |key,plist|
+              plist.backends [reference_backend_for(api_sym)]
+              ref_strings[fmt][key] = plist.send(api_sym)
+            end
+
+            @data_types.plist_1024.backends [reference_backend_for(api_sym)]
+            ref_string_1024[fmt] = @data_types.plist_1024.send(api_sym)
+
+
+            ri = 0
+            @backends.each do |b_sym|
+              ci = cgi
+
+              backend = eval "::Plist4r::Backend::#{b_sym.to_s.camelcase}"
+              if backend.respond_to? "from_#{fmt}"
+                failures = []
+                ref_strings[fmt].each_pair do |sym,string|
+                  begin
+                    plist_result = Plist4r.new :backends => [b_sym], :from_string => string                
+                    if @data_types.plists[sym].to_hash == plist_result.to_hash
+                      puts "match, #{b_sym}, #{sym}" if sym == :data
+                      # puts @data_types.plists[sym].hash.inspect
+                      # puts plist_result.hash.inspect
+                      # puts @data_types.plists[sym].to_hash["DataKeyW"].hash.inspect
+                      # puts plist_result.to_hash["DataKeyW"].hash.inspect
+                    else
+                      puts "fail, #{b_sym}, #{sym}" if sym == :data
+
+                      if sym == :data
+                        puts "expected:"
+                        puts @data_types.plists[sym].hash.inspect
+                        puts @data_types.plists[sym].to_hash.inspect
+                        # puts @data_types.plists[sym].to_hash["DataKeyW"].read.inspect
+                        # @data_types.plists[sym].to_hash["DataKeyW"].rewind
+                        # puts @data_types.plists[sym].to_hash["DataKeyW"].read.inspect
+                        puts "got:"
+                        puts plist_result.hash.inspect
+                        puts plist_result.to_hash.inspect
+                        # puts plist_result.to_xml if b_sym == "ruby_cocoa"
+                      end
+                    end
+                  rescue
+                    puts "fail, #{b_sym}, #{sym} - exception"
+                    failures << sym
+                  end
+                end
+                if failures.empty?
+                  time = Benchmark.measure { plist_result = Plist4r.new :backends => [b_sym], :from_string => ref_string_1024[fmt] }.real
+                  tms = (time*1000).round(1).to_s
+                  # puts "  :from_#{fmt} - time for 1024 keys = " + (time*1000).round(1).to_s + " ms"
+                  t.cell(ci, ri).content = "#{tms} ms"
+                else
+                  t.cell(ci, ri).content = "Failed #{failures.inspect}"
+                end
+                
+              else
+                # puts "  not implemented, :from_#{fmt}"
+                t.cell(ci, ri).content = "n/a"
+              end
+              ci += 1
+
+
+              if backend.respond_to? "to_#{fmt}"
+                failures = []
+                @data_types.plists.each_pair do |sym,ref_plist|
+                    begin
+                      plist = Plist4r.new :backends => [b_sym]
+                      plist.instance_eval "@hash = ref_plist.to_hash"
+                      
+                      # puts "was: to_#{fmt}, #{b_sym} - #{sym.inspect}" if [:data, :bool].include?(sym)
+                      # puts plist.to_binary.inspect if [:data, :bool].include?(sym)
+                      # puts "should be:"
+                      # 
+                      # puts "sepr char: #{plist.to_binary[20].chr.inspect}, last int #{plist.to_binary[20].inspect}," if sym == :data
+                      # puts "last char: #{plist.to_binary[plist.to_binary.length-1].chr.inspect}, last int #{plist.to_binary[plist.to_binary.length-1].inspect}," if sym == :data
+
+                      plist_gen_from = Plist4r.new :from_string => plist.send("to_#{fmt}"),
+                                        :backends => [reference_backend_for("from_#{fmt}".to_sym)]
+
+                      if plist_gen_from.to_hash == plist.to_hash
+                          puts "match, #{b_sym}, #{sym}" if sym == :data
+                          # puts plist.hash.inspect
+                          # puts plist_gen_from.hash.inspect
+                          if sym == :data
+                            if b_sym == "ruby_cocoa"
+                              # plist_gen_from.to_hash.keys.each do |key|
+                              # puts "point a"
+                              # plist.to_hash.keys.each do |key|
+                              #   puts "key hash mismatch: #{key.inspect}" unless plist.to_hash[key].hash == plist_gen_from.to_hash[key].hash
+                              # end
+                              # puts "key hash mismatch: keys differ" unless plist.to_hash.keys == plist_gen_from.to_hash.keys
+                              # puts "point b"
+                              # puts plist.to_hash["DataKeyW"].hash.inspect
+                              # puts plist_gen_from.to_hash["DataKeyW"].hash.inspect
+
+
+                              # puts "expected:"
+                              # puts plist.to_hash.inspect
+                              # puts "got:"
+                              # puts plist_gen_from.to_hash.inspect
+                            end
+                          end
+                      else
+                        puts "fail, #{b_sym}, #{sym}" if sym == :data
+                        if sym == :data
+                          puts "expected:"
+                          puts plist.to_hash.inspect
+                          puts "got:"
+                          puts plist_gen_from.to_hash.inspect
+                        end
+                      end
+                    rescue
+                      puts "fail, #{b_sym}, #{sym} - exception"
+
+                      begin
+                        # what went wrong?
+                        if fmt == :binary
+                          puts "to_#{fmt}, #{b_sym} - for #{sym.inspect}. (1)was, (2)should be:"
+                          plist = Plist4r.new :backends => [b_sym]
+                          plist.instance_eval "@hash = ref_plist.to_hash"
+                          puts plist.to_binary.inspect
+                        
+                          plist = Plist4r.new :backends => [ReferenceBackends["to_#{fmt}".to_sym]]
+                          plist.instance_eval "@hash = ref_plist.to_hash"
+                          puts plist.to_binary.inspect
+                        end
+                      rescue
+                      end
+                      failures << sym
+                    end
+                  end
+                  if failures.empty?
+                    plist = Plist4r.new :backends => [b_sym]
+                    plist_1024 = @data_types.plist_1024
+                    plist.instance_eval "@hash = plist_1024.to_hash"
+                    time = Benchmark.measure { eval "plist.to_#{fmt}" }.real
+                    tms = (time*1000).round(1).to_s
+                    # puts "  :to_#{fmt}   - time for 1024 keys = " + (time*1000).round(1).to_s + " ms"
+                    t.cell(ci, ri).content = "#{tms} ms"
+                  else
+                    t.cell(ci, ri).content = "Failed #{failures.inspect}"
+                  end
+              else
+                # puts "  not implemented, :to_#{fmt}"
+                t.cell(ci, ri).content = "n/a"
+              end
+
+              # puts ""
+              ri += 1
+            end
+
+            cgi += 2
+          end
+          puts ""
+          puts "REFERENCE BACKENDS"
+          puts "=================="
+          ReferenceBackends.each do |sym,b_sym|
+            puts "#{sym.inspect} generated by #{b_sym.inspect}"
+          end
+          puts ""
+          puts t.inspect
+          @results = t
+        end
+
+
+
+      end
+    end
+  end
+end

data/lib/plist4r/backend/test/output.rb

@@ -0,0 +1,47 @@
+
+require 'plist4r/backend/test/harness'
+
+module Plist4r
+  class Backend
+    module Test
+      class Output
+
+        def haml
+          @haml ||= <<-'EOC'
+%h1 Backends
+%div
+  %p Documentation for the Plist4r backend modules - please see <tt><a href="Plist4r/Backend.html" target="_self" title="Plist4r::Backend (class)">Plist4r::Backend</a></tt>
+  %h3 Performance
+  %p Time elapsed for encoding / decoding a non-flat (nested) plist structure of 1024 keys
+  %p Real elapsed time based on - 2GHz Intel Core Duo with 2GB Ram
+  %p Ruby Enterprise Edition (REE) 1.8.7 p248, Mac OS-X 10.6.3
+  = @test_harness.results
+  %p To re-run the backend tests
+  %pre{ :class => "code" } $ cd plist4r && rake backend:tests
+%p
+EOC
+        end
+
+        def to_s
+          require 'haml'
+          engine = ::Haml::Engine.new self.haml
+          rendered_html_output = engine.render self
+        end
+
+        def initialize *args, &blk
+          @test_harness = Plist4r::Backend::Test::Harness.new
+          @test_harness.run_tests
+        end
+
+        def write_html_file
+          docs_dir = File.dirname(__FILE__) + "/../../../../lib/plist4r/docs"
+          File.open "#{docs_dir}/Backends.html","w" do |o|
+            o << to_s
+          end
+        end
+
+      end
+    end
+  end
+end
+

data/lib/plist4r/backend_base.rb

@@ -1,3 +1,5 @@
 
-module Plist4r end
-class Plist4r::Backend; end
+module Plist4r
+  class Backend
+  end
+end

data/lib/plist4r/{options.rb → cli.rb}

@@ -2,7 +2,7 @@ require 'plist4r/mixin/mixlib_cli'
 require 'plist4r/mixin/mixlib_config'
 
 module Plist4r
-  # Defines options for the `plist4r` command line utility
+  # Defines options for the +plist4r+ command line utility
   class CLI
     include Plist4r::Mixlib::CLI
 
@@ -35,6 +35,7 @@ module Plist4r
     end
     plist4r_cli_options
     
+    # @yield Some block to yield
     def parse argv=ARGV
       parse_options(argv)
       config

data/lib/plist4r/commands.rb

@@ -21,9 +21,10 @@ module Plist4r
       end
     end
 
-    # Implements the `plist4r --ruby-lib` subcommand.
+    # Implements the +plist4r --ruby-lib+ subcommand.
     # @see Plist4r::CLI
     def ruby_lib
+      plist4r_root = File.expand_path "../../", File.dirname(__FILE__)
       plist4r_lib = File.expand_path "../../lib", File.dirname(__FILE__)
       dest = File.expand_path(Plist4r::Config[:args][:dir] || FileUtils.pwd)
 
@@ -33,23 +34,27 @@ module Plist4r
       FileUtils.mkdir_p dest
       FileUtils.rm_rf "#{dest}/plist4r"
       FileUtils.cp_r Dir.glob("#{plist4r_lib}/*"), dest
+      FileUtils.cp_r Dir.glob("#{plist4r_root}/VERSION"), "#{dest}/plist4r"
       
       if Plist4r::Config[:args][:brew]
         backends = Dir.glob "#{dest}/plist4r/backend/*"
+        docs = Dir.glob "#{dest}/plist4r/docs*"
+        haml4r = Dir.glob "#{dest}/plist4r/mixin/haml4r*"
         non_brew_files = [
+          "#{dest}/plist4r/application.rb",
           backends - ["#{dest}/plist4r/backend/ruby_cocoa.rb"],
-          "#{dest}/plist4r/mixin/mixlib_cli.rb",
-          "#{dest}/plist4r/options.rb",
+          "#{dest}/plist4r/cli.rb",
           "#{dest}/plist4r/commands.rb",
-          "#{dest}/plist4r/application.rb",
-          # "#{dest}/plist4r/",
+          docs,
+          haml4r,
+          "#{dest}/plist4r/mixin/mixlib_cli.rb",
+          "#{dest}/plist4r/mixin/script.rb",
+          "#{dest}/plist4r/mixin/table.rb",
         ].flatten
         FileUtils.rm_rf(non_brew_files)
 
         config = File.read "#{dest}/plist4r/config.rb"
-        config.gsub! /\n(\s*)backends \[.*\](\s*)\n/ do |match|
-          "\n#{$1}backends [\"ruby_cocoa\"]#{$2}\n"
-        end
+        config.gsub! /backends default_backends/,"backends default_backends :brew"
 
         File.open("#{dest}/plist4r/config.rb",'w') do |o|
           o << config

data/lib/plist4r/config.rb

@@ -1,7 +1,8 @@
 
 require 'plist4r/mixin/mixlib_config'
 require 'plist4r/backend'
-Dir.glob(File.dirname(__FILE__) + "/backend/**/*.rb").each {|b| require File.expand_path b}
+
+Dir.glob(File.dirname(__FILE__) + "/backend/*.rb").each {|b| require File.expand_path b}
 
 module Plist4r
 
@@ -12,10 +13,10 @@ module Plist4r
   # Plist4r::Config[:backends].reverse!
   # 
   # # Set the default folder from which to load / save plist files
-  # Plist4r::Config[:default_path] "/path/to/my/plist/files"
+  # Plist4r::Config[:default_path] = "/path/to/my/plist/files"
   # 
   # # Save new plist files as binary plists (when format not known)
-  # Plist4r::Config[:default_format] :binary
+  # Plist4r::Config[:default_format] = :binary
   # 
   # # Add custom / application specific Plist Type. You'll also need to subclass {Plist4r::PlistType}
   # Expects class Plist4r::PlistType::MyPlistType to be defined
@@ -23,20 +24,46 @@ module Plist4r
   # Plist4r::Config[:types] << "my_plist_type"
   # 
   # # Raise an exception plist keys which dont belong to the selected Plist type
-  # Plist4r::Config[:strict_keys] true
+  # Plist4r::Config[:strict_keys] = true
   class Config
     extend Mixlib::Config
 
-    types [] << Dir.glob(File.dirname(__FILE__) + "/plist_type/**/*.rb").collect {|b| File.basename(b,".rb") }
+    CoreFoundationFramework = "/System/Library/Frameworks/CoreFoundation.framework"
+    RubycocoaFramework      = "/System/Library/Frameworks/RubyCocoa.framework"
+
+    DefaultBackendsAny = ["c_f_property_list","haml","libxml4r"]
+    DefaultBackendsOsx = ["osx_plist","c_f_property_list","haml","libxml4r"]
+    
+    def self.default_backends sym=nil
+      case sym
+      when :brew
+        ["ruby_cocoa"]
+      else
+        if File.exists? CoreFoundationFramework
+          if File.exists? RubycocoaFramework
+            DefaultBackendsOsx + ["ruby_cocoa"]
+          else
+            DefaultBackendsOsx
+          end
+        else
+          DefaultBackendsAny
+        end
+      end
+    end
+
+    types [] << Dir.glob(File.dirname(__FILE__) + "/plist_type/*.rb").collect {|b| File.basename(b,".rb") }
     types.flatten!.uniq!
     
-    backends ["ruby_cocoa","haml","libxml4r"]
-    backends << Dir.glob(File.dirname(__FILE__) + "/backend/**/*.rb").collect {|b| File.basename(b,".rb") }
+    backends default_backends
+    backends << Dir.glob(File.dirname(__FILE__) + "/backend/*.rb").collect {|b| File.basename(b,".rb") }
     backends.flatten!.uniq!
+    backends.delete "example"
+
+    backend_timeout 15
 
     strict_keys false
-    raise_any_failure true
-    deafult_format :xml
+    raise_any_failure false
+    default_format :xml
     default_path nil
   end
 end