gom 0.2.0 → 0.3.0

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

@@ -5,20 +5,24 @@ shared_examples_for "a read-only adapter connected to a stateless storage" do
     GOM::Storage.setup
   end
 
+  after :all do
+    GOM::Storage.teardown
+  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
+      object.should be_instance_of(GOM::Spec::Object)
+      object.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 = object.related_object
       related_object.should be_instance_of(GOM::Object::Proxy)
-      related_object.object.instance_variable_get(:@test).should == "test value"
+      related_object.object.number.should == 7
     end
 
   end
@@ -58,10 +62,7 @@ shared_examples_for "a read-only adapter connected to a stateless storage" do
       collection = GOM::Storage.collection :test_storage, :test_object_class_view
       collection.size > 0
       collection.each do |object_proxy|
-        (
-          object_proxy.object.instance_variable_get(:@number) == 5 ||
-          object_proxy.object.instance_variable_get(:@test) == "test value"
-        ).should be_true
+        [ 5, 7 ].should include(object_proxy.object.number)
       end
     end
 

data/lib/gom/spec/object.rb

@@ -0,0 +1,8 @@
+
+# A dummy test class
+class GOM::Spec::Object
+
+  attr_accessor :number
+  attr_accessor :related_object
+
+end

data/lib/gom/storage.rb

@@ -1,39 +1,43 @@
 
-module GOM
+module GOM::Storage
 
-  module Storage
+  autoload :Adapter, File.join(File.dirname(__FILE__), "storage", "adapter")
+  autoload :Configuration, File.join(File.dirname(__FILE__), "storage", "configuration")
+  autoload :Fetcher, File.join(File.dirname(__FILE__), "storage", "fetcher")
+  autoload :Remover, File.join(File.dirname(__FILE__), "storage", "remover")
+  autoload :Saver, File.join(File.dirname(__FILE__), "storage", "saver")
 
-    autoload :Adapter, File.join(File.dirname(__FILE__), "storage", "adapter")
-    autoload :Configuration, File.join(File.dirname(__FILE__), "storage", "configuration")
-    autoload :Fetcher, File.join(File.dirname(__FILE__), "storage", "fetcher")
-    autoload :Remover, File.join(File.dirname(__FILE__), "storage", "remover")
-    autoload :Saver, File.join(File.dirname(__FILE__), "storage", "saver")
+  # This error can be thrown by the setup method if the given adapter name isn't registered
+  class AdapterNotFoundError < StandardError; end
 
-    # This error can be thrown by an adapter if it's doesn't support write operations
-    class ReadOnlyError < StandardError; end
+  # 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.setup
+    GOM::Object::Mapping.clear!
+    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.teardown
+    Configuration.teardown_all
+  end
 
-    def self.store(object, storage_name = nil)
-      Saver.new(object, storage_name).perform
-    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.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
+  def self.store(object, storage_name = nil)
+    Saver.new(object, storage_name).perform
+  end
 
-    def self.collection(storage_name, *arguments)
-      Configuration[storage_name].adapter.collection *arguments
-    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
 
+  def self.collection(storage_name, *arguments)
+    Configuration[storage_name].adapter.collection *arguments
   end
 
 end

data/lib/gom/storage/adapter.rb

@@ -1,58 +1,41 @@
 
-module GOM
+# Base class for a storage adapter
+class GOM::Storage::Adapter
 
-  module Storage
+  # If the adapter is used without a setup, this error is may raised.
+  class NoSetupError < StandardError; end
 
-    # Base class for a storage adapter
-    class Adapter
+  # If a view could not be found, this error is raised.
+  class ViewNotFoundError < StandardError; end
 
-      # If a view could not be found, this error is raised.
-      class ViewNotFoundError < StandardError; end
+  attr_reader :configuration
 
-      attr_reader :configuration
-
-      def initialize(configuration)
-        @configuration = configuration
-      end
-
-      def setup(*arguments)
-        not_implemented "setup"
-      end
-
-      def fetch(*arguments)
-        not_implemented "fetch"
-      end
-
-      def store(*arguments)
-        not_implemented "store"
-      end
-
-      def remove(*arguments)
-        not_implemented "remove"
-      end
+  def initialize(configuration)
+    @configuration = configuration
+  end
 
-      def collection(*arguments)
-        not_implemented "collection"
-      end
+  [ :setup, :teardown, :fetch, :store, :remove, :collection ].each do |key|
 
-      private
+    define_method key do |*arguments|
+      not_implemented key
+    end
 
-      def not_implemented(method_name)
-        raise NotImplementedError, "The adapter has no #{method_name} method implemented"
-      end
+  end
 
-      def self.register(id, adapter_class)
-        @adapter_classes ||= { }
-        @adapter_classes[id.to_sym] = adapter_class
-      end
+  private
 
-      def self.[](id)
-        @adapter_classes ||= { }
-        @adapter_classes[id.to_sym]
-      end
+  def not_implemented(method_name)
+    raise NotImplementedError, "The adapter has no #{method_name} method implemented"
+  end
 
-    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

data/lib/gom/storage/configuration.rb

@@ -1,94 +1,101 @@
-require File.join(File.dirname(__FILE__), "adapter")
 require 'yaml'
 
-module GOM
+# Stores all information to configure a storage.
+class GOM::Storage::Configuration
 
-  module Storage
+  autoload :View, File.join(File.dirname(__FILE__), "configuration", "view")
 
-    # Stores all information to configure a storage.
-    class Configuration
+  attr_reader :name
+  attr_reader :hash
 
-      autoload :View, File.join(File.dirname(__FILE__), "configuration", "view")
-
-      attr_reader :name
+  def initialize(name, hash)
+    @name, @hash = name, { }
+    hash.each{ |key, value| @hash[key.to_sym] = value }
+  end
 
-      def initialize(name, hash)
-        @name, @hash = name, { }
-        hash.each{ |key, value| @hash[key.to_sym] = value }
-      end
+  def setup
+    adapter.setup
+  end
 
-      def setup
-        adapter.setup
-      end
+  def teardown
+    adapter.teardown
+    clear_adapter
+  end
 
-      def adapter
-        @adapter ||= adapter_class.new self
-      end
+  def adapter
+    @adapter ||= adapter_class.new self
+  end
 
-      def adapter_class
-        @adapter_class ||= Adapter[@hash[:adapter]]
-      end
+  def adapter_class
+    @adapter_class ||= GOM::Storage::Adapter[@hash[:adapter]] || raise(GOM::Storage::AdapterNotFoundError)
+  end
 
-      def [](key)
-        @hash[key.to_sym]
-      end
+  def [](key)
+    @hash[key.to_sym]
+  end
 
-      def values_at(*arguments)
-        arguments.map{ |argument| self[argument] }
-      end
+  def values_at(*arguments)
+    arguments.map{ |argument| self[argument] }
+  end
 
-      def views
-        @views ||= begin
-          result = { }
-          (self["views"] || { }).each do |name, hash|
-            result[name.to_sym] = self.class.view hash
-          end
-          result
-        end
+  def views
+    @views ||= begin
+      result = { }
+      (self["views"] || { }).each do |name, hash|
+        result[name.to_sym] = self.class.view hash
       end
+      result
+    end
+  end
 
-      private
-
-      def self.view(hash)
-        type = hash["type"]
-        method_name = :"#{type}_view"
-        raise NotImplementedError, "the view type '#{type}' doesn't exists" unless self.respond_to?(method_name)
-        self.send method_name, hash
-      end
+  private
 
-      def self.class_view(hash)
-        View::Class.new hash["class"]
-      end
+  def clear_adapter
+    @adapter, @adapter_class = nil, nil
+  end
 
-      def self.map_reduce_view(hash)
-        View::MapReduce.new *hash.values_at("map", "reduce")
-      end
+  def self.view(hash)
+    type = hash["type"]
+    method_name = :"#{type}_view"
+    raise NotImplementedError, "the view type '#{type}' doesn't exists" unless self.respond_to?(method_name)
+    self.send method_name, hash
+  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.class_view(hash)
+    View::Class.new hash["class"]
+  end
 
-      def self.setup_all
-        @configurations.values.each do |configuration|
-          configuration.setup
-        end
-      end
+  def self.map_reduce_view(hash)
+    View::MapReduce.new *hash.values_at("map", "reduce")
+  end
 
-      def self.[](name)
-        @configurations ||= { }
-        @configurations[name.to_sym]
-      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.default
-        @configurations ||= { }
-        @configurations.values.first || raise(StandardError, "No storage configuration loaded!")
-      end
+  def self.setup_all
+    @configurations.values.each do |configuration|
+      configuration.setup
+    end
+  end
 
+  def self.teardown_all
+    @configurations.values.each do |configuration|
+      configuration.teardown
     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

data/lib/gom/storage/configuration/view.rb

@@ -1,20 +1,7 @@
 
-module GOM
+module GOM::Storage::Configuration::View
 
-  module Storage
-
-    # Stores all information to configure a storage.
-    class Configuration
-
-      module View
-
-        autoload :Class, File.join(File.dirname(__FILE__), "view", "class")
-        autoload :MapReduce, File.join(File.dirname(__FILE__), "view", "map_reduce")
-
-      end
-
-    end
-
-  end
+  autoload :Class, File.join(File.dirname(__FILE__), "view", "class")
+  autoload :MapReduce, File.join(File.dirname(__FILE__), "view", "map_reduce")
 
 end

data/lib/gom/storage/configuration/view/class.rb

@@ -1,28 +1,11 @@
 
-module GOM
+# Contains all the parameters for a class view.
+class GOM::Storage::Configuration::View::Class
 
-  module Storage
-
-    # Stores all information to configure a storage.
-    class Configuration
-
-      module View
-
-        # Contains all the parameters for a class view.
-        class Class
-
-          attr_accessor :class_name
-
-          def initialize(class_name)
-            @class_name = class_name
-          end
-
-        end
-
-      end
-
-    end
+  attr_accessor :class_name
 
+  def initialize(class_name)
+    @class_name = class_name
   end
 
 end

data/lib/gom/storage/configuration/view/map_reduce.rb

@@ -1,29 +1,12 @@
 
-module GOM
+# Contains all parameters for a map reduce view.
+class GOM::Storage::Configuration::View::MapReduce
 
-  module Storage
-
-    # Stores all information to configure a storage.
-    class Configuration
-
-      module View
-
-        # Contains all parameters for a map reduce view.
-        class MapReduce
-
-          attr_accessor :map
-          attr_accessor :reduce
-
-          def initialize(map, reduce)
-            @map, @reduce = map, reduce
-          end
-
-        end
-
-      end
-
-    end
+  attr_accessor :map
+  attr_accessor :reduce
 
+  def initialize(map, reduce)
+    @map, @reduce = map, reduce
   end
 
-end
+end