checkm 0.0.6 → 0.1.0

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    checkm (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    yard (0.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  checkm!
+  rake
+  rcov
+  rspec
+  yard

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.1.0

data/checkm.gemspec

@@ -5,8 +5,7 @@ require File.join(File.dirname(__FILE__), "lib/checkm/version")
 Gem::Specification.new do |s|
   s.name = %q{checkm}
   s.version = Checkm::VERSION
-  s.summary = "Checkm is a general-purpose text-based file manifest format "
-  s.description = "Checkm is a general-purpose text-based file manifest format "
+  s.summary = "checkm implementation"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Beer"]

data/lib/checkm.rb

@@ -1,5 +1,8 @@
 require 'checkm/manifest'
 require 'checkm/entry'
+require 'digest/md5'
+require 'digest/sha1'
+require 'digest/sha2'
 
 module Checkm
   # Size (in bytes) to read (in chunks) to compute checksums

data/lib/checkm/entry.rb

@@ -1,44 +1,69 @@
 require 'time'
 module Checkm  
   class Entry
-    BASE_FIELDS = ['sourcefileorurl', 'alg', 'digest', 'length', 'modtime', 'targetfileorurl']
+    def self.create file_or_path, args = {}
+      return file_or_path if file_or_path.is_a? Entry
+
+      options = args.delete(:options) || {}
+      path = options[:path] || Dir.pwd
+
+      return Checkm::Entry.new(file_or_path, options) if file_or_path.is_a? Array or file_or_path.is_a? Hash
+
+      file = file_or_path if file.is_a? File
+      file ||= File.open(File.expand_path(file_or_path, path))
+
+      args[:sourcefileorurl] = File.expand_path(file.path).gsub(path + "/", '') if file.respond_to? :path
+      args[:alg] ||= 'md5'
+      args[:digest] ||= Checkm.checksum(file, args[:alg])
+      args[:length] ||= File.size(file.path)
+      args[:modtime] ||= file.mtime.utc.xmlschema
+
+      Checkm::Entry.new(args, options)
+    end
+
     attr_reader :values
   
-    def self.create path, args = {}
-      base = args[:base] || Dir.pwd
-      alg = args[:alg] || 'md5'
-      file = File.new File.join(base, path)
-  
-      "%s | %s | %s | %s | %s | %s" % [path, alg, Checkm.checksum(file, alg), File.size(file.path), file.mtime.utc.xmlschema, nil]
+    def initialize source, options = {}
+      @fields = options[:fields] || Manifest::BASE_FIELDS 
+      @path = options[:path]
+      @path ||= Dir.pwd
+
+      @values = case source
+      when Hash
+        tmp = {}
+        source.each { |k, v| tmp[k.to_s.downcase.to_sym] = v }
+        @fields.map { |k| source[k.to_s.downcase.to_sym] }
+      when Array
+        source
+      when String
+        source.split("|").map { |x| x.strip }
+      end
     end
-  
-    def initialize line, manifest = nil
-      @line = line.strip
-      @include = false
-      @fields = BASE_FIELDS
-      @fields = manifest.fields if manifest and manifest.fields
-      @values = line.split('|').map { |s| s.strip }
-      @manifest = manifest
+
+    def [] idx
+      values[idx] rescue nil
+    end
+
+    def []= idx, value
+      values[idx] = value rescue nil
+    end
+
+    def to_s
+      values.join(" | ")
     end
   
     def method_missing(sym, *args, &block)
-      @values[@fields.index(sym.to_s.downcase) || BASE_FIELDS.index(sym.to_s.downcase)] rescue nil
+      self[@fields.map { |x| x.downcase }.index(sym.to_s.downcase) || Manifest::BASE_FIELDS.map { |x| x.downcase }.index(sym.to_s.downcase)]
     end
   
-  
     def valid?
-      return source_exists? && valid_checksum? && valid_multilevel? # xxx && valid_length? && valid_modtime?
+      return File.exists?(source) && valid_checksum? # xxx && valid_length? && valid_modtime?
     end
   
     private
     def source
       file = sourcefileorurl
-      file = file[1..-1] if file =~ /^@/
-      File.join(@manifest.path, file)
-    end
-  
-    def source_exists?
-      return File.exists? source
+      File.join(@path, file)
     end
   
     def valid_checksum?
@@ -55,10 +80,5 @@ module Checkm
     def valid_modtime?
       throw NotImplementedError
     end
-  
-    def valid_multilevel?
-      return true unless sourcefileorurl =~ /^@/
-      return Manifest.parse(open(source).read, File.dirname(source))
-    end
   end
 end

data/lib/checkm/manifest.rb

@@ -1,48 +1,75 @@
 module Checkm
   class Manifest
-    def self.parse str, args = {}
-      Manifest.new str, args
-    end
+    BASE_FIELDS = ['sourcefileorurl', 'alg', 'digest', 'length', 'modtime', 'targetfileorurl']
   
-    attr_reader :version
-    attr_reader :entries
+    attr_reader :source
+    attr_reader :eof
+
     attr_reader :fields
     attr_reader :path
+    attr_accessor :entries
   
-    def initialize checkm, args = {}
+    def initialize str_io_or_file, args = {}
+      @source = str_io_or_file
       @args = args
-      @version = nil
-      @checkm = checkm
-      @lines = checkm.split "\n"
       @entries = []
-      @eof = false
-      @fields= nil
+
+      @eof = args[:eof]
+      @version = args[:version]
+      @fields = args[:ields]
+
       @path = args[:path]
       @path ||= Dir.pwd
   
-      parse_lines 
-      # xxx error on empty entries?
-      @lines.unshift('#%checkm_0.7') and @version = '0.7' if @version.nil?
-  
+      parse_lines(@source) 
     end
-  
+
+    def version
+      @version || "0.7"
+    end
+
+    def fields
+      @fields || BASE_FIELDS
+    end
+
     def valid?
       return true if @entries.empty?
       not @entries.map { |e| e.valid? }.any? { |b| b == false }
     end
   
-    def add path, args = {}
-      line = Checkm::Entry.create path, args
-  
-      Checkm::Manifest.new [@lines, line].flatten.join("\n"), @args
+    def add path_or_entry, args = {}
+      @entries << Checkm::Entry.create(path_or_entry, args) 
     end
-  
-    def remove path
-      Checkm::Manifest.new @lines.reject { |x| x =~ /^@?#{path}/ }.join("\n"), @args
+
+    alias_method :<<, :add
+  
+    def remove path_or_entry
+      path = path_or_entry.path if path_or_entry.respond_to? :path
+      path ||= path_or_entry[0] if path_or_entry.is_a? Entry or path_or_entry.is_a? Array
+      path ||= path_or_entry
+
+      @entries.reject! { |x| x[0] =~ /^@?#{path}/ }
     end
+
+    alias_method :-, :remove
   
     def to_s
-      @lines.join("\n")
+      lines = []
+
+      lines << "#%checkm_#{version}"
+      lines << "#%fields | #{ @fields.join(" | ") }" if @fields
+
+      lines += entries.map(&:to_s)
+
+      lines << '#%eof' if eof
+
+      lines.join("\n")
+    end
+
+    def save
+      raise unless @source.is_a? File
+
+      File.open(@source.path, 'w') { |f| f.write(self.to_s) }
     end
   
     def to_hash
@@ -50,8 +77,24 @@ module Checkm
     end
   
     private
-    def parse_lines
-      @lines.each do |line|
+    def source_text
+      return if @source_text
+
+      case source 
+        when IO
+          @source_text ||= source.read
+        when String 
+          if source.is_a?(String) and (File.exists?(source) or source =~ /:\/\//)
+            @source_text ||= open(source).read
+          end
+      end
+      @source_text ||= source
+
+      @source_text
+    end
+
+    def parse_lines str
+      source_text.split("\n").each do |line|
         case line
           when /^#%/
             parse_header line
@@ -60,9 +103,9 @@ module Checkm
           when /^$/
   
           when /^@/
-            parse_line line     
+            parse_manifest line     
           else
-            parse_line line     
+            parse_entry line     
         end
       end
     end
@@ -71,13 +114,13 @@ module Checkm
       case line
         when /^#%checkm/
           match = /^#%checkm_(\d+)\.(\d+)/.match line
-          @version = "#{match[1]}.#{match[2]}" if match
+          @version ||= "#{match[1]}.#{match[2]}" if match
         when /^#%eof/
-          @eof = true
+          @eof ||= true
         when /^#%fields/
           list = line.split('|')
           list.shift
-          @fields = list.map { |v| v.strip.downcase }
+          @fields ||= list.map { |v| v.strip }
         when /^#%prefix/
   
         when /^#%profile/
@@ -89,8 +132,16 @@ module Checkm
   
     end
   
-    def parse_line line
-      @entries << Entry.new(line, self)
+    def parse_entry line
+      @entries << Entry.new(line, options_for_entries )
+    end
+
+    def options_for_entries
+      { :path => path, :fields => fields, :manifest => self }
+    end
+
+    def parse_manifest line
+      @entries << Manifest.new(line[/^@([^|]+)/].strip.gsub(/^@/, ''))
     end
   end
 end

data/spec/checkm_spec.rb

@@ -3,21 +3,21 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe "checkm" do
   it "should be valid if empty" do
     checkm = ''
-    res = Checkm::Manifest.parse(checkm)
+    res = Checkm::Manifest.new(checkm)
     res.entries.should be_empty
     res.should be_valid
   end
 
   it "should ignore comments" do
     checkm = '#'
-    res = Checkm::Manifest.parse(checkm)
+    res = Checkm::Manifest.new(checkm)
     res.entries.should be_empty
     res.should be_valid
   end
 
-  it "should parse the checkm version" do
+  it "should new the checkm version" do
     checkm = '#%checkm_0.7'
-    res = Checkm::Manifest.parse(checkm)
+    res = Checkm::Manifest.new(checkm)
     res.entries.should be_empty
     res.should be_valid
     res.version.should == '0.7'
@@ -26,15 +26,15 @@ describe "checkm" do
   describe "simple checkm line" do 
     before(:each) do 
       @checkm = 'book/Chapter9.xml |   md5   |  49afbd86a1ca9f34b677a3f09655eae9'
-      @result = Checkm::Manifest.parse(@checkm)
+      @result = Checkm::Manifest.new(@checkm)
       @line = @result.entries.first
     end
 
-    it "should parse one entry" do
+    it "should new one entry" do
       @result.should have(1).entries
     end
 
-    it "should parse a checkm line" do 
+    it "should new a checkm line" do 
       @line.values[0].should == 'book/Chapter9.xml'
       @line.values[1].should == 'md5'
       @line.values[2].should == '49afbd86a1ca9f34b677a3f09655eae9'
@@ -47,10 +47,10 @@ describe "checkm" do
     end
   end
 
-  it "should support custom field names" do
+  it "should support custom field names", :blah => true do
     checkm= '#%fields | testa | test b' + "\n" +
             'book/Chapter9.xml |   md5   |  49afbd86a1ca9f34b677a3f09655eae9'
-    res = Checkm::Manifest.parse(checkm)
+    res = Checkm::Manifest.new(checkm)
 
     line = res.entries.first
 
@@ -64,28 +64,28 @@ describe "checkm" do
   describe "validity check" do
     it "should be valid if the file exists" do
       checkm = '1 | md5 | b026324c6904b2a9cb4b88d6d61c81d1'
-      res = Checkm::Manifest.parse(checkm, :path => File.join(File.dirname(__FILE__), 'fixtures/test_1'))
+      res = Checkm::Manifest.new(checkm, :path => File.join(File.dirname(__FILE__), 'fixtures/test_1'))
       res.should have(1).entries
       res.should be_valid
     end
 
     it "should be valid if the directory exists" do
       checkm = 'test_1 | dir'
-      res = Checkm::Manifest.parse(checkm, :path => File.join(File.dirname(__FILE__), 'fixtures'))
+      res = Checkm::Manifest.new(checkm, :path => File.join(File.dirname(__FILE__), 'fixtures'))
       res.should have(1).entries
       res.should be_valid
     end
 
     it "should be invalid if a file is missing" do
       checkm = '2 | md5 | b026324c6904b2a9cb4b88d6d61c81d1'
-      res = Checkm::Manifest.parse(checkm, :path => File.join(File.dirname(__FILE__), 'fixtures/test_1'))
+      res = Checkm::Manifest.new(checkm, :path => File.join(File.dirname(__FILE__), 'fixtures/test_1'))
       res.should have(1).entries
       res.should_not be_valid
     end
 
     it "should be invalid if the checksum is different" do
       checkm = '1 | md5 | zzz'
-      res = Checkm::Manifest.parse(checkm, :path => File.join(File.dirname(__FILE__), 'fixtures/test_1'))
+      res = Checkm::Manifest.new(checkm, :path => File.join(File.dirname(__FILE__), 'fixtures/test_1'))
       res.should have(1).entries
       res.should_not be_valid
     end
@@ -94,21 +94,21 @@ describe "checkm" do
   describe "manipulate manifest" do
     it "should support simple create" do
       res = Checkm::Entry.create('LICENSE.txt')
-      res.should match( /LICENSE\.txt | md5 | 927368f89ca84dbec878a8d017f06443 | 1054 | \d{4}/)
+      res.to_s.should match( /LICENSE\.txt | md5 | 927368f89ca84dbec878a8d017f06443 | 1054 | \d{4}/)
     end
 
     it "should allow files to be added to an existing manifest" do
-      m = Checkm::Manifest.parse('')
-      res = m.add('LICENSE.txt')
-      res.should have(1).entries
-      res.should be_valid
+      m = Checkm::Manifest.new('')
+      m.add('LICENSE.txt')
+      m.should have(1).entries
+      m.should be_valid
     end
   end
 
   it "should be serializable to a string" do
-    m = Checkm::Manifest.parse('')
-    n = m.add('LICENSE.txt')
-    lines = n.to_s.split "\n"
+    m = Checkm::Manifest.new('')
+    m.add('LICENSE.txt')
+    lines = m.to_s.split "\n"
     lines[0].should == '#%checkm_0.7'
     lines[1].should match(/^LICENSE\.txt/)
   end

metadata

@@ -1,105 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: checkm
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
 platform: ruby
-authors: 
+authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-09 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70168432758200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70168432758200
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70168432757220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70168432757220
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70168432756460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70168432756460
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70168432755600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70168432755600
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70168432754900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-description: "Checkm is a general-purpose text-based file manifest format "
+  prerelease: false
+  version_requirements: *70168432754900
+description: 
 email: chris@cbeer.info
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .document
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.textile
 - Rakefile
@@ -107,47 +83,40 @@ files:
 - checkm.gemspec
 - lib/checkm.rb
 - lib/checkm/entry.rb
-- lib/checkm/file.rb
 - lib/checkm/manifest.rb
 - lib/checkm/version.rb
 - spec/checkm_spec.rb
 - spec/fixtures/test_1/1
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -4308377203823409037
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Checkm is a general-purpose text-based file manifest format
-test_files: 
+summary: checkm implementation
+test_files:
 - spec/checkm_spec.rb
 - spec/fixtures/test_1/1
 - spec/spec_helper.rb
+has_rdoc: