whispr 0.0.3 → 0.1.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
+0.1.0
+- [2](https://github.com/simulacre/whispr/pull/2): allows closing the filehandle [ovesh](https://github.com/ovesh)
+- IOError caught when reading header will be tagged as Whispr::Error rather than raising Whispr::CorruptWhisprFile
+- support testing Whispr from specs using StringIO objects
+ 
 0.0.3
-- fixes: branch test and call to #update_one from #udpate_many
+- fixes: branch test and call to #update_one from #update
 - [1](https://github.com/simulacre/whispr/pull/1): allows passing array to #update [ovesh](https://github.com/ovesh)
 
 0.0.2

data/lib/whispr.rb

@@ -75,57 +75,86 @@ class Whispr
       [precision, points]
     end
 
-    # Create whipser file.
+    # Create whipser file on the file system and prepopulate it.
     # @param [String] path
     # @param [Array] archiveList each archive is an array with two elements: [secondsPerPoint,numberOfPoints]
     # @param [Hash] opts
-    # @option opts [Float] :xff the fraction of data points in a propagation interval that must have known values for a propagation to occur
-    # @option opts [Symbol] :aggregationMethod the function to use when propogating data; must be one of AGGR_TYPES[1..-1]
+    # @option opts [Float] :xff (0.5) the fraction of data points in a propagation interval that must have known values for a propagation to occur
+    # @option opts [Symbol] :aggregationMethod (average) the function to use when propogating data; must be one of AGGR_TYPES[1..-1]
     # @option opts [Boolean] :overwrite (false)
+    # @option opts [Boolean] :sparse (false)
     # @raise [InvalidConfiguration] if the archiveList is inavlid, or if 'path' exists and :overwrite is not true
     # @see Whsipr.validateArchiveList
     def create(path, archiveList, opts = {})
-      opts = {:xff => 0.5, :aggregationMethod => :average, :sparse => false, :overwrite => false}.merge(opts)
-      unless AGGR_TYPES[1..-1].include?(opts[:aggregationMethod])
-        raise InvalidConfiguration.new("aggregationMethod must be one of #{AGGR_TYPES[1..-1]}")
-      end
-
+      validate_opts(opts)
       validateArchiveList!(archiveList)
       raise InvalidConfiguration.new("File #{path} already exists!") if File.exists?(path) && !opts[:overwrite]
 
       # if file exists it will be truncated
       File.open(path, "wb")  do |fh|
         fh.flock(File::LOCK_EX)
-        aggregationType = AGGR_TYPES.index(opts[:aggregationMethod])
-        oldest         = archiveList.map{|spp, points| spp * points }.sort.last
-        packedMetadata = [aggregationType, oldest, opts[:xff], archiveList.length].pack(METADATA_FMT)
-        fh.write(packedMetadata)
-        headerSize            = METADATA_SIZE + (ARCHIVE_INFO_SIZE * archiveList.length)
-        archiveOffsetPointer = headerSize
-        archiveList.each do |spp, points|
-          archiveInfo = [archiveOffsetPointer, spp, points].pack(ARCHIVE_INFO_FMT)
-          fh.write(archiveInfo)
-          archiveOffsetPointer += (points * POINT_SIZE)
-        end
+        prepopulate(fh, archiveList, opts)
+      end
 
-        if opts[:sparse]
-          fh.seek(archiveOffsetPointer - headerSize - 1)
-          fh.write("\0")
-        else
-          remaining = archiveOffsetPointer - headerSize
-          zeroes = "\x00" * CHUNK_SIZE
-          while remaining > CHUNK_SIZE
-            fh.write(zeroes)
-            remaining -= CHUNK_SIZE
-          end
-          fh.write(zeroes[0..remaining])
-        end
+      new(path)
+    end
 
-        fh.flush
-        fh.fsync rescue nil
+    # Set defaults for the options to #create and #prepopulate as well as validate the supplied options.
+    # @param [Hash] opts
+    # @return [Hash] updated options
+    def validate_opts(opts = {})
+      opts = {:xff => 0.5, :aggregationMethod => :average, :sparse => false, :overwrite => false}.merge(opts)
+      unless AGGR_TYPES[1..-1].include?(opts[:aggregationMethod])
+        raise InvalidConfiguration.new("aggregationMethod must be one of #{AGGR_TYPES[1..-1]}")
       end
+      opts
+    end
 
-      new(path)
+    # Build the header and reserve space for the archives in the Whispr file.
+    #
+    # You probably don't want to use this method, you probably want to use
+    # #create instead. Calls to prepopulate MUST be preceeded by a call to
+    # validateArchiveList! with the archiveList argument.
+    #
+    # @param [File] the filehandle that will hold the archive
+    # @param [Array] archiveList each archive is an array with two elements: [secondsPerPoint,numberOfPoints]
+    # @param [Hash] opts
+    # @option opts [Float] :xff the fraction of data points in a propagation interval that must have known values for a propagation to occur
+    # @option opts [Symbol] :aggregationMethod the function to use when propogating data; must be one of AGGR_TYPES[1..-1]
+    # @option opts [Boolean] :overwrite (false)
+    # @raise [InvalidConfiguration] if the archiveList is inavlid, or if 'path' exists and :overwrite is not true
+    # @see Whsipr.validateArchiveList
+    # @see Whsipr.create
+    def prepopulate(fh, archiveList, opts = {})
+      opts            = validate_opts(opts)
+      aggregationType = AGGR_TYPES.index(opts[:aggregationMethod])
+      oldest         = archiveList.map{|spp, points| spp * points }.sort.last
+      packedMetadata = [aggregationType, oldest, opts[:xff], archiveList.length].pack(METADATA_FMT)
+      fh.write(packedMetadata)
+      headerSize            = METADATA_SIZE + (ARCHIVE_INFO_SIZE * archiveList.length)
+      archiveOffsetPointer = headerSize
+      archiveList.each do |spp, points|
+        archiveInfo = [archiveOffsetPointer, spp, points].pack(ARCHIVE_INFO_FMT)
+        fh.write(archiveInfo)
+        archiveOffsetPointer += (points * POINT_SIZE)
+      end
+
+      if opts[:sparse]
+        fh.seek(archiveOffsetPointer - headerSize - 1)
+        fh.write("\0")
+      else
+        remaining = archiveOffsetPointer - headerSize
+        zeroes = "\x00" * CHUNK_SIZE
+        while remaining > CHUNK_SIZE
+          fh.write(zeroes)
+          remaining -= CHUNK_SIZE
+        end
+        fh.write(zeroes[0..remaining])
+      end
+
+      fh.flush
+      fh.fsync rescue nil
+      fh
     end
 
     # Is the provided archive list valid?
@@ -253,6 +282,14 @@ class Whispr
     end
   end
 
+  def closed?
+    @fh.closed?
+  end
+
+  def close
+    @fh.close
+  end
+
 private
 
 
@@ -273,6 +310,8 @@ private
           :offset => offset
         }
       end
+    rescue IOError => e
+      raise e.extend(Error)
     rescue => e
       raise CorruptWhisprFile.exception(e)
     ensure

data/lib/whispr/version.rb

@@ -1,3 +1,3 @@
 class Whispr
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whispr
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email: whispr@simulacre.org