gom-filesystem-adapter 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Philipp Brüll
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,50 @@
+
+= Generic Object Mapper - Filesystem adapter
+
+The filesystem adapter for the Generic Object Mapper (http://github.com/phifty/gom) provides an easy way to store
+object data in the filesystem. Currently the adapter is read-only. The object data - stored in YML files - can be
+mapped to object, but no object data can be written to disk.
+
+== Configuration
+
+If the adapter <tt>filesystem</tt> is chosen in the storage configuration, the following configuration values should
+specified.
+
+* <tt>directory</tt> - specifies to directory where the object data is placed in.
+
+=== Example
+
+  storage_name:
+    adapter: filesystem
+    directory: /var/project-name/data
+
+== Files
+
+The adapter reads all the *.yml files in the specified directory. The basename of the file defines the class of the
+containing objects. A file can store multiple object of that class and is structured the following way.
+
+  # file Book.yml
+  book_1:
+    properties:
+      pages: 1253
+    relations:
+      author: author_1
+
+  # file Author.yml
+  author_1:
+    properties:
+      name: "Mr. Storyteller"
+
+A fetch of that book would look like:
+
+  book = GOM::Storage.fetch "storage_name:book_1"
+
+The fetched object would have the instance variable <tt>@pages</tt> set to <tt>1253</tt> and <tt>@author</tt> would
+point to an object of the class <tt>Author</tt> with the id <tt>author_1</tt>.
+
+== Development
+
+Development has been done test-driven and the code follows at most the Clean Code paradigms. Code smells has been
+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!

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+gem 'rspec'
+gem 'reek'
+require 'rspec'
+require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+require 'reek/rake/task'
+
+task :default => :spec
+
+namespace :gem do
+
+  desc "Builds the gem"
+  task :build do
+    system "gem build *.gemspec && mkdir -p pkg/ && mv *.gem pkg/"
+  end
+
+  desc "Builds and installs the gem"
+  task :install => :build do
+    system "gem install pkg/"
+  end
+
+end
+
+Reek::Rake::Task.new do |task|
+  task.fail_on_error = true
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.add [ "README.rdoc", "lib/**/*.rb" ]
+  rdoc.main = "README.rdoc"
+  rdoc.title = ""
+end
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = "spec/gom/**/*_spec.rb"
+end
+
+namespace :spec do
+
+  desc "Run all integration specs in spec/acceptance directory"
+  RSpec::Core::RakeTask.new(:acceptance) do |task|
+    task.pattern = "spec/acceptance/**/*_spec.rb"
+  end
+
+end

data/lib/filesystem.rb

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

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

@@ -0,0 +1,47 @@
+
+module GOM
+
+  module Storage
+
+    module Filesystem
+
+      # The filesystem storage adapter
+      class Adapter < GOM::Storage::Adapter
+
+        def initialize(configuration)
+          super configuration
+        end
+
+        def setup
+          load_data
+        end
+
+        def fetch(id)
+          @data[id]
+        end
+
+        def store(object, storage_name = nil)
+          read_only_error "store"
+        end
+
+        def remove(object)
+          read_only_error "remove"
+        end
+
+        private
+
+        def load_data
+          @data = GOM::Storage::Filesystem::Loader.new(configuration[:directory]).data
+        end
+
+        def read_only_error(method_name)
+          raise GOM::Storage::ReadOnlyError, "The adapter doesn't provide write methods"
+        end
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,87 @@
+require 'yaml'
+
+module GOM
+
+  module Storage
+
+    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
+          @data = { }
+        end
+
+        def data
+          load_yml_files
+          @data
+        end
+
+        private
+
+        def load_yml_files
+          @data = { }
+          Dir[File.join(@directory, "*.yml")].each do |filename|
+            load_yml_file filename
+          end
+        end
+
+        def load_yml_file(filename)
+          classname = File.basename(filename).sub(/\..*$/, "")
+          load_file_hash classname, YAML.load_file(filename)
+        end
+
+        def load_file_hash(classname, file_hash)
+          file_hash.each do |id, hash|
+            @data[id] = Builder.new(classname, hash).object_hash
+          end
+        end
+
+        # Builds an object hash out of the file hashes.
+        class Builder
+
+          attr_reader :object_hash
+
+          def initialize(classname, hash)
+            @classname, @hash = classname, hash
+            @object_hash = { }
+            copy_classname
+            copy_properties
+            copy_relations
+          end
+
+          private
+
+          def copy_classname
+            @object_hash[:class] = @classname
+          end
+
+          def copy_properties
+            properties = { }
+            (@hash["properties"] || { }).each do |key, value|
+              properties[key] = value
+            end
+            @object_hash[:properties] = properties unless properties.empty?
+          end
+
+          def copy_relations
+            relations = { }
+            (@hash["relations"] || { }).each do |key, value|
+              relations[key] = GOM::Object::Proxy.new GOM::Object::Id.new(value)
+            end
+            @object_hash[:relations] = relations unless relations.empty?
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/gom/storage/filesystem.rb

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

data/lib/gom/storage.rb

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

data/spec/acceptance/adapter_spec.rb

@@ -0,0 +1,10 @@
+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 "a read-only adapter connected to a stateless storage"
+
+end

data/spec/acceptance/data/Object.yml

@@ -0,0 +1,10 @@
+
+object_1:
+  properties:
+    number: 5
+  relations:
+    related_object: test_storage:object_2
+
+object_2:
+  properties:
+    test: test value

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

@@ -0,0 +1,75 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "spec_helper"))
+
+describe GOM::Storage::Filesystem::Adapter do
+
+  before :each do
+    @data = {
+      "object_1" => {
+        :class => "Object",
+        :properties => { :test => "test value" }
+      },
+      "object_2" => {
+        :class => "Object",
+        :properties => { :test => "another test value" }
+      }
+    }
+
+    @loader = mock GOM::Storage::Filesystem::Loader, :data => @data
+    GOM::Storage::Filesystem::Loader.stub(:new).and_return(@loader)
+
+    @configuration = mock GOM::Storage::Configuration
+    @configuration.stub(:[]).with(:directory).and_return("test_directory")
+    @adapter = described_class.new @configuration
+  end
+
+  it "should register the adapter" do
+    GOM::Storage::Adapter[:filesystem].should == GOM::Storage::Filesystem::Adapter
+  end
+
+  describe "setup" do
+
+    it "should initialize a file system loader" do
+      GOM::Storage::Filesystem::Loader.should_receive(:new).with("test_directory").and_return(@loader)
+      @adapter.setup
+    end
+
+    it "should load the data" do
+      @loader.should_receive(:data).and_return(@data)
+      @adapter.setup
+    end
+
+  end
+
+  describe "fetch" do
+
+    before :each do
+      @adapter.setup
+    end
+
+    it "should return the object hash" do
+      @adapter.fetch("object_1").should == @data["object_1"]
+    end
+
+  end
+
+  describe "store" do
+
+    it "should raise a GOM::Storage::ReadOnlyError" do
+      lambda do
+        @adapter.store Object.new, "test_storage"
+      end.should raise_error(GOM::Storage::ReadOnlyError)
+    end
+
+  end
+
+  describe "remove" do
+
+    it "should raise a GOM::Storage::ReadOnlyError" do
+      lambda do
+        @adapter.remove Object.new
+      end.should raise_error(GOM::Storage::ReadOnlyError)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,77 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "spec_helper"))
+
+describe GOM::Storage::Filesystem::Loader do
+
+  before :each do
+    @directory = "directory"
+    @loader = GOM::Storage::Filesystem::Loader.new @directory
+  end
+
+  describe "initialize" do
+
+    it "should set the directory" do
+      @loader.directory.should == @directory
+    end
+
+  end
+
+  describe "data" do
+
+    before :each do
+      @filename = "directory/Object.yml"
+      @filenames = [ @filename ]
+      Dir.stub(:[]).and_return(@filenames)
+
+      @proxy = mock GOM::Object::Proxy
+      GOM::Object::Proxy.stub(:new).and_return(@proxy)
+
+      @file_hash = {
+        "object_1" => {
+          "properties" => {
+            "test" => "test value"
+          },
+          "relations" => {
+            "related_object" => "test_storage:object_2"
+          }
+        },
+        "object_2" => {
+          "properties" => {
+            "test" => "another test value"
+          }
+        }
+      }
+      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)
+      @loader.data
+    end
+
+    it "should load the files" do
+      YAML.should_receive(:load_file).with(@filename).and_return(@file_hash)
+      @loader.data
+    end
+
+    it "should create object proxies for relations" do
+      GOM::Object::Proxy.should_receive(:new).with(GOM::Object::Id.new("test_storage:object_2")).and_return(@proxy)
+      @loader.data
+    end
+
+    it "should convert the file hash into object hashes" do
+      @loader.data.should == {
+        "object_1" => {
+          :class => "Object",
+          :properties => { "test" => "test value" },
+          :relations => { "related_object" => @proxy }
+        },
+        "object_2" => {
+          :class => "Object",
+          :properties => { "test" => "another test value" }
+        }
+      }
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

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

data/spec/storage.configuration

@@ -0,0 +1,5 @@
+
+test_storage:
+  adapter:           filesystem
+  directory:         /home/phifty/projects/gom-filesystem-adapter/spec/acceptance/data
+  relation_detector: _id$

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: gom-filesystem-adapter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Philipp Br\xC3\xBCll"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gom
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.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 
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :development
+  version_requirements: *id003
+description: Filesystem storage adapter for the General Object Mapper. Currently just read-only storage.
+email: b.phifty@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- LICENSE
+- Rakefile
+- 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/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
+has_rdoc: true
+homepage: http://github.com/phifty/gom-filesystem-adapter
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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-filesystem-adapter
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Filesystem storage adapter for the General Object Mapper.
+test_files: 
+- spec/gom/storage/filesystem/adapter_spec.rb
+- spec/gom/storage/filesystem/loader_spec.rb
+- spec/acceptance/adapter_spec.rb