yaml_record 0.0.5 → 0.0.6

data/README.md

@@ -20,6 +20,8 @@ Or add gem to your Gemfile:
 
     # Gemfile
     gem 'yaml_record'
+    # OR if you're using Rails 3.1
+    gem 'yaml_record' :git => "git@github.com:Nico-Taing/yaml_record.git", :branch => "rails31"
 
 ## Usage ##
 
@@ -103,6 +105,22 @@ class Submission < YamlRecord::Base
 end
 ```
 
+## Storage Adapters ##
+
+YAMLRecord support pluggable storage adapters that change the storage engine for the YAML data. By default, the adapter used is the 
+'local' store which writes a file (specified by `source` path) to the local system. There are currently two available adapters: `Local` and `Redis`. 
+
+To configure the adapter, you can simply declare within the object:
+
+```ruby
+class Submission < YamlRecord::Base
+  adapter :redis, $redis # Second parameter is the redis client instance
+  source "contacts" # stores yaml namespaced as 'yaml_record:contacts' in redis
+end
+```
+
+Feel free to create additional adapters and send them to us via a pull request.
+
 ## Example ##
 
 Imagine a simple contact form that accepts a name and email from a user along with a body:
@@ -112,6 +130,9 @@ class Submission < YamlRecord::Base
   # Declare your properties
   properties :name, :email, :body
 
+  # Choose your adapter (local by default)
+  adapter :local # or :redis
+  
   # Declare source file path (config/contact.yml)
   source Rails.root.join("config/contact")
 end
@@ -169,6 +190,8 @@ And that's all! Each record will be persisted to the source file for easy access
 
 Created at Miso by Nico Taing and Nathan Esquenazi
 
+Special thanks to [Vaudoc](https://github.com/vaudoc)
+
 Contributors and patches are welcome! Please send a pull request!
 
 ## Notes ##

data/lib/yaml_record.rb

@@ -7,4 +7,6 @@ require 'yaml'
 
 module YamlRecord
   require File.dirname(__FILE__) + "/yaml_record/base"
+  require File.dirname(__FILE__) + "/yaml_record/adapters/redis_store"
+  require File.dirname(__FILE__) + "/yaml_record/adapters/local_store"
 end

data/lib/yaml_record/adapters/local_store.rb

@@ -0,0 +1,28 @@
+# YAML Adapter for using a local file store
+
+module YamlRecord
+  module Adapters
+    class LocalStore
+
+      # Returns YAML File as ruby collection
+      #
+      # === Example:
+      #
+      #   @adapter.read("foo") => [{...}, {...}]
+      #
+      def read(source)
+        YAML.load_file(source)
+      end
+
+      # Writes ruby collection as YAML File
+      #
+      # === Example:
+      #
+      #   @adapter.write("foo", [{...}, {...}]) => "<yaml data>"
+      #
+      def write(source, collection)
+        File.open(source, 'w') {|f| f.write(collection.to_yaml) }
+      end
+    end
+  end
+end

data/lib/yaml_record/adapters/redis_store.rb

@@ -0,0 +1,42 @@
+# YAML Adapter for using a redis client store
+# YamlRecord::Adapters::RedisStore.new(@redis)
+
+module YamlRecord
+  module Adapters
+    class RedisStore
+      attr_reader :client
+
+      # client is an instantiated redis client (i.e Redis::Client.new(...))
+      def initialize(client)
+        raise "Please specify a Redis client" unless client
+        @client = client
+      end
+
+      # Returns Redis YML data as ruby collection
+      #
+      # === Example:
+      #
+      #   @adapter.read("foo") => [{...}, {...}]
+      #
+      def read(source)
+        YAML.load(@client.get(redis_key(source)).to_s)
+      end
+
+      # Writes ruby collection as Redis YML data
+      #
+      # === Example:
+      #
+      #   @adapter.write("foo", [{...}, {...}]) => "<yaml data>"
+      #
+      def write(source, collection)
+        @client.set(redis_key(source), collection.to_yaml)
+      end
+
+      private
+
+      def redis_key(source)
+        "yaml_record:" + source
+      end
+    end
+  end
+end

data/lib/yaml_record/base.rb

@@ -264,7 +264,7 @@ module YamlRecord
     #   Post.all(true) => (...force reload...)
     #
     def self.all
-      raw_items = YAML.load_file(source) || []
+      raw_items = self.adapter.read(self.source) || []
       raw_items.map { |item| self.new(item.merge(:persisted => true)) }
     end
 
@@ -327,6 +327,20 @@ module YamlRecord
       end
     end
 
+    # Declares or retrieves adapter for Yaml storage
+    # Returns an instance of an adapter
+    #
+    # === Example:
+    #
+    #   class Post < YamlRecord::Base
+    #     adapter :redis, @redis #  => YamlRecord::Adapters::RedisAdapter
+    #   end
+    #
+    def self.adapter(kind=nil, *options)
+      kind.nil? ? @_adapter_kind ||= :local : @_adapter_kind = kind
+      @_adapter ||= eval("YamlRecord::Adapters::#{@_adapter_kind.to_s.capitalize}Store").new(*options)
+    end
+
     # Declares source file for YamlRecord class
     #
     # === Example:
@@ -362,7 +376,7 @@ module YamlRecord
     #   Post.write_content([{ :foo => "bar"}, { :foo => "baz"}, ...]) # writes to source file
     #
     def self.write_contents(raw_data)
-      File.open(self.source, 'w') {|f| f.write(raw_data.to_yaml) }
+      self.adapter.write(self.source, raw_data)
       @records = nil
     end
 

data/lib/yaml_record/version.rb

@@ -1,3 +1,3 @@
 module YamlRecord
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/base_test.rb

@@ -177,6 +177,29 @@ class BaseTest < Test::Unit::TestCase
       should("set @fs_not_created is_created field  to false"){ assert_false @fs_not_created.is_created }
     end
 
+    context "for self.adapter method" do
+      should("return local adapter") do
+        class YamlOtherObject < YamlRecord::Base; end
+        assert_kind_of YamlRecord::Adapters::LocalStore, YamlOtherObject.adapter
+      end
+      should("support explicit local adapter") do
+        YamlObject.adapter(:local)
+        assert_kind_of YamlRecord::Adapters::LocalStore, YamlObject.adapter
+      end
+      should("support changing adapter") do
+        class YamlRedisObject < YamlRecord::Base; end
+        @object = Object.new
+        YamlRedisObject.adapter(:redis, @object)
+        assert_kind_of YamlRecord::Adapters::RedisStore, YamlRedisObject.adapter
+        assert_equal @object, YamlRedisObject.adapter.client
+        class YamlOtherObject < YamlRecord::Base; end
+        assert_kind_of YamlRecord::Adapters::LocalStore, YamlOtherObject.adapter
+      end
+      should("not support invalid adapter") do
+        assert_raise(NameError) { class YamlFakeObject < YamlRecord::Base; adapter(:fake); end }
+      end
+    end
+
     context "for set_id!" do
       setup do
         @fs_no_id = YamlObject.new(@attr)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yaml_record
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Nico Taing
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-15 00:00:00 -07:00
+date: 2011-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,6 +81,8 @@ files:
 - README.md
 - Rakefile
 - lib/yaml_record.rb
+- lib/yaml_record/adapters/local_store.rb
+- lib/yaml_record/adapters/redis_store.rb
 - lib/yaml_record/base.rb
 - lib/yaml_record/version.rb
 - test/base_test.rb