ssherman-mongo_mapper 0.8.6

data/examples/scopes.rb

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+require 'pp'
+
+MongoMapper.database = 'testing'
+
+class User
+  include MongoMapper::Document
+
+  # plain old vanilla scopes with fancy queries
+  scope :johns,   where(:name => 'John')
+
+  # plain old vanilla scopes with hashes
+  scope :bills, :name => 'Bill'
+
+  # dynamic scopes with parameters
+  scope :by_name,  lambda { |name| where(:name => name) }
+  scope :by_ages,  lambda { |low, high| where(:age.gte => low, :age.lte => high) }
+
+  # Yep, even plain old methods work as long as they return a query
+  def self.by_tag(tag)
+    where(:tags => tag)
+  end
+
+  # You can even make a method that returns a scope
+  def self.twenties; by_ages(20, 29) end
+
+  key :name, String
+  key :tags, Array
+end
+User.collection.remove # empties collection
+
+User.create(:name => 'John',  :tags => %w[ruby mongo], :age => 28)
+User.create(:name => 'Bill',  :tags => %w[ruby mongo], :age => 30)
+User.create(:name => 'Frank', :tags => %w[mongo],      :age => 35)
+User.create(:name => 'Steve', :tags => %w[html5 css3], :age => 27)
+
+# simple scopes
+pp User.johns.first
+pp User.bills.first
+
+# scope with arg
+pp User.by_name('Frank').first
+
+# scope with two args
+pp User.by_ages(20, 29).all
+
+# chaining class methods on scopes
+pp User.by_ages(20, 40).by_tag('ruby').all
+
+# scope made using method that returns scope
+pp User.twenties.all

data/examples/validating/embedded_docs.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+require 'pp'
+
+MongoMapper.database = 'testing'
+
+class Field
+  include MongoMapper::EmbeddedDocument
+  key :name
+  validates_presence_of :name
+end
+
+class Template
+  include MongoMapper::Document
+  key :name
+  many :fields
+
+  # This tells the template to validate all
+  # fields when validating the template.
+  validates_associated :fields
+end
+
+# Name is missing on embedded field
+template = Template.new(:fields => [Field.new])
+puts template.valid? # false
+
+# Name is present on embedded field
+template = Template.new(:fields => [Field.new(:name => 'Yay')])
+puts template.valid? # true

data/lib/mongo_mapper.rb

@@ -0,0 +1,79 @@
+# encoding: UTF-8
+# Make sure you have the correct versions of the gems (see gemspec) in your load path.
+require 'plucky'
+require 'validatable'
+require 'active_support/all'
+
+module MongoMapper
+  autoload :Connection,             'mongo_mapper/connection'
+
+  autoload :Error,                  'mongo_mapper/exceptions'
+  autoload :DocumentNotFound,       'mongo_mapper/exceptions'
+  autoload :InvalidScheme,          'mongo_mapper/exceptions'
+  autoload :DocumentNotValid,       'mongo_mapper/exceptions'
+  autoload :AccessibleOrProtected,  'mongo_mapper/exceptions'
+
+  autoload :Document,               'mongo_mapper/document'
+  autoload :EmbeddedDocument,       'mongo_mapper/embedded_document'
+  autoload :Plugins,                'mongo_mapper/plugins'
+  autoload :Version,                'mongo_mapper/version'
+
+  module Plugins
+    autoload :Associations,     'mongo_mapper/plugins/associations'
+    autoload :Accessible,       'mongo_mapper/plugins/accessible'
+    autoload :Callbacks,        'mongo_mapper/plugins/callbacks'
+    autoload :Caching,          'mongo_mapper/plugins/caching'
+    autoload :Clone,            'mongo_mapper/plugins/clone'
+    autoload :Descendants,      'mongo_mapper/plugins/descendants'
+    autoload :Dirty,            'mongo_mapper/plugins/dirty'
+    autoload :Document,         'mongo_mapper/plugins/document'
+    autoload :DynamicQuerying,  'mongo_mapper/plugins/dynamic_querying'
+    autoload :EmbeddedDocument, 'mongo_mapper/plugins/embedded_document'
+    autoload :Equality,         'mongo_mapper/plugins/equality'
+    autoload :IdentityMap,      'mongo_mapper/plugins/identity_map'
+    autoload :Inspect,          'mongo_mapper/plugins/inspect'
+    autoload :Indexes,          'mongo_mapper/plugins/indexes'
+    autoload :Keys,             'mongo_mapper/plugins/keys'
+    autoload :Logger,           'mongo_mapper/plugins/logger'
+    autoload :Modifiers,        'mongo_mapper/plugins/modifiers'
+    autoload :Pagination,       'mongo_mapper/plugins/pagination'
+    autoload :Persistence,      'mongo_mapper/plugins/persistence'
+    autoload :Protected,        'mongo_mapper/plugins/protected'
+    autoload :Querying,         'mongo_mapper/plugins/querying'
+    autoload :Rails,            'mongo_mapper/plugins/rails'
+    autoload :Safe,             'mongo_mapper/plugins/safe'
+    autoload :Sci,              'mongo_mapper/plugins/sci'
+    autoload :Scopes,           'mongo_mapper/plugins/scopes'
+    autoload :Serialization,    'mongo_mapper/plugins/serialization'
+    autoload :Timestamps,       'mongo_mapper/plugins/timestamps'
+    autoload :Userstamps,       'mongo_mapper/plugins/userstamps'
+    autoload :Validations,      'mongo_mapper/plugins/validations'
+
+    module Associations
+      autoload :Base,                         'mongo_mapper/plugins/associations/base'
+      autoload :Collection,                   'mongo_mapper/plugins/associations/collection'
+      autoload :EmbeddedCollection,           'mongo_mapper/plugins/associations/embedded_collection'
+      autoload :ManyDocumentsProxy,           'mongo_mapper/plugins/associations/many_documents_proxy'
+      autoload :BelongsToProxy,               'mongo_mapper/plugins/associations/belongs_to_proxy'
+      autoload :BelongsToPolymorphicProxy,    'mongo_mapper/plugins/associations/belongs_to_polymorphic_proxy'
+      autoload :ManyPolymorphicProxy,         'mongo_mapper/plugins/associations/many_polymorphic_proxy'
+      autoload :ManyEmbeddedProxy,            'mongo_mapper/plugins/associations/many_embedded_proxy'
+      autoload :ManyEmbeddedPolymorphicProxy, 'mongo_mapper/plugins/associations/many_embedded_polymorphic_proxy'
+      autoload :ManyDocumentsAsProxy,         'mongo_mapper/plugins/associations/many_documents_as_proxy'
+      autoload :OneProxy,                     'mongo_mapper/plugins/associations/one_proxy'
+      autoload :OneEmbeddedProxy,             'mongo_mapper/plugins/associations/one_embedded_proxy'
+      autoload :InArrayProxy,                 'mongo_mapper/plugins/associations/in_array_proxy'
+    end
+  end
+
+  extend Connection
+end
+
+Dir[File.join(File.dirname(__FILE__), 'mongo_mapper', 'extensions', '*.rb')].each do |extension|
+  require extension
+end
+
+require 'mongo_mapper/support/descendant_appends'
+
+# FIXME: autoload with proxy is failing, need to investigate
+require 'mongo_mapper/plugins/associations/proxy'

data/lib/mongo_mapper/connection.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+require 'uri'
+
+module MongoMapper
+  module Connection
+    # @api public
+    def connection
+      @@connection ||= Mongo::Connection.new
+    end
+
+    # @api public
+    def connection=(new_connection)
+      @@connection = new_connection
+    end
+
+    # @api public
+    def logger
+      connection.logger
+    end
+
+    # @api public
+    def database=(name)
+      @@database = nil
+      @@database_name = name
+    end
+
+    # @api public
+    def database
+      if @@database_name.blank?
+        raise 'You forgot to set the default database name: MongoMapper.database = "foobar"'
+      end
+
+      @@database ||= MongoMapper.connection.db(@@database_name)
+    end
+
+    def config=(hash)
+      @@config = hash
+    end
+
+    def config
+      raise 'Set config before connecting. MongoMapper.config = {...}' unless defined?(@@config)
+      @@config
+    end
+
+    # @api private
+    def config_for_environment(environment)
+      env = config[environment]
+      return env if env['uri'].blank?
+
+      uri = URI.parse(env['uri'])
+      raise InvalidScheme.new('must be mongodb') unless uri.scheme == 'mongodb'
+      {
+        'host'     => uri.host,
+        'port'     => uri.port,
+        'database' => uri.path.gsub(/^\//, ''),
+        'username' => uri.user,
+        'password' => uri.password,
+      }
+    end
+
+    def connect(environment, options={})
+      raise 'Set config before connecting. MongoMapper.config = {...}' if config.blank?
+      env = config_for_environment(environment)
+      MongoMapper.connection = Mongo::Connection.new(env['host'], env['port'], options)
+      MongoMapper.database = env['database']
+      MongoMapper.database.authenticate(env['username'], env['password']) if env['username'] && env['password']
+    end
+
+    def setup(config, environment, options={})
+      handle_passenger_forking
+      self.config = config
+      connect(environment, options)
+    end
+
+    def handle_passenger_forking
+      if defined?(PhusionPassenger)
+        PhusionPassenger.on_event(:starting_worker_process) do |forked|
+          connection.connect if forked
+        end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/document.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+module MongoMapper
+  module Document
+    extend Support::DescendantAppends
+
+    def self.included(model)
+      model.class_eval do
+        extend  Plugins
+
+        plugin Plugins::Document
+        plugin Plugins::Querying # for now needs to be before associations (save_to_collection)
+        plugin Plugins::Associations
+        plugin Plugins::Caching
+        plugin Plugins::Clone
+        plugin Plugins::Descendants
+        plugin Plugins::DynamicQuerying
+        plugin Plugins::Equality
+        plugin Plugins::Inspect
+        plugin Plugins::Indexes
+        plugin Plugins::Keys
+        plugin Plugins::Dirty # for now dirty needs to be after keys
+        plugin Plugins::Logger
+        plugin Plugins::Modifiers
+        plugin Plugins::Pagination
+        plugin Plugins::Persistence
+        plugin Plugins::Accessible
+        plugin Plugins::Protected
+        plugin Plugins::Rails
+        plugin Plugins::Safe # needs to be after querying (save_to_collection)
+        plugin Plugins::Sci
+        plugin Plugins::Scopes
+        plugin Plugins::Serialization
+        plugin Plugins::Timestamps
+        plugin Plugins::Userstamps
+        plugin Plugins::Validations
+        plugin Plugins::Callbacks # for now callbacks needs to be after validations
+      end
+      super
+    end
+  end # Document
+end # MongoMapper

data/lib/mongo_mapper/embedded_document.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+module MongoMapper
+  module EmbeddedDocument
+    extend Support::DescendantAppends
+
+    def self.included(model)
+      model.class_eval do
+        extend  Plugins
+
+        plugin Plugins::EmbeddedDocument
+        plugin Plugins::Associations
+        plugin Plugins::Caching
+        plugin Plugins::Clone
+        plugin Plugins::Descendants
+        plugin Plugins::Equality
+        plugin Plugins::Inspect
+        plugin Plugins::Keys
+        plugin Plugins::Logger
+        plugin Plugins::Persistence
+        plugin Plugins::Accessible
+        plugin Plugins::Protected
+        plugin Plugins::Rails
+        plugin Plugins::Sci
+        plugin Plugins::Serialization
+        plugin Plugins::Validations
+        plugin Plugins::Callbacks
+      end
+      super
+    end
+  end
+end

data/lib/mongo_mapper/exceptions.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+module MongoMapper
+  # generic MM error
+  class Error < StandardError; end
+
+  # raised when document expected but not found
+  class DocumentNotFound < Error; end
+
+  # raised when trying to connect using uri with incorrect scheme
+  class InvalidScheme < Error; end
+
+  # raised when trying to do something not supported, mostly for edocs
+  class NotSupported < Error; end
+
+  # raised when document not valid and using !
+  class DocumentNotValid < Error
+    def initialize(document)
+      super("Validation failed: #{document.errors.full_messages.join(", ")}")
+    end
+  end
+
+  class AccessibleOrProtected < Error
+    def initialize(name)
+      super("Declare either attr_protected or attr_accessible for #{name}, but not both.")
+    end
+  end
+end

data/lib/mongo_mapper/extensions/array.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+module MongoMapper
+  module Extensions
+    module Array
+      def to_mongo(value)
+        value = value.respond_to?(:lines) ? value.lines : value
+        value.to_a
+      end
+
+      def from_mongo(value)
+        value || []
+      end
+    end
+  end
+end
+
+class Array
+  extend MongoMapper::Extensions::Array
+end

data/lib/mongo_mapper/extensions/binary.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+module MongoMapper
+  module Extensions
+    module Binary
+      def to_mongo(value)
+        if value.is_a?(::BSON::Binary)
+          value
+        else
+          value.nil? ? nil : ::BSON::Binary.new(value)
+        end
+      end
+
+      def from_mongo(value)
+        value
+      end
+    end
+  end
+end
+
+class Binary
+  extend MongoMapper::Extensions::Binary
+end

data/lib/mongo_mapper/extensions/boolean.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+module MongoMapper
+  module Extensions
+    module Boolean
+      Mapping = {
+        true    => true, 
+        'true'  => true, 
+        'TRUE'  => true, 
+        'True'  => true, 
+        't'     => true, 
+        'T'     => true, 
+        '1'     => true, 
+        1       => true, 
+        1.0     => true,
+        false   => false, 
+        'false' => false, 
+        'FALSE' => false, 
+        'False' => false, 
+        'f'     => false, 
+        'F'     => false, 
+        '0'     => false, 
+        0       => false, 
+        0.0     => false, 
+        nil     => nil
+      }
+
+      def to_mongo(value)
+        if value.is_a?(Boolean)
+          value
+        else
+          Mapping[value]
+        end
+      end
+
+      def from_mongo(value)
+        value.nil? ? nil : !!value
+      end
+    end
+  end
+end
+
+class Boolean
+  extend MongoMapper::Extensions::Boolean
+end

data/lib/mongo_mapper/extensions/date.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+module MongoMapper
+  module Extensions
+    module Date
+      def to_mongo(value)
+        if value.nil? || value == ''
+          nil
+        else
+          date = value.is_a?(::Date) || value.is_a?(::Time) ? value : ::Date.parse(value.to_s)
+          ::Time.utc(date.year, date.month, date.day)
+        end
+      rescue
+        nil
+      end
+
+      def from_mongo(value)
+        value.to_date if value.present?
+      end
+    end
+  end
+end
+
+class Date
+  extend MongoMapper::Extensions::Date
+end