gom-filesystem-adapter 0.2.0 → 0.3.0

data/README.rdoc

@@ -52,3 +52,8 @@ 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/108996/Generic-Object-Mapper-Filesystem-adapter]
+is welcome.

data/lib/{filesystem.rb → gom/filesystem-adapter.rb}

@@ -1,4 +1,4 @@
 require 'gom'
-require File.join(File.dirname(__FILE__), "gom", "storage")
+require File.join(File.dirname(__FILE__), "storage")
 
 GOM::Storage::Adapter.register :filesystem, GOM::Storage::Filesystem::Adapter

data/lib/gom/storage.rb

@@ -1,10 +1,6 @@
 
-module GOM
+module GOM::Storage
 
-  module Storage
-
-    autoload :Filesystem, File.join(File.dirname(__FILE__), "storage", "filesystem")
-
-  end
+  autoload :Filesystem, File.join(File.dirname(__FILE__), "storage", "filesystem")
 
 end

data/lib/gom/storage/filesystem.rb

@@ -1,16 +1,8 @@
 
-module GOM
+module GOM::Storage::Filesystem
 
-  module Storage
-
-    module Filesystem
-
-      autoload :Adapter, File.join(File.dirname(__FILE__), "filesystem", "adapter")
-      autoload :Collection, File.join(File.dirname(__FILE__), "filesystem", "collection")
-      autoload :Loader, File.join(File.dirname(__FILE__), "filesystem", "loader")
-
-    end
-
-  end
+  autoload :Adapter, File.join(File.dirname(__FILE__), "filesystem", "adapter")
+  autoload :Collection, File.join(File.dirname(__FILE__), "filesystem", "collection")
+  autoload :Loader, File.join(File.dirname(__FILE__), "filesystem", "loader")
 
 end

data/lib/gom/storage/filesystem/adapter.rb

@@ -1,50 +1,52 @@
 
-module GOM
+# The filesystem storage adapter
+class GOM::Storage::Filesystem::Adapter < GOM::Storage::Adapter
 
-  module Storage
+  attr_reader :drafts
 
-    module Filesystem
-
-      # The filesystem storage adapter
-      class Adapter < GOM::Storage::Adapter
-
-        def setup
-          load_drafts
-        end
-
-        def fetch(id)
-          @drafts[id]
-        end
+  def setup
+    load_drafts
+  end
 
-        def store(*arguments)
-          read_only_error
-        end
+  def teardown
+    @drafts = nil
+  end
 
-        def remove(*arguments)
-          read_only_error
-        end
+  def fetch(id)
+    check_setup
+    @drafts[id]
+  end
 
-        def collection(view_name, options = { })
-          view = configuration.views[view_name.to_sym]
-          raise ViewNotFoundError, "there are no view with the name #{view_name}" unless view
-          fetcher = Collection::Fetcher.new @drafts, view
-          GOM::Object::Collection.new fetcher
-        end
+  def store(*arguments)
+    check_setup
+    read_only_error
+  end
 
-        private
+  def remove(*arguments)
+    check_setup
+    read_only_error
+  end
 
-        def load_drafts
-          @drafts = GOM::Storage::Filesystem::Loader.new(configuration[:directory]).drafts
-        end
+  def collection(view_name, options = { })
+    check_setup
+    view = configuration.views[view_name.to_sym]
+    raise ViewNotFoundError, "there are no view with the name #{view_name}" unless view
+    fetcher = GOM::Storage::Filesystem::Collection::Fetcher.new @drafts, view
+    GOM::Object::Collection.new fetcher
+  end
 
-        def read_only_error
-          raise GOM::Storage::ReadOnlyError, "The adapter doesn't provide write methods"
-        end
+  private
 
-      end
+  def check_setup
+    raise GOM::Storage::Adapter::NoSetupError unless @drafts
+  end
 
-    end
+  def load_drafts
+    @drafts = GOM::Storage::Filesystem::Loader.new(configuration[:files]).drafts
+  end
 
+  def read_only_error
+    raise GOM::Storage::ReadOnlyError, "The adapter doesn't provide write methods"
   end
 
 end

data/lib/gom/storage/filesystem/collection.rb

@@ -1,18 +1,6 @@
 
-module GOM
+module GOM::Storage::Filesystem::Collection
 
-  module Storage
-
-    module Filesystem
-
-      module Collection
-
-        autoload :Fetcher, File.join(File.dirname(__FILE__), "collection", "fetcher")
-
-      end
-
-    end
-
-  end
+  autoload :Fetcher, File.join(File.dirname(__FILE__), "collection", "fetcher")
 
 end

data/lib/gom/storage/filesystem/collection/fetcher.rb

@@ -1,32 +1,16 @@
 
-module GOM
+# A class collection fetcher for the filesystem adapter.
+class GOM::Storage::Filesystem::Collection::Fetcher
 
-  module Storage
+  attr_accessor :drafts
+  attr_accessor :view
 
-    module Filesystem
-
-      module Collection
-
-        # A class collection fetcher for the filesystem adapter.
-        class Fetcher
-
-          attr_accessor :drafts
-          attr_accessor :view
-
-          def initialize(drafts, view)
-            @drafts, @view = drafts, view
-          end
-
-          def drafts
-            @drafts.values.select{ |draft| draft.class_name == @view.class_name }
-          end
-
-        end
-
-      end
-
-    end
+  def initialize(drafts, view)
+    @drafts, @view = drafts, view
+  end
 
+  def drafts
+    @drafts.values.select{ |draft| draft.class_name == @view.class_name }
   end
 
 end

data/lib/gom/storage/filesystem/loader.rb

@@ -1,86 +1,73 @@
 require 'yaml'
 
-module GOM
+# The loader for the filesystem data that is provided by the storage adapter.
+class GOM::Storage::Filesystem::Loader
 
-  module Storage
+  attr_accessor :files
 
-    module Filesystem
-
-      # The loader for the filesystem data that is provided by the storage adapter.
-      class Loader
-
-        attr_accessor :directory
-
-        def initialize(directory)
-          @directory = directory
-        end
-
-        def drafts
-          @drafts = { }
-          load_yml_files
-          @drafts
-        end
-
-        private
-
-        def load_yml_files
-          Dir[File.join(@directory, "*.yml")].each do |filename|
-            load_yml_file filename
-          end
-        end
+  def initialize(files)
+    @files = files
+  end
 
-        def load_yml_file(filename)
-          classname = File.basename(filename).sub(/\..*$/, "")
-          load_file_hash classname, YAML.load_file(filename)
-        end
+  def drafts
+    @drafts = { }
+    load_yml_files
+    @drafts
+  end
 
-        def load_file_hash(classname, file_hash)
-          file_hash.each do |id, hash|
-            @drafts[id] = Builder.new(classname, hash).draft
-          end
-        end
+  private
 
-        # Builds a draft out of the file hashes.
-        class Builder
+  def load_yml_files
+    Dir[@files].each do |filename|
+      load_yml_file filename
+    end
+  end
 
-          def initialize(class_name, hash)
-            @class_name, @hash = class_name, hash
-          end
+  def load_yml_file(filename)
+    load_file_hash YAML.load_file(filename)
+  end
 
-          def draft
-            @draft = GOM::Object::Draft.new
-            set_class_name
-            set_properties
-            set_relations
-            @draft
-          end
+  def load_file_hash(file_hash)
+    file_hash.each do |id, hash|
+      @drafts[id] = Builder.new(hash).draft
+    end
+  end
 
-          private
+  # Builds a draft out of the file hashes.
+  class Builder
 
-          def set_class_name
-            @draft.class_name = @class_name
-          end
+    def initialize(hash)
+      @hash = hash
+    end
 
-          def set_properties
-            properties = { }
-            (@hash["properties"] || { }).each do |key, value|
-              properties[key] = value
-            end
-            @draft.properties = properties unless properties.empty?
-          end
+    def draft
+      @draft = GOM::Object::Draft.new
+      set_class_name
+      set_properties
+      set_relations
+      @draft
+    end
 
-          def set_relations
-            relations = { }
-            (@hash["relations"] || { }).each do |key, value|
-              relations[key] = GOM::Object::Proxy.new GOM::Object::Id.new(value)
-            end
-            @draft.relations = relations unless relations.empty?
-          end
+    private
 
-        end
+    def set_class_name
+      @draft.class_name = @hash["class"] || "Object"
+    end
 
+    def set_properties
+      properties = { }
+      (@hash["properties"] || { }).each do |key, value|
+        properties[key] = value
       end
+      @draft.properties = properties unless properties.empty?
+    end
 
+    def set_relations
+      relations = { }
+      (@hash["relations"] || { }).each do |key, value|
+        relations[key] = GOM::Object::Proxy.new GOM::Object::Id.new(value)
+      end
+      @draft.relations = relations unless relations.empty?
     end
 
   end

data/spec/acceptance/adapter_spec.rb

@@ -1,10 +1,27 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "filesystem"))
 
 GOM::Storage::Configuration.read File.join(File.dirname(__FILE__), "..", "storage.configuration")
 
 describe "filesystem adapter" do
 
+  it_should_behave_like "an adapter that needs setup"
+
   it_should_behave_like "a read-only adapter connected to a stateless storage"
 
+  describe "setup without any data files" do
+
+    before :each do
+      GOM::Storage.teardown
+      GOM::Storage::Configuration[:test_storage].hash[:files] = "invalid"
+    end
+
+    it "should raise no exception" do
+      lambda do
+        GOM::Storage.setup
+        GOM::Storage.fetch "test_storage:object_1"
+      end.should_not raise_error
+    end
+
+  end
+
 end

data/spec/acceptance/data/{Object.yml → objects.yml}

@@ -1,10 +1,12 @@
 
 object_1:
+  class: GOM::Spec::Object
   properties:
     number: 5
   relations:
     related_object: test_storage:object_2
 
 object_2:
+  class: GOM::Spec::Object
   properties:
-    test: test value
+    number: 7

data/spec/gom/storage/filesystem/adapter_spec.rb

@@ -10,7 +10,7 @@ describe GOM::Storage::Filesystem::Adapter do
     GOM::Storage::Filesystem::Loader.stub(:new).and_return(@loader)
 
     @configuration = mock GOM::Storage::Configuration
-    @configuration.stub(:[]).with(:directory).and_return("test_directory")
+    @configuration.stub(:[]).with(:files).and_return("test_files")
     @adapter = described_class.new @configuration
   end
 
@@ -21,7 +21,7 @@ describe GOM::Storage::Filesystem::Adapter do
   describe "setup" do
 
     it "should initialize a file system loader" do
-      GOM::Storage::Filesystem::Loader.should_receive(:new).with("test_directory").and_return(@loader)
+      GOM::Storage::Filesystem::Loader.should_receive(:new).with("test_files").and_return(@loader)
       @adapter.setup
     end
 
@@ -32,6 +32,20 @@ describe GOM::Storage::Filesystem::Adapter do
 
   end
 
+  describe "teardown" do
+
+    before :each do
+      @adapter.setup
+    end
+
+    it "should clear the loaded drafts" do
+      lambda do
+        @adapter.teardown
+      end.should change(@adapter, :drafts).from(@drafts).to(nil)
+    end
+
+  end
+
   describe "fetch" do
 
     before :each do
@@ -42,26 +56,55 @@ describe GOM::Storage::Filesystem::Adapter do
       @adapter.fetch("object_1").should == @draft
     end
 
+    it "should raise a #{GOM::Storage::Adapter::NoSetupError} if no drafts has been loaded" do
+      @adapter.teardown
+      lambda do
+        @adapter.fetch "object_1"
+      end.should raise_error(GOM::Storage::Adapter::NoSetupError)
+    end
+
   end
 
   describe "store" do
 
+    before :each do
+      @adapter.setup
+    end
+
     it "should raise a GOM::Storage::ReadOnlyError" do
       lambda do
         @adapter.store Object.new, "test_storage"
       end.should raise_error(GOM::Storage::ReadOnlyError)
     end
 
+    it "should raise a #{GOM::Storage::Adapter::NoSetupError} if no drafts has been loaded" do
+      @adapter.teardown
+      lambda do
+        @adapter.store Object.new, "test_storage"
+      end.should raise_error(GOM::Storage::Adapter::NoSetupError)
+    end
+
   end
 
   describe "remove" do
 
+    before :each do
+      @adapter.setup
+    end
+
     it "should raise a GOM::Storage::ReadOnlyError" do
       lambda do
         @adapter.remove Object.new
       end.should raise_error(GOM::Storage::ReadOnlyError)
     end
 
+    it "should raise a #{GOM::Storage::Adapter::NoSetupError} if no drafts has been loaded" do
+      @adapter.teardown
+      lambda do
+        @adapter.remove Object.new
+      end.should raise_error(GOM::Storage::Adapter::NoSetupError)
+    end
+
   end
 
   describe "collection" do
@@ -107,6 +150,13 @@ describe GOM::Storage::Filesystem::Adapter do
       collection.should == @collection
     end
 
+    it "should raise a #{GOM::Storage::Adapter::NoSetupError} if no drafts has been loaded" do
+      @adapter.teardown
+      lambda do
+        @adapter.collection :test_object_class_view
+      end.should raise_error(GOM::Storage::Adapter::NoSetupError)
+    end
+
   end
 
 end

data/spec/gom/storage/filesystem/loader_spec.rb

@@ -3,14 +3,14 @@ require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "sp
 describe GOM::Storage::Filesystem::Loader do
 
   before :each do
-    @directory = "directory"
-    @loader = GOM::Storage::Filesystem::Loader.new @directory
+    @files = "files"
+    @loader = GOM::Storage::Filesystem::Loader.new @files
   end
 
   describe "initialize" do
 
     it "should set the directory" do
-      @loader.directory.should == @directory
+      @loader.files.should == @files
     end
 
   end
@@ -27,6 +27,7 @@ describe GOM::Storage::Filesystem::Loader do
 
       @file_hash = {
         "object_1" => {
+          "class" => "Test::Model",
           "properties" => {
             "test" => "test value"
           },
@@ -43,8 +44,8 @@ describe GOM::Storage::Filesystem::Loader do
       YAML.stub(:load_file).and_return(@file_hash)
     end
 
-    it "should searches all .yml file in the directory" do
-      Dir.should_receive(:[]).with("directory/*.yml").and_return(@filenames)
+    it "should searches all files that matches the pattern" do
+      Dir.should_receive(:[]).with("files").and_return(@filenames)
       @loader.drafts
     end
 
@@ -60,7 +61,7 @@ describe GOM::Storage::Filesystem::Loader do
 
     it "should convert the file hash into drafts" do
       draft_one = @loader.drafts["object_1"]
-      draft_one.class_name.should == "Object"
+      draft_one.class_name.should == "Test::Model"
       draft_one.properties.should == { "test" => "test value" }
       draft_one.relations.should == { "related_object" => @proxy }
 

data/spec/spec_helper.rb

@@ -2,5 +2,5 @@ require 'rubygems'
 gem 'rspec', '>= 2'
 require 'rspec'
 
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "filesystem"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "gom", "filesystem-adapter"))
 require 'gom/spec'

data/spec/storage.configuration

@@ -1,7 +1,7 @@
 
 test_storage:
   adapter:   filesystem
-  directory: /home/phifty/projects/gom-filesystem-adapter/spec/acceptance/data
+  files: /home/phifty/projects/gom-filesystem-adapter/spec/acceptance/data/*.yml
   views:
     test_object_class_view:
       type: class

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - "Philipp Br\xC3\xBCll"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-20 00:00:00 +01:00
+date: 2011-02-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,9 +27,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 2
-        - 0
-        version: 0.2.0
+        - 3
+        version: "0.3"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -71,20 +70,20 @@ files:
 - README.rdoc
 - LICENSE
 - Rakefile
-- lib/gom/storage/filesystem/adapter.rb
-- lib/gom/storage/filesystem/loader.rb
+- lib/gom/storage.rb
+- lib/gom/filesystem-adapter.rb
 - lib/gom/storage/filesystem/collection/fetcher.rb
 - lib/gom/storage/filesystem/collection.rb
+- lib/gom/storage/filesystem/adapter.rb
+- lib/gom/storage/filesystem/loader.rb
 - lib/gom/storage/filesystem.rb
-- lib/gom/storage.rb
-- lib/filesystem.rb
+- spec/storage.configuration
+- spec/gom/storage/filesystem/loader_spec.rb
 - spec/gom/storage/filesystem/collection/fetcher_spec.rb
 - spec/gom/storage/filesystem/adapter_spec.rb
-- spec/gom/storage/filesystem/loader_spec.rb
-- spec/storage.configuration
-- spec/spec_helper.rb
-- spec/acceptance/data/Object.yml
 - spec/acceptance/adapter_spec.rb
+- spec/acceptance/data/objects.yml
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/phifty/gom-filesystem-adapter
 licenses: []
@@ -118,7 +117,7 @@ signing_key:
 specification_version: 3
 summary: Filesystem storage adapter for the General Object Mapper.
 test_files: 
+- spec/gom/storage/filesystem/loader_spec.rb
 - spec/gom/storage/filesystem/collection/fetcher_spec.rb
 - spec/gom/storage/filesystem/adapter_spec.rb
-- spec/gom/storage/filesystem/loader_spec.rb
 - spec/acceptance/adapter_spec.rb