gom 0.2.0 → 0.3.0

data/README.rdoc

@@ -24,6 +24,17 @@ Look at the adapter pages to see the adapter-specific configuration values.
 
 == How to use
 
+=== Setup the system
+
+First step after the configuration has been read is to setup the whole storage system. This can be done by
+
+  GOM::Storage.setup
+
+The call should be done during the initialization of your application and triggers each storage adapter to do his own
+setup. To shutdown the system and trigger final clean ups simply call
+
+  GOM::Storage.teardown
+
 === Storing an object
 
 To store an object just pass it to <tt>GOM::Storage.store</tt>.
@@ -179,3 +190,7 @@ Development has been done test-driven and the code follows at most the Clean Cod
 removed by using the reek[http://github.com/kevinrutherford/reek] code smell detector.
 
 This project is still experimental and under development. Any bug report and contribution is welcome!
+
+== Support
+
+Apart from contribution, support via Flattr[http://flattr.com/thing/108957/Generic-Object-Mapper-for-Ruby] is welcome.

data/Rakefile

@@ -35,7 +35,7 @@ end
 
 desc "Run all specs in spec directory"
 RSpec::Core::RakeTask.new do |task|
-  task.pattern = "spec/gom/**/*_spec.rb"
+  task.pattern = "spec/lib/**/*_spec.rb"
 end
 
 namespace :spec do

data/lib/gom.rb

@@ -2,6 +2,7 @@
 module GOM
 
   autoload :Object, File.join(File.dirname(__FILE__), "gom", "object")
+  autoload :Spec, File.join(File.dirname(__FILE__), "gom", "spec")
   autoload :Storage, File.join(File.dirname(__FILE__), "gom", "storage")
 
 end

data/lib/gom/object.rb

@@ -1,26 +1,22 @@
 
-module GOM
+module GOM::Object
 
-  module Object
+  autoload :Builder, File.join(File.dirname(__FILE__), "object", "builder")
+  autoload :CachedBuilder, File.join(File.dirname(__FILE__), "object", "cached_builder")
+  autoload :Collection, File.join(File.dirname(__FILE__), "object", "collection")
+  autoload :Draft, File.join(File.dirname(__FILE__), "object", "draft")
+  autoload :Id, File.join(File.dirname(__FILE__), "object", "id")
+  autoload :Inspector, File.join(File.dirname(__FILE__), "object", "inspector")
+  autoload :Mapping, File.join(File.dirname(__FILE__), "object", "mapping")
+  autoload :Proxy, File.join(File.dirname(__FILE__), "object", "proxy")
 
-    autoload :Builder, File.join(File.dirname(__FILE__), "object", "builder")
-    autoload :CachedBuilder, File.join(File.dirname(__FILE__), "object", "cached_builder")
-    autoload :Collection, File.join(File.dirname(__FILE__), "object", "collection")
-    autoload :Draft, File.join(File.dirname(__FILE__), "object", "draft")
-    autoload :Id, File.join(File.dirname(__FILE__), "object", "id")
-    autoload :Inspector, File.join(File.dirname(__FILE__), "object", "inspector")
-    autoload :Mapping, File.join(File.dirname(__FILE__), "object", "mapping")
-    autoload :Proxy, File.join(File.dirname(__FILE__), "object", "proxy")
-
-    def self.id(object)
-      id = Mapping.id_by_object object
-      id ? id.to_s : nil
-    end
-
-    def self.reference(object)
-      Proxy.new object
-    end
+  def self.id(object)
+    id = Mapping.id_by_object object
+    id ? id.to_s : nil
+  end
 
+  def self.reference(object)
+    Proxy.new object
   end
 
 end

data/lib/gom/object/builder.rb

@@ -1,47 +1,49 @@
 
-module GOM
+# Build an object out of the given draft.
+class GOM::Object::Builder
 
-  module Object
+  attr_accessor :draft
+  attr_writer :object
 
-    # Build an object out of the given draft.
-    class Builder
-
-      attr_accessor :draft
-      attr_writer :object
-
-      def initialize(draft, object = nil)
-        @draft, @object = draft, object
-      end
+  def initialize(draft, object = nil)
+    @draft, @object = draft, object
+  end
 
-      def object
-        initialize_object unless @object
-        set_properties
-        set_relations
-        @object
-      end
+  def object
+    initialize_object unless @object
+    set_properties
+    set_relations
+    @object
+  end
 
-      private
+  private
 
-      def initialize_object
-        klass = Object.const_get @draft.class_name
-        arity = [ klass.method(:new).arity, 0 ].max
-        @object = klass.new *([ nil ] * arity)
-      end
+  def initialize_object
+    set_class
+    arity = [ @klass.method(:new).arity, 0 ].max
+    @object = @klass.new *([ nil ] * arity)
+  end
 
-      def set_properties
-        @draft.properties.each do |name, value|
-          @object.instance_variable_set :"@#{name}", value
-        end
-      end
+  def set_class
+    names = @draft.class_name.split "::"
+    names.shift if names.empty? || names.first.empty?
 
-      def set_relations
-        @draft.relations.each do |name, value|
-          @object.instance_variable_set :"@#{name}", value
-        end
-      end
+    @klass = ::Object
+    names.each do |name|
+      @klass = @klass.const_defined?(name) ? @klass.const_get(name) : @klass.const_missing(name)
+    end
+  end
 
+  def set_properties
+    @draft.properties.each do |name, value|
+      @object.instance_variable_set :"@#{name}", value
     end
+  end
 
+  def set_relations
+    @draft.relations.each do |name, value|
+      @object.instance_variable_set :"@#{name}", value
+    end
   end
 
 end

data/lib/gom/object/cached_builder.rb

@@ -1,42 +1,34 @@
 
-module GOM
+# Build an object out of the given draft using Builder. Uses the object-id mapping
+# for caching the results.
+class GOM::Object::CachedBuilder
 
-  module Object
+  attr_accessor :draft
+  attr_accessor :id
 
-    # Build an object out of the given draft using Builder. Uses the object-id mapping
-    # for caching the results.
-    class CachedBuilder
-
-      attr_accessor :draft
-      attr_accessor :id
-
-      def initialize(draft, id = nil)
-        @draft, @id = draft, id
-      end
-
-      def object
-        check_mapping
-        build_object
-        set_mapping
-        @object
-      end
-
-      private
+  def initialize(draft, id = nil)
+    @draft, @id = draft, id
+  end
 
-      def check_mapping
-        @object = GOM::Object::Mapping.object_by_id @id
-      end
+  def object
+    check_mapping
+    build_object
+    set_mapping
+    @object
+  end
 
-      def build_object
-        @object = GOM::Object::Builder.new(@draft, @object).object
-      end
+  private
 
-      def set_mapping
-        GOM::Object::Mapping.put @object, @id
-      end
+  def check_mapping
+    @object = GOM::Object::Mapping.object_by_id @id
+  end
 
-    end
+  def build_object
+    @object = GOM::Object::Builder.new(@draft, @object).object
+  end
 
+  def set_mapping
+    GOM::Object::Mapping.put @object, @id
   end
 
 end

data/lib/gom/object/collection.rb

@@ -1,72 +1,64 @@
 
-module GOM
+# A class for a collection of objects.
+class GOM::Object::Collection
 
-  module Object
-
-    # A class for a collection of objects.
-    class Collection
-
-      def initialize(fetcher)
-        @fetcher = fetcher
-      end
-
-      def total_count
-        @fetcher.total_count
-      end
-
-      def respond_to?(method_name)
-        (@object_proxies || @rows).respond_to?(method_name)
-      end
-
-      def method_missing(method_name, *arguments, &block)
-        load unless (@object_proxies || @rows)
-        (@object_proxies || @rows).send method_name, *arguments, &block
-      end
-
-      private
+  def initialize(fetcher)
+    @fetcher = fetcher
+  end
 
-      def load
-        if fetcher_has_drafts?
-          load_object_proxies_from_drafts
-        elsif fetcher_has_ids?
-          load_object_proxies_from_ids
-        elsif fetcher_has_rows?
-          load_rows
-        else
-          raise NotImplementedError, "the collection fetcher doesn't provide drafts, ids nor rows."
-        end
-      end
+  def total_count
+    @fetcher.total_count
+  end
 
-      def fetcher_has_drafts?
-        @fetcher.respond_to?(:drafts) && @fetcher.drafts
-      end
+  def respond_to?(method_name)
+    (@object_proxies || @rows).respond_to?(method_name)
+  end
 
-      def load_object_proxies_from_drafts
-        @object_proxies = @fetcher.drafts.map do |draft|
-          GOM::Object::Proxy.new GOM::Object::CachedBuilder.new(draft).object
-        end
-      end
+  def method_missing(method_name, *arguments, &block)
+    load unless (@object_proxies || @rows)
+    (@object_proxies || @rows).send method_name, *arguments, &block
+  end
 
-      def fetcher_has_ids?
-        @fetcher.respond_to?(:ids) && @fetcher.ids
-      end
+  private
+
+  def load
+    if fetcher_has_drafts?
+      load_object_proxies_from_drafts
+    elsif fetcher_has_ids?
+      load_object_proxies_from_ids
+    elsif fetcher_has_rows?
+      load_rows
+    else
+      raise NotImplementedError, "the collection fetcher doesn't provide drafts, ids nor rows."
+    end
+  end
 
-      def load_object_proxies_from_ids
-        @object_proxies = @fetcher.ids.map do |id|
-          GOM::Object::Proxy.new id
-        end
-      end
+  def fetcher_has_drafts?
+    @fetcher.respond_to?(:drafts) && @fetcher.drafts
+  end
 
-      def fetcher_has_rows?
-        @fetcher.respond_to?(:rows) && @fetcher.rows
-      end
+  def load_object_proxies_from_drafts
+    @object_proxies = @fetcher.drafts.map do |draft|
+      GOM::Object::Proxy.new GOM::Object::CachedBuilder.new(draft).object
+    end
+  end
 
-      def load_rows
-        @rows = @fetcher.rows
-      end
+  def fetcher_has_ids?
+    @fetcher.respond_to?(:ids) && @fetcher.ids
+  end
 
+  def load_object_proxies_from_ids
+    @object_proxies = @fetcher.ids.map do |id|
+      GOM::Object::Proxy.new id
     end
+  end
+
+  def fetcher_has_rows?
+    @fetcher.respond_to?(:rows) && @fetcher.rows
+  end
 
+  def load_rows
+    @rows = @fetcher.rows
   end
 
 end

data/lib/gom/object/draft.rb

@@ -1,34 +1,26 @@
 
-module GOM
+# A draft for an object
+class GOM::Object::Draft
 
-  module Object
+  attr_accessor :id
+  attr_accessor :class_name
+  attr_writer :properties
+  attr_writer :relations
 
-    # A draft for an object
-    class Draft
-
-      attr_accessor :id
-      attr_accessor :class_name
-      attr_writer :properties
-      attr_writer :relations
-
-      def initialize(id = nil, class_name = nil, properties = { }, relations = { })
-        @id, @class_name, @properties, @relations = id, class_name, properties, relations
-      end
-
-      def properties
-        @properties || { }
-      end
-
-      def relations
-        @relations || { }
-      end
+  def initialize(id = nil, class_name = nil, properties = { }, relations = { })
+    @id, @class_name, @properties, @relations = id, class_name, properties, relations
+  end
 
-      def ==(other)
-        id == other.id && class_name == other.class_name && properties == other.properties && relations == other.relations
-      end
+  def properties
+    @properties || { }
+  end
 
-    end
+  def relations
+    @relations || { }
+  end
 
+  def ==(other)
+    id == other.id && class_name == other.class_name && properties == other.properties && relations == other.relations
   end
 
 end

data/lib/gom/object/id.rb

@@ -1,30 +1,22 @@
 
-module GOM
+# Value class for object ids.
+class GOM::Object::Id
 
-  module Object
+  attr_accessor :storage_name
+  attr_accessor :object_id
 
-    # Value class for object ids.
-    class Id
-
-      attr_accessor :storage_name
-      attr_accessor :object_id
-
-      def initialize(id_or_storage_name = nil, object_id = nil)
-        @storage_name, @object_id = id_or_storage_name.is_a?(String) ?
-          (object_id.is_a?(String) ? [ id_or_storage_name, object_id ] : id_or_storage_name.split(":")) :
-          [ nil, nil ]
-      end
-
-      def ==(other)
-        other.is_a?(self.class) && @storage_name == other.storage_name && @object_id == other.object_id
-      end
-
-      def to_s
-        "#{@storage_name}:#{@object_id}"
-      end
+  def initialize(id_or_storage_name = nil, object_id = nil)
+    @storage_name, @object_id = id_or_storage_name.is_a?(String) ?
+      (object_id.is_a?(String) ? [ id_or_storage_name, object_id ] : id_or_storage_name.split(":")) :
+      [ nil, nil ]
+  end
 
-    end
+  def ==(other)
+    other.is_a?(self.class) && @storage_name == other.storage_name && @object_id == other.object_id
+  end
 
+  def to_s
+    "#{@storage_name}:#{@object_id}"
   end
 
 end