couch_tomato 0.1.0

data/lib/couch_tomato/migrator.rb

@@ -0,0 +1,235 @@
+module CouchTomato
+  class IrreversibleMigration < StandardError#:nodoc:
+  end
+
+  class DuplicateMigrationVersionError < StandardError#:nodoc:
+    def initialize(version)
+      super("Multiple migrations have the version number #{version}")
+    end
+  end
+
+  class DuplicateMigrationNameError < StandardError#:nodoc:
+    def initialize(name)
+      super("Multiple migrations have the name #{name}")
+    end
+  end
+
+  class UnknownMigrationVersionError < StandardError #:nodoc:
+    def initialize(version)
+      super("No migration with version number #{version}")
+    end
+  end
+
+  class IllegalMigrationNameError < StandardError#:nodoc:
+    def initialize(name)
+      super("Illegal name for migration file: #{name}\n\t(only lower case letters, numbers, and '_' allowed)")
+    end
+  end
+
+  # MigrationProxy is used to defer loading of the actual migration classes
+  # until they are needed
+  class MigrationProxy
+    attr_accessor :name, :version, :filename
+
+    delegate :migrate, :announce, :write, :to=>:migration
+
+    private
+      def migration
+        @migration ||= load_migration
+      end
+
+      def load_migration
+        load(filename)
+        name.constantize
+      end
+  end
+
+  class Migrator#:nodoc:
+    class << self
+      def migrate(db, migrations_path, target_version = nil)
+        case
+          when target_version.nil?                  then up(db, migrations_path, target_version)
+          when current_version(db) > target_version then down(db, migrations_path, target_version)
+          else                                           up(db, migrations_path, target_version)
+        end
+      end
+
+      def rollback(db, migrations_path, steps=1)
+        move(:down, db, migrations_path, steps)
+      end
+
+      def forward(db, migrations_path, steps=1)
+        move(:up, db, migrations_path, steps)
+      end
+
+      def up(db, migrations_path, target_version = nil)
+        self.new(:up, db, migrations_path, target_version).migrate
+      end
+
+      def down(db, migrations_path, target_version = nil)
+        self.new(:down, db, migrations_path, target_version).migrate
+      end
+
+      def run(direction, db, migrations_path, target_version)
+        self.new(direction, db, migrations_path, target_version).run
+      end
+
+      def migrations_doc(db)
+        begin
+          doc = db.get('_design/migrations')
+        rescue RestClient::ResourceNotFound
+          db.save_doc('_id' => '_design/migrations', 'versions' => nil)
+          doc = db.get('_design/migrations')
+        end
+
+        return doc
+      end
+
+      def get_all_versions(db)
+        doc = migrations_doc(db)
+
+        if doc['versions']
+          doc['versions'].sort
+        else
+          []
+        end
+      end
+
+      def current_version(db)
+        get_all_versions(db).max || 0
+      end
+
+      private
+
+      def move(direction, db, migrations_path, steps)
+        migrator = self.new(direction, db, migrations_path)
+        start_index = migrator.migrations.index(migrator.current_migration) || 0
+        
+        finish = migrator.migrations[start_index + steps]
+        version = finish ? finish.version : 0
+        send(direction, db, migrations_path, version)
+      end
+    end
+
+    def initialize(direction, db, migrations_path, target_version = nil)
+      @db = db
+      @migrations_doc = self.class.migrations_doc(@db)
+      @direction, @migrations_path, @target_version = direction, migrations_path, target_version
+    end
+
+    def current_version
+      migrated.last || 0
+    end
+
+    def current_migration
+      migrations.detect { |m| m.version == current_version }
+    end
+
+    def run
+      target = migrations.detect { |m| m.version == @target_version }
+      raise UnknownMigrationVersionError.new(@target_version) if target.nil?
+      unless (up? && migrated.include?(target.version.to_i)) || (down? && !migrated.include?(target.version.to_i))
+        target.migrate(@direction, @db)
+        record_version_state_after_migrating(target.version)
+      end
+    end
+
+    def migrate
+      current = migrations.detect { |m| m.version == current_version }
+      target = migrations.detect { |m| m.version == @target_version }
+
+      if target.nil? && !@target_version.nil? && @target_version > 0
+        raise UnknownMigrationVersionError.new(@target_version)
+      end
+
+      start = up? ? 0 : (migrations.index(current) || 0)
+      finish = migrations.index(target) || migrations.size - 1
+      runnable = migrations[start..finish]
+
+      # skip the last migration if we're headed down, but not ALL the way down
+      runnable.pop if down? && !target.nil?
+
+      runnable.each do |migration|
+        puts "Migrating to #{migration.name} (#{migration.version})"
+
+        # On our way up, we skip migrating the ones we've already migrated
+        next if up? && migrated.include?(migration.version.to_i)
+
+        # On our way down, we skip reverting the ones we've never migrated
+        if down? && !migrated.include?(migration.version.to_i)
+          migration.announce 'never migrated, skipping'; migration.write
+          next
+        end
+
+        begin
+          migration.migrate(@direction, @db)
+          record_version_state_after_migrating(migration.version)
+        rescue => e
+          raise StandardError, "An error has occurred, all later migrations canceled:\n\n#{e}", e.backtrace
+        end
+      end
+    end
+
+    def migrations
+      @migrations ||= begin
+        files = Dir["#{@migrations_path}/[0-9]*_*.rb"]
+
+        migrations = files.inject([]) do |klasses, file|
+          version, name = file.scan(/([0-9]+)_([_a-z0-9]*).rb/).first
+
+          raise IllegalMigrationNameError.new(file) unless version
+          version = version.to_i
+
+          if klasses.detect { |m| m.version == version }
+            raise DuplicateMigrationVersionError.new(version)
+          end
+
+          if klasses.detect { |m| m.name == name.camelize }
+            raise DuplicateMigrationNameError.new(name.camelize)
+          end
+
+          migration = MigrationProxy.new
+          migration.name     = name.camelize
+          migration.version  = version
+          migration.filename = file
+          klasses << migration
+        end
+
+        migrations = migrations.sort_by(&:version)
+        down? ? migrations.reverse : migrations
+      end
+    end
+
+    def pending_migrations
+      already_migrated = migrated
+      migrations.reject { |m| already_migrated.include?(m.version.to_i) }
+    end
+
+    def migrated
+      @migrated_versions ||= self.class.get_all_versions(@db)
+    end
+
+    private
+      def record_version_state_after_migrating(version)
+        @migrated_versions ||= []
+        if down?
+          @migrated_versions.delete(version.to_i)
+          @migrations_doc['versions'].delete(version)
+          @db.save_doc(@migrations_doc)
+        else
+          @migrated_versions.push(version.to_i).sort!
+          @migrations_doc['versions'] ||= []
+          @migrations_doc['versions'].push(version)
+          @db.save_doc(@migrations_doc)
+        end
+      end
+
+      def up?
+        @direction == :up
+      end
+
+      def down?
+        @direction == :down
+      end
+  end
+end

data/lib/couch_tomato/persistence/base.rb

@@ -0,0 +1,62 @@
+module CouchTomato
+  module Persistence
+    module Base
+      # initialize a new instance of the model optionally passing it a hash of attributes.
+      # the attributes have to be declared using the #property method
+      # 
+      # example: 
+      #   class Book
+      #     include CouchTomato::Persistence
+      #     property :title
+      #   end
+      #   book = Book.new :title => 'Time to Relax'
+      #   book.title # => 'Time to Relax'
+      def initialize(attributes = {})
+        attributes.each do |name, value|
+          self.send("#{name}=", value)
+        end if attributes
+      end
+    
+      # assign multiple attributes at once.
+      # the attributes have to be declared using the #property method
+      #
+      # example:
+      #   class Book
+      #     include CouchTomato::Persistence
+      #     property :title
+      #     property :year
+      #   end
+      #   book = Book.new
+      #   book.attributes = {:title => 'Time to Relax', :year => 2009}
+      #   book.title # => 'Time to Relax'
+      #   book.year # => 2009
+      def attributes=(hash)
+        hash.each do |attribute, value|
+          self.send "#{attribute}=", value
+        end
+      end
+    
+      # returns all of a model's attributes that have been defined using the #property method as a Hash
+      #
+      # example:
+      #   class Book
+      #     include CouchTomato::Persistence
+      #     property :title
+      #     property :year
+      #   end
+      #   book = Book.new :year => 2009
+      #   book.attributes # => {:title => nil, :year => 2009}
+      def attributes
+        self.class.properties.inject({}) do |res, property|
+          property.serialize(res, self)
+          res
+        end
+      end
+    
+      def ==(other) #:nodoc:
+        other.class == self.class && self.to_json == other.to_json
+      end
+    
+    end
+  end
+end

data/lib/couch_tomato/persistence/belongs_to_property.rb

@@ -0,0 +1,58 @@
+module CouchTomato
+  module Persistence
+    class BelongsToProperty #:nodoc:
+      attr_accessor :name
+      
+      def initialize(owner_clazz, name, options = {})
+        self.name = name
+        accessors =  <<-ACCESSORS
+          def #{name}
+            return @#{name} if instance_variable_defined?(:@#{name})
+            @#{name} = @#{name}_id ? #{item_class_name}.find(@#{name}_id) : nil
+          end
+          
+          def #{name}=(value)
+            @#{name} = value
+            if value.nil?
+              @#{name}_id = nil
+            else
+              @#{name}_id = value.id
+            end
+          end
+          
+          def #{name}_id=(id)
+            remove_instance_variable(:@#{name}) if instance_variable_defined?(:@#{name})
+            @#{name}_id = id
+          end
+        ACCESSORS
+        owner_clazz.class_eval accessors
+        owner_clazz.send :attr_reader, "#{name}_id"
+      end
+      
+      # def save(object)
+      #   
+      # end
+      
+      def dirty?(object)
+        false
+      end
+      
+      # def destroy(object)
+      #   
+      # end
+      
+      def build(object, json)
+        object.send "#{name}_id=", json["#{name}_id"]
+      end
+      
+      def serialize(json, object)
+        json["#{name}_id"] = object.send("#{name}_id") if object.send("#{name}_id")
+      end
+      
+      def item_class_name
+        @name.to_s.camelize
+      end
+      
+    end
+  end
+end

data/lib/couch_tomato/persistence/callbacks.rb

@@ -0,0 +1,60 @@
+module CouchTomato
+  module Persistence
+    module Callbacks
+      def self.included(base)
+        base.extend ClassMethods
+
+        base.class_eval do
+          attr_accessor :skip_callbacks
+          def self.callbacks
+            @callbacks ||= {}
+            @callbacks[self.name] ||= {:before_validation => [], :before_validation_on_create => [], 
+              :before_validation_on_update => [], :before_validation_on_save => [], :before_create => [], 
+              :after_create => [], :before_update => [], :after_update => [],
+              :before_save => [], :after_save => [],
+              :before_destroy => [], :after_destroy => []}
+          end
+        end
+      end
+
+      # Runs all callbacks on a model with the given name, i.g. :after_create.
+      # 
+      # This method is called by the CouchTomato::Database object when saving/destroying an object 
+      def run_callbacks(name)
+        return if skip_callbacks
+        self.class.callbacks[name].uniq.each do |callback|
+          if callback.is_a?(Symbol)
+            send callback
+          elsif callback.is_a?(Proc)
+            callback.call self
+          else
+            raise "Don't know how to handle callback of type #{name.class.name}"
+          end
+        end
+      end
+
+      module ClassMethods
+        [
+          :before_validation,
+          :before_validation_on_create,
+          :before_validation_on_update,
+          :before_validation_on_save,
+          :before_create,
+          :before_save,
+          :before_update,
+          :before_destroy,
+          :after_update,
+          :after_save,
+          :after_create,
+          :after_destroy
+        ].each do |callback|
+          define_method callback do |*names|
+            names.each do |name|
+              callbacks[callback] << name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/couch_tomato/persistence/dirty_attributes.rb

@@ -0,0 +1,27 @@
+module CouchTomato
+  module Persistence
+    module DirtyAttributes
+      
+      def self.included(base)
+        base.class_eval do
+          after_save :reset_dirty_attributes
+        end
+      end
+      
+      # returns true if a model has dirty attributes, i.e. their value has changed since the last save
+      def dirty? 
+        new? || self.class.properties.inject(false) do |res, property|
+          res || property.dirty?(self)
+        end
+      end
+      
+      private
+      
+      def reset_dirty_attributes
+        self.class.properties.each do |property|
+          instance_variable_set("@#{property.name}_was", send(property.name))
+        end
+      end
+    end
+  end
+end

data/lib/couch_tomato/persistence/json.rb

@@ -0,0 +1,48 @@
+module CouchTomato
+  module Persistence
+    module Json
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      # returns a JSON representation of a model in order to store it in CouchDB
+      def to_json(*args)
+        to_hash.to_json(*args)
+        # to_json(*args)
+      end
+      
+      # returns all the attributes, the ruby class and the _id and _rev of a model as a Hash
+      def to_hash
+        (self.class.properties).inject({}) do |props, property|
+          property.serialize(props, self)
+          props
+        end.merge('ruby_class' => self.class.name).merge(id_and_rev_json)
+      end
+      
+      private
+      
+      def id_and_rev_json
+        ['_id', '_rev', '_deleted'].inject({}) do |hash, key|
+          hash[key] = self.send(key) unless self.send(key).nil?
+          hash
+        end
+      end
+      
+      module ClassMethods
+        
+        # creates a model instance from JSON
+        def json_create(json, meta={})
+          return if json.nil?
+          instance = self.new
+          instance._id = json[:_id] || json['_id']
+          instance._rev = json[:_rev] || json['_rev']
+          properties.each do |property|
+            property.build(instance, json)
+          end
+          instance.metadata = meta
+          instance
+        end
+      end
+    end
+  end
+end

data/lib/couch_tomato/persistence/magic_timestamps.rb

@@ -0,0 +1,15 @@
+module CouchTomato
+  module Persistence
+    module MagicTimestamps #:nodoc:
+      def self.included(base)
+        base.instance_eval do
+          property :created_at, :type => Time
+          property :updated_at, :type => Time
+        
+          before_create lambda {|model| model.created_at = Time.now; model.created_at_not_changed}
+          before_save lambda {|model| model.updated_at = Time.now; model.updated_at_not_changed}
+        end
+      end
+    end    
+  end
+end

data/lib/couch_tomato/persistence/properties.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/simple_property'
+require File.dirname(__FILE__) + '/belongs_to_property'
+
+module CouchTomato
+  module Persistence
+    module Properties
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          def self.properties
+            @properties ||= {}
+            @properties[self.name] ||= []
+          end
+        end
+      end
+
+      module ClassMethods
+        # returns all the property names of a model class that have been defined using the #property method
+        #
+        # example:
+        #  class Book
+        #    property :title
+        #    property :year
+        #  end
+        #  Book.property_names # => [:title, :year]
+        def property_names
+          properties.map(&:name)
+        end
+
+        def json_create(json, meta={}) #:nodoc:
+          return if json.nil?
+          instance = super
+          # instance.send(:assign_attribute_copies_for_dirty_tracking)
+          instance.metadata = meta
+          instance
+        end
+
+        # Declare a proprty on a model class. properties are not typed by default. You can use any of the basic types by JSON (String, Integer, Fixnum, Array, Hash). If you want a property to be of a custom class you have to define it using the :class option.
+        #
+        # example:
+        #  class Book
+        #    property :title
+        #    property :year
+        #    property :publisher, :class => Publisher
+        #  end
+        def property(name, options = {})
+          clazz = options.delete(:class)
+          properties << (clazz || SimpleProperty).new(self, name, options)
+        end
+
+        def belongs_to(name) #:nodoc:
+          property name, :class => BelongsToProperty
+        end
+
+      end
+    end
+  end
+end

data/lib/couch_tomato/persistence/simple_property.rb

@@ -0,0 +1,97 @@
+module CouchTomato
+  module Persistence
+    class SimpleProperty  #:nodoc:
+      attr_accessor :name, :type
+      JSON_TYPES = [String, Integer, Hash, Array, Fixnum, Float]
+
+      def initialize(owner_clazz, name, options = {})
+        if JSON_TYPES.include?(options[:type])
+          raise "#{options[:type]} is a native JSON type, only custom types should be specified"
+        end
+
+        if options[:type].kind_of?(Array) && options[:type].empty?
+          raise "property defined with `:type => []` but expected `:type => [SomePersistableType]`"
+        end
+
+        self.name = name
+        self.type = options[:type]
+        owner_clazz.class_eval do
+          attr_reader name, "#{name}_was"
+
+          def initialize(attributes = {})
+            super attributes
+            # assign_attribute_copies_for_dirty_tracking
+          end
+
+          # def assign_attribute_copies_for_dirty_tracking
+          #   attributes.each do |name, value|
+          #     self.instance_variable_set("@#{name}_was", clone_attribute(value))
+          #   end if attributes
+          # end
+          # private :assign_attribute_copies_for_dirty_tracking
+
+          def clone_attribute(value)
+            if [Bignum, Fixnum, Symbol, TrueClass, FalseClass, NilClass, Float].include?(value.class)
+              value
+            else
+              value.clone
+            end
+          end
+
+          define_method "#{name}=" do |value|
+            self.instance_variable_set("@#{name}", value)
+          end
+
+          define_method "#{name}?" do
+            !self.send(name).nil? && !self.send(name).try(:blank?)
+          end
+
+          define_method "#{name}_changed?" do
+            !self.instance_variable_get("@#{name}_not_changed") && self.send(name) != self.send("#{name}_was")
+          end
+
+          define_method "#{name}_not_changed" do
+            self.instance_variable_set("@#{name}_not_changed", true)
+          end
+        end
+      end
+
+      def build(object, json)
+        value = json[name.to_s]
+        value = json[name.to_sym] if value.nil?
+
+        if type.kind_of? Array
+          typecasted_value = []
+          value.each do |val|
+            el = type[0].json_create val
+            typecasted_value << el
+          end
+        else
+          typecasted_value = if type
+                               type.json_create value
+                             else
+                               value
+                             end
+        end
+
+        object.send "#{name}=", typecasted_value
+      end
+
+      def dirty?(object)
+        object.send("#{name}_changed?")
+      end
+
+      # def save(object)
+      #
+      #   end
+      #
+      #   def destroy(object)
+      #
+      #   end
+
+      def serialize(json, object)
+        json[name] = object.send name
+      end
+    end
+  end
+end

data/lib/couch_tomato/persistence/validation.rb

@@ -0,0 +1,18 @@
+require 'validatable'
+
+module CouchTomato
+  module Persistence
+    module Validation
+      def self.included(base)
+        base.send :include, Validatable
+        base.class_eval do
+          # Override the validate method to first run before_validation callback
+          def valid?
+            self.run_callbacks :before_validation
+            super
+          end
+        end
+      end
+    end
+  end
+end