active_redis_orm 0.0.10 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 835629f57538a971822d8594eb11be972232c5d1
-  data.tar.gz: 417ff294268b204aa1e2f22d865a36de727fd1bc
+  metadata.gz: 899ade6f6bc04ef66e156a453353590f4d66289b
+  data.tar.gz: e80082d10320bfdc323dda8673341ad443864e45
 SHA512:
-  metadata.gz: d8dc8e27c8638a909e9d0c5157c6e6835735fa8db5d92a8211e5ef01a43c31668bd34c19ba0465a5c8713c8f5508c88cc7ddc71f89ae5361a90ba2c8935a5951
-  data.tar.gz: 4f9d501a9a4516a9fcfe2ddba2402e6c28dd32e1df17a1e865b231c26bbe82e9aa2ee64b9d95e626e02d59582992b829128f02878238b45c8d09bbf74c34a334
+  metadata.gz: 86ae6af995214ec4443333edc352e5ff8e4953ad8a03c0d9e7dd879947897d7f97f65c7f11915ac8e6f8c0df57a0557d0eb4756dbee7e859e18d50e193fc0f0a
+  data.tar.gz: 145d76d2954de1e367a315ece73bf18d36d6de24a0ba838962347aeafc10a3ddc05696f37a138c2b9e0ea9d99b24db82803cbd1d4c4c5ae24e59a441f519e080

data/README.md

@@ -1,6 +1,4 @@
-# ActiveRedisOrm
-
-TODO: Write a gem description
+# ActiveRedis
 
 ## Installation
 
@@ -18,7 +16,102 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In an initializer, make sure that you're using the correct connection:
+
+
+```ruby
+ActiveRedis.redis = Redis.new(connection_details)
+```
+
+Creating an ActiveRedis class looks like a combination of ActiveRecord and Mongoid:
+
+```ruby
+class User < ActiveRedis::Base
+  field :username, finder_field: true
+  field :name
+  field :birthday, type: :date
+  field :age, type: :integer, default: lambda{|user| user.age_from_birthday}
+  field :things, type: :set
+end
+```
+
+Declaring fields is similar to Mongoid - you declare the field, and its type (the default is string). We use symbols for type, unlike Mongoid which uses the data type's class.
+
+Available types are: :string, :set, :sorted_set, :list, :hash, :float, :integer (or :int), :counter, :boolean, :date, :time (or :datetime, :timestamp).
+
+You can declare a default value with either a value or a lambda.
+
+
+### Finder Fields
+
+When you want to be able to find an object by something other than its ID, you can define an index by stating a field to be a finder_field. This will allow you to do this:
+
+```ruby
+User.create(username: "some_guy")
+
+User.find_by_username("some_guy") #=> our user
+```
+
+### Redis Data Structures
+
+Using hashes, sets, sorted sets and lists is simple-ish.
+
+
+Hash simply acts like a hash
+
+
+Sets and Lists act like any ruby array
+
+
+Sorted sets' getters act as an array, but setters are hash-like, where the hash key is the value and hash value is the score. Yes, it's a bit confusing.
+
+```ruby
+class User < ActiveRedis::Base
+  field :foo, type: :sorted_set
+end
+
+user = User.new
+
+user.foo["value2"] = 1
+
+user.foo["value1"] = 0
+user.save
+
+user.foo #=> ["value1", "value2"]
+```
+
+## Callbacks and Validations
+
+Callbacks and validations work just like in Mongoid or ActiveRecord
+
+```ruby
+class Messages < ActiveRedis::Base
+  include ActiveRedis::Timestamps
+
+  field :text
+  field :user_id
+
+  validates :text, presence: true, length: {maximum: 256}
+  validates :user_id, presence: true
+
+  after_create :do_something
+
+  def do_something
+    #this gets called after create
+  end
+end
+
+message = Message.new(text: "I am new text")
+message.save #=> false
+
+message.errors.messages #=> {:user_id=>["can't be blank"]}
+```
+
+available callbacks are before/after/around for create/update/save
+
+
+available validations are any validations which come with ActiveModel (we're still missing the uniqueness validation, as it's a problem in redis, but it'll happen)
+
 
 ## Contributing
 

data/lib/active_redis/attributes.rb

@@ -445,7 +445,7 @@ module ActiveRedis
 
       class_eval %Q{
         def self.find_by_#{field_name}(value)
-          id = Redis.current.get(finder_key(:#{field_name}, value))
+          id = ActiveRedis.redis.get(finder_key(:#{field_name}, value))
           if id.present?
             self.find(id)
           else

data/lib/active_redis/save.rb

@@ -27,7 +27,7 @@ module ActiveRedis
 
     def perform_save
       run_callbacks :save do
-        Redis.current.pipelined do
+        ActiveRedis.redis.pipelined do
           self.changes.each do |key, value|
             if value.last.nil?
               send("#{key}_object").delete

data/lib/active_redis/version.rb

@@ -1,3 +1,3 @@
 module ActiveRedis
-  VERSION = "0.0.10"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_redis_orm
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.1
 platform: ruby
 authors:
 - Tom Caspy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-03 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler