mongo_mapper 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) hide show
  1. data/.gitignore +7 -0
  2. data/LICENSE +20 -0
  3. data/README.rdoc +39 -0
  4. data/Rakefile +87 -0
  5. data/VERSION +1 -0
  6. data/bin/mmconsole +55 -0
  7. data/lib/mongo_mapper.rb +92 -0
  8. data/lib/mongo_mapper/associations.rb +86 -0
  9. data/lib/mongo_mapper/associations/base.rb +83 -0
  10. data/lib/mongo_mapper/associations/belongs_to_polymorphic_proxy.rb +34 -0
  11. data/lib/mongo_mapper/associations/belongs_to_proxy.rb +22 -0
  12. data/lib/mongo_mapper/associations/many_documents_as_proxy.rb +27 -0
  13. data/lib/mongo_mapper/associations/many_documents_proxy.rb +116 -0
  14. data/lib/mongo_mapper/associations/many_embedded_polymorphic_proxy.rb +33 -0
  15. data/lib/mongo_mapper/associations/many_embedded_proxy.rb +67 -0
  16. data/lib/mongo_mapper/associations/many_polymorphic_proxy.rb +11 -0
  17. data/lib/mongo_mapper/associations/many_proxy.rb +6 -0
  18. data/lib/mongo_mapper/associations/proxy.rb +64 -0
  19. data/lib/mongo_mapper/callbacks.rb +106 -0
  20. data/lib/mongo_mapper/document.rb +317 -0
  21. data/lib/mongo_mapper/dynamic_finder.rb +35 -0
  22. data/lib/mongo_mapper/embedded_document.rb +354 -0
  23. data/lib/mongo_mapper/finder_options.rb +94 -0
  24. data/lib/mongo_mapper/key.rb +32 -0
  25. data/lib/mongo_mapper/observing.rb +50 -0
  26. data/lib/mongo_mapper/pagination.rb +51 -0
  27. data/lib/mongo_mapper/rails_compatibility/document.rb +15 -0
  28. data/lib/mongo_mapper/rails_compatibility/embedded_document.rb +27 -0
  29. data/lib/mongo_mapper/save_with_validation.rb +19 -0
  30. data/lib/mongo_mapper/serialization.rb +55 -0
  31. data/lib/mongo_mapper/serializers/json_serializer.rb +92 -0
  32. data/lib/mongo_mapper/support.rb +157 -0
  33. data/lib/mongo_mapper/validations.rb +69 -0
  34. data/mongo_mapper.gemspec +156 -0
  35. data/test/NOTE_ON_TESTING +1 -0
  36. data/test/custom_matchers.rb +48 -0
  37. data/test/functional/associations/test_belongs_to_polymorphic_proxy.rb +54 -0
  38. data/test/functional/associations/test_belongs_to_proxy.rb +46 -0
  39. data/test/functional/associations/test_many_documents_as_proxy.rb +244 -0
  40. data/test/functional/associations/test_many_embedded_polymorphic_proxy.rb +132 -0
  41. data/test/functional/associations/test_many_embedded_proxy.rb +174 -0
  42. data/test/functional/associations/test_many_polymorphic_proxy.rb +297 -0
  43. data/test/functional/associations/test_many_proxy.rb +331 -0
  44. data/test/functional/test_associations.rb +48 -0
  45. data/test/functional/test_binary.rb +18 -0
  46. data/test/functional/test_callbacks.rb +85 -0
  47. data/test/functional/test_document.rb +951 -0
  48. data/test/functional/test_embedded_document.rb +97 -0
  49. data/test/functional/test_pagination.rb +87 -0
  50. data/test/functional/test_rails_compatibility.rb +30 -0
  51. data/test/functional/test_validations.rb +279 -0
  52. data/test/models.rb +169 -0
  53. data/test/test_helper.rb +29 -0
  54. data/test/unit/serializers/test_json_serializer.rb +189 -0
  55. data/test/unit/test_association_base.rb +144 -0
  56. data/test/unit/test_document.rb +165 -0
  57. data/test/unit/test_dynamic_finder.rb +125 -0
  58. data/test/unit/test_embedded_document.rb +645 -0
  59. data/test/unit/test_finder_options.rb +193 -0
  60. data/test/unit/test_key.rb +163 -0
  61. data/test/unit/test_mongomapper.rb +28 -0
  62. data/test/unit/test_observing.rb +101 -0
  63. data/test/unit/test_pagination.rb +109 -0
  64. data/test/unit/test_rails_compatibility.rb +39 -0
  65. data/test/unit/test_serializations.rb +52 -0
  66. data/test/unit/test_support.rb +272 -0
  67. data/test/unit/test_time_zones.rb +40 -0
  68. data/test/unit/test_validations.rb +503 -0
  69. metadata +204 -0
@@ -0,0 +1,7 @@
1
+ *.sw?
2
+ .DS_Store
3
+ coverage
4
+ rdoc
5
+ pkg
6
+ *~
7
+ *.gem
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 John Nunemaker
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,39 @@
1
+ = MongoMapper
2
+
3
+ Awesome gem for modeling your domain and storing it in mongo.
4
+
5
+ Releases are tagged on github and also released as gems on github and rubyforge. Master is pushed to whenever I add a patch or a new feature. To build from master, you can clone the code, generate the updated gemspec, build the gem and install.
6
+
7
+ * rake gemspec
8
+ * gem build mongo_mapper.gemspec
9
+ * gem install the gem that was built
10
+
11
+ == Note on Patches/Pull Requests
12
+
13
+ * Fork the project.
14
+ * Make your feature addition or bug fix.
15
+ * Add tests for it. This is important so I don't break it in a future version unintentionally.
16
+ * 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 in another branch so I can ignore when I pull)
17
+ * Send me a pull request. Bonus points for topic branches.
18
+
19
+ == Dependencies
20
+
21
+ * ActiveSupport (activesupport)
22
+ * Mongo Ruby Driver (mongodb-mongo)
23
+ * My fork of the validatable gem (jnunemaker-validatable)
24
+
25
+ == Documentation
26
+
27
+ http://rdoc.info/projects/jnunemaker/mongomapper
28
+
29
+ == More Info
30
+
31
+ You can learn more about mongo here:
32
+ http://www.mongodb.org/
33
+
34
+ You can learn more about the mongo ruby driver here:
35
+ http://github.com/mongodb/mongo-ruby-driver/tree/master
36
+
37
+ == Copyright
38
+
39
+ Copyright (c) 2009 John Nunemaker. See LICENSE for details.
@@ -0,0 +1,87 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "mongo_mapper"
8
+ gem.summary = %Q{Awesome gem for modeling your domain and storing it in mongo}
9
+ gem.email = "nunemaker@gmail.com"
10
+ gem.homepage = "http://github.com/jnunemaker/mongomapper"
11
+ gem.authors = ["John Nunemaker"]
12
+ gem.rubyforge_project = "mongomapper"
13
+
14
+ gem.add_dependency('activesupport')
15
+ gem.add_dependency('mongo', '0.15')
16
+ gem.add_dependency('jnunemaker-validatable', '1.7.3')
17
+
18
+ gem.add_development_dependency('mocha', '0.9.4')
19
+ gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
20
+ end
21
+
22
+ Jeweler::RubyforgeTasks.new do |rubyforge|
23
+ rubyforge.doc_task = "rdoc"
24
+ end
25
+ rescue LoadError
26
+ puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
27
+ end
28
+
29
+ require 'rake/testtask'
30
+ Rake::TestTask.new(:test) do |test|
31
+ test.libs << 'lib' << 'test'
32
+ test.pattern = 'test/**/test_*.rb'
33
+ test.verbose = true
34
+ end
35
+
36
+ namespace :test do
37
+ Rake::TestTask.new(:units) do |test|
38
+ test.libs << 'lib' << 'test'
39
+ test.pattern = 'test/unit/**/test_*.rb'
40
+ test.verbose = true
41
+ end
42
+
43
+ Rake::TestTask.new(:functionals) do |test|
44
+ test.libs << 'lib' << 'test'
45
+ test.pattern = 'test/functional/**/test_*.rb'
46
+ test.verbose = true
47
+ end
48
+ end
49
+
50
+ begin
51
+ require 'rcov/rcovtask'
52
+ Rcov::RcovTask.new do |test|
53
+ test.libs << 'test'
54
+ test.pattern = 'test/**/test_*.rb'
55
+ test.verbose = true
56
+ end
57
+ rescue LoadError
58
+ task :rcov do
59
+ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
60
+ end
61
+ end
62
+
63
+ begin
64
+ require 'cucumber/rake/task'
65
+ Cucumber::Rake::Task.new(:features)
66
+ rescue LoadError
67
+ task :features do
68
+ abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
69
+ end
70
+ end
71
+
72
+ task :default => :test
73
+
74
+ require 'rake/rdoctask'
75
+ Rake::RDocTask.new do |rdoc|
76
+ if File.exist?('VERSION.yml')
77
+ config = YAML.load(File.read('VERSION.yml'))
78
+ version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
79
+ else
80
+ version = ""
81
+ end
82
+
83
+ rdoc.rdoc_dir = 'rdoc'
84
+ rdoc.title = "MongoMapper #{version}"
85
+ rdoc.rdoc_files.include('README*')
86
+ rdoc.rdoc_files.include('lib/**/*.rb')
87
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.5.0
@@ -0,0 +1,55 @@
1
+ #!/usr/bin/env ruby
2
+ $:.unshift File.dirname(__FILE__)+"/../lib"
3
+
4
+ require 'mongo_mapper'
5
+ require 'irb'
6
+
7
+ IRB.setup(nil)
8
+ irb = IRB::Irb.new
9
+
10
+ IRB.conf[:MAIN_CONTEXT] = irb.context
11
+
12
+ irb.context.evaluate("require 'irb/completion'", 0)
13
+ irb.context.evaluate(%@
14
+ include MongoMapper
15
+
16
+ MongoMapper.database = "mmtest"
17
+ $db = MongoMapper.database
18
+
19
+ @, 0)
20
+
21
+ puts %@
22
+ Welcome to the MongoMapper Console!
23
+
24
+ Example 1:
25
+ things = $db.collection("things")
26
+ things.insert("name" => "Raw Thing")
27
+ things.insert("name" => "Another Thing", "date" => Time.now)
28
+
29
+ cursor = things.find("name" => "Raw Thing")
30
+ puts cursor.next_object.inspect
31
+
32
+ Example 2:
33
+ class Thing
34
+ include MongoMapper::Document
35
+ key :name, String, :required => true
36
+ key :date, Time
37
+ end
38
+
39
+ thing = Thing.new
40
+ thing.name = "My thing"
41
+ thing.date = Time.now
42
+ thing.save
43
+
44
+ all_things = Thing.all
45
+ puts all_things.map { |object| object.name }.inspect
46
+
47
+ @
48
+
49
+ trap("SIGINT") do
50
+ irb.signal_handle
51
+ end
52
+ catch(:IRB_EXIT) do
53
+ irb.eval_input
54
+ end
55
+
@@ -0,0 +1,92 @@
1
+ require 'rubygems'
2
+
3
+ gem 'activesupport'
4
+ gem 'mongo', '0.15'
5
+ gem 'jnunemaker-validatable', '1.7.3'
6
+
7
+ require 'activesupport'
8
+ require 'mongo'
9
+ require 'validatable'
10
+
11
+ module MongoMapper
12
+ DocumentNotFound = Class.new(StandardError)
13
+
14
+ DocumentNotValid = Class.new(StandardError) do
15
+ def initialize(document)
16
+ @document = document
17
+ super("Validation failed: #{@document.errors.full_messages.join(", ")}")
18
+ end
19
+ end
20
+
21
+ def self.connection
22
+ @@connection ||= Mongo::Connection.new
23
+ end
24
+
25
+ def self.connection=(new_connection)
26
+ @@connection = new_connection
27
+ end
28
+
29
+ def self.database=(name)
30
+ @@database = nil
31
+ @@database_name = name
32
+ end
33
+
34
+ def self.database
35
+ if @@database_name.blank?
36
+ raise 'You forgot to set the default database name: MongoMapper.database = "foobar"'
37
+ end
38
+
39
+ @@database ||= MongoMapper.connection.db(@@database_name)
40
+ end
41
+
42
+ module Finders
43
+ def dynamic_find(finder, args)
44
+ attributes = {}
45
+ find_options = args.extract_options!.deep_merge(:conditions => attributes)
46
+
47
+ finder.attributes.each_with_index do |attr, index|
48
+ attributes[attr] = args[index]
49
+ end
50
+
51
+ result = find(finder.finder, find_options)
52
+
53
+ if result.nil?
54
+ if finder.bang
55
+ raise DocumentNotFound, "Couldn't find Document with #{attributes.inspect} in collection named #{collection.name}"
56
+ end
57
+
58
+ if finder.instantiator
59
+ self.send(finder.instantiator, attributes)
60
+ end
61
+ else
62
+ result
63
+ end
64
+ end
65
+ end
66
+ end
67
+
68
+ require 'mongo_mapper/support'
69
+ require 'mongo_mapper/associations'
70
+ require 'mongo_mapper/associations/base'
71
+ require 'mongo_mapper/associations/proxy'
72
+ require 'mongo_mapper/associations/many_documents_proxy'
73
+ require 'mongo_mapper/associations/belongs_to_proxy'
74
+ require 'mongo_mapper/associations/belongs_to_polymorphic_proxy'
75
+ require 'mongo_mapper/associations/many_proxy'
76
+ require 'mongo_mapper/associations/many_polymorphic_proxy'
77
+ require 'mongo_mapper/associations/many_embedded_proxy'
78
+ require 'mongo_mapper/associations/many_embedded_polymorphic_proxy'
79
+ require 'mongo_mapper/associations/many_documents_as_proxy'
80
+ require 'mongo_mapper/callbacks'
81
+ require 'mongo_mapper/finder_options'
82
+ require 'mongo_mapper/dynamic_finder'
83
+ require 'mongo_mapper/key'
84
+ require 'mongo_mapper/observing'
85
+ require 'mongo_mapper/pagination'
86
+ require 'mongo_mapper/save_with_validation'
87
+ require 'mongo_mapper/serialization'
88
+ require 'mongo_mapper/validations'
89
+ require 'mongo_mapper/rails_compatibility/document'
90
+ require 'mongo_mapper/rails_compatibility/embedded_document'
91
+ require 'mongo_mapper/embedded_document'
92
+ require 'mongo_mapper/document'
@@ -0,0 +1,86 @@
1
+ module MongoMapper
2
+ module Associations
3
+ module ClassMethods
4
+ def belongs_to(association_id, options = {})
5
+ create_association(:belongs_to, association_id, options)
6
+ self
7
+ end
8
+
9
+ def many(association_id, options = {})
10
+ create_association(:many, association_id, options)
11
+ self
12
+ end
13
+
14
+ def associations
15
+ @associations ||= self.superclass.respond_to?(:associations) ?
16
+ self.superclass.associations :
17
+ HashWithIndifferentAccess.new
18
+ end
19
+
20
+ private
21
+ def create_association(type, name, options)
22
+ association = Associations::Base.new(type, name, options)
23
+ associations[association.name] = association
24
+ define_association_methods(association)
25
+ define_dependent_callback(association)
26
+ association
27
+ end
28
+
29
+ def define_association_methods(association)
30
+ define_method(association.name) do
31
+ get_proxy(association)
32
+ end
33
+
34
+ define_method("#{association.name}=") do |value|
35
+ get_proxy(association).replace(value)
36
+ value
37
+ end
38
+ end
39
+
40
+ def define_dependent_callback(association)
41
+ if association.options[:dependent]
42
+ if association.many?
43
+ define_dependent_callback_for_many(association)
44
+ elsif association.belongs_to?
45
+ define_dependent_callback_for_belongs_to(association)
46
+ end
47
+ end
48
+ end
49
+
50
+ def define_dependent_callback_for_many(association)
51
+ return if association.embeddable?
52
+
53
+ after_destroy do |doc|
54
+ case association.options[:dependent]
55
+ when :destroy
56
+ doc.get_proxy(association).destroy_all
57
+ when :delete_all
58
+ doc.get_proxy(association).delete_all
59
+ when :nullify
60
+ doc.get_proxy(association).nullify
61
+ end
62
+ end
63
+ end
64
+
65
+ def define_dependent_callback_for_belongs_to(association)
66
+ after_destroy do |doc|
67
+ case association.options[:dependent]
68
+ when :destroy
69
+ doc.get_proxy(association).destroy
70
+ end
71
+ end
72
+ end
73
+ end
74
+
75
+ module InstanceMethods
76
+ def get_proxy(association)
77
+ unless proxy = self.instance_variable_get(association.ivar)
78
+ proxy = association.proxy_class.new(self, association)
79
+ self.instance_variable_set(association.ivar, proxy) if !frozen?
80
+ end
81
+
82
+ proxy
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,83 @@
1
+ module MongoMapper
2
+ module Associations
3
+ class Base
4
+ attr_reader :type, :name, :options
5
+
6
+ def initialize(type, name, options = {})
7
+ @type, @name, @options = type, name, options
8
+ end
9
+
10
+ def class_name
11
+ @class_name ||= begin
12
+ if cn = options[:class_name]
13
+ cn
14
+ elsif many?
15
+ name.to_s.singularize.camelize
16
+ else
17
+ name.to_s.camelize
18
+ end
19
+ end
20
+ end
21
+
22
+ def klass
23
+ @klass ||= class_name.constantize
24
+ end
25
+
26
+ def many?
27
+ @many_type ||= @type == :many
28
+ end
29
+
30
+ def belongs_to?
31
+ @belongs_to_type ||= @type == :belongs_to
32
+ end
33
+
34
+ def polymorphic?
35
+ !!@options[:polymorphic]
36
+ end
37
+
38
+ def as?
39
+ !!@options[:as]
40
+ end
41
+
42
+ def type_key_name
43
+ @type_key_name ||= many? ? '_type' : "#{as}_type"
44
+ end
45
+
46
+ def as
47
+ @options[:as] || self.name
48
+ end
49
+
50
+ def foreign_key
51
+ @options[:foreign_key] || "#{name}_id"
52
+ end
53
+
54
+ def ivar
55
+ @ivar ||= "@_#{name}"
56
+ end
57
+
58
+ def embeddable?
59
+ many? && klass.embeddable?
60
+ end
61
+
62
+ def proxy_class
63
+ @proxy_class ||= begin
64
+ if many?
65
+ if self.klass.embeddable?
66
+ polymorphic? ? ManyEmbeddedPolymorphicProxy : ManyEmbeddedProxy
67
+ else
68
+ if polymorphic?
69
+ ManyPolymorphicProxy
70
+ elsif as?
71
+ ManyDocumentsAsProxy
72
+ else
73
+ ManyProxy
74
+ end
75
+ end
76
+ else
77
+ polymorphic? ? BelongsToPolymorphicProxy : BelongsToProxy
78
+ end
79
+ end # end begin
80
+ end # end proxy_class
81
+ end
82
+ end
83
+ end