dm-yaml-adapter 0.5

data/README

@@ -0,0 +1,49 @@
+dm-yaml-adapter
+
+This adapter is for DataMapper. This allows you to persist objects to YAML files and still have the query capabilities of DataMapper. I wouldn't scale this out to a zillion files, but if you have a lot of read action on a small database this could be the project for you. OR use it to better understand DataMapper.
+
+
+Example usage:
+
+We have to tell datamapper where we will be storing the YAML files. 
+directory tells the adapter where to store.
+
+DataMapper.setup(:default, {:adapter => 'yaml', :directory => 'db'})
+
+
+Trying it out: 
+
+If you want some examples of defining classes, check out the spec directory.
+
+Anyway, assuming you have a decent environment set up, you can try out some examples.
+
+If you want to use irb to try some of this interactively, try 'irb' and then
+> load 'irbhelper.irb'
+
+That sets up a basic environment with User and Post resources already defined.
+
+irb(main):001:0> load 'irbhelper.irb'
+=> true
+irb(main):002:0> u = User.create(:name => 'Bob', :age => 55)
+=> #<User user_id=1 name="Bob" age=55>
+irb(main):003:0> u.save
+=> true
+irb(main):004:0> User.all
+=> [#<User user_id=1 name="Bob" age=55>]
+irb(main):005:0> 
+
+If you use another window to check out the db directory you should have a nice User directory with a 1.yaml file in there, with the data of Bob.
+
+You can also add another object and start playing around with some queries.
+
+irb(main):005:0> User.create(:name => 'Sue', :age => 32)
+=> #<User user_id=2 name="Sue" age=32>
+irb(main):006:0> User.all(:age => 32)
+=> [#<User user_id=2 name="Sue" age=32>]
+irb(main):007:0> User.all
+=> [#<User user_id=1 name="Bob" age=55>, #<User user_id=2 name="Sue" age=32>]
+irb(main):008:0> u.destroy
+=> true
+irb(main):009:0> User.all
+=> [#<User user_id=2 name="Sue" age=32>]
+irb(main):010:0> 

data/lib/dm-yaml-adapter.rb

@@ -0,0 +1,189 @@
+require 'rubygems'
+require 'dm-core'
+require 'yaml'
+require 'dm-core/adapters/abstract_adapter'
+
+module DataMapper::Adapters
+
+  class YamlAdapter < AbstractAdapter      
+
+    def initialize(name, options)
+      super
+
+      @options = Hash.new
+      
+      @options[:directory] = options[:directory]
+      
+      @options[:directory] ||= './db'         
+
+    end
+    
+    def destroy_model_storage(repository, model)
+	    FileUtils.rm_rf(classname_to_dir(model.to_s))
+    end
+    
+    def create_model_storage(repository, model)
+	    FileUtils.mkdir_p(classname_to_dir(model.to_s))
+    end
+   
+    def create(resources) 
+       resources.each do |resource|
+	       model = resource.model
+	       id = find_free_id_for(resource.class.to_s)
+	       # find name of key attribute
+	       key = model.key.first.name
+	       resource.attributes[key] = id
+	       resource.instance_variable_set("@" + key.to_s, id)
+	       save(resource)
+       end
+       return resources.size
+    end
+    
+    def delete(query)
+	    resultset = yaml_query(query)
+	    resultset.each do |result|
+		    yaml_destroy(result)
+	    end
+	    return resultset.size
+    end
+    
+    def read_one(query)
+	    return(filter_result_set(get_all(query.model), query).first)
+    end
+    
+    def update(attributes, query)
+	    # ok, for each object found we have to update the attribs we found
+	    # first thing is figure out what class we are dealing with
+	    clazz = query.model
+	    # next, get all the matching objects
+	    objs = filter_result_set(clazz.all, query)
+	    # iterate over every object in this set and set the given attributes
+	    objs.each do |obj|
+		    attributes.each do |attrib|
+			    # attrib is an array
+			    # first member is Property object
+			    # second member is the value
+			    obj.instance_variable_set("@" + attrib[0].name.to_s, attrib[1])
+		    end
+		    save(obj)
+	    end
+    end
+   
+    def read_many(query)
+	    return filter_result_set(get_all(query.model), query)
+    end
+
+  
+  private
+  
+  	def yaml_destroy(resource)
+		# take an objects class and ID and figure
+		# out what file it's in
+		# and then remove that file
+		class_name = resource.class.to_s
+		id = resource.key.first
+		file = class_name_to_file(class_name, id)
+		File.unlink(file)
+	end
+	
+	def yaml_query(query)
+		# in this method, we want to take each condition and figure out
+		# what we should return
+		
+		# first is figuring out our class
+		model = query.model
+		# if we just want all the objects...
+		if (query.conditions.empty?)
+			return get_all(model)
+		end
+		
+		# otherwise we have to filter on some conditions...
+		all_objs = get_all(model)
+		# for each object, check all the conditions
+		filter_result_set(all_objs, query)
+	end
+	
+	def filter_result_set(objects, query)
+		result_set = objects.clone
+		objects.each do |obj|
+			query.conditions.each do |operator, property, value|
+				case operator
+					# handle eql
+					when :eql, :like
+						if ! (obj.instance_variable_get("@" + property.field) == value)
+							# remove from teh result set...
+							result_set.delete(obj)
+						end
+					# handle :not
+					when :not
+						if (obj.instance_variable_get("@" + property.field) == value)
+							result_set.delete(obj)
+						end
+				end
+			end
+		end
+		return result_set
+	end
+  	
+  	def get_all(clazz)
+		objects = Array.new
+		directory = classname_to_dir(clazz.to_s)
+		if ! File.exists?(directory)
+			return objects
+		end
+		Dir.entries(directory).grep(/\.yaml$/).each do |entry|
+			objects << file_to_object(File.join(directory, entry))
+		end
+		return objects
+	end
+	
+	def file_to_object(file)
+		new_obj =  YAML.load_file(file)
+		new_obj.instance_variable_set("@new_record", false)
+		return new_obj
+	end
+  	
+   	def find_free_id_for(class_name)
+		# if there are no entries in the directory, or the directory doesn't exist
+		# we need to create it...
+		
+		if ! File.exists?(classname_to_dir(class_name))
+			# default ID
+			return 1
+		end
+		directory = classname_to_dir(class_name)
+		if directory.entries.size == 0
+			return 1
+		end
+		free_id = -1
+		id = 1
+		until free_id != -1 do
+			id += 1
+			if ! File.exists?(File.join(directory, id.to_s + ".yaml"))
+				return id
+			end
+		end
+	end
+  	
+        def save(resource)
+		file = File.join(class_name_to_file(resource.class.to_s, resource.id))
+		# see if the directory exists, if it doesn't, we need to create it
+		if ! File.exists?(classname_to_dir(resource.class.to_s))
+			FileUtils.mkdir_p(classname_to_dir(resource.class.to_s))
+		end
+		yamlfile = File.new(class_name_to_file(resource.class.to_s, resource.id), "w")
+		yamlfile.puts resource.to_yaml
+		yamlfile.close
+	end
+
+	def classname_to_dir(class_name)
+		return File.join(@options[:directory], class_name.gsub("/", "_"))
+	end
+	
+	def class_name_to_file(class_name, id)
+		return File.join(classname_to_dir(class_name), id.to_s + ".yaml")
+	end
+	
+    end
+end
+

data/spec/dm-yaml-adapter_spec.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'dm-core'
+require 'dm-yaml-adapter'
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path + 'spec_helper'
+
+describe DataMapper::Adapters::YamlAdapter do
+  before(:all) do
+	  @adapter = DataMapper.setup(:default, {:adapter => 'yaml', :directory => 'db'})
+	  User.auto_migrate!
+          @user1 = User.create(:name => 'tom')
+          @user2 = User.create(:name => 'jim')
+  end
+
+  describe "CRUD" do
+  
+     describe "create" do
+        it "should create" do
+           @user1.user_id.should_not == nil
+        end 
+     end
+     
+     describe "read" do
+	     it "should read all" do
+		     begin
+			     users = User.all
+	     	     rescue Exception => e
+			     puts e
+			     puts e.backtrace
+		     end
+		     users.size.should_not == 0
+	     end
+     end
+     
+     describe "delete" do 
+	     it "should delete someone" do
+		     user = User.create
+		     user.destroy.should == true
+     	     end     
+     end
+ 
+     describe "find not" do
+             it "should find someone with a not clause" do
+                     users = User.all(:user_id.not => @user1.id) 
+                     users.first.user_id.should_not == @user1.id 
+             end
+     end
+ 
+  end
+  
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'dm-core'
+require 'pathname'
+require Pathname(__FILE__).dirname.parent.expand_path + 'lib/dm-yaml-adapter'
+
+class Post
+  include DataMapper::Resource
+ 
+  property :post_id, Serial
+  property :title, String
+  
+  belongs_to :user
+end
+ 
+class User
+  include DataMapper::Resource
+  
+  property :user_id, Serial
+  property :name, String
+  property :age, Integer
+  
+  has n, :posts
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: dm-yaml-adapter
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- Joshua Harding
+autorequire: dm-yaml-adapter
+bindir: bin
+cert_chain: []
+
+date: 2009-05-20 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: josh@statewidesoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/dm-yaml-adapter.rb
+- spec/dm-yaml-adapter_spec.rb
+- spec/spec_helper.rb
+- README
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: a YAML adapter for DataMapper. this (slow) adapter allows you to use DataMapper with YAML files as a backing store.
+test_files: 
+- spec/dm-yaml-adapter_spec.rb
+- spec/spec_helper.rb