hold 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccf3c450bd0581651f077eba61da713f1d1d2c55
-  data.tar.gz: 9c91f6779ba78610c0cbf5140f1c401994b04f6a
+  metadata.gz: 5c24da8a40bff937b20200d7c3165c6b7f1aca2a
+  data.tar.gz: 34bc4c8bfe75830097e022376abd0a6b6d431d76
 SHA512:
-  metadata.gz: a9264703012fd325bf2dacd390aa732830dbb6874c2da1cf05a774a15a8424ff300f46c268a6351f983cd9af29a79ccf8851407c8e358dab3b27f4eb74322dc3
-  data.tar.gz: fbf1e4cb8abfd62aad061b5e5675f251e30e2a6d357c8da5e31c021a56d9624c6eeecdf2bf47976512d815fba8f458a1fe67684eefd1c1ea4fa2303a1acad52d
+  metadata.gz: eef09f90c3496dbedf8d9e651e8ae8dd6b9b2501a74fb9cf318c249b846787b622083eaee78a480d8d3a76fdca1611d219b9ec772edd98ca7949834d0cbe59c3
+  data.tar.gz: 3cfc1289ae4df6e2d633af0eeb2cfc129709e2b7d744f17eec5f48ee439ac793fa61dd0ae2a8bb5e8d956bbd9cb7a11f8520453240181e89a361223c7acf7b5e

data/lib/hold.rb

@@ -1,12 +1,20 @@
-require_relative 'hold/interfaces'
-require_relative 'hold/file/hash_repository'
-require_relative 'hold/sequel'
+require 'hold/interfaces'
+require 'hold/file/hash_repository'
+require 'hold/sequel'
 
-module Hold; end
+require 'hold/error'
 
-module Persistence
-  def self.const_missing(const_name)
-    warn "'Persistence' has been deprecated, please use 'Hold' instead"
-    Hold.const_get(const_name)
+# Top level namespace
+module Hold
+end
+
+unless defined?(Persistence)
+
+  # Display a warning if the old gem name is used.
+  module Persistence
+    def self.const_missing(const_name)
+      warn "'Persistence' has been deprecated, please use 'Hold' instead"
+      Hold.const_get(const_name)
+    end
   end
 end

data/lib/hold/error.rb

@@ -0,0 +1,28 @@
+module Hold
+  # Error tag module
+  module Error; end
+
+  # Base error for Hold module
+  class StdError < StandardError
+    extend Error
+
+    attr_reader :original
+
+    def initialize(msg = nil, original = $ERROR_INFO)
+      super(msg)
+      @original = original
+    end
+  end
+
+  # UnsupoortedOperation
+  class UnsupportedOperation < StdError; end
+
+  # EmptyConflict
+  class EmptyConflict < StdError; end
+
+  # IdentityConflict
+  class IdentityConflict < StdError; end
+
+  # MissingIdentity
+  class MissingIdentity < StdError; end
+end

data/lib/hold/file/hash_repository.rb

@@ -1,59 +1,66 @@
 require 'hold/interfaces'
 require 'fileutils'
 
-# A simple HashRepository (ie key/value store implementation) which stores each
-# key in a separate file.
-#
-# * Keys must be suitable pathnames
-# * Values must be strings
-# * base_path should end with a /, or keys should start with a /, one or the other
-# * subdirectories will be created as required if the keys contain path separators
-# * watch out for per-directory file limits.
-#
-# NB: Not threadsafe for writes
 module Hold
-  module File; end
+  module File
+    # A simple HashRepository (ie key/value store implementation) which stores
+    # each key in a separate file.
+    #
+    # * Keys must be suitable pathnames
+    # * Values must be strings
+    # * base_path should end with a /, or keys should start with a /, one or the
+    #   other
+    # * subdirectories will be created as required if the keys contain path
+    #   separators
+    # * watch out for per-directory file limits.
+    #
+    # NB: Not threadsafe for writes
+    class HashRepository
+      include Hold::HashRepository
 
-  class File::HashRepository
-    include Hold::HashRepository
+      def can_get_class?(klass)
+        klass == String
+      end
 
-    def can_get_class?(klass); klass == String; end
-    def can_set_class?(klass); klass == String; end
+      def can_set_class?(klass)
+        klass == String
+      end
 
-    def initialize(base_path)
-      @base_path = base_path
-    end
+      def initialize(base_path)
+        @base_path = base_path
+      end
 
-    def path_to_key(key)
-      "#{@base_path}#{key}"
-    end
+      def path_to_key(key)
+        "#{@base_path}#{key}"
+      end
 
-    def set_with_key(key, value)
-      path = path_to_key(key)
-      FileUtils.mkdir_p(::File.dirname(path))
-      ::File.open(path, "wb") {|file| file.write(value.to_s)}
-      value
-    end
+      def set_with_key(key, value)
+        path = path_to_key(key)
+        FileUtils.mkdir_p(::File.dirname(path))
+        ::File.open(path, 'wb') { |file| file.write(value.to_s) }
+        value
+      end
 
-    def get_with_key(key)
-      path = path_to_key(key)
-      begin
-        ::File.read(path)
-      rescue Errno::ENOENT
+      def get_with_key(key)
+        path = path_to_key(key)
+        begin
+          ::File.read(path)
+        rescue Errno::ENOENT
+        end
       end
-    end
 
-    def clear_key(key)
-      path = path_to_key(key)
-      begin
-        ::File.unlink(path)
-      rescue Errno::ENOENT
+      def clear_key(key)
+        path = path_to_key(key)
+        begin
+          ::File.unlink(path)
+        rescue Errno::ENOENT
+        end
       end
-    end
 
-    def has_key?(key)
-      ::File.exist?(path_to_key(key))
+      def key?(key)
+        ::File.exist?(path_to_key(key))
+      end
+      alias_method :has_key?, :key?
     end
-    alias_method :key?, :has_key?
   end
 end

data/lib/hold/in_memory.rb

@@ -1,184 +1,16 @@
-require 'set'
-
+require 'hold/in_memory/cell'
+require 'hold/in_memory/array_cell'
+require 'hold/in_memory/object_cell'
+require 'hold/in_memory/hash_repository'
+require 'hold/in_memory/set_repository'
+require 'hold/in_memory/identity_set_repository'
+
+# namespace module
 module Hold
-
-  # These are a set of implementations of Hold interfaces based on in-memory storage.
-  # They're not threadsafe or for production use, but are here as lightweight implementations to use in
-  # tests, and for illustrative purposes.
+  # These are a set of implementations of Hold interfaces based on in-memory
+  # storage.  They're not threadsafe or for production use, but are here as
+  # lightweight implementations to use in tests, and for illustrative purposes.
   module InMemory; end
 
   ARG_EMPTY = Object.new.freeze # something different to everything else
-
-  class InMemory::Cell
-    include Hold::Cell
-
-    # new -- empty
-    # new(nil) -- non-empty, value is nil
-    # new(123) -- non-empty, value is 123
-    def initialize(value=ARG_EMPTY)
-      @value = value unless ARG_EMPTY.equal?(value)
-    end
-
-    def get
-      @value
-    end
-
-    def set(value)
-      @value = value
-    end
-
-    def empty?
-      !instance_variable_defined?(:@value)
-    end
-
-    def clear
-      remove_instance_variable(:@value) if instance_variable_defined?(:@value)
-    end
-  end
-
-  class InMemory::ArrayCell
-    include Hold::ArrayCell
-
-    def initialize(array=[])
-      @array = array
-    end
-
-    def get
-      @array.dup
-    end
-
-    def set(value)
-      @array.replace(value)
-    end
-
-    def get_slice(start,length)
-      @array[start, length]
-    end
-
-    def get_length
-      @array.length
-    end
-  end
-
-  class InMemory::ObjectCell < InMemory::Cell
-    include Hold::ObjectCell
-
-    def get
-      @value && @value.dup
-    end
-
-    def get_property(property_name)
-      @value && @value[property_name]
-    end
-
-    def set_property(property_name, value)
-      raise EmptyConflict unless @value
-      @value[property_name] = value
-    end
-
-    def clear_property(property_name)
-      raise EmptyConflict unless @value
-      @value.delete(property_name)
-    end
-
-    def has_property?(property_name)
-      raise EmptyConflict unless @value
-      @value.has_key?(property_name)
-    end
-  end
-
-  class InMemory::HashRepository
-    include Hold::HashRepository
-
-    def initialize
-      @hash = {}
-    end
-
-    def set_with_key(key, value)
-      @hash[key] = value
-    end
-
-    def get_with_key(key)
-      value = @hash[key] and value.dup
-    end
-
-    def clear_key(key)
-      @hash.delete(key)
-    end
-
-    def has_key?(key)
-      @hash.key?(key)
-    end
-    alias_method :key?, :has_key?
-  end
-
-  class InMemory::SetRepository
-    include Hold::SetRepository
-
-    def initialize
-      @set = Set.new
-    end
-
-    def store(value)
-      @set << value
-    end
-
-    def delete(value)
-      @set.delete(value)
-    end
-
-    def contains?(value)
-      @set.include?(value)
-    end
-
-    def get_all
-      @set.to_a
-    end
-  end
-
-  class InMemory::IdentitySetRepository
-    include Hold::IdentitySetRepository
-
-    def initialize(allocates_ids=false)
-      @by_id = {}
-      @id_seq = 0 if allocates_ids
-    end
-
-    def allocates_ids?
-      !!@id_seq
-    end
-
-    def store(object)
-      id = object.id
-      object.send(:id=, id = @id_seq += 1) if @id_seq && !id
-      raise MissingIdentity unless id
-      @by_id[id] = object
-    end
-
-    def delete(object)
-      id = object.id or raise MissingIdentity
-      delete_id(id)
-    end
-
-    def contains?(object)
-      id = object.id or raise MissingIdentity
-      @by_id.include?(id)
-    end
-
-    def get_all
-      @by_id.values
-    end
-
-    def get_by_id(id)
-      value = @by_id[id] and value.dup
-    end
-
-    def delete_id(id)
-      @by_id.delete(id)
-    end
-
-    def contains_id?(id)
-      @by_id.include?(id)
-    end
-  end
 end

data/lib/hold/in_memory/array_cell.rb

@@ -0,0 +1,27 @@
+module Hold
+  module InMemory
+    class ArrayCell
+      include Hold::ArrayCell
+
+      def initialize(array=[])
+        @array = array
+      end
+
+      def get
+        @array.dup
+      end
+
+      def set(value)
+        @array.replace(value)
+      end
+
+      def get_slice(start,length)
+        @array[start, length]
+      end
+
+      def get_length
+        @array.length
+      end
+    end
+  end
+end

data/lib/hold/in_memory/cell.rb

@@ -0,0 +1,30 @@
+module Hold
+  module InMemory
+    class Cell
+      include Hold::Cell
+
+      # new -- empty
+      # new(nil) -- non-empty, value is nil
+      # new(123) -- non-empty, value is 123
+      def initialize(value=ARG_EMPTY)
+        @value = value unless ARG_EMPTY.equal?(value)
+      end
+
+      def get
+        @value
+      end
+
+      def set(value)
+        @value = value
+      end
+
+      def empty?
+        !instance_variable_defined?(:@value)
+      end
+
+      def clear
+        remove_instance_variable(:@value) if instance_variable_defined?(:@value)
+      end
+    end
+  end
+end

data/lib/hold/in_memory/hash_repository.rb

@@ -0,0 +1,28 @@
+module Hold
+  module InMemory
+    class HashRepository
+      include Hold::HashRepository
+
+      def initialize
+        @hash = {}
+      end
+
+      def set_with_key(key, value)
+        @hash[key] = value
+      end
+
+      def get_with_key(key)
+        value = @hash[key] and value.dup
+      end
+
+      def clear_key(key)
+        @hash.delete(key)
+      end
+
+      def has_key?(key)
+        @hash.key?(key)
+      end
+      alias_method :key?, :has_key?
+    end
+  end
+end