packable 1.3.8 → 1.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9ff119e7cc22b81b365a6b56bfea0f5361cd4171
-  data.tar.gz: 76cff9e8574909266778c4164035e54e41319439
+SHA256:
+  metadata.gz: 010ee6e2262aa7ea8e3bccde2fa58a80afd1ba4356678c0456a638091cc50f97
+  data.tar.gz: 357c44f3a0252815976df5c4ac2260dabe87fb4d907546d1d8380fb37f714ae5
 SHA512:
-  metadata.gz: 771b79907fda443f469cdbadcdc05f1740c1c0666bb55ed6cec5589d9061df758a0a4b4c7f0929adb0375422172bddd61eb2b2a11cf5654c361d67b2011ea103
-  data.tar.gz: 1cd0a39beeb41566bc721d25ff64abe2fa7401bb0e39544893f81e3da3b91dcc4ff0e2a9c306521fd1dec6ef631e416a06fbd2cbabe35fb0cf7800ffbc9355d7
+  metadata.gz: 34a8168ef33d77d73dfd27156db34a95e0787900611d5c88878c07953239d80a5e4ec57002057f044ca2fcfa3879295de67206f50e730395c264f84d0cbdcacd
+  data.tar.gz: 8619bf57c88279a4d5a852b6a3a7810495881665da8e160ffb7bbcd7b3fc7920e18ade6f50641d19ae341be5fd65447608f06260bc9f7543231a6e7f336d9289

data/README.rdoc

@@ -1,7 +1,7 @@
-*Note*: SciRuby are taking over maintenance for this library: https://github.com/SciRuby/packable
-
 = Packable Library - Intro
 
+*NOTE:* This library monkeypatches core classes and wa designed for Ruby 1.8 & 1.9. A redesign using refinements would be much better. Minimal support is provided.
+
 If you need to do read and write binary data, there is of course <tt>Array::pack</tt> and <tt>String::unpack</tt>.
 The packable library makes (un)packing nicer, smarter and more powerful.
 In case you are wondering why on earth someone would want to do serious (un)packing when YAML & XML are built-in:
@@ -26,6 +26,7 @@ The method +each+ also accepts packing options:
     StringIO.new("\000\001\000\002\000\003").each(:short).to_a  ===>  [1,2,3]
 === Custom classes
 It's easy to make you own classes (un)packable. All the previous goodies are thus available:
+
 		File.open("great_flick.flv") do |f|
 			head = f.read(FLV::Header)
 			f.each(FLV::Tag) do |tag|
@@ -48,7 +49,7 @@ Add GitHub to your gem sources (if you haven't already):
 Get the gem:
 
   sudo gem install marcandre-packable
-  
+
 That's it! Simply <tt>require 'packable'</tt> in your code to use it.
 
 == Compatibility
@@ -97,7 +98,7 @@ When unpacking, it is necessary to specify the class in addition to any option,
 
 It's easy to add shortcuts for easier (un)packing:
 
-	String.packers.set :flv_signature, :bytes => 3, :fill => "FLV"
+  String.packers.set :flv_signature, :bytes => 3, :fill => "FLV"
 
   "x".pack(:flv_signature)  ===>  "xFL"
 
@@ -131,14 +132,14 @@ The following shortcuts and defaults are built-in the library:
   :byte           =>   :bytes=>1
   :unsigned_long  =>   :bytes=>4, :signed=>false
   :unsigned_short =>   :bytes=>2, :signed=>false
-                       
-=== Float              
+
+=== Float
   :merge_all      =>   :precision => :single, :endian => :big
   :default        =>   :float
   :double         =>   :precision => :double
   :float          =>   {}
-                       
-=== String             
+
+=== String
   :merge_all      =>   :fill => " "
 
 == Files and StringIO
@@ -180,7 +181,7 @@ and unpacking on +read_packed+. For example:
 
   class MyHeader < Struct.new(:signature, :nb_blocks)
     include Packable
-  
+
     def write_packed(packedio, options)
       packedio << [signature, {:bytes=>3}] << [nb_blocks, :short]
     end
@@ -238,7 +239,7 @@ A final note to say that packers are inherited in some way. For instance one cou
       io.read(klass)
     end
   end
-  
+
   [42, MyHeader.new("Wow", 1)].pack(:with_class, :with_class).unpack(:with_class, :with_class) ===> [42, MyHeader.new("Wow", 1)]
 
 = License

data/lib/packable.rb

@@ -1,5 +1,6 @@
 require "packable/version"
-require 'backports'
+require 'backports/tools/alias_method_chain'
+require 'backports/rails/module'
 require_relative 'packable/packers'
 require_relative 'packable/mixin'
 [Object, Array, String, Integer, Float, IO, Proc].each do |klass|

data/lib/packable/extensions/integer.rb

@@ -3,7 +3,7 @@ module Packable
     module Integer #:nodoc:
       NEEDS_REVERSAL = Hash.new{|h, endian| raise ArgumentError, "Endian #{endian} is not valid. It must be one of #{h.keys.join(', ')}"}.
         merge!(:little => true, :big => false, :network => false, :native => "*\x00\x00\x00".unpack('L').first == 42).freeze
-      
+
       def self.included(base)
         base.class_eval do
           include Packable

data/lib/packable/extensions/io.rb

@@ -9,7 +9,26 @@ module Packable
         base.alias_method_chain :write, :packing
         base.alias_method_chain :each, :packing
       end
-      
+
+      # Methods supported by seekable streams.
+      SEEKABLE_API = %i[pos pos= seek rewind].freeze
+
+      # Check whether can seek without errors.
+      def seekable?
+        if !defined?(@seekable)
+          @seekable =
+            # The IO class throws an exception at runtime if we try to change
+            # position on a non-regular file.
+            if respond_to?(:stat)
+              stat.file?
+            else
+              # Duck-type the rest of this.
+              SEEKABLE_API.all? { |m| respond_to?(m) }
+            end
+        end
+        @seekable
+      end
+
       # Returns the change in io.pos caused by the block.
       # Has nothing to do with packing, but quite helpful and so simple...
       def pos_change(&block)
@@ -33,11 +52,11 @@ module Packable
         r.stream = self
         r >> options
       end
-      
+
       # 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 
+        packedio.set_encoding("ascii-8bit") if packedio.respond_to? :set_encoding
         class << packedio
           def << (arg)
             arg = [arg, :default] unless arg.instance_of?(::Array)
@@ -53,17 +72,17 @@ module Packable
       end
 
       def each_with_packing(*options, &block)
-        return each_without_packing(*options, &block) if (Integer === options.first) || (String === options.first)
+        return each_without_packing(*options, &block) if options.empty? || (Integer === options.first) || (String === options.first) || !seekable?
         return Enumerator.new(self, :each_with_packing, *options) unless block_given?
         yield read(*options) until eof?
       end
 
       def write_with_packing(*arg)
-        (arg.length == 1) ? write_without_packing(*arg) : pack_and_write(*arg)
+        (arg.length <= 1 || !seekable?) ? write_without_packing(*arg) : pack_and_write(*arg)
       end
-    
+
       def read_with_packing(*arg)
-        return read_without_packing(*arg) if arg.length == 0 || arg.first.nil? || arg.first.is_a?(Numeric)
+        return read_without_packing(*arg) if arg.empty? || arg.first.nil? || arg.first.is_a?(Numeric) || !seekable?
         values = Packable::Packers.to_class_option_list(*arg).map do |klass, options, original|
           if options[:read_packed]
             options[:read_packed].call(self)
@@ -73,7 +92,7 @@ module Packable
         end
         return values.size > 1 ? values : values.first
       end
-      
+
       # returns a string of exactly n bytes, or else raises an EOFError
       def read_exactly(n)
         return "" if n.zero?
@@ -81,7 +100,7 @@ module Packable
         raise EOFError if s.nil? || s.length < n
         s
       end
-      
+
       def pack_and_write(*arg)
         original_pos = pos
         Packable::Packers.to_object_option_list(*arg).each do |obj, options|
@@ -94,7 +113,6 @@ module Packable
         pos - original_pos
       end
 
-    
     end
   end
 end

data/lib/packable/extensions/proc.rb

@@ -6,11 +6,11 @@ module Packable
         Object.send(:define_method, :__temp_bound_method, &self)
         Object.instance_method(:__temp_bound_method)
       end
-      
+
       # Shortcut for <tt>unbind.bind(to)</tt>
       def bind(to)
         unbind.bind(to)
       end
     end
   end
-end
+end

data/lib/packable/mixin.rb

@@ -5,7 +5,7 @@ require 'stringio'
 module Packable
   def self.included(base) #:nodoc:
     base.class_eval do
-      class << self 
+      class << self
         include PackersClassMethod
         include ClassMethods
       end
@@ -26,18 +26,18 @@ module Packable
     #
     def packers
       yield packers if block_given?
-      Packers.for(self) 
+      Packers.for(self)
     end
   end
 
-  module ClassMethods    
+  module ClassMethods
 
     def unpack(s, options = :default)
       return s.unpack(options).first if options.is_a? String
       StringIO.new(s).packed.read(self, options)
     end
- 
-    # Default +read_packed+ calls either the instance method <tt>read_packed</tt> or the 
+
+    # Default +read_packed+ calls either the instance method <tt>read_packed</tt> or the
     # class method +unpack_string+. Choose:
     # * define a class method +read_packed+ that returns the newly read object
     # * define an instance method +read_packed+ which reads the io into +self+
@@ -57,5 +57,5 @@ module Packable
       end
     end
 
-  end  
-end
+  end
+end

data/lib/packable/packers.rb

@@ -1,9 +1,9 @@
 module Packable
-  
+
   # Packers for any packable class.
   class Packers < Hash
     SPECIAL = [:default, :merge_all].freeze
-  
+
     # Usage:
     #   PackableClass.packers.set :shortcut, :option => value, ...
     #   PackableClass.packers { |p| p.set...; p.set... }
@@ -42,7 +42,7 @@ module Packable
     end
 
     @@packers_for_class = Hash.new{|h, klass| h[klass] = Packers.new(klass)}
-    
+
     # Returns the configuration for the given +klass+.
     def self.for(klass)
       @@packers_for_class[klass]
@@ -59,7 +59,7 @@ module Packable
       end
       r
     end
-    
+
     def self.to_object_option_list(*arg) #:nodoc:
       r=[]
       until arg.empty? do
@@ -85,7 +85,6 @@ module Packable
       raise "Couldn't find packing option #{key}"
     end
 
-    
   end
 
   # Use to capture the blocks given to read/write
@@ -103,5 +102,5 @@ module Packable
       options[:write_packed] = block.unbind
     end
   end
-    
-end
+
+end

data/lib/packable/version.rb

@@ -1,3 +1,3 @@
 module Packable
-  VERSION = "1.3.8"
+  VERSION = "1.3.14"
 end

data/packable.gemspec

@@ -6,6 +6,7 @@ require 'packable/version'
 Gem::Specification.new do |gem|
   gem.name          = "packable"
   gem.version       = Packable::VERSION
+  gem.homepage      = "https://github.com/marcandre/packable"
   gem.authors       = ["Marc-André Lafortune"]
   gem.email         = ["github@marc-andre.ca"]
   gem.description   = %q{If you need to do read and write binary data, there is of course <Array::pack and String::unpack\n      The packable library makes (un)packing nicer, smarter and more powerful.\n}
@@ -16,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+  gem.required_ruby_version = '>= 1.8.7'
   gem.add_runtime_dependency 'backports'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'shoulda'

data/test/packing_doc_test.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/test_helper')
 # Warning: ugly...
 class MyHeader < Struct.new(:signature, :nb_blocks)
   include Packable
-  
+
   def write_packed(packedio, options)
     packedio << [signature, {:bytes=>3}] << [nb_blocks, :short]
   end
@@ -10,19 +10,17 @@ class MyHeader < Struct.new(:signature, :nb_blocks)
   def read_packed(packedio, options)
     self.signature, self.nb_blocks = packedio >> [String, {:bytes => 3}] >> :short
   end
-  
+
   def ohoh
     :ahah
   end
 end
 
-
-class PackableDocTest < Minitest::Test 
+class PackableDocTest < Minitest::Test
   def test_doc
 
     assert_equal  [1,2,3], StringIO.new("\000\001\000\002\000\003").each(:short).to_a
 
-
   	String.packers.set :flv_signature, :bytes => 3, :fill => "FLV"
 
     assert_equal "xFL", "x".pack(:flv_signature)
@@ -31,12 +29,12 @@ class PackableDocTest < Minitest::Test
       p.set :merge_all, :fill => "*"	# Unless explicitly specified, :fill will now be "*"
       p.set :default, :bytes => 8     # If no option is given, this will act as default
     end
-    
+
     assert_equal "ab******", "ab".pack
     assert_equal "ab**", "ab".pack(:bytes=>4)
     assert_equal "ab", "ab".pack(:fill => "!")
     assert_equal "ab!!", "ab".pack(:fill => "!", :bytes => 4)
-    
+
     String.packers do |p|
   		p.set :creator, :bytes => 4
   		p.set :app_type, :creator
@@ -44,9 +42,9 @@ class PackableDocTest < Minitest::Test
       p.set :merge_all, :fill => " "
       p.set :eigth_bytes, :bytes => 8
   	end
-    
+
     assert_equal "hello".pack(:app_type), "hell"
-    
+
     assert_equal [["sig", 1, "hello, w"]]*4,
     [
     lambda { |io| io >> :flv_signature >> Integer >> [String, {:bytes => 8}]                     },
@@ -54,8 +52,7 @@ class PackableDocTest < Minitest::Test
     lambda { |io| io.read(:flv_signature, Integer, String, {:bytes => 8})                        },
     lambda { |io| [io.read(:flv_signature), io.read(Integer), io.read(String, {:bytes => 8})]    }
     ].map {|proc| proc.call(StringIO.new("sig\000\000\000\001hello, world"))}
-    
-    
+
     ex = "xFL\000\000\000BHello   "
     [
     lambda { |io| io << "x".pack(:flv_signature) << 66.pack << "Hello".pack(:bytes => 8)},   # returns io
@@ -68,31 +65,28 @@ class PackableDocTest < Minitest::Test
       ios.rewind
       assert_equal ex, ios.read, "With #{proc}"
     end
-    
+
     #insure StringIO class is not affected
     ios = StringIO.new
     ios.packed
     ios << 66
     ios.rewind
     assert_equal "66", ios.read
-    
-    
+
     String.packers.set :length_encoded do |packer|
       packer.write  { |io| io << length << self }
       packer.read   { |io| io.read(io.read(Integer)) }
     end
-    
+
     assert_equal "\000\000\000\006hello!", "hello!".pack(:length_encoded)
     assert_equal ["this", "is", "great!"], ["this", "is", "great!"].pack(*[:length_encoded]*3).unpack(*[:length_encoded]*3)
-  
+
     h = MyHeader.new("FLV", 65)
     assert_equal "FLV\000A", h.pack
     h2, = StringIO.new("FLV\000A") >> MyHeader
     assert_equal h, h2
     assert_equal h.ohoh, h2.ohoh
 
-
-  
     Object.packers.set :with_class do |packer|
       packer.write { |io| io << [self.class.name, :length_encoded] << self }
       packer.read  do |io|
@@ -103,4 +97,4 @@ class PackableDocTest < Minitest::Test
     ar = [42, MyHeader.new("FLV", 65)]
     assert_equal ar, ar.pack(:with_class, :with_class).unpack(:with_class, :with_class)
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packable
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.3.14
 platform: ruby
 authors:
 - Marc-André Lafortune
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports
@@ -107,15 +107,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Extensive packing and unpacking capabilities
@@ -123,4 +122,3 @@ test_files:
 - test/packing_doc_test.rb
 - test/packing_test.rb
 - test/test_helper.rb
-has_rdoc: