archive-ar 0.0.6 → 0.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWY1YWRjODBiOTQ0NTY0MGJiZTRlYWEyNDk4MTVhOWE0ZDIzODRiMw==
+    ZjljZDM4OGY1Y2Y5OTViNjNmYjVlOGY4MzQzM2E3YmJiMWVkNWRjZQ==
   data.tar.gz: !binary |-
-    YzJkMGUzMGM5MzljNjAwMWEyMjYxM2QyNjIyOGEyOWQ4MzZhMzc0Mg==
+    M2Y1YjY1NDYzNTA0ZDZkNmIyMGMwOTY4ODNhYzc1YTAxY2Y5NWM2Yg==
 SHA512:
   metadata.gz: !binary |-
-    MDllMDhkOGRlNjNmOTc2YmU3ZWE3MmNkMjRhZjNkNjkzYTgwZTk1MTZlOWFl
-    ZTZkNTYxZjc0NTc1ZTQ1YmE3ODliZDY5NDVkNDVlN2EzMGExNjNmMDUzMGQ0
-    ZWYyODZhNDI0NDAzYWFkNWVmYTEwMGZkNjQxYWQ5OWE3Mzc5ZjQ=
+    YmIxNDZkZjY0ZGY4ZWM2NTE1ODkzOTA3YjgwYWRkNDFlNWFlMmQ3YTk2ODIz
+    OGJlY2ZlMTY4YTJmN2I2ZWIyNDZiZWE4M2IwNTJjMmIwM2UxOTcxNjc0MmZj
+    MTVmZjk2YzI1NDYwZmExNmVjZDYyYzVjOWRlYTIzZjMwYzE2ZGQ=
   data.tar.gz: !binary |-
-    YjM4MThiMjFiYzgzMTQ5ZjJjODk4MGRkYmEyOWViOTcyNzc2NWUxY2JiYzZl
-    OTQ1MzczMGYxMTlmZTQ1NDNlZWFiMzY0ZjJkYWFhNGVmYzA3MjRiOTYyMWI5
-    ZTZmMjJkZDM5ZGMyNTYxNDAxMzdmNWQ5ZmI3NTU1YjM1NzA1Y2Q=
+    YjNhMjJhZDZkZjVkNTBhODI5YjVlNjI5OGYzMzc4MGZjYzg5ODFiNDc5YmUz
+    MTk1MjY3OGQzNmY2YTM3ZjRjMTUwOTZlY2U5ZDk0YTc2OGM2NjYzYWNhYTll
+    OTk1NmM0OTNkMDQyNTA0YzMxZTM4ZDJjNzY3MWJiMWJiOWEzNDg=

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+before_script:
+  - cd ext; ./integration.rb
 rvm:
   - 2.1.1
   - 1.9.3

data/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 unless RUBY_VERSION < "1.9"
   gem 'coveralls', :require => false
+  gem 'guard-rspec'
 end
 
 # Specify your gem's dependencies in archive-ar.gemspec

data/NOTES.md

@@ -0,0 +1,15 @@
+# Global Header
+
+    <!arch>\n
+
+# File Header
+
+| Name          | Offset | Length |
+| ------------- | ------ | ------ |
+| Filename      | 0      | 16     |
+| Modified Time | 16     | 12     |
+| Owner         | 28     | 6      |
+| Group         | 34     | 6      |
+| File Mode     | 40     | 8      |
+| Size          | 48     | 10     |
+| Magic         | 58     | 2      |

data/README.md

@@ -24,11 +24,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Create an archive
+
+    $ ar.rb -r somearchive.ar file1 file2
+
+`````ruby
+Archive::Ar.create("somearchive.ar", ["file1", "file2"])
+`````
+
+### Extract an archive
+
+    $ ar.rb -x somearchive.ar /tmp
+
+`````ruby
+Archive::Ar.extract("somearchive.ar", "/tmp")
+`````
+
+### Advanced
+
+    $ ar.rb -t somearchive.ar
+
+`````ruby
+Archive::Ar.traverse("somearchive.ar") do |file|
+  puts file.name
+end
+`````
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/archive-ar/fork )
+1. Fork it ( http://github.com/jbussdieker/ruby-archive-ar/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/bin/ar.rb

@@ -51,6 +51,12 @@ OptionParser.new do |opts|
     options[:p] = v
   end
 
+  opts.on("-r", "Replace or add the specified files to the archive.  If the archive does not exist a new archive file
+             is created.  Files that replace existing files do not change the order of the files within the ar-
+             chive.  New files are appended to the archive unless one of the options -a, -b or -i is specified.") do |v|
+    options[:r] = v
+  end
+
   opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
     options[:verbose] = v
   end
@@ -59,6 +65,7 @@ end.parse!
 if options[:p]
   raise "illegal option combination for -p" if options[:t]
   raise "illegal option combination for -p" if options[:x]
+  raise "illegal option combination for -p" if options[:r]
 
   Archive::Ar.traverse(ARGV[0]) do |header, data|
     if options[:verbose]
@@ -68,6 +75,18 @@ if options[:p]
     end
     puts data
   end
+elsif options[:r]
+  raise "illegal option combination for -r" if options[:t]
+  raise "illegal option combination for -r" if options[:x]
+
+  filename = ARGV.shift
+  unless File.exists?(filename)
+    puts "ar: creating archive #{filename}"
+    Archive::Ar.create(filename, ARGV)
+  else
+    puts "we only support create"
+    exit 1
+  end
 elsif options[:t]
   raise "illegal option combination for -t" if options[:x]
 
@@ -92,7 +111,7 @@ elsif options[:x]
   if options[:verbose]
     Archive::Ar.traverse(ARGV[0]) do |header, data|
       puts "x - #{header[:name]}"
-      Archive::Ar::Format.extract_file(Dir.pwd, header, data)
+      Archive::Ar::Format::BSD.extract_file(Dir.pwd, header, data)
     end
   else
     Archive::Ar.extract(ARGV[0], Dir.pwd)

data/ext/aaaaaaaaaaaaaaaa

@@ -0,0 +1 @@
+test

data/ext/bbbbbbbbbbbbbbbbb

@@ -0,0 +1 @@
+asdf

data/ext/integration.rb

@@ -1,25 +1,65 @@
 #!/usr/bin/env ruby
+require 'digest/md5'
+require 'fileutils'
+
 AR_COMMAND = 'ar'
 ARCHIVE_AR_COMMAND = 'bundle exec ../bin/ar.rb'
 
-def run_test(cmd)
+def run_test(cmd, md5file = nil)
+  pass = true
   puts "Testing `ar #{cmd}`"
+
+  # Test original
   out_ar = `#{AR_COMMAND} #{cmd} 2>&1`
+  if md5file
+    md5_ar = Digest::MD5.file(md5file)
+    file_ar = File.read(md5file)
+    FileUtils.rm_rf(md5file)
+  end
+
+  # Test ruby version
   out_archive_ar = `#{ARCHIVE_AR_COMMAND} #{cmd} 2>&1`
+  if md5file
+    md5_archive_ar = Digest::MD5.file(md5file)
+    file_archive_ar = File.read(md5file)
+    FileUtils.rm_rf(md5file)
+  end
+
+  if md5_ar != md5_archive_ar
+    pass = false
+
+    puts " Error #{cmd}"
+    puts " File mismatch:"
+    puts "   Expected: #{md5_ar}"
+    puts "        Got: #{md5_archive_ar}"
+    puts "   Expected:"
+    puts "--------------------"
+    puts file_ar
+    puts "--------------------"
+    puts "        Got:"
+    puts "--------------------"
+    puts file_archive_ar
+    puts "--------------------"
+  end
 
   if out_ar != out_archive_ar
+    pass = false
+
     puts " Error #{cmd}"
     puts " Expected:"
     out_ar.split("\n").each {|l| puts "  | #{l}"}
     puts " Got:"
     out_archive_ar.split("\n").each {|l| puts "  | #{l}"}
-    false
-  else
-    true
   end
+
+  pass
 end
 
-#run_test("-r test.ar myfile")
+run_test("-r integration-temp.ar myfile", "integration-temp.ar")
+run_test("-r integration-temp.ar abcdefghijklmnopqrstuvwxyz", "integration-temp.ar")
+run_test("-r integration-temp.ar myfile.even", "integration-temp.ar")
+run_test("-r integration-temp.ar myfile myfile.even", "integration-temp.ar")
+run_test("-r integration-temp.ar aaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbb cccccccccccccccccc ddddddddddddddddddd eeeeeeeeeeeeeeeeeeee fffffffffffffffffffff gggggggggggggggggggggg", "integration-temp.ar")
 run_test("-t test.ar")
 run_test("-tv test.ar")
 run_test("-p test.ar")

data/ext/myfile.even

@@ -0,0 +1,35 @@
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah
+blahblahblahblahblahblah

data/lib/archive/ar/format.rb

@@ -1,75 +1,9 @@
+require 'archive/ar/format/bsd'
+require 'archive/ar/format/gnu'
+
 module Archive
   module Ar
-    class Format
-      class << self
-        def read_global_header(io)
-          io.read(8).tap do |global_header|
-            raise "Invalid header" unless global_header == Archive::Ar::MAGIC
-          end
-        end
-
-        def build_header(file)
-          header = {
-            :name => File.basename(file),
-            :modified => File.mtime(file).to_i,
-            :owner => File.stat(file).uid,
-            :group => File.stat(file).gid,
-            :mode => File.stat(file).mode,
-            :size => File.size(file),
-            :magic => "`\n"
-          }
-
-          data = ""
-          data += "%-16s" % header[:name]
-          data += "%-12s" % header[:modified]
-          data += "%-6s" % header[:owner]
-          data += "%-6s" % header[:group]
-          data += "%-8s" % header[:mode].to_s(8)
-          data += "%-10s" % header[:size]
-          data += "%2s" % header[:magic]
-          data
-        end
-
-        def parse_header(data)
-          h = data.unpack("A16 Z12 a6 a6 A8 Z10 Z2")
-          {
-            :name => h.shift.chomp("/"), # Remove trailing slash. Some archives have this...
-            :modified => Time.at(h.shift.to_i),
-            :owner => h.shift.to_i,
-            :group => h.shift.to_i,
-            :mode => h.shift.to_i(8),
-            :size => h.shift.to_i,
-            :magic => h.shift,
-          }
-        end
-
-        def read_header(io)
-          block = io.read(60)
-          header = parse_header(block)
-          header.merge! :start => io.tell
-
-          if header[:name].start_with? "#1/"
-            long_size = header[:name][3..-1].to_i
-            header[:start] += long_size
-            header[:name] = io.read(long_size).strip
-          end
-
-          header
-        end
-
-        def extract_file(dest_dir, header, data, options = {})
-          file = File.join(dest_dir, header[:name])
-
-          File.open(file, "w") do |f|
-            f.write(data)
-          end
-
-          File.chmod(header[:mode], file)
-          #FileUtils.chown(header[:owner], header[:group], file)
-
-          true
-        end
-      end
+    module Format
     end
   end
 end

data/lib/archive/ar/format/bsd.rb

@@ -0,0 +1,94 @@
+module Archive
+  module Ar
+    module Format
+      class BSD
+        class << self
+          def read_global_header(io)
+            io.read(8).tap do |global_header|
+              raise "Invalid header" unless global_header == Archive::Ar::MAGIC
+            end
+          end
+
+          def extract_file(dest_dir, header, data, options = {})
+            file = File.join(dest_dir, header[:name])
+
+            File.open(file, "w") do |f|
+              f.write(data)
+            end
+
+            File.chmod(header[:mode], file)
+            #FileUtils.chown(header[:owner], header[:group], file)
+
+            true
+          end
+
+          def read_header(io)
+            block = io.read(60)
+            header = parse_header(block)
+            header.merge! :start => io.tell
+
+            if header[:name].start_with? "#1/"
+              long_size = header[:name][3..-1].to_i
+              header[:start] += long_size
+              header[:name] = io.read(long_size).strip
+            end
+
+            header
+          end
+
+          def build_header(file)
+            header = read_file_header(file)
+            header_to_s(header)
+          end
+
+          private
+
+          def read_file_header(file)
+            {
+              :name => File.basename(file),
+              :modified => File.mtime(file).to_i,
+              :owner => File.stat(file).uid,
+              :group => File.stat(file).gid,
+              :mode => File.stat(file).mode,
+              :size => File.size(file),
+              :magic => "`\n"
+            }
+          end
+
+          def header_to_s(header)
+            data = ""
+            namebuf = header[:name]
+            if namebuf.length > 16
+              namebuf += "\0" * (4 - namebuf.length % 4) if (namebuf.length % 4) != 0
+              data += "%-16s" % "#1/#{namebuf.length}"
+              header[:size] += namebuf.length
+            else
+              data += "%-16s" % header[:name]
+            end
+            data += "%-12s" % header[:modified]
+            data += "%-6s" % header[:owner]
+            data += "%-6s" % header[:group]
+            data += "%-8s" % header[:mode].to_s(8)
+            data += "%-10s" % header[:size]
+            data += "%2s" % header[:magic]
+            data += namebuf if header[:name].length > 16
+            data
+          end
+
+          def parse_header(data)
+            h = data.unpack("A16 Z12 a6 a6 A8 Z10 Z2")
+            {
+              :name => h.shift.chomp("/"), # Remove trailing slash. Some archives have this...
+              :modified => Time.at(h.shift.to_i),
+              :owner => h.shift.to_i,
+              :group => h.shift.to_i,
+              :mode => h.shift.to_i(8),
+              :size => h.shift.to_i,
+              :magic => h.shift,
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/archive/ar/format/gnu.rb

@@ -0,0 +1,8 @@
+module Archive
+  module Ar
+    module Format
+      class GNU
+      end
+    end
+  end
+end

data/lib/archive/ar/reader.rb

@@ -4,11 +4,12 @@ module Archive
       def initialize(source, options)
         @source = source 
         @options = options
+        @format = Archive::Ar::Format::BSD
       end
 
       def extract(dest_dir, options)
         each do |header, data|
-          Archive::Ar::Format.extract_file(dest_dir, header, data, options)
+          @format.extract_file(dest_dir, header, data, options)
         end
       end
 
@@ -27,10 +28,10 @@ module Archive
         @index = []
         @records = {}
 
-        Archive::Ar::Format.read_global_header(io)
+        @format.read_global_header(io)
         
         until io.eof?
-          header = Archive::Ar::Format.read_header(io)
+          header = @format.read_header(io)
           size = header[:size]
           name = header[:name]
 

data/lib/archive/ar/version.rb

@@ -1,5 +1,5 @@
 module Archive
   module Ar
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/lib/archive/ar/writer.rb

@@ -3,11 +3,13 @@ module Archive
     class Writer
       def initialize(filenames)
         @filenames = filenames
+        @format = Archive::Ar::Format::BSD
       end
 
       def build_ar_entry(file)
-        header = Archive::Ar::Format.build_header(file)
+        header = @format.build_header(file)
         data = File.read(file)
+        data += "\n" if (data.length + header.length) % 2 == 1
         [header, data].join
       end
 

data/spec/lib/archive/ar/{format_spec.rb → format/bsd_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper' 
-describe Archive::Ar::Format do
+describe Archive::Ar::Format::BSD do
   describe "read_global_header" do
-    let(:read_global_header) { Archive::Ar::Format.read_global_header(io) }
+    let(:read_global_header) { Archive::Ar::Format::BSD.read_global_header(io) }
     subject { read_global_header }
 
     context "when valid" do
@@ -20,18 +20,25 @@ describe Archive::Ar::Format do
   end
 
   describe "build_header" do
-    let(:file) { "spec/fixtures/file" }
     let(:timestamp) { "%-12s" % File.mtime(file).to_i }
     let(:owner) { "%-6s" % File.stat(file).uid }
     let(:group) { "%-6s" % File.stat(file).gid }
     let(:mode) { "%-8s" % File.stat(file).mode.to_s(8) }
-    let(:subject) { Archive::Ar::Format.build_header(file) }
+    let(:subject) { Archive::Ar::Format::BSD.build_header(file) }
 
-    it { should == "file            #{timestamp}#{owner}#{group}#{mode}5         `\n" }
+    context "normal single file" do
+      let(:file) { "spec/fixtures/file" }
+      it { should == "file            #{timestamp}#{owner}#{group}#{mode}5         `\n" }
+    end
+
+    context "long name single file" do
+      let(:file) { "spec/fixtures/abcdefghijklmnopqrstuvwxyz" }
+      it { should == "#1/28           #{timestamp}#{owner}#{group}#{mode}28        `\nabcdefghijklmnopqrstuvwxyz\0\0" }
+    end
   end
 
   describe "read_header" do
-    let(:read_header) { Archive::Ar::Format.read_header(io) }
+    let(:read_header) { Archive::Ar::Format::BSD.read_header(io) }
     let(:io) { StringIO.new(payload) }
     subject { read_header }
 
@@ -75,7 +82,7 @@ describe Archive::Ar::Format do
     let(:header) { { :name => "file", :mode => 0100644 } }
     let(:data) { "test" }
     let(:options) { {} }
-    subject { Archive::Ar::Format.extract_file(dest_dir, header, data, options) }
+    subject { Archive::Ar::Format::BSD.extract_file(dest_dir, header, data, options) }
 
     it { should == true }
   end

data/spec/lib/archive/ar_spec.rb

@@ -8,7 +8,7 @@ describe Archive::Ar do
     let(:filenames) { ["spec/fixtures/file"] }
     subject { Archive::Ar.create(dest_file, filenames, options) }
 
-    it { should == 65 }
+    it { should == 66 }
   end
 
   describe "extract" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archive-ar
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Joshua B. Bussdieker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2014-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,22 +66,35 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
+- NOTES.md
 - README.md
 - Rakefile
 - archive-ar.gemspec
 - bin/ar.rb
+- ext/aaaaaaaaaaaaaaaa
+- ext/abcdefghijklmnopqrstuvwxyz
+- ext/bbbbbbbbbbbbbbbbb
+- ext/cccccccccccccccccc
+- ext/ddddddddddddddddddd
+- ext/eeeeeeeeeeeeeeeeeeee
+- ext/fffffffffffffffffffff
+- ext/gggggggggggggggggggggg
 - ext/integration.rb
 - ext/myfile
+- ext/myfile.even
 - ext/test.ar
 - lib/archive/ar.rb
 - lib/archive/ar/format.rb
+- lib/archive/ar/format/bsd.rb
+- lib/archive/ar/format/gnu.rb
 - lib/archive/ar/reader.rb
 - lib/archive/ar/version.rb
 - lib/archive/ar/writer.rb
+- spec/fixtures/abcdefghijklmnopqrstuvwxyz
 - spec/fixtures/archive.ar
 - spec/fixtures/emptyfile
 - spec/fixtures/file
-- spec/lib/archive/ar/format_spec.rb
+- spec/lib/archive/ar/format/bsd_spec.rb
 - spec/lib/archive/ar/reader_spec.rb
 - spec/lib/archive/ar/writer_spec.rb
 - spec/lib/archive/ar_spec.rb
@@ -112,10 +125,11 @@ signing_key:
 specification_version: 4
 summary: Simple AR file functions
 test_files:
+- spec/fixtures/abcdefghijklmnopqrstuvwxyz
 - spec/fixtures/archive.ar
 - spec/fixtures/emptyfile
 - spec/fixtures/file
-- spec/lib/archive/ar/format_spec.rb
+- spec/lib/archive/ar/format/bsd_spec.rb
 - spec/lib/archive/ar/reader_spec.rb
 - spec/lib/archive/ar/writer_spec.rb
 - spec/lib/archive/ar_spec.rb