gom 0.1.0

data/lib/gom/spec.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+
+require File.join(File.dirname(__FILE__), "spec", "acceptance", "adapter_with_stateful_storage")
+require File.join(File.dirname(__FILE__), "spec", "acceptance", "read_only_adapter_with_stateless_storage")

data/lib/gom/spec/acceptance/adapter_with_stateful_storage.rb

@@ -0,0 +1,111 @@
+
+shared_examples_for "an adapter connected to a stateful storage" do
+
+  before :all do
+    GOM::Storage.setup
+  end
+
+  before :each do
+    @related_object = Object.new
+    @related_object.instance_variable_set :@number, 16
+
+    @object = Object.new
+    @object.instance_variable_set :@number, 11
+    @object.instance_variable_set :@related_object, GOM::Object.reference(@related_object)
+  end
+
+  describe "fetching an object" do
+
+    before :each do
+      GOM::Storage.store @object, :test_storage
+      @id = GOM::Object.id(@object)
+
+      @object = GOM::Storage.fetch @id
+    end
+
+    after :each do
+      GOM::Storage.remove @object
+    end
+
+    it "should return an object of the correct class" do
+      @object.class.should == Object
+    end
+
+    it "should set the object's instance variables" do
+      @object.instance_variable_get(:@number).should == 11
+    end
+
+    it "should assign an object id" do
+      GOM::Object.id(@object).should == @id
+    end
+
+    it "should also fetch the related object" do
+      related_object = @object.instance_variable_get :@related_object
+      related_object.should be_instance_of(GOM::Object::Proxy)
+      related_object.object.should == @related_object
+      related_object.object.instance_variable_get(:@number).should == 16
+    end
+
+  end
+
+  describe "storing an object" do
+
+    it "should store the object" do
+      GOM::Storage.store @object, :test_storage
+      object = GOM::Storage.fetch GOM::Object.id(@object)
+      object.should == @object
+    end
+
+    it "should use default storage if nothing specified" do
+      GOM::Storage.store @object
+      GOM::Object.id(@object).should =~ /^test_storage:/
+    end
+
+    it "should set the object's id" do
+      GOM::Storage.store @object, :test_storage
+      GOM::Object.id(@object).should =~ /^test_storage:.+$/
+    end
+
+    it "should store the related object" do
+      GOM::Storage.store @object, :test_storage
+      related_object = GOM::Storage.fetch GOM::Object.id(@related_object)
+      related_object.should == @related_object
+      related_object.instance_variable_get(:@number).should == 16
+    end
+
+  end
+
+  describe "removing an object" do
+
+    before :each do
+      GOM::Storage.store @object, :test_storage
+      @id = GOM::Object.id @object
+    end
+
+    after :each do
+      GOM::Storage.remove @related_object
+    end
+
+    it "should remove the object" do
+      GOM::Storage.remove @object
+      GOM::Storage.fetch(@id).should be_nil
+    end
+
+    it "should remove the object identified by the id" do
+      GOM::Storage.remove @id
+      GOM::Storage.fetch(@id).should be_nil
+    end
+
+    it "should remove the object's id" do
+      GOM::Storage.remove @object
+      GOM::Object.id(@object).should be_nil
+    end
+
+    it "should not remove the related object" do
+      GOM::Storage.remove @object
+      GOM::Object.id(@related_object).should_not be_nil
+    end
+
+  end
+
+end

data/lib/gom/spec/acceptance/read_only_adapter_with_stateless_storage.rb

@@ -0,0 +1,50 @@
+
+shared_examples_for "a read-only adapter connected to a stateless storage" do
+
+  before :all do
+    GOM::Storage.setup
+  end
+
+  describe "fetching an object" do
+
+    it "should return the correct object" do
+      object = GOM::Storage.fetch "test_storage:object_1"
+      object.should be_instance_of(Object)
+      object.instance_variable_get(:@number).should == 5
+      GOM::Object.id(object).should == "test_storage:object_1"
+    end
+
+    it "should return proxy objects that fetches the related objects" do
+      object = GOM::Storage.fetch "test_storage:object_1"
+      related_object = object.instance_variable_get :@related_object
+      related_object.should be_instance_of(GOM::Object::Proxy)
+      related_object.object.instance_variable_get(:@test).should == "test value"
+    end
+
+  end
+
+  describe "storing an object" do
+
+    it "should raise a ReadOnlyError" do
+      lambda do
+        GOM::Storage.store Object.new, "test_storage"
+      end.should raise_error(GOM::Storage::ReadOnlyError)
+    end
+
+  end
+
+  describe "removing an object" do
+
+    before :each do
+      @object = GOM::Storage.fetch "test_storage:object_1"
+    end
+
+    it "should raise a ReadOnlyError" do
+      lambda do
+        GOM::Storage.remove @object
+      end.should raise_error(GOM::Storage::ReadOnlyError)
+    end
+
+  end
+
+end

data/lib/gom/storage.rb

@@ -0,0 +1,35 @@
+
+module GOM
+
+  module Storage
+
+    autoload :Configuration, File.join(File.dirname(__FILE__), "storage", "configuration")
+    autoload :Adapter, File.join(File.dirname(__FILE__), "storage", "adapter")
+    autoload :Fetcher, File.join(File.dirname(__FILE__), "storage", "fetcher")
+    autoload :Saver, File.join(File.dirname(__FILE__), "storage", "saver")
+    autoload :Remover, File.join(File.dirname(__FILE__), "storage", "remover")
+
+    # This error can be thrown by an adapter if it's doesn't support write operations
+    class ReadOnlyError < StandardError; end
+
+    def self.setup
+      Configuration.setup_all
+    end
+
+    def self.fetch(id_string)
+      id = id_string.is_a?(String) ? GOM::Object::Id.new(id_string) : nil
+      Fetcher.new(id).object
+    end
+
+    def self.store(object, storage_name = nil)
+      Saver.new(object, storage_name).perform
+    end
+
+    def self.remove(object_or_id)
+      object_or_id = GOM::Object::Id.new object_or_id if object_or_id.is_a?(String)
+      Remover.new(object_or_id).perform
+    end
+
+  end
+
+end

data/lib/gom/storage/adapter.rb

@@ -0,0 +1,51 @@
+
+module GOM
+
+  module Storage
+
+    # Base class for a storage adapter
+    class Adapter
+
+      attr_reader :configuration
+
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def setup
+        not_implemented "setup"
+      end
+
+      def fetch
+        not_implemented "fetch"
+      end
+
+      def store
+        not_implemented "store"
+      end
+
+      def remove
+        not_implemented "remove"
+      end
+
+      private
+
+      def not_implemented(method_name)
+        raise NotImplementedError, "The adapter has no #{method_name} method implemented"
+      end
+
+      def self.register(id, adapter_class)
+        @adapter_classes ||= { }
+        @adapter_classes[id.to_sym] = adapter_class
+      end
+
+      def self.[](id)
+        @adapter_classes ||= { }
+        @adapter_classes[id.to_sym]
+      end
+
+    end
+
+  end
+
+end

data/lib/gom/storage/configuration.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(__FILE__), "adapter")
+require 'yaml'
+
+module GOM
+
+  module Storage
+
+    # Stores all information to configure a storage
+    class Configuration
+
+      attr_reader :name
+
+      def initialize(name, hash)
+        @name, @hash = name, { }
+        hash.each{ |key, value| @hash[key.to_sym] = value }
+      end
+
+      def setup
+        adapter.setup
+      end
+
+      def adapter
+        @adapter ||= adapter_class.new self
+      end
+
+      def adapter_class
+        @adapter_class ||= Adapter[@hash[:adapter]]
+      end
+
+      def [](key)
+        @hash[key.to_sym]
+      end
+
+      def values_at(*arguments)
+        arguments.map{ |argument| self[argument] }
+      end
+
+      def self.read(file_name)
+        @configurations = { }
+        YAML::load_file(file_name).each do |name, values|
+          @configurations[name.to_sym] = self.new name, values
+        end
+      end
+
+      def self.setup_all
+        @configurations.values.each do |configuration|
+          configuration.setup
+        end
+      end
+
+      def self.[](name)
+        @configurations ||= { }
+        @configurations[name.to_sym]
+      end
+
+      def self.default
+        @configurations ||= { }
+        @configurations.values.first || raise(StandardError, "No storage configuration loaded!")
+      end
+
+    end
+
+  end
+
+end

data/lib/gom/storage/fetcher.rb

@@ -0,0 +1,69 @@
+
+module GOM
+
+  module Storage
+
+    # Fetches an object from the storage.
+    class Fetcher
+
+      attr_accessor :id
+
+      def initialize(id)
+        @id = id
+      end
+
+      def object
+        perform
+        @object
+      end
+
+      private
+
+      def perform
+        fetch_object_hash
+        return unless has_object_hash?
+        initialize_object
+        inject_object_hash
+        set_mapping
+      end
+
+      def fetch_object_hash
+        @object_hash = @id ? adapter.fetch(@id.object_id) : nil
+      end
+
+      def has_object_hash?
+        !!@object_hash
+      end
+
+      def initialize_object
+        @object = GOM::Object::Mapping.object_by_id @id
+        unless @object
+          klass = object_class
+          arity = [ klass.method(:new).arity, 0 ].max
+          @object = klass.new *([ nil ] * arity)
+        end
+      end
+
+      def inject_object_hash
+        injector = GOM::Object::Injector.new @object, @object_hash
+        injector.perform
+        @object = injector.object
+      end
+
+      def set_mapping
+        GOM::Object::Mapping.put @object, @id
+      end
+
+      def adapter
+        @adapter ||= GOM::Storage::Configuration[@id.storage_name].adapter
+      end
+
+      def object_class
+        Object.const_get @object_hash[:class]
+      end
+
+    end
+
+  end
+
+end

data/lib/gom/storage/remover.rb

@@ -0,0 +1,47 @@
+
+module GOM
+
+  module Storage
+
+    # Removes an object from the storage.
+    class Remover
+
+      attr_reader :object
+      attr_reader :id
+
+      def initialize(object_or_id)
+        @object, @id = object_or_id.is_a?(GOM::Object::Id) ?
+          [ nil, object_or_id ] :
+          [ object_or_id, nil ]
+      end
+
+      def perform
+        check_mapping
+        remove_object
+        remove_mapping
+      end
+
+      private
+
+      def check_mapping
+        @id ||= GOM::Object::Mapping.id_by_object @object
+        raise ArgumentError, "No id existing for the given object!" unless @id
+      end
+
+      def remove_object
+        adapter.remove @id.object_id
+      end
+
+      def remove_mapping
+        GOM::Object::Mapping.remove_by_object @object
+      end
+
+      def adapter
+        @adapter ||= GOM::Storage::Configuration[@id.storage_name].adapter
+      end
+
+    end
+
+  end
+
+end

data/lib/gom/storage/saver.rb

@@ -0,0 +1,59 @@
+
+module GOM
+
+  module Storage
+
+    # Stores an object to the storage.
+    class Saver
+
+      attr_reader :object
+      attr_reader :storage_name
+
+      def initialize(object, storage_name = nil)
+        @object, @storage_name = object, storage_name
+      end
+
+      def perform
+        fetch_id
+        update_storage_name
+        inspect_object
+        store_object_hash
+        store_id
+      end
+
+      private
+
+      def fetch_id
+        @id = GOM::Object::Mapping.id_by_object @object
+      end
+
+      def update_storage_name
+        @storage_name ||= @id.storage_name if @id
+        @storage_name ||= GOM::Storage::Configuration.default.name
+      end
+
+      def inspect_object
+        inspector = GOM::Object::Inspector.new @object
+        inspector.perform
+        @object_hash = inspector.object_hash
+        @object_hash[:id] = @id.object_id if @id
+      end
+
+      def store_object_hash
+        object_id = adapter.store @object_hash
+        @id = GOM::Object::Id.new @storage_name.to_s, object_id
+      end
+
+      def store_id
+        GOM::Object::Mapping.put @object, @id
+      end
+
+      def adapter
+        GOM::Storage::Configuration[@storage_name].adapter
+      end
+
+    end
+
+  end
+
+end