mongoid-locomotive 2.0.0.beta9

data/lib/mongoid/scope.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  class Scope #:nodoc:
+
+    delegate :scopes, :to => :parent
+
+    attr_reader :parent, :conditions
+
+    # If the other is a scope then compare the parent and conditions, otherwise
+    # if its enumerable collect and compare.
+    def ==(other)
+      case other
+      when Scope
+        @parent == other.parent && @conditions == other.conditions
+      when Enumerable
+        @collection ||= entries
+        return (@collection == other)
+      else
+        return false
+      end
+    end
+
+    # Create the new +Scope+. If a block is passed in, this Scope will extend
+    # the block.
+    #
+    # Options:
+    #
+    # parent: The class the scope belongs to, or a parent +Scope+.
+    # conditions: A +Hash+ of conditions.
+    #
+    # Example:
+    #
+    #   Mongoid::Scope.new(Person, { :title => "Sir" }) do
+    #     def knighted?
+    #       title == "Sir"
+    #     end
+    #   end
+    def initialize(parent, conditions, &block)
+      @parent, @conditions = parent, conditions
+      extend Module.new(&block) if block_given?
+    end
+
+    # Return the class for the +Scope+. This will be the parent if the parent
+    # is a class, otherwise will be nil.
+    def klass
+      @klass ||= @parent unless @parent.is_a?(Scope)
+    end
+
+    # Chaining is supported through method_missing. If a scope is already
+    # defined with the method name the call will be passed there, otherwise it
+    # will be passed to the target or parent.
+    def method_missing(name, *args, &block)
+      if scopes.include?(name)
+        scopes[name].call(self, *args)
+      elsif klass
+        target.send(name, *args, &block)
+      else
+        @parent.fuse(@conditions); @parent.send(name, *args, &block)
+      end
+    end
+
+    # The +Scope+ must respond like a +Criteria+ object. If this is a parent
+    # criteria delegate to the target, otherwise bubble up to the parent.
+    def respond_to?(name)
+      super || (klass ? target.respond_to?(name) : @parent.respond_to?(name))
+    end
+
+    # Returns the target criteria if it has already been set or creates a new
+    # criteria from the parent class.
+    def target
+      @target ||= klass.criteria.fuse(@conditions)
+    end
+  end
+end
+

data/lib/mongoid/state.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module State #:nodoc:
+    # Returns true if the +Document+ has not been persisted to the database,
+    # false if it has. This is determined by the variable @new_record
+    # and NOT if the object has an id.
+    def new_record?
+      @new_record == true
+    end
+
+    # Sets the new_record boolean - used after document is saved.
+    def new_record=(saved)
+      @new_record = saved
+    end
+
+    # Checks if the document has been saved to the database.
+    def persisted?
+      !new_record?
+    end
+
+    # Returns true if the +Document+ has been succesfully destroyed, and false if it hasn't.
+    # This is determined by the variable @destroyed and NOT by checking the database.
+    def destroyed?
+      @destroyed == true
+    end
+
+    # Sets the destroyed boolean - used after document is destroyed.
+    def destroyed=(destroyed)
+      @destroyed = destroyed && true
+    end
+  end
+end

data/lib/mongoid/timestamps.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Timestamps
+    extend ActiveSupport::Concern
+    included do
+      field :created_at, :type => Time
+      field :updated_at, :type => Time
+      set_callback :create, :before, :set_created_at
+      set_callback :save, :before, :set_updated_at
+
+      class_inheritable_accessor :record_timestamps, :instance_writer => false
+      self.record_timestamps = true
+    end
+
+    # Update the created_at field on the Document to the current time. This is
+    # only called on create.
+    def set_created_at
+      self.created_at = Time.now.utc if !created_at
+    end
+
+    # Update the updated_at field on the Document to the current time.
+    # This is only called on create and on save.
+    def set_updated_at
+      self.updated_at = Time.now.utc
+    end
+  end
+end

data/lib/mongoid/validations.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require "mongoid/validations/associated"
+require "mongoid/validations/uniqueness"
+
+I18n.load_path << File.join(
+  File.dirname(__FILE__), "validations", "locale", "en.yml"
+)
+
+module Mongoid #:nodoc:
+  # This module provides additional validations that ActiveModel does not
+  # provide: validates_associated and validates_uniqueness_of
+  module Validations
+    extend ActiveSupport::Concern
+    included do
+      include ActiveModel::Validations
+    end
+
+    module ClassMethods #:nodoc:
+      # Validates whether or not an association is valid or not. Will correctly
+      # handle has one and has many associations.
+      #
+      # Example:
+      #
+      #   class Person
+      #     include Mongoid::Document
+      #     embeds_one :name
+      #     embeds_many :addresses
+      #
+      #     validates_associated :name, :addresses
+      #   end
+      def validates_associated(*args)
+        validates_with(AssociatedValidator, _merge_attributes(args))
+      end
+
+      # Validates whether or not a field is unique against the documents in the
+      # database.
+      #
+      # Example:
+      #
+      #   class Person
+      #     include Mongoid::Document
+      #     field :title
+      #
+      #     validates_uniqueness_of :title
+      #   end
+      def validates_uniqueness_of(*args)
+        validates_with(UniquenessValidator, _merge_attributes(args))
+      end
+    end
+  end
+end

data/lib/mongoid/validations/associated.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Validations #:nodoc:
+    # Validates whether or not an association is valid or not. Will correctly
+    # handle has one and has many associations.
+    #
+    # Example:
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     embeds_one :name
+    #     embeds_many :addresses
+    #
+    #     validates_associated :name, :addresses
+    #   end
+    class AssociatedValidator < ActiveModel::EachValidator
+
+      # Validates that the associations provided are either all nil or all
+      # valid. If neither is true then the appropriate errors will be added to
+      # the parent document.
+      #
+      # Example:
+      #
+      # <tt>validator.validate_each(document, :name, name)</tt>
+      def validate_each(document, attribute, value)
+        values = value.is_a?(Array) ? value : [ value ]
+        return if values.collect { |doc| doc.nil? || doc.valid? }.all?
+        document.errors.add(attribute, :invalid, options.merge!(:value => value))
+      end
+    end
+  end
+end

data/lib/mongoid/validations/locale/en.yml

@@ -0,0 +1,5 @@
+en:
+  activemodel:
+    errors:
+      messages:
+        taken: "is already taken"

data/lib/mongoid/validations/uniqueness.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Validations #:nodoc:
+    # Validates whether or not a field is unique against the documents in the
+    # database.
+    #
+    # Example:
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     field :title
+    #
+    #     validates_uniqueness_of :title
+    #   end
+    class UniquenessValidator < ActiveModel::EachValidator
+      # Unfortunately, we have to tie Uniqueness validators to a class.
+      def setup(klass)
+        @klass = klass
+      end
+
+      def validate_each(document, attribute, value)
+        if document.embedded?
+          return if document._parent.nil?
+
+          criteria = document._parent.send(document.association_name)
+
+          # If the parent document embeds_one, no need to validate uniqueness
+          return if criteria.is_a?(Mongoid::Document)
+
+          criteria = criteria.where(attribute => value, :_id => {'$ne' => document._id})
+        else
+          criteria = @klass.where(attribute => value)
+
+          unless document.new_record?
+            criteria = criteria.where(:_id => {'$ne' => document._id})
+          end
+        end
+
+        Array.wrap(options[:scope]).each do |item|
+          criteria = criteria.where(item => document.attributes[item])
+        end
+
+        if criteria.exists?
+          document.errors.add(attribute, :taken, :default => options[:message], :value => value)
+        end
+      end
+
+      protected
+      def key_changed?(document)
+        (document.primary_key || {}).each do |key|
+          return true if document.send("#{key}_changed?")
+        end; false
+      end
+    end
+  end
+end

data/lib/mongoid/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  VERSION = "2.0.0.beta9"
+end

data/lib/mongoid/versioning.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  # Include this module to get automatic versioning of root level documents.
+  # This will add a version field to the +Document+ and a has_many association
+  # with all the versions contained in it.
+  module Versioning
+    extend ActiveSupport::Concern
+    included do
+      field :version, :type => Integer, :default => 1
+      embeds_many :versions, :class_name => self.name
+      set_callback :save, :before, :revise
+    end
+
+    # Create a new version of the +Document+. This will load the previous
+    # document from the database and set it as the next version before saving
+    # the current document. It then increments the version number.
+    def revise
+      last_version = self.class.first(:conditions => { :_id => id, :version => version })
+      if last_version
+        self.versions << last_version.clone
+        self.version = version + 1
+        @modifications["versions"] = [ nil, @attributes["versions"] ] if @modifications
+      end
+    end
+  end
+end

data/lib/rails/generators/mongoid/config/config_generator.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'rails/generators/mongoid_generator'
+
+module Mongoid
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc "Creates a Mongoid configuration file at config/mongoid.yml"
+
+      argument :database_name, :type => :string, :optional => true
+
+      def self.source_root
+        @_mongoid_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def app_name
+        Rails::Application.subclasses.first.parent.to_s.underscore
+      end
+
+      def create_config_file
+        template 'mongoid.yml', File.join('config', "mongoid.yml")
+      end
+
+    end
+  end
+end

data/lib/rails/generators/mongoid/config/templates/mongoid.yml

@@ -0,0 +1,24 @@
+defaults: &defaults
+  host: localhost
+  # slaves:
+  #   - host: slave1.local
+  #     port: 27018
+  #   - host: slave2.local
+  #     port: 27019
+
+development:
+  <<: *defaults
+  database: <%= database_name || app_name %>_development
+
+test:
+  <<: *defaults
+  database: <%= database_name || app_name %>_test
+
+# set these environment variables on your prod server
+production:
+  <<: *defaults
+  host: <%%= ENV['MONGOID_HOST'] %>
+  port: <%%= ENV['MONGOID_PORT'] %>
+  username: <%%= ENV['MONGOID_USERNAME'] %>
+  password: <%%= ENV['MONGOID_PASSWORD'] %>
+  database: <%%= ENV['MONGOID_DATABASE'] %>

data/lib/rails/generators/mongoid/model/model_generator.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require "rails/generators/mongoid_generator"
+
+module Mongoid #:nodoc:
+  module Generators #:nodoc:
+    class ModelGenerator < Base #:nodoc:
+
+      desc "Creates a Mongoid model"
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      check_class_collision
+
+      class_option :timestamps, :type => :boolean
+      class_option :parent,     :type => :string, :desc => "The parent class for the generated model"
+      class_option :versioning, :type => :boolean, :default => false, :desc => "Enable mongoid versioning"
+
+      def create_model_file
+        template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/rails/generators/mongoid/model/templates/model.rb

@@ -0,0 +1,15 @@
+class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent] %>
+<% unless options[:parent] -%>
+  include Mongoid::Document
+<% end -%>
+<% if options[:timestamps] -%>
+  include Mongoid::Timestamps
+<% end -%>
+<%= 'include Mongoid::Versioning' if options[:versioning] -%>
+<% attributes.reject{|attr| attr.reference?}.each do |attribute| -%>
+  field :<%= attribute.name %>, :type => <%= attribute.type_class %>
+<% end -%>
+<% attributes.select{|attr| attr.reference? }.each do |attribute| -%>
+  embedded_in :<%= attribute.name%>, :inverse_of => :<%= class_name.tableize %>
+<% end -%>
+end

data/lib/rails/generators/mongoid_generator.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+require "rails/generators/named_base"
+require "rails/generators/active_model"
+
+module Mongoid #:nodoc:
+  module Generators #:nodoc:
+    class Base < ::Rails::Generators::NamedBase #:nodoc:
+
+      def self.source_root
+        @_mongoid_source_root ||=
+        File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
+      end
+    end
+
+    class ActiveModel < ::Rails::Generators::ActiveModel #:nodoc:
+      def self.all(klass)
+        "#{klass}.all"
+      end
+
+      def self.find(klass, params=nil)
+        "#{klass}.find(#{params})"
+      end
+
+      def self.build(klass, params=nil)
+        if params
+          "#{klass}.new(#{params})"
+        else
+          "#{klass}.new"
+        end
+      end
+
+      def save
+        "#{name}.save"
+      end
+
+      def update_attributes(params=nil)
+        "#{name}.update_attributes(#{params})"
+      end
+
+      def errors
+        "#{name}.errors"
+      end
+
+      def destroy
+        "#{name}.destroy"
+      end
+    end
+  end
+end
+
+module Rails
+  module Generators
+    class GeneratedAttribute #:nodoc:
+      def type_class
+        return "Time" if type.to_s == "datetime"
+        return "String" if type.to_s == "text"
+        return type.to_s.camelcase
+      end
+    end
+  end
+end