djsun-mongomapper 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. data/.gitignore +7 -0
  2. data/History +51 -0
  3. data/LICENSE +20 -0
  4. data/README.rdoc +39 -0
  5. data/Rakefile +71 -0
  6. data/VERSION +1 -0
  7. data/bin/mmconsole +56 -0
  8. data/lib/mongomapper.rb +96 -0
  9. data/lib/mongomapper/associations.rb +61 -0
  10. data/lib/mongomapper/associations/base.rb +71 -0
  11. data/lib/mongomapper/associations/belongs_to_polymorphic_proxy.rb +32 -0
  12. data/lib/mongomapper/associations/belongs_to_proxy.rb +22 -0
  13. data/lib/mongomapper/associations/many_documents_proxy.rb +85 -0
  14. data/lib/mongomapper/associations/many_embedded_polymorphic_proxy.rb +33 -0
  15. data/lib/mongomapper/associations/many_embedded_proxy.rb +17 -0
  16. data/lib/mongomapper/associations/many_polymorphic_proxy.rb +11 -0
  17. data/lib/mongomapper/associations/many_proxy.rb +6 -0
  18. data/lib/mongomapper/associations/proxy.rb +67 -0
  19. data/lib/mongomapper/callbacks.rb +106 -0
  20. data/lib/mongomapper/document.rb +278 -0
  21. data/lib/mongomapper/embedded_document.rb +237 -0
  22. data/lib/mongomapper/finder_options.rb +96 -0
  23. data/lib/mongomapper/key.rb +80 -0
  24. data/lib/mongomapper/observing.rb +50 -0
  25. data/lib/mongomapper/pagination.rb +52 -0
  26. data/lib/mongomapper/rails_compatibility/document.rb +15 -0
  27. data/lib/mongomapper/rails_compatibility/embedded_document.rb +25 -0
  28. data/lib/mongomapper/save_with_validation.rb +19 -0
  29. data/lib/mongomapper/serialization.rb +55 -0
  30. data/lib/mongomapper/serializers/json_serializer.rb +79 -0
  31. data/lib/mongomapper/validations.rb +47 -0
  32. data/mongomapper.gemspec +139 -0
  33. data/test/NOTE_ON_TESTING +1 -0
  34. data/test/functional/associations/test_belongs_to_polymorphic_proxy.rb +39 -0
  35. data/test/functional/associations/test_belongs_to_proxy.rb +35 -0
  36. data/test/functional/associations/test_many_embedded_polymorphic_proxy.rb +131 -0
  37. data/test/functional/associations/test_many_embedded_proxy.rb +106 -0
  38. data/test/functional/associations/test_many_polymorphic_proxy.rb +267 -0
  39. data/test/functional/associations/test_many_proxy.rb +236 -0
  40. data/test/functional/test_associations.rb +40 -0
  41. data/test/functional/test_callbacks.rb +85 -0
  42. data/test/functional/test_document.rb +691 -0
  43. data/test/functional/test_pagination.rb +81 -0
  44. data/test/functional/test_rails_compatibility.rb +31 -0
  45. data/test/functional/test_validations.rb +172 -0
  46. data/test/models.rb +108 -0
  47. data/test/test_helper.rb +67 -0
  48. data/test/unit/serializers/test_json_serializer.rb +103 -0
  49. data/test/unit/test_association_base.rb +136 -0
  50. data/test/unit/test_document.rb +125 -0
  51. data/test/unit/test_embedded_document.rb +370 -0
  52. data/test/unit/test_finder_options.rb +214 -0
  53. data/test/unit/test_key.rb +217 -0
  54. data/test/unit/test_mongo_id.rb +35 -0
  55. data/test/unit/test_mongomapper.rb +28 -0
  56. data/test/unit/test_observing.rb +101 -0
  57. data/test/unit/test_pagination.rb +113 -0
  58. data/test/unit/test_rails_compatibility.rb +34 -0
  59. data/test/unit/test_serializations.rb +52 -0
  60. data/test/unit/test_validations.rb +259 -0
  61. metadata +189 -0
data/.gitignore ADDED
@@ -0,0 +1,7 @@
1
+ *.sw?
2
+ .DS_Store
3
+ coverage
4
+ rdoc
5
+ pkg
6
+ *~
7
+ *.gem
data/History ADDED
@@ -0,0 +1,51 @@
1
+ 0.3.2 (master)
2
+ * Added many polymorphic documents association
3
+ * Implemented build and create for many and many polymorphic documents
4
+ * <<, push and concat now work correctly for many and many polymorphic documents
5
+ * find(:first) now accepts order option
6
+
7
+ 0.3.1 7/28/2009
8
+ * 1 minor tweak
9
+ * Removed deep_merge gem as dependency as ActiveSupport has deep_merge that works good enough
10
+
11
+ 0.3.0 7/28/2009
12
+ * 5 major additions, 3 minor additions, 3 bug fix, and other miscellany
13
+ * BACKWORDS COMPATIBILITY BREAK: _id is now stored in binary form (recommended by mongodb team) instead of string, api is the same everywhere as before but data stored with string id's previous to change will need to be updated
14
+ * Added Document#paginate which works just like find but adds pagination (dcu did basics and I pimped)
15
+ * Added a basic console for playing around with MongoMapper (dcu)
16
+ * Embedded associations can now be deeply nested (Keith Hanson)
17
+ * Added support for many polymorphic documents (Felipe Coury and Me)
18
+ * Fixed bug where conditions that disallowed using $in, $all and $any with an array
19
+ * Bumped version of validatable so :if validation option supports symbol/string to proc.
20
+ * Document#create with no attributes now creates a document as long as it is valid
21
+ * Now defining accessor methods when key is declared rather than using method missing and all that jazz
22
+ * Attributes now have boolean methods that return true or false based on whether they have value present
23
+ * Added scoped finds and pagination on many document association.
24
+ * find first and last now use natural order which is more reliable.
25
+ * Updated to latest ruby driver (0.10.1)
26
+
27
+
28
+ 0.2.0 7/7/2009
29
+ * 2 major additions (observers, associations), several minor additions, and a few bug fixes
30
+ * Added observers
31
+ * many now supports embedded docs or docs in another collection (dcu on github)
32
+ * added belongs_to association (dcu)
33
+ * added validates_uniqueness_of (dcu)
34
+ * added :unique key shortcut to add validates_uniqueness_of automatically
35
+ * now tracking descendants of document (dcu)
36
+ * added validates_exclusion_of and validates_inclusion_of
37
+ * Bumped required version of validatable for callback fixes
38
+ * More thorough use of converting find conditions and options to mongo speak
39
+ * #attributes= no longer bombs when given nil
40
+
41
+ 0.1.2 7/3/2009
42
+ * 2 minor changes
43
+ * Straightened out callbacks and added validate, validate_on_create and validate_on_update.
44
+ * Attributes passed into attributes= now call writer methods if they exist. This is mostly for virtual attributes.
45
+
46
+ 0.1.1 6/28/2009
47
+ * 1 minor change
48
+ * bumped ruby driver to 0.9 and removed hacks I had in while waiting for it
49
+
50
+ 0.1.0 6/26/2009
51
+ * Initial release
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.
data/README.rdoc ADDED
@@ -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 mongomapper.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.
data/Rakefile ADDED
@@ -0,0 +1,71 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "mongomapper"
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('mongodb-mongo', '0.10.1')
16
+ gem.add_dependency('jnunemaker-validatable', '1.7.2')
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
23
+ rescue LoadError
24
+ puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
25
+ end
26
+
27
+ require 'rake/testtask'
28
+ Rake::TestTask.new(:test) do |test|
29
+ test.libs << 'lib' << 'test'
30
+ test.pattern = 'test/**/test_*.rb'
31
+ test.verbose = true
32
+ end
33
+
34
+ begin
35
+ require 'rcov/rcovtask'
36
+ Rcov::RcovTask.new do |test|
37
+ test.libs << 'test'
38
+ test.pattern = 'test/**/test_*.rb'
39
+ test.verbose = true
40
+ end
41
+ rescue LoadError
42
+ task :rcov do
43
+ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
44
+ end
45
+ end
46
+
47
+ begin
48
+ require 'cucumber/rake/task'
49
+ Cucumber::Rake::Task.new(:features)
50
+ rescue LoadError
51
+ task :features do
52
+ abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
53
+ end
54
+ end
55
+
56
+ task :default => :test
57
+
58
+ require 'rake/rdoctask'
59
+ Rake::RDocTask.new do |rdoc|
60
+ if File.exist?('VERSION.yml')
61
+ config = YAML.load(File.read('VERSION.yml'))
62
+ version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
63
+ else
64
+ version = ""
65
+ end
66
+
67
+ rdoc.rdoc_dir = 'rdoc'
68
+ rdoc.title = "MongoMapper #{version}"
69
+ rdoc.rdoc_files.include('README*')
70
+ rdoc.rdoc_files.include('lib/**/*.rb')
71
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.3.1
data/bin/mmconsole ADDED
@@ -0,0 +1,56 @@
1
+ #!/usr/bin/env ruby
2
+ $:.unshift File.dirname(__FILE__)+"/../lib"
3
+
4
+ require 'mongomapper'
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 XGen::Mongo::Driver
15
+ include MongoMapper
16
+
17
+ MongoMapper.database = "mmtest"
18
+ $db = MongoMapper.database
19
+
20
+ @, 0)
21
+
22
+ puts %@
23
+ Welcome to the MongoMapper Console!
24
+
25
+ Example 1:
26
+ things = $db.collection("things")
27
+ things.insert("name" => "Raw Thing")
28
+ things.insert("name" => "Another Thing", "date" => Time.now)
29
+
30
+ cursor = things.find("name" => "Raw Thing")
31
+ puts cursor.next_object.inspect
32
+
33
+ Example 2:
34
+ class Thing
35
+ include MongoMapper::Document
36
+ key :name, String, :required => true
37
+ key :date, Time
38
+ end
39
+
40
+ thing = Thing.new
41
+ thing.name = "My thing"
42
+ thing.date = Time.now
43
+ thing.save
44
+
45
+ all_things = Thing.all
46
+ puts all_things.map { |object| object.name }.inspect
47
+
48
+ @
49
+
50
+ trap("SIGINT") do
51
+ irb.signal_handle
52
+ end
53
+ catch(:IRB_EXIT) do
54
+ irb.eval_input
55
+ end
56
+
@@ -0,0 +1,96 @@
1
+ require 'pathname'
2
+ require 'rubygems'
3
+
4
+ gem 'activesupport'
5
+ gem 'mongodb-mongo', '0.10.1'
6
+ gem 'jnunemaker-validatable', '1.7.2'
7
+
8
+ require 'activesupport'
9
+ require 'mongo'
10
+ require 'validatable'
11
+
12
+ class BasicObject #:nodoc:
13
+ instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval/ }
14
+ end unless defined?(BasicObject)
15
+
16
+ class Boolean
17
+ def self.mm_typecast(value)
18
+ ['true', 't', '1'].include?(value.to_s.downcase)
19
+ end
20
+ end
21
+
22
+ class MongoID < XGen::Mongo::Driver::ObjectID
23
+ def self.mm_typecast(value)
24
+ begin
25
+ if value.is_a?(XGen::Mongo::Driver::ObjectID)
26
+ value
27
+ else
28
+ XGen::Mongo::Driver::ObjectID::from_string(value.to_s)
29
+ end
30
+ rescue => exception
31
+ if exception.message == 'illegal ObjectID format'
32
+ raise MongoMapper::IllegalID
33
+ else
34
+ raise exception
35
+ end
36
+ end
37
+ end
38
+ end
39
+
40
+ dir = Pathname(__FILE__).dirname.expand_path + 'mongomapper'
41
+
42
+ require dir + 'associations'
43
+ require dir + 'associations/base'
44
+
45
+ require dir + 'associations/proxy'
46
+ require dir + 'associations/many_documents_proxy'
47
+
48
+ require dir + 'associations/belongs_to_proxy'
49
+ require dir + 'associations/belongs_to_polymorphic_proxy'
50
+ require dir + 'associations/many_proxy'
51
+ require dir + 'associations/many_polymorphic_proxy'
52
+ require dir + 'associations/many_embedded_proxy'
53
+ require dir + 'associations/many_embedded_polymorphic_proxy'
54
+
55
+ require dir + 'callbacks'
56
+ require dir + 'finder_options'
57
+ require dir + 'key'
58
+ require dir + 'observing'
59
+ require dir + 'pagination'
60
+ require dir + 'save_with_validation'
61
+ require dir + 'serialization'
62
+ require dir + 'validations'
63
+
64
+ require dir + 'rails_compatibility/document'
65
+ require dir + 'rails_compatibility/embedded_document'
66
+
67
+ require dir + 'embedded_document'
68
+ require dir + 'document'
69
+
70
+ module MongoMapper
71
+ DocumentNotFound = Class.new(StandardError)
72
+ IllegalID = Class.new(StandardError)
73
+
74
+ DocumentNotValid = Class.new(StandardError) do
75
+ def initialize(document)
76
+ @document = document
77
+ super("Validation failed: #{@document.errors.full_messages.join(", ")}")
78
+ end
79
+ end
80
+
81
+ def self.connection
82
+ @@connection ||= XGen::Mongo::Driver::Mongo.new
83
+ end
84
+
85
+ def self.connection=(new_connection)
86
+ @@connection = new_connection
87
+ end
88
+
89
+ def self.database=(name)
90
+ @@database = MongoMapper.connection.db(name)
91
+ end
92
+
93
+ def self.database
94
+ @@database
95
+ end
96
+ end
@@ -0,0 +1,61 @@
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 ||= HashWithIndifferentAccess.new
16
+ end
17
+
18
+ private
19
+ def create_association(type, name, options)
20
+ association = Associations::Base.new(type, name, options)
21
+ associations[association.name] = association
22
+ define_association_methods(association)
23
+ define_association_keys(association)
24
+ association
25
+ end
26
+
27
+ def define_association_methods(association)
28
+ define_method(association.name) do
29
+ get_proxy(association)
30
+ end
31
+
32
+ define_method("#{association.name}=") do |value|
33
+ get_proxy(association).replace(value)
34
+ value
35
+ end
36
+ end
37
+
38
+ def define_association_keys(association)
39
+ if association.belongs_to?
40
+ key(association.belongs_to_key_name, String)
41
+ key(association.type_key_name, String) if association.polymorphic?
42
+ end
43
+
44
+ if association.many? && association.polymorphic?
45
+ association.klass.send(:key, association.type_key_name, String)
46
+ end
47
+ end
48
+ end
49
+
50
+ module InstanceMethods
51
+ def get_proxy(association)
52
+ unless proxy = self.instance_variable_get(association.ivar)
53
+ proxy = association.proxy_class.new(self, association)
54
+ self.instance_variable_set(association.ivar, proxy)
55
+ end
56
+
57
+ proxy
58
+ end
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,71 @@
1
+ module MongoMapper
2
+ module Associations
3
+ class Base
4
+ attr_reader :type, :name, :options
5
+
6
+ def initialize(type, name, options = {})
7
+ @options = options
8
+ @type = type
9
+ @name = name
10
+ end
11
+
12
+ def class_name
13
+ @class_name ||= begin
14
+ if cn = options[:class_name]
15
+ cn
16
+ elsif many?
17
+ name.to_s.singularize.camelize
18
+ else
19
+ name.to_s.camelize
20
+ end
21
+ end
22
+ end
23
+
24
+ def klass
25
+ @klass ||= class_name.constantize
26
+ end
27
+
28
+ def many?
29
+ @many_type ||= @type == :many
30
+ end
31
+
32
+ def belongs_to?
33
+ @belongs_to_type ||= @type == :belongs_to
34
+ end
35
+
36
+ def polymorphic?
37
+ !!@options[:polymorphic]
38
+ end
39
+
40
+ def type_key_name
41
+ @type_key_name ||= many? ? '_type' : "#{name}_type"
42
+ end
43
+
44
+ def belongs_to_key_name
45
+ "#{name}_id"
46
+ end
47
+
48
+ def ivar
49
+ @ivar ||= "@_#{name}"
50
+ end
51
+
52
+ def embeddable?
53
+ many? && klass.embeddable?
54
+ end
55
+
56
+ def proxy_class
57
+ @proxy_class ||= begin
58
+ if many?
59
+ if self.klass.embeddable?
60
+ polymorphic? ? ManyEmbeddedPolymorphicProxy : ManyEmbeddedProxy
61
+ else
62
+ polymorphic? ? ManyPolymorphicProxy : ManyProxy
63
+ end
64
+ else
65
+ polymorphic? ? BelongsToPolymorphicProxy : BelongsToProxy
66
+ end
67
+ end # end begin
68
+ end # end proxy_class
69
+ end
70
+ end
71
+ end