store-digest 0.3.1 → 0.4.3

data/lib/store/digest/meta.rb

@@ -37,7 +37,7 @@ module Store::Digest::Meta
 
   # Set/add an individual object's metadata to the database.
   #
-  # @param obj [Store::Digest::Object] the object to store
+  # @param obj [Store::Digest::Entry] the object to store
   # @param preserve [false, true] flag to preserve modification time
   #
   # @return [void]

data/lib/store/digest/readwrapper.rb

@@ -0,0 +1,174 @@
+require 'store/digest/version'
+
+require 'thread'
+require 'stringio'
+
+# This class is an attempt to normalize input so that it can be
+# {#read} like an IO handle. Use the class method {.coerce} to
+# determine if it's even necessary.
+#
+class Store::Digest::ReadWrapper
+
+  private
+
+  # Test if the object quacks like an IO.
+  #
+  # @param obj [Object] said object
+  #
+  # @return [false, true]
+  #
+  def self.quacks? obj
+    obj.is_a?(IO) or %i[gets read close].all? do |m|
+      obj.respond_to? m
+    end
+  end
+
+  # close the pipe and join the thread.
+  #
+  # @return [void]
+  #
+  def cleanup
+    @mutex.synchronize do
+      return if @done
+      @done = true
+      @read.close unless @read.closed?
+    end
+
+    @thread.join
+  end
+
+  public
+
+  # XXX maybe later lol
+  # def self.assert! obj, thunk: false
+  #   return true if obj.is_a?(self) || quacks?(obj) || obj.respond_to?(:each)
+
+  #   if obj.respond_to?(:call)
+  #     elsif obj.respond.to_?
+  #   end
+  # end
+
+  # Attempt to coerce a suitable object or no-op.
+  #
+  # @param obj [Object] an object to be coerced
+  #
+  # @param thunk [false, true] let a thunk (a zero-arity callable that
+  #  in this case returns a read handle) pass through; if falsy, it
+  #  will execute the thunk and expect it to return something that
+  #  quacks like a read handle, and throw an error if it isn't.
+  #
+  # @raise [ArgumentError] if the input is not sufficiently coercible
+  #
+  # @return [ReadWrapper,Object] a new proxy object around whatever
+  #  the input is, or the original input if file-handle-ey enough
+  #
+  def self.coerce obj, thunk: false
+    return obj if [self, Store::Digest::Entry].any? { |c| obj.is_a? c }
+
+    return obj.open('rb') if obj.is_a? Pathname
+
+    return obj if quacks? obj # no need for this if it can read
+
+    return StringIO.new(obj) if obj.is_a? String
+
+    # response bodies /don't do this but other stuff does
+    if obj.respond_to?(:arity) && obj.arity == 0 ||
+        obj.respond_to?(:call) && obj.method(:call).arity == 0
+      # let the thunk through
+      return obj if thunk
+
+      out = obj.call
+      raise ArgumentError,
+        'a `call` with no arguments must return an IO-like object' unless
+        quacks? out
+
+      return out
+    end
+
+    new obj
+  end
+
+  class << self
+    alias_method :[], :coerce
+  end
+
+  # Initialize a wrapper.
+  #
+  # @param obj [#call, #each] a suitable object
+  #
+  # @raise [ArgumentError] said object is unsuitable
+  #
+  def initialize obj
+    test = obj.respond_to?(:arity) ? obj :
+      obj.respond_to?(:call) ? obj.method(:call) : nil
+
+    if test
+      raise ArgumentError,
+        'Callable object is expected to take a write handle as an argument' if
+        test.arity == 0
+    elsif obj.respond_to?(:each)
+      nil
+    elsif obj.respond_to? :to_s
+      obj = [obj.to_s]
+    else
+      raise ArgumentError,
+        'Argument must respond to #call(write_fh) or #each or #to_s'
+    end
+
+    @done  = false
+    @mutex = Mutex.new
+
+    @read, @write = IO.pipe
+
+    @thread = Thread.new do
+      if obj.respond_to? :call
+        obj.call @write
+      else
+        obj.each { |x| @write << x.to_s.b }
+      end
+    rescue Errno::EPIPE # => e
+      nil # not sure if we do anything here
+    ensure
+      @write.close unless @write.closed?
+    end
+  end
+
+  # `gets` for parity with IO
+  #
+  # @return [String, nil]
+  #
+  def gets sep = $/, chomp = false
+    unless @read.closed?
+      out = @read.gets sep, chomp
+      cleanup if out.nil?
+
+      out
+    end
+  end
+
+  # `read` for parity with IO
+  #
+  # @param maxlen [Integer] the length to read
+  # @param string [String] an optional string
+  #
+  # @return [String, nil]
+  #
+  def read maxlen = nil, string = nil
+    unless @read.closed?
+      out = @read.read maxlen, string
+      cleanup if out.nil?
+
+      out
+    end
+  end
+
+  # `close` for parity with IO
+  #
+  def close
+    cleanup
+    nil # close returns nil
+  end
+end
+
+# for the symbol
+class Store::Digest::Entry; end

data/lib/store/digest/version.rb

@@ -1,5 +1,5 @@
 module Store
   class Digest
-    VERSION = "0.3.1"
+    VERSION = "0.4.3".freeze
   end
 end