active_column 0.0.1 → 0.0.2

data/README.md

@@ -68,14 +68,15 @@ development and testing.
 ### Saving data
 
 To make a model in to an ActiveColumn model, just extend ActiveColumn::Base, and provide two pieces of information:
-* Column Family
-* Function(s) to generate keys for your rows of data
+
+- Column Family
+- Function(s) to generate keys for your rows of data
 
 The most basic form of using ActiveColumn looks like this:
 <pre>
 class Tweet &lt; ActiveColumn::Base
   column_family :tweets
-  keys :user_id
+  key :user_id
 end
 </pre>
 
@@ -97,7 +98,7 @@ by telling it the name of a function to use to generate the keys during a save.
 <pre>
 class Tweet &lt; ActiveColumn::Base
   column_family :tweets
-  keys :user_id => :generate_user_keys
+  key :user_id, :values => :generate_user_keys
 
   def generate_user_keys
     [ attributes[:user_id], 'all']
@@ -117,7 +118,8 @@ and looks like this:
 <pre>
 class TweetDM &lt; ActiveColumn::Base
   column_family :tweet_dms
-  keys [ { :user_id => :generate_user_keys }, { :recipient_id => :recipient_ids } ]
+  key :user_id,      :values => :generate_user_keys
+  key :recipient_id, :values => :recipient_ids
 
   def generate_user_keys
     [ attributes[:user_id], 'all ]
@@ -132,10 +134,11 @@ dm = TweetDM.new( :user_id => 'mwynholds', :recipient_ids => [ 'fsinatra', 'dmar
 </pre>
 
 This tweet direct message will saved to four different rows in the "tweet_dms" column family, under these keys:
-* mwynholds:fsinatra
-* mwynholds:dmartin
-* all:fsinatra
-* all:dmartin
+
+- mwynholds:fsinatra
+- mwynholds:dmartin
+- all:fsinatra
+- all:dmartin
 
 Now my app can pretty easily figure find all DMs I sent to Old Blue Eyes, or to Dino, and it can also easily find all
 DMs sent from *anyone* to Frank or Dino.
@@ -147,4 +150,44 @@ are ordered is necessary to keep the compounds keys canonical (ie: deterministic
 
 ### Finding data
 
-Working on this...
+Ok, congratulations - now you have a bunch of fantastic data in Cassandra.  How do you get it out?  ActiveColumn can
+help you here too.
+
+Here is how you look up data that have a simple key:
+
+<pre>
+tweets = Tweet.find( 'mwynholds', :reversed => true, :count => 3 )
+</pre>
+
+This code will find the last 10 tweets for the 'mwynholds' user in reverse order.  It comes back as a hash of arrays,
+and would looks like this if represented in JSON:
+
+<pre>
+{
+  'mwynholds': [ { 'user_id': 'mwynholds', 'message': 'I\'m going to bed now' },
+                 { 'user_id': 'mwynholds', 'message': 'It\'s lunch time' },
+                 { 'user_id': 'mwynholds', 'message': 'Just woke up' } ]
+}
+</pre>
+
+Here are some other examples and their return values:
+
+<pre>
+Tweet.find( [ 'mwynholds', 'all' ], :count => 2 )
+
+{
+  'mwynholds': [ { 'user_id': 'mwynholds', 'message': 'Good morning' },
+                 { 'user_id': 'mwynholds', 'message': 'Good afternoon' } ],
+  'all': [ { 'user_id': 'mwynholds', 'message': 'Good morning' },
+             'user_id': 'bmurray', 'message': 'Who ya gonna call!' } ]
+}
+</pre>
+
+<pre>
+Tweet.find( { 'user_id' => 'all', 'recipient_id' => [ 'fsinatra', 'dmartin' ] }, :reversed => true, :count => 1 )
+
+{
+  'all:fsinatra' => [ { 'user_id': 'mwynholds', 'recipient_ids' => [ 'fsinatra', 'dmartin' ], 'message' => 'Here we come Vegas!' } ],
+  'all:dmartin' => [ { 'user_id': 'fsinatra', 'recipient_ids' => [ 'dmartin' ], 'message' => 'Vegas was fun' } ]
+}
+</pre>

data/active_column.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Michael Wynholds"]
   s.email       = ["mike@wynholds.com"]
-  s.homepage    = "http://rubygems.org/gems/active_column"
+  s.homepage    = "https://github.com/carbonfive/active_column"
   s.summary     = %q{Provides time line support for Cassandra}
   s.description = %q{Provides time line support for Cassandra}
 
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'simple_uuid'
-
-  s.add_development_dependency 'cassandra'
+  s.add_dependency 'cassandra'
+  
   s.add_development_dependency 'rspec'
 end

data/lib/active_column/base.rb

@@ -13,10 +13,9 @@ module ActiveColumn
       @column_family = column_family
     end
 
-    def self.keys(*keys)
-      return @keys if keys.nil? || keys.empty?
-      flattened = ( keys.size == 1 && keys[0].is_a?(Array) ? keys[0] : keys )
-      @keys = flattened.collect { |k| KeyConfig.new(k) }
+    def self.key(key, options = {})
+      @keys ||= []
+      @keys << KeyConfig.new(key, options)
     end
 
     def save()
@@ -46,6 +45,10 @@ module ActiveColumn
 
     private
 
+    def self.keys
+      @keys
+    end
+
     def get_keys(key_config)
       key_config.func.nil? ? attributes[key_config.key] : self.send(key_config.func)
     end
@@ -73,13 +76,9 @@ module ActiveColumn
   class KeyConfig
     attr_accessor :key, :func
 
-    def initialize(key_conf)
-      if key_conf.is_a?(Hash)
-        @key = key_conf.keys[0]
-        @func = key_conf[@key]
-      else
-        @key = key_conf
-      end
+    def initialize(key, options)
+      @key = key
+      @func = options[:values]
     end
 
     def to_s

data/lib/active_column/version.rb

@@ -1,3 +1,3 @@
 module ActiveColumn
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/support/aggregating_tweet.rb

@@ -1,7 +1,7 @@
 class AggregatingTweet < ActiveColumn::Base
 
   column_family :tweets
-  keys :user_id => :user_keys
+  key :user_id, :values => :user_keys
 
   def user_keys
     [ attributes[:user_id], 'all' ]

data/spec/support/compound_key.rb

@@ -1,4 +1,6 @@
 class CompoundKey < ActiveColumn::Base
   column_family :time
-  keys :one, :two, :three
+  key :one
+  key :two
+  key :three
 end

data/spec/support/simple_key.rb

@@ -1,4 +1,4 @@
 class SimpleKey < ActiveColumn::Base
   column_family :time
-  keys :one
+  key :one
 end

data/spec/support/tweet.rb

@@ -1,6 +1,6 @@
 class Tweet < ActiveColumn::Base
 
   column_family :tweets
-  keys :user_id
+  key :user_id
 
 end

data/spec/support/tweet_dm.rb

@@ -1,7 +1,8 @@
 class TweetDM < ActiveColumn::Base
 
   column_family :tweet_dms
-  keys [ { :user_id => :user_keys }, { :recipient_id => :recipient_keys } ]
+  key :user_id,      :values => :user_keys
+  key :recipient_id, :values => :recipient_keys
 
   def user_keys
     [ attributes[:user_id], 'all' ]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Michael Wynholds
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-12 00:00:00 -08:00
+date: 2010-12-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,7 +41,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -70,7 +70,6 @@ files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
-- README.html
 - README.md
 - Rakefile
 - active_column.gemspec
@@ -88,7 +87,7 @@ files:
 - spec/support/tweet.rb
 - spec/support/tweet_dm.rb
 has_rdoc: true
-homepage: http://rubygems.org/gems/active_column
+homepage: https://github.com/carbonfive/active_column
 licenses: []
 
 post_install_message: 

data/README.html

@@ -1,156 +0,0 @@
-<h1>ActiveColumn</h1>
-
-<p>ActiveColumn is a framework for saving and retrieving data from Cassandra in a "time line" model.  It is loosely based
-on concepts in ActiveRecord, but is adapted to saving data in which rows in Cassandra grow indefinitely over time, such
-as in the oft-used Twitter example for Cassandra.</p>
-
-<h2>Installation</h2>
-
-<p>Add ActiveColumn to your Gemfile:</p>
-
-<pre>
-gem 'active_column'
-</pre>
-
-<p>Install with bundler:</p>
-
-<pre>
-bundle install
-</pre>
-
-<h2>Usage</h2>
-
-<h3>Configuration</h3>
-
-<p>ActiveColumn requires the <a href="https://github.com/fauna/cassandra">cassandra gem</a>.  You must provide ActiveColumn with an
-instance of a Cassandra object.  You can do this very simply like this:</p>
-
-<pre>
-ActiveColumn.connection = Cassandra.new('my_keyspace', '127.0.0.1:9160')
-</pre>
-
-<p>However, in a real app this is not flexible enough, so I often create a cassandra.yml file and configure Cassandra in an
-initializer.</p>
-
-<p>config/cassandra.yml</p>
-
-<pre>
-test:
-  home: ":"
-  servers: "127.0.0.1:9160"
-  keyspace: "myapp_test"
-  thrift:
-    timeout: 3
-    retries: 2
-
-development:
-  home: ":"
-  servers: "127.0.0.1:9160"
-  keyspace: "myapp_development"
-  thrift:
-    timeout: 3
-    retries: 2
-</pre>
-
-<p>config/initializers/cassandra.rb</p>
-
-<pre>
-config = YAML.load_file(Rails.root.join("config", "cassandra.yml"))[Rails.env]
-$cassandra = Cassandra.new(config['keyspace'],
-                           config['servers'],
-                           config['thrift'])
-
-ActiveColumn.connection = $cassandra
-</pre>
-
-<p>As you can see, I create a global $cassandra variable, which I use in my tests to validate data directly in Cassandra.</p>
-
-<p>One other thing to note is that you obviously must have Cassandra installed and running!  Please take a look at the
-<a href="https://github.com/carbonfive/mama_cass">mama_cass gem</a> for a quick way to get up and running with Cassandra for
-development and testing.</p>
-
-<h3>Saving data</h3>
-
-<p>To make a model in to an ActiveColumn model, just extend ActiveColumn::Base, and provide two pieces of information:
-* Column Family
-* Function(s) to generate keys for your rows of data</p>
-
-<p>The most basic form of using ActiveColumn looks like this:</p>
-
-<pre>
-class Tweet &lt; ActiveColumn::Base
-  column_family :tweets
-  keys :user_id
-end
-</pre>
-
-<p>Then in your app you can create and save a tweet like this:</p>
-
-<pre>
-tweet = Tweet.new( :user_id => 'mwynholds', :message => "I'm going for a bike ride" )
-tweet.save
-</pre>
-
-<p>When you run #save, ActiveColumn saves a new column in the "tweets" column family in the row with key "mwynholds".  The
-content of the row is the Tweet instance JSON-encoded.</p>
-
-<p><em>Key Generator Functions</em></p>
-
-<p>This is great, but quite often you want to save the content in multiple rows for the sake of speedy lookups.  This is
-basically de-normalizing data, and is extremely common in Cassandra data.  ActiveColumn lets you do this quite easily
-by telling it the name of a function to use to generate the keys during a save.  It works like this:</p>
-
-<pre>
-class Tweet &lt; ActiveColumn::Base
-  column_family :tweets
-  keys :user_id => :generate_user_keys
-
-  def generate_user_keys
-    [ attributes[:user_id], 'all']
-  end
-end
-</pre>
-
-<p>The code to save the tweet is the same as the previous example, but now it saves the tweet in both the "mwynholds" row
-and the "all" row.  This way, you can pull out the last 20 of all tweets quite easily (assuming you needed to do this
-in your app).</p>
-
-<p><em>Compound Keys</em></p>
-
-<p>In some cases you may want to have your rows keyed by multiple values.  ActiveColumn supports compound keys,
-and looks like this:</p>
-
-<pre>
-class TweetDM &lt; ActiveColumn::Base
-  column_family :tweet_dms
-  keys [ { :user_id => :generate_user_keys }, { :recipient_id => :recipient_ids } ]
-
-  def generate_user_keys
-    [ attributes[:user_id], 'all ]
-  end
-end
-</pre>
-
-<p>Now, when you create a new TweetDM, it might look like this:</p>
-
-<pre>
-dm = TweetDM.new( :user_id => 'mwynholds', :recipient_ids => [ 'fsinatra', 'dmartin' ], :message => "Let's go to Vegas" )
-</pre>
-
-<p>This tweet direct message will saved to four different rows in the "tweet_dms" column family, under these keys:
-* mwynholds:fsinatra
-* mwynholds:dmartin
-* all:fsinatra
-* all:dmartin</p>
-
-<p>Now my app can pretty easily figure find all DMs I sent to Old Blue Eyes, or to Dino, and it can also easily find all
-DMs sent from <em>anyone</em> to Frank or Dino.</p>
-
-<p>One thing to note about the TweetDM class above is that the "keys" configuration at the top looks a little uglier than
-before.  If you have a compound key and any of the keys have custom key generators, you need to pass in an array of
-single-element hashes.  This is in place to support Ruby 1.8, which does not have ordered hashes.  Making sure the keys
-are ordered is necessary to keep the compounds keys canonical (ie: deterministic).</p>
-
-<h3>Finding data</h3>
-
-<p>Working on this...</p>