gom 0.3.1 → 0.4.0

data/README.rdoc

@@ -10,15 +10,14 @@ is plugged-in via an adapter interface. Currently, the following adapters are pr
 
 == Configuration
 
-At the beginning of your program the configuration should be read with the following command.
+At the beginning of your program the storage configuration should be done with the <tt>GOM::Storage.configure</tt>
+command.
 
-  GOM::Storage::Configuration.read filename
-
-The configuration file should be written in the YML format and look like...
-
-  storage_name:
-    adapter: filesystem
-    directory: /var/project-name/data
+  GOM::Storage.configure {
+    name :storage_name
+    adapter :filesystem
+    directory "/var/project-name/data"
+  }
 
 Look at the adapter pages to see the adapter-specific configuration values.
 
@@ -124,13 +123,16 @@ of results at runtime. There are several kinds of views.
 There views simply provides a collection of all object of a specified class. They are defined at the storage
 configuration.
 
-  storage_name:
-    adapter: filesystem
-    directory: /var/project-name/data
-    views:
-      users:
-        type: class
-        class: User
+  GOM::Storage.configure {
+    name :storage_name
+    adapter :filesystem
+    directory "/var/project-name/data"
+    view {
+      name :users
+      type :class
+      model_class User
+    }
+  }
 
 The example defines a class view for all objects of the class <tt>User</tt>. The result can be fetched via...
 
@@ -143,21 +145,26 @@ array.
 
 These views are also defined in the storage configuration.
 
-  storage_name:
-    adapter: couchdb
-    views:
-      active_user_count:
-        type: map_reduce
-        map:
-          function(document) {
-            if (document['model_class'] == 'User' && document['active']) {
-              emit(document['_id'], 1);
-            }
-          }
-        reduce:
-          function(keys, values, rereduce) {
-            return sum(values);
+  GOM::Storage.configure {
+    name :storage_name
+    adapter :couchdb
+    view {
+      name :active_user_count
+      type :map_reduce
+      map_function """
+        function(document) {
+          if (document['model_class'] == 'User' && document['active']) {
+            emit(document['_id'], 1);
           }
+        }
+      """
+      reduce_function """
+        function(keys, values, rereduce) {
+          return sum(values);
+        }
+      """
+    }
+  }
 
 The example defined a map/reduce view that results in a single row with the count of all active users. This row can be
 fetched by...
@@ -168,17 +175,21 @@ fetched by...
 If no <tt>reduce</tt> method is given, <tt>GOM</tt> will try to map the fetched data back to ruby-objects. The
 definition would be...
 
-  storage_name:
-    adapter: couchdb
-    views:
-      active_users:
-        type: map_reduce
-        map:
-          function(document) {
-            if (document['model_class'] == 'User') {
-              emit(document['_id'], null);
-            }
+  GOM::Storage.configure {
+    name :storage_name
+    adapter :couchdb
+    view {
+      name :active_users
+      type :map_reduce
+      map_function """
+        function(document) {
+          if (document['model_class'] == 'User') {
+            emit(document['_id'], null);
           }
+        }
+      """
+    }
+  }
 
 ...and the fetch is done by...
 

data/lib/gom/storage.rb

@@ -14,6 +14,10 @@ module GOM::Storage
   # This error can be thrown by an adapter if it's doesn't support write operations
   class ReadOnlyError < StandardError; end
 
+  def self.configure(&block)
+    Configuration.configure &block
+  end
+
   def self.setup
     GOM::Object::Mapping.clear!
     Configuration.setup_all

data/lib/gom/storage/configuration.rb

@@ -1,15 +1,29 @@
 require 'yaml'
+require 'configure'
 
 # Stores all information to configure a storage.
 class GOM::Storage::Configuration
 
   autoload :View, File.join(File.dirname(__FILE__), "configuration", "view")
 
-  attr_reader :name
+  SCHEMA = Configure::Schema.build{
+    only :storage
+    nested {
+      storage {
+        not_nil :name, :adapter
+        nested {
+          view {
+            not_nil :name, :type
+          }
+        }
+      }
+    }
+  }.freeze
+
   attr_reader :hash
 
-  def initialize(name, hash)
-    @name, @hash = name, { }
+  def initialize(hash)
+    @hash = { }
     hash.each{ |key, value| @hash[key.to_sym] = value }
   end
 
@@ -22,6 +36,10 @@ class GOM::Storage::Configuration
     clear_adapter
   end
 
+  def name
+    @hash[:name].to_s
+  end
+
   def adapter
     @adapter ||= adapter_class.new self
   end
@@ -41,7 +59,8 @@ class GOM::Storage::Configuration
   def views
     @views ||= begin
       result = { }
-      (self["views"] || { }).each do |name, hash|
+      [ @hash[:view] ].flatten.compact.each do |hash|
+        name = hash[:name]
         result[name.to_sym] = self.class.view hash
       end
       result
@@ -54,26 +73,28 @@ class GOM::Storage::Configuration
     @adapter, @adapter_class = nil, nil
   end
 
+  def self.configure(&block)
+    @configurations = { }
+    configurations = Configure.process SCHEMA, &block
+    [ configurations[:storage] ].flatten.compact.each do |hash|
+      name = hash[:name]
+      @configurations[name.to_sym] = self.new hash
+    end
+  end
+
   def self.view(hash)
-    type = hash["type"]
+    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.class_view(hash)
-    View::Class.new hash["class"]
+    View::Class.new hash[:model_class]
   end
 
   def self.map_reduce_view(hash)
-    View::MapReduce.new *hash.values_at("map", "reduce")
-  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
+    View::MapReduce.new *hash.values_at(:map_function, :reduce_function)
   end
 
   def self.setup_all

data/spec/acceptance/adapter_spec.rb

@@ -1,7 +1,5 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
 
-GOM::Storage::Configuration.read File.join(File.dirname(__FILE__), "..", "storage.configuration")
-
 describe "adapter" do
 
   before :each do
@@ -19,4 +17,4 @@ describe "adapter" do
 
   end
 
-end
+end

data/spec/acceptance/fake_adapter_spec.rb

@@ -1,7 +1,5 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
 
-GOM::Storage::Configuration.read File.join(File.dirname(__FILE__), "..", "storage.configuration")
-
 describe "fake adapter" do
 
   it_should_behave_like "an adapter that needs setup"

data/spec/acceptance/object_spec.rb

@@ -1,7 +1,5 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
 
-GOM::Storage::Configuration.read File.join(File.dirname(__FILE__), "..", "storage.configuration")
-
 describe "object" do
 
   before :each do

data/spec/lib/gom/storage/configuration_spec.rb

@@ -5,13 +5,29 @@ describe GOM::Storage::Configuration do
   before :each do
     @adapter = mock GOM::Storage::Adapter, :setup => nil
     @adapter_class = mock Class, :new => @adapter
-    GOM::Storage::Adapter.stub(:[]).and_return(@adapter_class)
-
-    described_class.read File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "storage.configuration"))
+    GOM::Storage::Adapter.stub :[] => @adapter_class
+
+    described_class.configure {
+      storage {
+        name :test_storage
+        adapter :test
+        view {
+          name :test_object_class_view
+          type :class
+          model_class Object
+        }
+        view {
+          name :test_map_view
+          type :map_reduce
+          map_function "function(document) { }"
+          reduce_function "function(key, values) { }"
+        }
+      }
+    }
     @configuration = described_class[:test_storage]
   end
 
-  describe "setup" do
+  describe "#setup" do
 
     it "should call setup on the adapter instance" do
       @adapter.should_receive(:setup)
@@ -20,7 +36,7 @@ describe GOM::Storage::Configuration do
 
   end
 
-  describe "teardown" do
+  describe "#teardown" do
 
     it "should call teardown on the adapter instance" do
       @adapter.should_receive(:teardown)
@@ -29,7 +45,12 @@ describe GOM::Storage::Configuration do
 
   end
 
-  describe "adapter_class" do
+  describe "#adapter_class" do
+
+    it "should fetch the right adapter class" do
+      GOM::Storage::Adapter.should_receive(:[]).with(:test).and_return(@adapter_class)
+      @configuration.adapter_class
+    end
 
     it "should return the adapter class" do
       adapter_class = @configuration.adapter_class
@@ -45,28 +66,43 @@ describe GOM::Storage::Configuration do
 
   end
 
-  describe "[]" do
+  describe "#[]" do
 
     it "should return the configuration value" do
-      @configuration[:test].should == "test value"
+      @configuration[:name].should == :test_storage
     end
 
   end
 
-  describe "values_at" do
+  describe "#values_at" do
 
     it "should return multiple configuration values" do
-      @configuration.values_at(:adapter, :test).should == [ "fake_adapter", "test value" ]
+      @configuration.values_at(:adapter, :name).should == [ :test, :test_storage ]
+    end
+
+  end
+
+  describe "#self.configure" do
+
+    before :each do
+      @block = Proc.new { }
+      @configuration = { :storage => { :name => :test } }
+      Configure.stub :process => @configuration
+    end
+
+    it "should pass the given block to Configure.process along with the configuration schema" do
+      Configure.should_receive(:process).with(described_class::SCHEMA, &@block).and_return(@configuration)
+      described_class.configure &@block
     end
 
   end
 
-  describe "views" do
+  describe "#self.views" do
 
     it "should return a hash including class views" do
       view = @configuration.views[:test_object_class_view]
       view.should be_instance_of(described_class::View::Class)
-      view.class_name.should == "Object"
+      view.class_name.should == Object
     end
 
     it "should return a hash including map reduce views" do
@@ -77,7 +113,7 @@ describe GOM::Storage::Configuration do
     end
 
     it "should raise a #{NotImplementedError} if the view type is invalid" do
-      @configuration["views"]["test_invalid_view"] = { "type" => "invalid" }
+      @configuration["view"] << { :name => "test", :type => "invalid" }
       lambda do
         @configuration.views[:test_invalid_view]
       end.should raise_error(NotImplementedError)
@@ -90,24 +126,7 @@ describe GOM::Storage::Configuration do
 
   end
 
-  describe "read" do
-
-    it "should read the configuration file" do
-      @configuration.should be_instance_of(described_class)
-    end
-
-    it "should initialize the right adapter class" do
-      @configuration.adapter_class.should == @adapter_class
-    end
-
-    it "should create an adapter instance if requested" do
-      @adapter_class.should_receive(:new).with(@configuration).and_return(@adapter)
-      @configuration.adapter.should == @adapter
-    end
-
-  end
-
-  describe "setup_all" do
+  describe "#self.setup_all" do
 
     before :each do
       @configuration.stub(:setup)
@@ -120,7 +139,7 @@ describe GOM::Storage::Configuration do
 
   end
 
-  describe "teardown_all" do
+  describe "#self.teardown_all" do
 
     before :each do
       @configuration.stub(:teardown)
@@ -133,7 +152,7 @@ describe GOM::Storage::Configuration do
 
   end
 
-  describe "default" do
+  describe "#self.default" do
 
     it "should select the first configuration" do
       described_class.default.should == GOM::Storage::Configuration[:test_storage]

data/spec/lib/gom/storage_spec.rb

@@ -7,11 +7,25 @@ describe GOM::Storage do
     @object = Object.new
   end
 
-  describe "setup" do
+  describe "#self.configure" do
 
     before :each do
-      GOM::Object::Mapping.stub(:clear!)
-      described_class::Configuration.stub(:setup_all)
+      @block = Proc.new { }
+      described_class::Configuration.stub :configure => nil
+    end
+
+    it "should call :configure on the configuration class" do
+      described_class::Configuration.should_receive(:configure).with(&@block)
+      described_class.configure &@block
+    end
+
+  end
+
+  describe "#self.setup" do
+
+    before :each do
+      GOM::Object::Mapping.stub :clear! => nil
+      described_class::Configuration.stub :setup_all => nil
     end
 
     it "should clear the mapping" do
@@ -26,10 +40,10 @@ describe GOM::Storage do
 
   end
 
-  describe "teardown" do
+  describe "#self.teardown" do
 
     before :each do
-      described_class::Configuration.stub(:teardown_all)
+      described_class::Configuration.stub :teardown_all => nil
     end
 
     it "should teardown all storage configurations" do
@@ -39,11 +53,11 @@ describe GOM::Storage do
 
   end
 
-  describe "fetch" do
+  describe "#self.fetch" do
 
     before :each do
       @id = mock GOM::Object::Id
-      GOM::Object::Id.stub(:new).and_return(@id)
+      GOM::Object::Id.stub :new => @id
 
       @fetcher = mock GOM::Storage::Fetcher, :object => @object
       described_class::Fetcher.stub(:new).and_return(@fetcher)
@@ -65,19 +79,19 @@ describe GOM::Storage do
 
     it "should return nil if nil is given" do
       described_class::Fetcher.should_receive(:new).with(nil).and_return(@fetcher)
-      @fetcher.stub(:object).and_return(nil)
+      @fetcher.stub :object => nil
 
       described_class.fetch(nil).should be_nil
     end
 
   end
 
-  describe "store" do
+  describe "#self.store" do
 
     before :each do
       @storage_name = "another_test_storage"
       @saver = mock described_class::Saver, :perform => nil
-      described_class::Saver.stub(:new).and_return(@saver)
+      described_class::Saver.stub :new => @saver
     end
 
     it "should initialize the saver correctly" do
@@ -92,14 +106,14 @@ describe GOM::Storage do
 
   end
 
-  describe "remove" do
+  describe "#self.remove" do
 
     before :each do
       @id = mock GOM::Object::Id
-      GOM::Object::Id.stub(:new).and_return(@id)
+      GOM::Object::Id.stub :new => @id
 
       @remover = mock described_class::Remover, :perform => nil
-      described_class::Remover.stub(:new).and_return(@remover)
+      described_class::Remover.stub :new => @remover
     end
 
     it "should initialize the remover correctly" do
@@ -120,11 +134,11 @@ describe GOM::Storage do
 
   end
 
-  describe "count" do
+  describe "#self.count" do
 
     before :each do
       @counter = mock described_class::Counter, :perform => 1
-      described_class::Counter.stub(:new).and_return(@counter)
+      described_class::Counter.stub :new => @counter
     end
 
     it "should initialize the counter" do
@@ -139,7 +153,7 @@ describe GOM::Storage do
 
   end
 
-  describe "collection" do
+  describe "#self.collection" do
 
     before :each do
       @collection = mock GOM::Object::Collection

data/spec/spec_helper.rb

@@ -5,3 +5,21 @@ require 'rspec'
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "gom"))
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "gom", "spec"))
 require File.join(File.dirname(__FILE__), "fake_adapter")
+
+GOM::Storage.configure {
+  storage {
+    name :test_storage
+    adapter :fake_adapter
+    view {
+      name :test_object_class_view
+      type :class
+      model_class Object
+    }
+    view {
+      name :test_map_view
+      type :map_reduce
+      map_function "function(document) { }"
+      reduce_function "function(key, values) { }"
+    }
+  }
+}

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: gom
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 1
-  version: 0.3.1
+  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors: 
 - "Philipp Br\xC3\xBCll"
@@ -14,36 +10,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 +01:00
+date: 2011-05-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: configure
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: "2"
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: reek
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
         version: "1.2"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 description: Core package of the General Object Mapper.
 email: b.phifty@gmail.com
 executables: []
@@ -119,21 +121,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: gom
-rubygems_version: 1.3.7
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: General Object Mapper - maps any ruby object to different kinds of storage engines and vice versa.