cooler 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cooler (0.0.2)
+    cooler (0.0.3)
       activesupport (>= 3.0.0)
 
 GEM

data/README.md

@@ -4,8 +4,73 @@
 
 _The Good-Hearted Leader_
 
-> Cooler Howard Smith has an outgoing and mellow personality and always keeps his
-> head up even in the most daring situations. He is smart, laid-back, friendly,
-> witty, and usually optimistic even when things get serious.
+> Cooler Howard Smith has an outgoing and mellow personality and always keeps
+> his head up even in the most daring situations. He is smart, laid-back,
+> friendly, witty, and usually optimistic even when things get serious.
 
 A mini ORM, agnostic to key value store databases.
+
+If you're in a hurry, and need to define some models that should be persisted,
+in any Key-Value Store Database, this is the right gem.
+
+## Installation
+
+Add `gem 'cooler'` to your Gemfile.
+
+## Define Adapter's set, get and delete
+
+In an initializer, you'll need to specify how to set, get and delete a key.
+Let's say that you use Redis, then you want to do something similar to:
+
+```ruby
+redis = Redis.new
+
+Cooler::Adapater.set = ->(key, value) { redis.set(key, value.to_json) }
+Cooler::Adapater.get = ->(key) do
+  result = Bloodhound.redis.get(key) and JSON.parse(result)
+end
+Cooler::Adapater.delete = ->(key) { redis.del(key) }
+```
+
+That's it.
+
+## Define your models
+
+Defining a model is as easy as 1, 2, 3.
+
+```ruby
+# A model should inherit from Struct, attributes defined there are PERSISTED
+# in the database.
+class User < Struct.new(:login, :age, :encrypted_password, :created_at)
+  # You must include Cooler::Model
+  include Cooler::Model
+
+  # Any attribute accessor, or instance variables, are NOT STORED in the
+  # database, however you can  initialize an object with these attributes.
+  attr_accessor :password
+
+  # You can set defaults for any of the attributes.
+  default :age, 18
+  default :encrypted_password,
+    ->(user) { Digest::MD5.hexdigest(user.password) }
+  default :created_at, -> { Time.now.utc }
+
+  # To define the key for a Model, you need to pass a block, and return an
+  # String that will be the key to store the object.
+  key { |user| "user_#{user.login}" }
+end
+
+# You can create a new instance, passing its atributes:
+user = User.new(login: 'cooler', age: 20, password: 'im_cooler')
+user.save
+
+# You can also get any stored object, passing a Hash as argument, or
+# specifying the exact key.
+user = User.get(login: 'cooler') # or User.get('user_cooler')
+user.age = 10
+user.save
+```
+
+## License
+
+MIT

data/lib/cooler/adapter.rb

@@ -7,6 +7,9 @@ module Cooler
 
       # Gets the set block.
       attr_reader :set
+
+      # Gets the delete block.
+      attr_reader :delete
     end
 
     # Sets the block that handles getting a key.
@@ -48,5 +51,20 @@ module Cooler
       raise 'Argument must be a block' unless Proc === block
       @set = block
     end
+
+    # Sets the block that handles deleting a key.
+    #
+    # block - The block that receives as argument the String with the key to
+    #         delete.
+    #
+    # Examples
+    #
+    #   Cooler::Adapter.delete = ->(key) { redis.del(key) }
+    #
+    # Returns nothing.
+    def self.delete=(block)
+      raise 'Argument must be a block' unless Proc === block
+      @delete = block
+    end
   end
 end

data/lib/cooler/errors.rb

@@ -1,11 +1,11 @@
 module Cooler
-  class NotFound < NameError
+  class KeyNotFound < NameError
     def http_status
       404
     end
   end
 
-  class InvalidRecord < StandardError
+  class InvalidObject < StandardError
     def http_status
       406
     end

data/lib/cooler/model.rb

@@ -106,11 +106,11 @@ module Cooler
       # key - The String that contains the key to query the object.
       #
       # Return a Model instance.
-      # Raises Cooler::NotFound if not found. Compatible with
+      # Raises Cooler::KeyNotFound if not found. Compatible with
       # Sinatra::NotFound;
       # http://www.sinatrarb.com/intro.html#Not%20Found
       def get!(key)
-        get(key) || raise(Cooler::NotFound)
+        get(key) || raise(Cooler::KeyNotFound)
       end
 
       # Initializes a new instance, and saves it at the same time.
@@ -162,7 +162,9 @@ module Cooler
     #
     # Returns the serialized Hash.
     def serializable_hash
-      Hash[*each_pair.map { |k, v| [k, v] }.flatten]
+      hash = {}
+      each_pair { |key, value| hash[key] = value }
+      hash
     end
 
     # Saves persisted attributes to the database.
@@ -177,9 +179,9 @@ module Cooler
     # not able to save it.
     #
     # Returns nothing.
-    # Raises Cooler::InvalidRecord if not able to save it.
+    # Raises Cooler::InvalidObject if not able to save it.
     def save!
-      raise Cooler::InvalidRecord unless save
+      raise Cooler::InvalidObject unless save
     end
 
     private

data/lib/cooler/version.rb

@@ -1,3 +1,3 @@
 module Cooler
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/cooler/model_spec.rb

@@ -102,7 +102,8 @@ describe Cooler::Model do
 
     it 'should raise an exception if no results' do
       mock(Cooler::Adapter).get { ->(k) { nil } }
-      expect { TestModel.get!('test_bacon') }.to raise_error(Cooler::NotFound)
+      expect { TestModel.get!('test_bacon') }.
+        to raise_error(Cooler::KeyNotFound)
     end
   end
 
@@ -140,6 +141,12 @@ describe Cooler::Model do
       instance.serializable_hash.keys.should include(:foo)
       instance.serializable_hash[:foo].should == 'bar'
     end
+
+    it 'should allow an Array as a value' do
+      instance = TestModelUsingAttrAccessors.new(foo: [1, 2, 3, 4])
+      expect { instance.serializable_hash }.to_not raise_error
+      instance.serializable_hash[:foo].should == [1, 2, 3, 4]
+    end
   end
 
   context 'using attribute accessors' do
@@ -193,7 +200,7 @@ describe Cooler::Model do
   describe '.save!' do
     it 'should raise an exception if not saved' do
       mock(instance = TestModelForSave.new).save { false }
-      expect { instance.save! }.to raise_error(Cooler::InvalidRecord)
+      expect { instance.save! }.to raise_error(Cooler::InvalidObject)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cooler
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3025709922472475179
+      hash: 3227870062238590793
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3025709922472475179
+      hash: 3227870062238590793
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23