redis_object 0.5.0 → 1.0

data/.gitignore

@@ -1,6 +1,4 @@
 *.gem
 .bundle
-.DS_Store
 Gemfile.lock
 pkg/*
-coverage/

data/Gemfile

@@ -1,8 +1,4 @@
 source "http://rubygems.org"
 
-gem 'rake'
-gem 'rspec'
-gem 'coveralls', require: false
-
 # Specify your gem's dependencies in redis_object.gemspec
 gemspec

data/README.markdown

@@ -1,20 +1,14 @@
 # RedisObject
 RedisObject is a fast and simple-to-use object persistence layer for Ruby.
 
-[![Build Status](https://travis-ci.org/remotezygote/RedisObject.png?branch=master)](https://travis-ci.org/remotezygote/RedisObject)
-[![Coverage Status](https://coveralls.io/repos/remotezygote/RedisObject/badge.png?branch=master)](https://coveralls.io/r/remotezygote/RedisObject?branch=master)
-
 ## Prerequisites
-You'll need [Redis](http://redis.io). Other storage adapters are in the works. Maybe.
+You'll need [Redis](http://redis.io).
 
 
 ## Installation
+It's hosted on [rubygems.org][rubygems].
 
-	gem install redis_object
-
-Or, you can add it to your Gemfile:
-
-	gem 'redis_object'
+	sudo gem install redis_object
 
 
 ## Usage
@@ -57,7 +51,7 @@ end
 ## 'Collections'
 Object relationships are stored in collections of objects attached to other objects. To 'collect' an object onto another, you simply call `reference` to reference the objects (also aliased to the concat operator `<<`).
 
-Collections are automatically created, and can be access by their plural, lower-case name to gather all of the items in a collection (returns an Enumerable `Collection` object), or by its singular lower-case name to just get one somewhat randomly (useful for 1 -> 1 style relationships).
+Collections are automatically created, and can be access by their plural, lower-case name to gather all of the items in a collection (returns and Enumerable `Collection` object), or by its singular lower-case name to just get one somewhat randomly (useful for 1 -> 1 style relationships).
 
 Example:
 
@@ -88,19 +82,19 @@ john.address
 # }
 ```
 
-You may notice that the type of object, its basic storage key, and some timestamps are automatically created and updated appropriately.
+You may also notice that the type of object, its basic storage key, and some timestamps are also automatically created and updated appropriately.
 
 It is important to note that collections inherit any indices of its underlying object type. See Indices below for examples.
 
 ## Types
 A few types of data can be specified for certain fields. The types supported are:
 
-* Date
-* Number
-* Float
-* Bool
-* Array
-* JSON (store any data that can be JSON-encoded - it will be automatically encoded/decoded when stored/accessed)
+Date
+Number
+Float
+Bool
+Array
+JSON (store any data that can be JSON-encoded - it will be automatically encoded/decoded when stored/accessed)
 
 These types are also used for scoring when keeping field indices. If no type is specified, String is used, and no scoring is possible at this time.
 
@@ -119,7 +113,7 @@ john.verified # false
 
 TODO: Add verified? and verified! -style methods automagically for boolean fields.
 
-You can add your own custom types by defining filter methods for getting and setting a field, and can define a scoring function if you would like to index fields of your type.
+You can also add your own custom types by defining filter methods for getting and setting a field, and can also define a scoring function if you would like to index fields of the type.
 
 Example:
 
@@ -154,7 +148,7 @@ end
 TODO: Make defining custom formats easier - no need to define class methods for this - could have helper function for it like `custom_format :bool, :get => :format_boolean` or similar.
 
 ## Indices
-Any field that can be scored can store a sidecar index by that score. These indices can be used to index items in a collection (internally, it is a simple Redis set intersection, so it is very fast). Timestamps are indexed by default for any object, so out of the box you can do:
+Any field that can be scored can store a sidecar index by that score. These indices can also be used to index items in a collection (internally, it is a simple Redis set intersection, so it is very fast). Timestamps are indexed by default for any object, so out of the box you can do:
 
 ```ruby
 Person.indexed(:created_at) # all Person objects, oldest first
@@ -166,14 +160,11 @@ Person.indexed(:updated_at, -1, true) do |person|
 end
 ```
 
-Accessing indexed items always returns an Enumerator, so first/last/each/count/etc. are usable anywhere and will access objects only when iterated.
-
-## Named Views
-`TODO: Add some damn View documentation.`
+Accessing indexed items always returns an Enumerator, so first/last/each/count/etc. are always usable and will access items only when iterated.
 
 ## Links
 Redis: [http://redis.io](http://redis.io)  
 RedisObject Code: [https://github.com/remotezygote/RedisObject](https://github.com/remotezygote/RedisObject)  
 
 
-[rubygems]: http://rubygems.org/gems/redis_object
+[rubygems]: http://rubygems.org/gems/redis_object

data/Rakefile

@@ -1,10 +1,2 @@
 require 'bundler'
-require 'rspec/core/rake_task'
-
-task :default => :spec
-
-RSpec::Core::RakeTask.new do |t|
-	t.pattern = './spec/*_spec.rb'
-end
-
 Bundler::GemHelper.install_tasks

data/doc/Object.html

@@ -0,0 +1,185 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>class Object - StubbornObject</title>
+
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+
+
+<body id="top" class="class">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="./index.html">Home</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/redis_object.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    <nav id="parent-class-section" class="section">
+  <h3 class="section-header">Parent</h3>
+  
+  <p class="link">BasicObject
+  
+</nav>
+
+    
+    
+  </div>
+
+  <div id="project-metadata">
+    
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./Seabright.html">Seabright</a>
+  
+    <li><a href="./Seabright/Adapter.html">Seabright::Adapter</a>
+  
+    <li><a href="./Seabright/Collection.html">Seabright::Collection</a>
+  
+    <li><a href="./Seabright/Collections.html">Seabright::Collections</a>
+  
+    <li><a href="./Seabright/Collections/ClassMethods.html">Seabright::Collections::ClassMethods</a>
+  
+    <li><a href="./Seabright/ExternalIndex.html">Seabright::ExternalIndex</a>
+  
+    <li><a href="./Seabright/History.html">Seabright::History</a>
+  
+    <li><a href="./Seabright/History/ClassMethods.html">Seabright::History::ClassMethods</a>
+  
+    <li><a href="./Seabright/Indices.html">Seabright::Indices</a>
+  
+    <li><a href="./Seabright/Indices/ClassMethods.html">Seabright::Indices::ClassMethods</a>
+  
+    <li><a href="./Seabright/Keys.html">Seabright::Keys</a>
+  
+    <li><a href="./Seabright/Keys/ClassMethods.html">Seabright::Keys::ClassMethods</a>
+  
+    <li><a href="./Seabright/ObjectBase.html">Seabright::ObjectBase</a>
+  
+    <li><a href="./Seabright/ObjectBase/ClassMethods.html">Seabright::ObjectBase::ClassMethods</a>
+  
+    <li><a href="./Seabright/RedisObject.html">Seabright::RedisObject</a>
+  
+    <li><a href="./Seabright/RedisObject.html">Seabright::RedisObject</a>
+  
+    <li><a href="./Seabright/References.html">Seabright::References</a>
+  
+    <li><a href="./Seabright/Storage.html">Seabright::Storage</a>
+  
+    <li><a href="./Seabright/Storage/ClassMethods.html">Seabright::Storage::ClassMethods</a>
+  
+    <li><a href="./Seabright/Storage/MySQL.html">Seabright::Storage::MySQL</a>
+  
+    <li><a href="./Seabright/Storage/Redis.html">Seabright::Storage::Redis</a>
+  
+    <li><a href="./Seabright/Template.html">Seabright::Template</a>
+  
+    <li><a href="./Seabright/Template/ClassMethods.html">Seabright::Template::ClassMethods</a>
+  
+    <li><a href="./Seabright/Timestamps.html">Seabright::Timestamps</a>
+  
+    <li><a href="./Seabright/Timestamps/ClassMethods.html">Seabright::Timestamps::ClassMethods</a>
+  
+    <li><a href="./Seabright/Types.html">Seabright::Types</a>
+  
+    <li><a href="./Seabright/Types/ClassMethods.html">Seabright::Types::ClassMethods</a>
+  
+    <li><a href="./Object.html">Object</a>
+  
+    <li><a href="./Seabright/RedisObject.html">Object::RedisObject</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="class">class Object</h1>
+
+  <div id="description" class="description">
+    
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+    <!-- Constants -->
+    <section id="constants-list" class="section">
+      <h3 class="section-header">Constants</h3>
+      <dl>
+      
+        <dt id="RedisObject">RedisObject
+        
+        <dd class="description">
+        
+      
+      </dl>
+    </section>
+    
+
+    
+
+    <!-- Methods -->
+    
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+

data/doc/Seabright.html

@@ -0,0 +1,181 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>module Seabright - StubbornObject</title>
+
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+
+
+<body id="top" class="module">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="./index.html">Home</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/redis_object/base.rb
+    <li>lib/redis_object/collection.rb
+    <li>lib/redis_object/external_index.rb
+    <li>lib/redis_object/history.rb
+    <li>lib/redis_object/indices.rb
+    <li>lib/redis_object/keys.rb
+    <li>lib/redis_object/references.rb
+    <li>lib/redis_object/storage/adapter.rb
+    <li>lib/redis_object/storage/mysql.rb
+    <li>lib/redis_object/storage/redis.rb
+    <li>lib/redis_object/storage.rb
+    <li>lib/redis_object/timestamps.rb
+    <li>lib/redis_object/tpl.rb
+    <li>lib/redis_object/types.rb
+    <li>lib/redis_object/version.rb
+    <li>lib/redis_object.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    
+    
+    
+  </div>
+
+  <div id="project-metadata">
+    
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./Seabright.html">Seabright</a>
+  
+    <li><a href="./Seabright/Adapter.html">Seabright::Adapter</a>
+  
+    <li><a href="./Seabright/Collection.html">Seabright::Collection</a>
+  
+    <li><a href="./Seabright/Collections.html">Seabright::Collections</a>
+  
+    <li><a href="./Seabright/Collections/ClassMethods.html">Seabright::Collections::ClassMethods</a>
+  
+    <li><a href="./Seabright/ExternalIndex.html">Seabright::ExternalIndex</a>
+  
+    <li><a href="./Seabright/History.html">Seabright::History</a>
+  
+    <li><a href="./Seabright/History/ClassMethods.html">Seabright::History::ClassMethods</a>
+  
+    <li><a href="./Seabright/Indices.html">Seabright::Indices</a>
+  
+    <li><a href="./Seabright/Indices/ClassMethods.html">Seabright::Indices::ClassMethods</a>
+  
+    <li><a href="./Seabright/Keys.html">Seabright::Keys</a>
+  
+    <li><a href="./Seabright/Keys/ClassMethods.html">Seabright::Keys::ClassMethods</a>
+  
+    <li><a href="./Seabright/ObjectBase.html">Seabright::ObjectBase</a>
+  
+    <li><a href="./Seabright/ObjectBase/ClassMethods.html">Seabright::ObjectBase::ClassMethods</a>
+  
+    <li><a href="./Seabright/RedisObject.html">Seabright::RedisObject</a>
+  
+    <li><a href="./Seabright/RedisObject.html">Seabright::RedisObject</a>
+  
+    <li><a href="./Seabright/References.html">Seabright::References</a>
+  
+    <li><a href="./Seabright/Storage.html">Seabright::Storage</a>
+  
+    <li><a href="./Seabright/Storage/ClassMethods.html">Seabright::Storage::ClassMethods</a>
+  
+    <li><a href="./Seabright/Storage/MySQL.html">Seabright::Storage::MySQL</a>
+  
+    <li><a href="./Seabright/Storage/Redis.html">Seabright::Storage::Redis</a>
+  
+    <li><a href="./Seabright/Template.html">Seabright::Template</a>
+  
+    <li><a href="./Seabright/Template/ClassMethods.html">Seabright::Template::ClassMethods</a>
+  
+    <li><a href="./Seabright/Timestamps.html">Seabright::Timestamps</a>
+  
+    <li><a href="./Seabright/Timestamps/ClassMethods.html">Seabright::Timestamps::ClassMethods</a>
+  
+    <li><a href="./Seabright/Types.html">Seabright::Types</a>
+  
+    <li><a href="./Seabright/Types/ClassMethods.html">Seabright::Types::ClassMethods</a>
+  
+    <li><a href="./Object.html">Object</a>
+  
+    <li><a href="./Seabright/RedisObject.html">Object::RedisObject</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="module">module Seabright</h1>
+
+  <div id="description" class="description">
+    
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    <!-- Methods -->
+    
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+