marcandre-packable 1.1.3 → 1.2.0

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Packable --- History
 
+== Version 1.2 - April 2nd, 2009
+Compatible with ruby 1.9.1.
+The 'jungle_survival_kit' is now in its own 'backports' gem.
+
 == Version 1.1 - December 17, 2008
 Fixed bug when packing objects implementing to_ary
 Added inheritance of shortcuts & filters to documentation

data/LICENSE

@@ -0,0 +1,26 @@
+# packable library
+# Copyright (c) 2008, Marc-André Lafortune.
+# All rights reserved.
+# Licensed under the terms of the (modified) BSD License below:
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of the author nor the
+#       names of its contributors may be used to endorse or promote products
+#       derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -49,7 +49,9 @@ Get the gem:
   
 That's it! Simply <tt>require 'packable'</tt> in your code to use it.
 
-Compatibility: Ruby 1.8, 1.9
+== Compatibility
+
+Designed to work with ruby 1.8 & 1.9.
 
 = Documentation
 

data/VERSION.yml

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

data/lib/packable/extensions/io.rb

@@ -1,4 +1,5 @@
 require 'enumerator'
+Enumerator = Enumerable::Enumerator unless defined?(Enumerator)
 
 module Packable
   module Extensions #:nodoc:
@@ -37,6 +38,7 @@ module Packable
       # Returns (or yields) a modified IO object that will always pack/unpack when writing/reading.
       def packed
         packedio = clone
+        packedio.set_encoding("ascii-8bit") if packedio.respond_to? :set_encoding 
         class << packedio
           def << (arg)
             arg = [arg, :default] unless arg.instance_of?(::Array)
@@ -53,7 +55,7 @@ module Packable
 
       def each_with_packing(*options, &block)
         return each_without_packing(*options, &block) if (Integer === options.first) || (String === options.first)
-        return Enumerable::Enumerator.new(self, :each_with_packing, *options) unless block_given?
+        return Enumerator.new(self, :each_with_packing, *options) unless block_given?
         yield read(*options) until eof?
       end
 
@@ -62,8 +64,8 @@ module Packable
       end
     
       def read_with_packing(*arg)
-        return read_without_packing(*arg) if (arg.length == 0) || arg.first.is_a?(Numeric)
-        return *Packable::Packers.to_class_option_list(*arg).map do |klass, options, original|
+        return read_without_packing(*arg) if (arg.length == 0) || (arg.first.is_a?(Numeric) && (arg.length == 1))
+        values = Packable::Packers.to_class_option_list(*arg).map do |klass, options, original|
           if eof?
             raise EOFError, "End of IO when attempting to read #{klass} with options #{original.inspect}" if @throw_on_eof
             nil
@@ -73,6 +75,7 @@ module Packable
             klass.read_packed(self, options)
           end
         end
+        return values.size > 1 ? values : values.first
       end
       
       def pack_and_write(*arg)

data/lib/packable/packers.rb

@@ -53,6 +53,7 @@ module Packable
       until arg.empty? do
         k, options = original = arg.shift
         k, options = global_lookup(k) if k.is_a? Symbol
+        raise TypeError, "Expected a class or symbol: #{k.inspect}" unless k.instance_of? Class
         options ||= arg.first.is_a?(Hash) ? arg.shift.tap{|o| original = [original, o]} : :default
         r << [k, k.packers.finalize(options), original]
       end

data/lib/packable.rb

@@ -1,5 +1,5 @@
-require File.dirname(__FILE__)+'/packable/jungle_survival_kit'
-
+require 'rubygems'
+require 'backports'
 require_relative 'packable/packers'
 require_relative 'packable/mixin'
 [Object, Array, String, Integer, Float, IO, Proc].each do |klass|

data/test/packing_doc_test.rb

@@ -42,6 +42,7 @@ class PackableDocTest < Test::Unit::TestCase
   		p.set :app_type, :creator
   		p.set :default, {} # Reset to a sensible default...
       p.set :merge_all, :fill => " "
+      p.set :eigth_bytes, :bytes => 8
   	end
     
     assert_equal "hello".pack(:app_type), "hell"

data/test/packing_test.rb

@@ -50,13 +50,18 @@ class TestingPack < Test::Unit::TestCase
   end
   
   def test_io
-    io = StringIO.new("\000\000\000\006abcd!")
-    n, s = io >> [Fixnum, {:signed=>false}] >> [String, {:bytes => 4}]
-    assert_equal n, 6
-    assert_equal s, "abcd"
+    io = StringIO.new("\000\000\000\006abcdE!")
+    n, s, c = io >> [Fixnum, {:signed=>false}] >> [String, {:bytes => 4}] >> :char
+    assert_equal 6, n
+    assert_equal "abcd", s
+    assert_equal 69, c
     assert_equal "!", io.read
   end
   
+  should "do basic type checking" do
+    assert_raise(TypeError) {"".unpack(42, :short)}
+  end
+  
   context "Filters" do
     context "for Object" do
       Object.packers.set :generic_class_writer do |packer|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marcandre-packable
 version: !ruby/object:Gem::Version 
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors: 
 - "Marc-Andr\xC3\xA9 Lafortune"
@@ -9,18 +9,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-19 00:00:00 -08:00
+date: 2009-04-02 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: marcandre-backports
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: If you need to do read and write binary data, there is of course <Array::pack and String::unpack The packable library makes (un)packing nicer, smarter and more powerful.
 email: github@marc-andre.ca
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
 files: 
 - CHANGELOG.rdoc
 - README.rdoc
@@ -34,13 +44,13 @@ files:
 - lib/packable/extensions/object.rb
 - lib/packable/extensions/proc.rb
 - lib/packable/extensions/string.rb
-- lib/packable/jungle_survival_kit.rb
 - lib/packable/mixin.rb
 - lib/packable/packers.rb
 - lib/packable.rb
 - test/packing_doc_test.rb
 - test/packing_test.rb
 - test/test_helper.rb
+- LICENSE
 has_rdoc: true
 homepage: http://github.com/marcandre/packable
 post_install_message: 
@@ -51,6 +61,8 @@ rdoc_options:
 - README.rdoc
 - --line-numbers
 - --inline-source
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -67,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: marcandre
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2

data/lib/packable/jungle_survival_kit.rb

@@ -1,72 +0,0 @@
-# Insures that the following basic utilities (standard with ruby 1.9 and/or rails) are defined
-# so we can get out of the uncivilized jungle (straight ruby 1.8) alive:
-# - +require_relative+
-# - +try+
-# - +tap+
-# - +alias_method_chain+
-# - &:some_symbol
-
-# Standard in ruby 1.9. Adapted from Pragmatic's "Programming Ruby" (since their version was buggy...)
-module Kernel
-  def require_relative(relative_feature) 
-    file = caller.first.split(/:\d/,2).first
-    if /\A\((.*)\)/ =~ file # eval, etc. 
-      raise LoadError, "require_relative is called in #{$1}" 
-    end 
-    require File.expand_path(relative_feature, File.dirname(file))
-  end unless method_defined? :require_relative
-end
-
-class Object
-  # Standard in rails...
-  def try(method_id, *args, &block)
-    send(method_id, *args, &block) if respond_to?(method_id, true)
-  end unless method_defined? :try
-
-  # Standard in ruby 1.9
-  def tap
-    yield self
-    self
-  end unless method_defined? :tap
-end
-
-class Module
-  # Standard in rails...
-  def alias_method_chain(target, feature)
-    # Strip out punctuation on predicates or bang methods since
-    # e.g. target?_without_feature is not a valid method name.
-    aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
-    yield(aliased_target, punctuation) if block_given?
-    
-    with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"
-    
-    alias_method without_method, target
-    alias_method target, with_method
-    
-    case
-      when public_method_defined?(without_method)
-        public target
-      when protected_method_defined?(without_method)
-        protected target
-      when private_method_defined?(without_method)
-        private target
-    end
-  end unless method_defined? :alias_method_chain
-end
-
-# Standard in ruby 1.9 & rails
-unless :to_proc.respond_to?(:to_proc)
-  class Symbol
-    # Turns the symbol into a simple proc, which is especially useful for enumerations. Examples:
-    #
-    #   # The same as people.collect { |p| p.name }
-    #   people.collect(&:name)
-    #
-    #   # The same as people.select { |p| p.manager? }.collect { |p| p.salary }
-    #   people.select(&:manager?).collect(&:salary)
-    def to_proc
-      Proc.new { |*args| args.shift.__send__(self, *args) }
-    end
-  end
-end
-