tractor 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Shane Wolf
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= tractor
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Shane Wolf. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tractor"
+    gem.summary = "Very simple object mapping for ruby objects"
+    gem.description = "Very simple object mappings for ruby objects"
+    gem.email = "shanewolf@gmail.com"
+    gem.homepage = "http://github.com/gizm0duck/tractor"
+    gem.authors = ["Shane Wolf"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tractor #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/tractor/model/base.rb

@@ -0,0 +1,253 @@
+require 'base64'
+
+module Tractor
+  
+  class << self
+    attr_reader :redis
+    
+    # important options are port, host and db
+    def connectdb(options={})
+      if options.nil?
+        @redis = Redis.new(options)
+      else
+        @redis = Redis.new(:db => 1)
+      end
+    end
+
+    def flushdb
+      @redis.flushdb
+    end
+  end
+  
+  class Set
+    include Enumerable
+    
+    attr_accessor :key, :klass
+
+    def initialize(key, klass)
+      self.klass = klass
+      self.key = key
+    end
+    
+    def push(val)
+      Tractor.redis.sadd key, val.id
+    end
+    
+    def all
+      ids = Tractor.redis.smembers(key)
+      ids.inject([]){ |a, id| a << klass.find_by_id(id); a }
+    end
+  end
+  
+  class Index
+    include Enumerable
+    attr_reader :klass, :name, :value
+    
+    def initialize(klass, name, value)
+      @klass = klass
+      @name = name
+      @value = value
+    end
+    
+    def insert(id)
+      Tractor.redis.sadd(key, id) unless Tractor.redis.smembers(key).include?(id)
+    end
+    
+    def delete(id)
+      Tractor.redis.srem(key, id)
+    end
+    
+    def self.key_for(klass, name, value)
+      i = self.new(klass, name, value)
+      i.key
+    end
+    
+    def key
+      encoded_value = "#{Base64.encode64(value.to_s)}".gsub("\n", "")
+      "#{klass}:#{name}:#{encoded_value}"
+    end
+  end
+  
+  module Model
+    class Base
+      def initialize(attributes={})
+        @attribute_store = {}
+        @association_store = {}
+        
+        attributes.each do |k,v|
+          send("#{k}=", v)
+        end
+      end
+      
+      def save
+        raise "Probably wanna set an id" if self.id.nil? || self.id.to_s.empty?
+        key_base = "#{self.class}:#{self.id}"
+        #raise "Duplicate value for #{self.class} 'id'" if Tractor.redis.keys("#{key_base}:*").any?
+        
+        scoped_attributes = attribute_store.inject({}) do |h, (attr_name, value)| 
+          h["#{key_base}:#{attr_name}"] = value
+          h
+        end
+        Tractor.redis.mset scoped_attributes
+        Tractor.redis.sadd "#{self.class}:all", self.id
+        add_to_indices
+        
+        return self
+      end
+      
+      def destroy
+        keys = Tractor.redis.keys("#{self.class}:#{self.id}:*")
+        delete_from_indices(keys.map{|k| k.split(":").last })
+        Tractor.redis.srem("#{self.class}:all", self.id)
+        keys.each { |k| Tractor.redis.del k }
+      end
+      
+      def update(attributes = {})
+        attributes.delete(:id)
+        delete_from_indices(attributes)
+        attributes.each{ |k,v| self.send("#{k}=", v) }
+        save
+      end
+      
+      def add_to_indices
+        self.class.indices.each do |name|
+          index = Index.new(self.class, name, send(name))
+          index.insert(self.id)
+        end
+      end
+      
+      def delete_from_indices(attributes)
+        attributes.each do |name, value|
+          if self.class.indices.include?(name.to_sym)
+            index = Index.new(self.class, name, self.send(name))
+            index.delete(self.id)
+          end
+        end
+      end
+      
+      def to_h
+        self.class.attributes.keys.inject({}) do |h, attribute|
+          h[attribute.to_sym] = self.send(attribute)
+          h
+        end
+      end
+      
+      class << self
+        attr_reader :attributes, :associations, :indices
+        
+        def create(attributes={})
+          m = new(attributes)
+          m.save
+          m
+        end
+
+        def find_by_id(id)
+          keys = Tractor.redis.keys("#{self}:#{id}:*")
+          return nil if keys.empty?
+
+          scoped_attributes = Tractor.redis.mapped_mget(*keys)
+          unscoped_attributes = scoped_attributes.inject({}) do |h, (key, value)| 
+
+            name = key.split(":").last
+            type = attributes[name.to_sym][:type]
+            if type == :integer
+              value = value.to_i
+            elsif type == :boolean
+              value = value.to_s.match(/(true|1)$/i) != nil
+            end
+            h[name] = value
+            h
+          end
+          self.new(unscoped_attributes)
+        end
+
+        # use method missing to do craziness, or define a find_by on each index (BETTER)
+        def find_by_attribute(name, value)
+          raise "No index on '#{name}'" unless indices.include?(name)
+
+          ids = Tractor.redis.smembers(Index.key_for(self, name, value))
+          ids.map do |id|
+            find_by_id(id)
+          end
+        end
+
+        def find(options = {})
+          return [] if options.empty?
+          sets = options.map do |name, value|
+            Index.key_for(self, name, value)
+          end
+          ids = Tractor.redis.sinter(*sets)
+          ids.map do |id|
+            find_by_id(id)
+          end
+        end
+        
+        def attribute(name, options={})
+          options[:map] = name unless options[:map]
+          attributes[name] = options
+          setter(name, options[:type])
+          getter(name, options[:type])
+        end
+        
+        def index(name)
+          indices << name unless indices.include?(name)
+        end
+        
+        def association(name, klass)
+          associations[name] = name
+          
+          define_method(name) do
+            @association_store[name] = Set.new("#{self.class}:#{self.id}:#{name}", klass)
+          end
+        end
+        
+        def all
+          ids = Tractor.redis.smembers("#{self}:all")
+          ids.inject([]){ |a, id| a << find_by_id(id); a }
+        end
+        
+        ###
+        # Minions
+        ###
+        
+        def getter(name, type)
+          define_method(name) do
+            value = @attribute_store[name]
+            if type == :integer
+              value.to_i
+            elsif type == :boolean
+              value.to_s.match(/(true|1)$/i) != nil
+            else
+              value
+            end
+          end
+        end
+        
+        def setter(name, type)
+          define_method(:"#{name}=") do |value|
+            if type == :boolean
+              value = value.to_s
+            end
+            @attribute_store[name] = value
+          end
+        end
+        
+        def attributes
+          @attributes ||= {}
+        end
+        
+        def associations
+          @associations ||= {}
+        end
+        
+        def indices
+          @indices ||= []
+        end
+      end
+      
+      private 
+      
+        attr_reader :attribute_store, :association_store
+    end
+  end
+end

data/lib/tractor/model/mapper.rb

@@ -0,0 +1,93 @@
+module Tractor
+  module Model
+    class Mapper < Tractor::Model::Base
+      class << self
+        attr_reader :dependencies
+        
+        def depends_on(klass, options = {})
+          dependencies[klass] = options
+          
+          # set index by default on items that have a depends on
+          #set_redis_index(klass, options[:key_name])
+        end
+        
+        def representation_for(server_instance)
+          if find_from_instance(server_instance)
+            update_from_instance(server_instance)
+          else
+            create_from_instance(server_instance)
+          end
+        end
+        
+        def find_from_instance(server_instance)
+          self.find_by_id(server_instance.id)
+        end
+        
+        def create_from_instance(server_instance)
+          hydrate_attributes(server_instance) do |attributes|
+            self.create(attributes)
+          end
+        end
+        
+        def update_from_instance(server_instance)
+          existing_record = find_from_instance(server_instance)
+          raise "Cannot update an object that doesn't exist." unless existing_record
+          
+          hydrate_attributes(server_instance) do |attributes|
+            existing_record.update(attributes)
+          end
+        end
+        
+        def remove(server_id)
+          obj_to_destroy = self.find_by_id(server_id)
+          return false if obj_to_destroy.nil?
+          obj_to_destroy.destroy
+        end
+        
+        def hydrate_attributes(server_instance)
+          attributes = attribute_mapper(server_instance)
+          ensure_dependencies_met(server_instance)
+          yield attributes
+        end
+        
+        def attribute_mapper(server_instance)
+          attributes = {}
+          self.attributes.each do |name, options|
+            server_value = server_instance.respond_to?(options[:map]) ? server_instance.send(options[:map]) : nil
+            attributes[name] = server_value
+          end
+          attributes
+        end
+        
+        def dependency_met_for?(server_instance, klass)
+          !!klass.find_by_id(server_instance.send(dependencies[klass][:key_name]))
+        end
+        
+        def dependencies_met?(server_instance)
+          dependencies.each do |klass, options|
+            return false unless dependency_met_for?(server_instance, klass)
+          end
+          return true
+        end
+        
+        def ensure_dependencies_met(server_instance)          
+          return if dependencies_met?(server_instance)
+
+          dependencies.each do |klass, options|
+            if klass.find_by_id(server_instance.send(options[:key_name])).nil?
+              server_instances = server_instance.send(options[:method_name])
+              server_instances = server_instances.is_a?(Array) ? server_instances : [server_instances]
+              server_instances.each do |obj|
+                klass.create_from_instance(obj)
+              end
+            end
+          end
+        end
+        
+        def dependencies
+          @dependencies ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/tractor.rb

@@ -0,0 +1,3 @@
+require 'redis'
+require "tractor/model/base"
+require "tractor/model/mapper"

data/spec/model/base_spec.rb

@@ -0,0 +1,366 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Tractor::Model::Base do
+  attr_reader :redis
+  before do
+    class Player < Tractor::Model::Base
+      attribute :id
+      attribute :name
+      attribute :wins_loses
+    end
+    
+    class Game < Tractor::Model::Base
+      attribute :id
+      attribute :board
+      attribute :flying_object
+      attribute :score, :type => :integer
+      
+      association :players, Player
+    end
+  end
+  
+  describe ".attribute" do
+    it "inserts the values into the attributes class instance variable" do
+      Game.attributes.should include(:board)
+    end
+    
+    it "allows you to specify what type the value should be when it comes out of the tractor" do
+      Game.attributes[:score][:type].should == :integer
+    end
+    
+    it "creates a set method for each attribute" do
+      game = Game.new(:board => "fancy")
+      game.send(:attribute_store)[:board].should == "fancy"
+    end
+    
+    it "creates a get method for each attribute" do
+      game = Game.new(:board => "schmancy")
+      game.board.should == "schmancy"
+    end
+    
+    describe "when attribute is a boolean" do
+      it "returns a boolean" do
+        expensive_sammich = Sammich.new(:expensive => true)
+        expensive_sammich.expensive.should == true
+        expensive_sammich.expensive.should be_a(TrueClass)
+      end
+    end
+    
+    describe "when attribute is a integer" do
+      it "returns an integer" do
+        game = Game.new(:score => 1222)
+        game.score.should == 1222
+        game.score.should be_a(Fixnum)
+      end
+    end
+  end
+  
+  describe "#association" do
+    attr_reader :game, :player1, :player2
+    
+    before do
+      @game     = Game.new({ :id => 'g1' })
+      @player1  = Player.new({ :id => 'p1', :name => "delicious" })
+      @player2  = Player.new({ :id => 'p2', :name => "gross" })
+      
+      game.save
+      player1.save
+      player2.save
+    end
+    
+    it "adds a set with the given name to the instance" do # "Monkey:a1a:SET_NAME"
+      Game.associations.keys.should include(:players)
+    end
+    
+    it "adds a push method for the set on an instance of the class" do
+      game.players.push player1
+      redis.smembers('Game:g1:players').should == ['p1']
+    end
+    
+    it "adds an all method for the association to return the items in it" do
+      game.players.all.should == []
+      game.players.push player1
+      game.players.push player2
+      player1_from_game = game.players.all[0]
+      player2_from_game = game.players.all[1]
+      
+      player1_from_game.name.should == player1.name
+      player1_from_game.id.should == player1.id
+      player2_from_game.name.should == player2.name
+      player2_from_game.id.should == player2.id
+    end
+    
+    it "requires the object being added to have been saved to the database before adding it to the set"
+  end
+  
+  describe ".associations" do
+    it "returns all association that have been added to this class" do
+      Game.associations.keys.should == [:players]
+    end
+  end
+  
+  describe ".indices" do
+    it "returns all indices on a class" do
+      Sammich.indices.should == [:product, :weight]
+    end
+  end
+  
+  describe "index" do
+    it "removes newline characters from index key"
+  end
+    
+  describe ".attributes" do
+    attr_reader :sorted_attributes
+    
+    before do
+      @sorted_attributes = Game.attributes.keys.sort{|x,y| x.to_s <=> y.to_s}  
+    end
+  
+    it "returns all attributes that have been added to this class" do
+      sorted_attributes.size.should == 4
+      sorted_attributes.should == [:board, :flying_object, :id, :score]
+    end
+    
+    it "allows different attributes to be specified for different child classes" do
+      Game.attributes.size.should == 4
+      Player.attributes.size.should == 3
+      
+      Game.attributes.keys.should_not include(:name)
+      Player.attributes.keys.should_not include(:flying_object)
+    end
+  end
+  
+  describe "#save" do
+    it "raises if id is nil or empty" do
+      game = Game.new
+      game.id = nil
+      lambda { game.save }.should raise_error("Probably wanna set an id")
+      game.id = ''
+      lambda { game.save }.should raise_error("Probably wanna set an id")
+    end
+    
+    it "should write attributes to redis" do
+      game = Game.new({:id => '1', :board => "large", :flying_object => "disc"})
+      game.save
+      
+      redis["Game:1:id"].should == "1"
+      redis["Game:1:board"].should == "large"
+      redis["Game:1:flying_object"].should == "disc"
+    end
+    
+    it "appends the new object to the Game set" do
+      Game.all.size.should == 0
+      game = Game.new({ :id => '1', :board => "small" })
+      game.save
+      
+      Game.all.size.should == 1
+    end
+  end
+  
+  describe ".all" do
+    it "every object that is created for this class will be in this set" do
+      MonkeyClient.all.size.should == 0
+      MonkeyClient.create({ :id => 'a1a', :evil => true, :birthday => "Dec 3" })
+      MonkeyClient.create({ :id => 'b1b', :evil => false, :birthday => "Dec 4" })
+      MonkeyClient.all.size.should == 2
+    end
+    
+    it "each class only tracks their own" do
+      MonkeyClient.all.size.should == 0
+      BananaClient.all.size.should == 0
+      
+      MonkeyClient.create({ :id => 'a1a', :evil => true, :birthday => "Dec 3" })
+      BananaClient.create({ :id => 'a1a', :name => "delicious" })
+      
+      MonkeyClient.all.size.should == 1
+      BananaClient.all.size.should == 1
+    end
+    
+    it "returns the entire instance of a given object" do
+      MonkeyClient.create({ :id => 'a1a', :evil => true, :birthday => "Dec 3" })
+      MonkeyClient.all[0].birthday.should == "Dec 3"
+    end
+  end
+  
+  describe "#create" do
+    it "allows you to specify which attributes should be unique"
+    # it "raises exception if the id exists" do
+    #   MonkeyClient.create({ :id => 'a1a', :evil => true, :birthday => "Dec 3" })
+    #   lambda do
+    #     MonkeyClient.create({ :id => 'a1a', :evil => false, :birthday => "Jan 4" })
+    #   end.should raise_error("Duplicate value for MonkeyClient 'id'")
+    # end
+    
+    it "should write attributes to redis" do
+      sammich = Sammich.create({ :id => '1', :product => "Veggie Sammich" })
+      
+      redis["Sammich:1:id"].should == "1"
+      redis["Sammich:1:product"].should == "Veggie Sammich"
+    end
+    
+    it "populates all the indices that are specified on the class" do
+      Sammich.create({ :id => '1', :weight => "heavy", :product => "Ham Sammich" })
+      Sammich.create({ :id => '2', :weight => "heavy", :product => "Tuna Sammich" })
+
+      redis.smembers("Sammich:product:SGFtIFNhbW1pY2g=").should include('1')
+      redis.smembers("Sammich:product:VHVuYSBTYW1taWNo").should include('2')
+      redis.smembers("Sammich:weight:aGVhdnk=").should == ['1', '2']
+    end
+    
+    it "returns the instance that has been created" do
+      sammich = Sammich.create({ :id => '1', :weight => "heavy", :product => "Tuna Melt" })
+      sammich.weight.should == "heavy"
+    end
+  end
+  
+  describe ".find_by_id" do
+    it "takes an id and returns the object from redis" do
+      sammich = Sammich.create({ :id => '1', :product => "Cold Cut Trio" })
+      
+      redis_sammich = Sammich.find_by_id('1')
+      redis_sammich.product.should == "Cold Cut Trio"
+    end
+    
+    it "returns nil if the keys do not exist in redis" do
+      Sammich.find_by_id('1').should be_nil
+    end
+  end
+  
+  describe "#update" do
+    attr_reader :sammich
+    
+    before do
+      @sammich = Sammich.create({ :id => '1', :weight => "medium", :product => "Turkey Avocado" })
+    end
+        
+    it "updates the item from redis" do
+      @sammich.update( {:weight => "heavy"} )
+      @sammich.weight.should == "heavy"
+    end
+    
+    it "does not update the id" do
+      @sammich.update( {:id => "111111"} )
+      @sammich.id.should == "1"
+    end
+    
+    it "only changes attributes passed in" do
+      @sammich.update( {:weight => "light"} )
+      @sammich.id.should == "1"
+      @sammich.weight.should == "light"
+      @sammich.product.should == "Turkey Avocado"
+    end
+    
+    it "updates all the indices associated with this object" do
+      Sammich.find( {:weight => "light"} ).should be_empty
+      Sammich.find( {:weight => "medium"} ).should_not be_empty
+      sammich.update( {:weight => "light"} )
+      Sammich.find( {:weight => "light"} ).should_not be_empty
+      Sammich.find( {:weight => "medium"} ).should be_empty
+    end
+    
+    it "raises if object has not been saved yet"
+  end
+  
+  describe "#destroy" do
+    attr_reader :cheese, :balogna
+    
+    before do
+      @cheese = Sammich.create({ :id => '1', :weight => "medium", :product => "Cheese Sammich" })
+      @balogna = Sammich.create({ :id => '2', :weight => "medium", :product => "Balogna Sammich" })
+    end
+    
+    it "removes the item from redis" do
+      @cheese.destroy
+      Sammich.find_by_id(cheese.id).should be_nil
+    end
+    
+    it "removes the id from the all index" do
+      Sammich.all.map{|t| t.id }.should == ["1", "2"]
+      cheese.destroy
+      Sammich.all.map{|t| t.id }.should == ["2"]
+    end
+    
+    it "removes the id from all of it's other indices" do
+      Sammich.find({ :weight => "medium" }).size.should == 2
+      cheese.destroy
+      Sammich.find({ :weight => "medium" }).size.should == 1
+    end
+    
+    it "removes the id from all of the associations that it may be in"
+  end
+  
+  describe ".find" do
+    attr_reader :cheese, :balogna
+    
+    before do
+      @cheese = Sammich.create({ :id => '1', :weight => "medium", :product => "Cheese Sammich" })
+      @balogna = Sammich.create({ :id => '2', :weight => "medium", :product => "Balogna Sammich" })
+    end
+    
+    context "when searching on 1 attribute" do
+      it "returns all matching products" do
+        redis_cheese, redis_balogna = Sammich.find( {:weight => "medium" } )
+        
+        redis_cheese.id.should == cheese.id
+        redis_cheese.product.should == cheese.product
+        redis_balogna.id.should == balogna.id
+        redis_balogna.product.should == balogna.product
+      end
+    end
+    
+    context "when searching on multiple attribute" do
+      it "returns the intersection of all matching objects" do
+        sammiches = Sammich.find( {:weight => "medium", :product => "Cheese Sammich" } )
+        sammiches.size.should == 1
+        sammiches[0].id.should == "1"
+        sammiches[0].product.should == "Cheese Sammich"
+      end
+    end
+    
+    it "returns empty array if no options are given" do
+      Sammich.find({}).should == []
+    end
+    
+    it "returns empty array if nothing matches the given options" do
+      Sammich.find( {:weight => "light" } ).should == []
+    end
+  end
+  
+  describe ".find_by_attribute" do
+    it "raises if index does not exist for given key" do
+      lambda do
+        Sammich.find_by_attribute(:expensive, true)
+      end.should raise_error("No index on 'expensive'")
+    end
+    
+    it "takes an index name and value and finds all matching objects" do
+      meat_supreme = Sammich.create({ :id => '1', :weight => "heavy", :product => "Meat Supreme" })
+      bacon_with_bacon = Sammich.create({ :id => '2', :weight => "heavy", :product => "Bacon with extra Bacon" })
+    
+      redis_meat_supreme, redis_bacon_with_bacon = Sammich.find_by_attribute(:weight, "heavy")
+      redis_meat_supreme.id.should == meat_supreme.id
+      redis_meat_supreme.weight.should == meat_supreme.weight
+      redis_meat_supreme.product.should == meat_supreme.product
+      
+      redis_bacon_with_bacon.id.should == bacon_with_bacon.id
+      redis_bacon_with_bacon.weight.should == bacon_with_bacon.weight
+      redis_bacon_with_bacon.product.should == bacon_with_bacon.product
+    end
+    
+    it "returns nil if nothing matches" do
+      Sammich.find_by_attribute(:weight, "heavy").should == []
+    end
+  end
+  
+  describe ".to_h" do
+    it "returns the attributes for a mapped object in a hash" do
+      chicken = Sammich.create({ :id => '1', :weight => "heavy", :product => "Chicken" })
+      
+      chicken = Sammich.find_by_id('1')
+      hashed_attributes = chicken.to_h
+      hashed_attributes[:id].should == "1"
+      hashed_attributes[:weight].should == "heavy"
+      hashed_attributes[:product].should == "Chicken"
+    end
+  end
+end

data/spec/model/mapper_spec.rb

@@ -0,0 +1,271 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Tractor::Model::Mapper do
+  before do
+    class RedisTrain < Tractor::Model::Mapper
+      attribute :id
+      attribute :name
+      attribute :num_cars, :type => :integer, :map => :number_of_cars
+      index :num_cars
+    end
+    
+    class Train
+      attr_accessor :number_of_cars, :id
+
+      def initialize(number_of_cars, id)
+        @id             = id
+        @number_of_cars = number_of_cars
+      end
+    end
+    
+    class FamousTrain < Train
+      attr_accessor :name
+      def initialize(name, number_of_cars, id)
+        @id = id; @number_of_cars = number_of_cars; @name = name
+      end
+    end
+  end
+  
+  describe ".attribute_mapper" do
+    describe "when all of the mapped attributes are methods on the server object" do
+      it "should include all attributes with their proper values" do
+        train = FamousTrain.new('Wabash Cannonball', 7, '5309')
+        redis_train_attributes = RedisTrain.attribute_mapper(train)
+        
+        redis_train_attributes.keys.size.should == 3
+        redis_train_attributes[:id].should == "5309"
+        redis_train_attributes[:num_cars].should == 7
+        redis_train_attributes[:name].should == "Wabash Cannonball"
+      end
+    end
+    
+    describe "when some of the mapped attributes do not exist on the server object" do
+      it "should leave those mappings out of the attributes for the client object" do
+        train = Train.new(9, '5309')
+        redis_train_attributes = RedisTrain.attribute_mapper(train)
+        
+        redis_train_attributes.keys.size.should == 3
+        redis_train_attributes[:id].should == "5309"
+        redis_train_attributes[:num_cars].should == 9
+        redis_train_attributes[:name].should be_nil
+      end
+    end
+  end
+  
+  describe "find_from_instance" do
+    it "returns nil if record does not exist in redis" do
+      monkey_1 = Monkey.new("Dec. 3, 1981", true, 'a1a')
+      monkey_client_1 = MonkeyClient.find_from_instance(monkey_1)
+      monkey_client_1.should be_nil
+    end
+    
+    it "returns the object from redis if it exists" do      
+      monkey_1 = Monkey.new("Dec. 3, 1981", true, 'a1a')
+      monkey_2 = Monkey.new("Dec. 4, 1981", false, 'b1b')
+      
+      MonkeyClient.create_from_instance(monkey_1)
+      MonkeyClient.create_from_instance(monkey_2)
+      MonkeyClient.all.size.should == 2
+      
+      redis_monkey_1 = MonkeyClient.find_from_instance(monkey_1)
+      redis_monkey_2 = MonkeyClient.find_from_instance(monkey_2)
+      
+      redis_monkey_1.birthday.should == "Dec. 3, 1981"
+      redis_monkey_2.birthday.should == "Dec. 4, 1981"
+      
+      redis_monkey_1.evil.should == true
+      redis_monkey_2.evil.should == false
+    end
+  end
+  
+  describe "create_from_instance" do
+    it "ensures dependencies are met"
+    it "writes the client representation out to redis with proper object types" do
+      monkey = Monkey.new("Dec. 3, 1981", true, 'a1a')
+      redis_monkey = MonkeyClient.create_from_instance(monkey)
+      
+      redis_monkey = MonkeyClient.all.first
+      redis_monkey.birthday.should == "Dec. 3, 1981"
+      redis_monkey.evil.should == true
+      redis_monkey.id.should == "a1a"
+    end
+  end
+  
+  describe "update_from_instance" do
+    it "ensures dependencies are met"
+    it "finds an existing record based on id and updates the attributes accordingly" do
+      monkey = Monkey.new("Dec. 3, 1981", true, 'a1a')
+      redis_monkey = MonkeyClient.create_from_instance(monkey)
+      
+      MonkeyClient.all.size.should == 1
+      redis_monkey = MonkeyClient.all.first
+      redis_id = redis_monkey.id
+      redis_monkey.id.should == monkey.id
+      
+      monkey.birthdate = "Dec. 2, 1981"
+      monkey.evil_monkey = false
+      
+      MonkeyClient.update_from_instance(monkey)
+      MonkeyClient.all.size.should == 1
+      redis_monkey = MonkeyClient.find_by_id(redis_id)
+      
+      redis_monkey.birthday.should == "Dec. 2, 1981"
+      redis_monkey.evil.should == false
+    end
+    
+    it "raises if record does not exist" do
+      MonkeyClient.all.should be_empty
+      monkey = Monkey.new("Dec. 3, 1981", true, 'a1a')
+      
+      lambda do 
+        redis_monkey = MonkeyClient.update_from_instance(monkey)
+      end.should raise_error("Cannot update an object that doesn't exist.")
+    end
+  end
+  
+  describe ".remove" do
+    it "removes the client representation with the given id" do
+      monkey = Monkey.new("Dec. 3, 1981", true, 'a1a')
+      redis_monkey = MonkeyClient.create_from_instance(monkey)
+      
+      MonkeyClient.find_from_instance(monkey).should_not be_nil
+      MonkeyClient.remove(monkey.id)
+      MonkeyClient.find_from_instance(monkey).should be_nil
+    end
+    
+    it "returns false if the client representation with the given id does not exist" do
+      monkey = Monkey.new("Dec. 3, 1981", true, 'a1a')
+      
+      MonkeyClient.remove(monkey.id).should be_false
+      MonkeyClient.find_from_instance(monkey).should be_nil
+    end
+  end
+  
+  describe ".representation_for" do
+    attr_reader :monkey
+    
+    before do
+      @monkey = Monkey.new("Dec. 3, 1981", true, 'aabc1')
+    end
+    
+    context "when the object does NOT exist in the cache" do
+      before do
+        MonkeyClient.all.should be_empty
+      end
+      
+      it "inserts the object and returns it" do
+        monkey_client = MonkeyClient.representation_for(monkey)
+        monkey_client.class.should == MonkeyClient
+        monkey_client.birthday.should == "Dec. 3, 1981"
+        monkey_client.evil.should == true
+      end
+    end
+    
+    context "when the object exists in the cache" do
+      before do
+        monkey_client = MonkeyClient.create_from_instance(monkey)
+        MonkeyClient.find_by_id(monkey.id).should_not be_nil
+        monkey_client.birthday.should == monkey.birthdate
+        MonkeyClient.all.size.should == 1
+      end
+      
+      it "updates the values and returns the object" do
+        monkey.birthdate = "Nov. 27, 1942"
+        monkey_client = MonkeyClient.representation_for(monkey)
+        monkey_client.birthday.should == "Nov. 27, 1942"
+        MonkeyClient.all.size.should == 1
+      end
+    end
+  end
+  
+  describe "dependencies" do
+    it "returns a list of all the dependencies for this class" do
+      dependencies = SlugClient.dependencies
+      dependencies.keys.should == [BananaClient]
+      dependencies[BananaClient][:key_name].should == :banana_id
+      dependencies[BananaClient][:method_name].should == :banana
+    end
+  end
+  
+  describe ".dependency_met_for?" do
+    attr_reader :slug
+    before do
+      @slug = Slug.new('slug_1', "banana_1")
+    end
+    
+    context "when dependency is met" do
+      before do
+        banana = BananaClient.create_from_instance(Banana.new("banana_1", "yellow"))
+        BananaClient.find_by_id(banana.id).should_not be_nil
+      end
+      
+      it "returns true" do
+        SlugClient.dependency_met_for?(slug, BananaClient).should be_true
+      end
+    end
+    
+    context "when dependency is NOT met" do
+      before do
+        MonkeyClient.find_by_id(slug.banana_id).should be_nil
+      end
+      
+      it "returns false" do
+        SlugClient.dependency_met_for?(slug, BananaClient).should be_false
+      end
+    end
+  end
+      
+  describe ".dependencies_met?" do
+    context "when all dependencies are met" do
+      before do
+        SlugClient.stub!(:dependency_met_for?).and_return(true)
+      end
+      
+      it "returns true" do
+        SlugClient.dependencies_met?(BananaClient).should be_true
+      end
+    end
+    
+    context "when any dependency is not met" do
+      before do
+        SlugClient.stub!(:dependency_met_for?).and_return(false)
+      end
+      
+      it "returns false" do
+        SlugClient.dependencies_met?(BananaClient).should be_false
+      end
+    end
+  end
+  
+  describe ".ensure_dependencies_met" do
+    attr_reader :banana, :slug
+    describe "when the dependencies are met" do
+      before do
+        SlugClient.stub!(:dependencies_met?).and_return(true)
+        @banana = Banana.new('banana1', 'yellowish')
+        @slug = Slug.new('slug1', 'banana1')
+      end
+      
+      it "Does not create any objects" do
+        BananaClient.all.should be_empty
+        SlugClient.ensure_dependencies_met(banana)
+        BananaClient.all.should be_empty
+      end
+    end
+    
+    describe "when the dependencies are NOT met" do
+      before do
+        @banana = Banana.new('banana1', 'yellowish')
+        @slug = Slug.new('slug1', 'banana1')
+        
+        SlugClient.dependencies_met?(slug).should be_false
+      end
+      
+      it "creates the dependent objects" do
+        BananaClient.all.should be_empty
+        SlugClient.ensure_dependencies_met(slug)
+        BananaClient.all.should_not be_empty
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'tractor'
+require 'spec'
+require 'spec/autorun'
+require 'redis'
+
+Spec::Runner.configure do |config|
+  config.before(:each) do 
+    @redis = Tractor.connectdb
+    Tractor.flushdb 
+  end
+end
+
+class Sammich < Tractor::Model::Base
+  attribute :id
+  attribute :product
+  attribute :weight
+  attribute :expensive, :type => :boolean
+  index :product
+  index :weight
+end
+
+class BananaClient < Tractor::Model::Mapper
+  attribute :id
+  attribute :name
+end
+
+class Banana
+  attr_accessor :id, :type
+  def initialize(id, type)
+    @id = id; @type = type;
+  end
+end
+
+class MonkeyClient < Tractor::Model::Mapper
+  attribute :id
+  attribute :birthday, :map => :birthdate
+  attribute :evil, :type => :boolean, :map => :evil_monkey #[:evil_monkey, :boolean]
+  index :evil
+  
+  association :bananas, BananaClient
+end
+
+class Monkey
+  attr_accessor :birthdate, :evil_monkey, :id
+  
+  def initialize(birthdate, evil_monkey, id)
+    @id           = id
+    @birthdate    = birthdate
+    @evil_monkey  = evil_monkey
+  end
+end
+
+class SlugClient < Tractor::Model::Mapper
+  attribute :id
+  attribute :banana_id
+  
+  depends_on BananaClient, :key_name => :banana_id, :method_name => :banana
+end
+
+class Slug
+  attr_accessor :id, :banana_id
+  
+  def initialize(id, banana_id)
+    @id = id; @banana_id = banana_id
+  end
+  
+  def banana
+    Banana.new(banana_id, "yellow")
+  end
+end

data/tractor.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tractor}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Shane Wolf"]
+  s.date = %q{2010-02-12}
+  s.description = %q{Very simple object mappings for ruby objects}
+  s.email = %q{shanewolf@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/tractor.rb",
+     "lib/tractor/model/base.rb",
+     "lib/tractor/model/mapper.rb",
+     "spec/model/base_spec.rb",
+     "spec/model/mapper_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/tractor_spec.rb",
+     "tractor.gemspec"
+  ]
+  s.homepage = %q{http://github.com/gizm0duck/tractor}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Very simple object mapping for ruby objects}
+  s.test_files = [
+    "spec/model/base_spec.rb",
+     "spec/model/mapper_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/tractor_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: tractor
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Shane Wolf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-12 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Very simple object mappings for ruby objects
+email: shanewolf@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tractor.rb
+- lib/tractor/model/base.rb
+- lib/tractor/model/mapper.rb
+- spec/model/base_spec.rb
+- spec/model/mapper_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/tractor_spec.rb
+- tractor.gemspec
+has_rdoc: true
+homepage: http://github.com/gizm0duck/tractor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Very simple object mapping for ruby objects
+test_files: 
+- spec/model/base_spec.rb
+- spec/model/mapper_spec.rb
+- spec/spec_helper.rb
+- spec/tractor_spec.rb