plist 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b76cafca96f807c09a6ab294cfbbdb7382d037e3
-  data.tar.gz: 6934d855210d3a9962b3810139061075eec5ef23
+  metadata.gz: 6419e8cb1fbfdc4d07ec54cf7ca8e2baf6ed33af
+  data.tar.gz: a4c8aa0a95cc0ad9bf25b724963ca8493543a015
 SHA512:
-  metadata.gz: 446131557d54d2a68e215ab21ff083a9181a6228e02a6e060b5307927e37c5f2c1fef85cf65317da12e633c59388502b83a85d7d3d5f3170067dd43ddeec72c9
-  data.tar.gz: aa7bfd8345be6d48b86f526df32837e1890114c76c8170c9c88dd1d19042a271a1d619002659badcb7a0dfd8c0a53cacdb9ba0028aedae30c8d265ab9ea2b583
+  metadata.gz: 973b6bed1abafcffd88e4e51bfa8c304ce38b37a60f9d1424e68360ccdb7b749368f13c645fe5827ca63c11396aa45b6f980b8ff2dac56123a86202ad50c00bf
+  data.tar.gz: 623bd3fca1591131ca3cd8d0dc6a683b444f63ed9aec50a3dc257408de93c3686b45ef4484b34fa43d04d9ca118799b0d7af84734e4cc8fa751abd1ca8de24bb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: ruby
+rvm:
+  - ree
+  - jruby-18mode
+  - 1.8.7
+  - jruby-19mode
+  - 1.9.3
+  - 2.0.0-p648 # macOS
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - ruby-head
+  - jruby-head
+before_install: gem install bundler -v '~> 1.14' --conservative

data/{CHANGELOG → CHANGELOG.rdoc}

@@ -1,6 +1,28 @@
 = plist - All-purpose Property List manipulation library
 
-=== Release version 3.0.0!
+=== Unreleased
+
+https://github.com/patsplat/plist/compare/v3.3.0...HEAD
+
+* Your contribution here!
+
+=== 3.3.0 (2017-04-28)
+
+https://github.com/patsplat/plist/compare/dece870...v3.3.0
+
+* Fix ASCII/UTF-8 error (https://github.com/patsplat/plist/pull/38).
+* Fix Fixnum, Bignum deprecations in Ruby 2.4
+* Fix unused variable `e` warning
+
+=== 3.2.0 (2016-01-28)
+
+https://github.com/patsplat/plist/compare/ea0b4e7...dece870
+
+* Changed sort to sort_by in Plist::Emit.plist_node to allow mixed symbol and string hash keys
+* Updated deprecated File.exists? to File.exist?
+* Fixed defect in PData in which exception was thrown when <data/> element was read from plist
+
+=== 3.1.0 (2010-02-23)
 
 2010-02-23:
  * Ruby 1.9.x compatibility!
@@ -24,7 +46,7 @@
 2006-09-20 (r80):
  * tweak a comment in generator.rb to make it clear that we're not using Base64.b64encode because it's broken.
 
-=== Release version 3.0.0!
+=== 3.0.0 (2006-09-20)
 
 2006-09-20 (r77 - r79):
  * move IndentedString inside Plist::Emit and :nodoc: it
@@ -56,6 +78,8 @@
 * Sort hash keys before emitting (now we can test multi-element hashes!)
 * Inject #<=> into Symbol so that sorting Symbol-keyed hashes won't freak out
 
+=== 2.1.2 (2006-09-20)
+
 2006-09-12 (r47 - r51):
 * More test rejiggering
 * New tests to expose some bugs
@@ -68,7 +92,7 @@
 * Make the parser strip out comments and Marshal.load <data> elements if possible
 * Update some rdoc
 
-=== Release version 2.1.1!
+=== 2.1.1 (2006-09-10)
 
 2006-09-10 (r31 - r32):
 * Added encoding / decoding for entities (&amp; etc)

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in plist.gemspec
+gemspec

data/README.rdoc

@@ -1,5 +1,8 @@
 = All-purpose Property List manipulation library
 
+{<img src="https://badge.fury.io/rb/plist.svg" alt="Gem Version" />}[https://rubygems.org/gems/plist]
+{<img src="https://travis-ci.org/patsplat/plist.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/patsplat/plist]
+
 Plist is a library to manipulate Property List files, also known as plists.  It can parse plist files into native Ruby data structures as well as generating new plist files from your Ruby objects.
 
 == Usage

data/Rakefile

@@ -1,154 +1,10 @@
-#
-# Plist Rakefile
-#
-# Based heavily on Geoffrey Grosenbach's Rakefile for gruff.
-# Includes whitespace-fixing task based on code from Typo.
-#
-# Copyright 2006-2010 Ben Bleything and Patrick May
-# Distributed under the MIT License
-#
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-require 'fileutils'
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/contrib/rubyforgepublisher'
-require 'rubygems/package_task'
-
-$:.unshift(File.dirname(__FILE__) + "/lib")
-require 'plist'
-
-PKG_NAME      = 'plist'
-PKG_VERSION   = Plist::VERSION
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-
-RELEASE_NAME  = "REL #{PKG_VERSION}"
-
-RUBYFORGE_PROJECT = "plist"
-RUBYFORGE_USER    = ENV['RUBYFORGE_USER']
-
-TEST_FILES    = Dir.glob('test/test_*')
-TEST_ASSETS   = Dir.glob('test/assets/*')
-LIB_FILES     = Dir.glob('lib/**/*')
-RELEASE_FILES = [ "Rakefile", "README.rdoc", "CHANGELOG", "LICENSE" ] + LIB_FILES + TEST_FILES + TEST_ASSETS
-
-task :default => [ :test ]
-# Run the unit tests
-Rake::TestTask.new { |t|
+Rake::TestTask.new(:test) do |t|
   t.libs << "test"
-  t.test_files = TEST_FILES
-  t.verbose = true
-}
-
-desc "Clean pkg, coverage, and rdoc; remove .bak files"
-task :clean => [ :clobber_rdoc, :clobber_package, :clobber_coverage ] do
-  puts cmd = "find . -type f -name *.bak -delete"
-  `#{cmd}`
-end
-
-task :clobber_coverage do
-  puts cmd = "rm -rf coverage"
-  `#{cmd}`
-end
-
-desc "Generate coverage analysis with rcov (requires rcov to be installed)"
-task :rcov => [ :clobber_coverage ] do
-  puts cmd = "rcov -Ilib --xrefs -T test/*.rb"
-  puts `#{cmd}`
-end
-
-desc "Strip trailing whitespace and fix newlines for all release files"
-task :fix_whitespace => [ :clean ] do
-  RELEASE_FILES.reject {|i| i =~ /assets/}.each do |filename|
-    next if File.directory? filename
-
-    File.open(filename) do |file|
-      newfile = ''
-      needs_love = false
-
-      file.readlines.each_with_index do |line, lineno|
-        if line =~ /[ \t]+$/
-          needs_love = true
-          puts "#{filename}: trailing whitespace on line #{lineno}"
-          line.gsub!(/[ \t]*$/, '')
-        end
-
-        if line.chomp == line
-          needs_love = true
-          puts "#{filename}: no newline on line #{lineno}"
-          line << "\n"
-        end
-
-        newfile << line
-      end
-
-      if needs_love
-        tempname = "#{filename}.new"
-
-        File.open(tempname, 'w').write(newfile)
-        File.chmod(File.stat(filename).mode, tempname)
-
-        FileUtils.ln filename, "#{filename}.bak"
-        FileUtils.ln tempname, filename, :force => true
-        File.unlink(tempname)
-      end
-    end
-  end
-end
-
-desc "Copy documentation to rubyforge"
-task :update_rdoc => [ :rdoc ] do
-  Rake::SshDirPublisher.new("#{RUBYFORGE_USER}@rubyforge.org", "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}", "rdoc").upload
-end
-
-begin
-  require 'rdoc/task'
-
-  # Generate the RDoc documentation
-  RDoc::Task.new do |rdoc|
-    rdoc.title = "All-purpose Property List manipulation library"
-    rdoc.main  = "README.rdoc"
-
-    rdoc.rdoc_dir = 'rdoc'
-    rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'CHANGELOG')
-    rdoc.rdoc_files.include('lib/**')
-
-    rdoc.options = [
-      '-H', # show hash marks on method names in comments
-      '-N', # show line numbers
-    ]
-  end
-rescue LoadError
-  $stderr.puts "Could not load rdoc tasks"
-end
-
-# Create compressed packages
-spec = Gem::Specification.new do |s|
-  s.name    = PKG_NAME
-  s.version = PKG_VERSION
-
-  s.summary     = "All-purpose Property List manipulation library."
-  s.description = <<-EOD
-Plist is a library to manipulate Property List files, also known as plists.  It can parse plist files into native Ruby data structures as well as generating new plist files from your Ruby objects.
-EOD
-
-  s.authors  = "Ben Bleything and Patrick Way"
-  s.homepage = "http://plist.rubyforge.org"
-
-  s.rubyforge_project = RUBYFORGE_PROJECT
-
-  s.has_rdoc = true
-
-  s.files      = RELEASE_FILES
-  s.test_files = TEST_FILES
-
-  s.autorequire = 'plist'
-end
-
-Gem::PackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  p.need_tar = true
-  p.need_zip = true
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
 end
 
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "plist"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/plist.rb

@@ -1,5 +1,5 @@
-#!/usr/bin/env ruby
-#
+# encoding: utf-8
+
 # = plist
 #
 # This is the main file for plist. Everything interesting happens in
@@ -15,7 +15,7 @@ require 'stringio'
 
 require 'plist/generator'
 require 'plist/parser'
+require 'plist/version'
 
 module Plist
-  VERSION = '3.2.0'
 end

data/lib/plist/generator.rb

@@ -1,12 +1,12 @@
-#!/usr/bin/env ruby
-#
+# encoding: utf-8
+
 # = plist
 #
 # Copyright 2006-2010 Ben Bleything and Patrick May
 # Distributed under the MIT License
 #
 
-module Plist ; end
+module Plist; end
 
 # === Create a plist
 # You can dump an object to a plist in one of two ways:
@@ -94,7 +94,7 @@ module Plist::Emit
         output << tag('date', element.utc.strftime('%Y-%m-%dT%H:%M:%SZ'))
       when Date # also catches DateTime
         output << tag('date', element.strftime('%Y-%m-%dT%H:%M:%SZ'))
-      when String, Symbol, Fixnum, Bignum, Integer, Float
+      when String, Symbol, Integer, Float
         output << tag(element_type(element), CGI::escapeHTML(element.to_s))
       when IO, StringIO
         element.rewind
@@ -159,7 +159,7 @@ module Plist::Emit
     when String, Symbol
       'string'
 
-    when Fixnum, Bignum, Integer
+    when Integer
       'integer'
 
     when Float

data/lib/plist/parser.rb

@@ -1,5 +1,5 @@
-#!/usr/bin/env ruby
-#
+# encoding: utf-8
+
 # = plist
 #
 # Copyright 2006-2010 Ben Bleything and Patrick May
@@ -73,10 +73,10 @@ module Plist
     end
 
     TEXT       = /([^<]+)/
-    XMLDECL_PATTERN = /<\?xml\s+(.*?)\?>*/um
-    DOCTYPE_PATTERN = /\s*<!DOCTYPE\s+(.*?)(\[|>)/um
-    COMMENT_START = /\A<!--/u
-    COMMENT_END = /.*?-->/um
+    XMLDECL_PATTERN = /<\?xml\s+(.*?)\?>*/m
+    DOCTYPE_PATTERN = /\s*<!DOCTYPE\s+(.*?)(\[|>)/m
+    COMMENT_START = /\A<!--/
+    COMMENT_END = /.*?-->/m
 
 
     def parse
@@ -91,7 +91,14 @@ module Plist
         if @scanner.scan(COMMENT_START)
           @scanner.scan(COMMENT_END)
         elsif @scanner.scan(XMLDECL_PATTERN)
+          encoding = parse_encoding_from_xml_declaration(@scanner[1])
+          next if encoding.nil?
+
+          # use the specified encoding for the rest of the file
+          next unless String.method_defined?(:force_encoding)
+          @scanner.string = @scanner.rest.force_encoding(encoding)
         elsif @scanner.scan(DOCTYPE_PATTERN)
+          next
         elsif @scanner.scan(start_tag)
           @listener.tag_start(@scanner[1], nil)
           if (@scanner[2] =~ /\/$/)
@@ -106,6 +113,22 @@ module Plist
         end
       end
     end
+
+    private
+
+    def parse_encoding_from_xml_declaration(xml_declaration)
+      return unless defined?(Encoding)
+
+      xml_encoding = xml_declaration.match(/(?:\A|\s)encoding=(?:"(.*?)"|'(.*?)')(?:\s|\Z)/)
+
+      return if xml_encoding.nil?
+
+      begin
+        Encoding.find(xml_encoding[1])
+      rescue ArgumentError
+        nil
+      end
+    end
   end
 
   class PTag
@@ -213,7 +236,7 @@ module Plist
       data = Base64.decode64(text.gsub(/\s+/, '')) unless text.nil?
       begin
         return Marshal.load(data)
-      rescue Exception => e
+      rescue Exception
         io = StringIO.new
         io.write data
         io.rewind

data/lib/plist/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Plist
+  VERSION = '3.3.0'.freeze
+end

data/plist.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "plist/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "plist"
+  spec.version       = Plist::VERSION
+  spec.authors       = ["Ben Bleything", "Patrick May"]
+
+  spec.summary       = "All-purpose Property List manipulation library"
+  spec.description   = "Plist is a library to manipulate Property List files, "\
+                       "also known as plists. It can parse plist files into "\
+                       "native Ruby data structures as well as generating new "\
+                       "plist files from your Ruby objects."
+  spec.homepage      = "https://github.com/patsplat/plist"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "test-unit", "~> 1.2"
+end