Permalink
Browse files

updates to CHANGELOG, README, and Gemfile

  • Loading branch information...
1 parent a13549c commit 46ea3a630709397ed7eb01b5d52600a12a9c5a9e @jsmestad jsmestad committed Apr 6, 2011
Showing with 60 additions and 54 deletions.
  1. +5 −0 CHANGELOG
  2. +8 −7 Gemfile
  3. +30 −15 Gemfile.lock
  4. +12 −22 README.rdoc
  5. +5 −10 Rakefile
View
5 CHANGELOG
@@ -1,3 +1,8 @@
+= 0.9.pre
+
+ Internal:
+ * Updated development dependencies and Jeweler definitions (jsmestad)
+
= 0.8.1
* Add Mongomatic::Base#insert and Mongomatic::Base#insert! (jsmestad)
View
15 Gemfile
@@ -1,17 +1,18 @@
source "http://rubygems.org"
# Add dependencies required to use your gem here.
# Example:
-gem "activesupport", ">= 2.3.5"
-gem "mongo", "~> 1.1"
-gem "bson", "~> 1.1"
-gem "i18n", ">= 0.4.1"
+gem "activesupport", ">= 3.0.0"
+gem "mongo", ">= 1.2.4"
+gem "bson", ">= 1.2.4"
+gem "i18n", ">= 0.5.0"
# Add dependencies to develop your gem here.
# Include everything needed to run rake, tests, features, etc.
group :development do
gem "minitest", ">= 0"
- gem "autotest", ">=0"
- gem "bundler", "~> 1.0.0"
- gem "jeweler", "~> 1.5.1"
+ gem "bundler", "~> 1.0.11"
+ gem "jeweler", "~> 1.5.2"
gem "rcov", ">= 0"
+ gem (RUBY_VERSION =~ /^1\.9/ ? "ruby-debug19" : "ruby-debug")
+ gem "yard", "~> 0.6.5"
end
View
45 Gemfile.lock
@@ -1,31 +1,46 @@
GEM
remote: http://rubygems.org/
specs:
- activesupport (3.0.3)
- autotest (4.4.5)
- bson (1.1.2)
+ activesupport (3.0.6)
+ archive-tar-minitar (0.5.2)
+ bson (1.3.0)
+ columnize (0.3.2)
git (1.2.5)
- i18n (0.4.2)
- jeweler (1.5.1)
+ i18n (0.5.0)
+ jeweler (1.5.2)
bundler (~> 1.0.0)
git (>= 1.2.5)
rake
- minitest (2.0.0)
- mongo (1.1.2)
- bson (>= 1.1.1)
+ linecache19 (0.5.12)
+ ruby_core_source (>= 0.1.4)
+ minitest (2.0.2)
+ mongo (1.3.0)
+ bson (>= 1.3.0)
rake (0.8.7)
rcov (0.9.9)
+ ruby-debug-base19 (0.11.25)
+ columnize (>= 0.3.1)
+ linecache19 (>= 0.5.11)
+ ruby_core_source (>= 0.1.4)
+ ruby-debug19 (0.11.6)
+ columnize (>= 0.3.1)
+ linecache19 (>= 0.5.11)
+ ruby-debug-base19 (>= 0.11.19)
+ ruby_core_source (0.1.5)
+ archive-tar-minitar (>= 0.5.2)
+ yard (0.6.6)
PLATFORMS
ruby
DEPENDENCIES
- activesupport (>= 2.3.5)
- autotest
- bson (~> 1.1)
- bundler (~> 1.0.0)
- i18n (>= 0.4.1)
- jeweler (~> 1.5.1)
+ activesupport (>= 3.0.0)
+ bson (>= 1.2.4)
+ bundler (~> 1.0.11)
+ i18n (>= 0.5.0)
+ jeweler (~> 1.5.2)
minitest
- mongo (~> 1.1)
+ mongo (>= 1.2.4)
rcov
+ ruby-debug19
+ yard (~> 0.6.5)
View
34 README.rdoc
@@ -2,25 +2,25 @@
Mongomatic allows you to map your Ruby objects to Mongo documents. It is designed to be fast and simple.
-== 0.6.0 CHANGELOG NOTES
+=== Release Notes
- !! THE ERROR CLASS HAS BEEN REWORKED IN THIS VERSION.
- !! DO NOT EXPECT YOUR UPGRADE TO BE SEAMLESS. NOTHING /SHOULD/
- !! BREAK BUT YOU SHOULD TEST THOROUGHLY.
+This project follows semantic versioning as detailed here (http://semver.org/). This means that minor version bumps (0.x => 0.y) can break compatibility. Please see the CHANGELOG for upgrade notes.
- * Added methods to bring ActiveModel compliancy
+=== Note on Patches/Pull Requests
- * Pulled in do_callback fix (no more NoMethodError catching)
-
- * Relaxed restrictions on dependencies
-
- * Reworked the Error class to mimic the ActiveModel style errors.
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+ future version unintentionally.
+* Commit just the modifications, do not mess with Rakefile, VERSION, or CHANGELOG.
+* Add a separate commit with modifications to the CHANGELOG file
+* Send me a pull request. Bonus points for branches.
== What's different about Mongomatic?
-* Follows Mongo idioms wherever possible.
+* Follows MongoDB idioms wherever possible.
* Only strives to do "just enough" and never too much.
-* When possible, we defer to Mongo. For example, there's no Mongomatic query API, instead you use the same query hash syntax you would with the Ruby Mongo driver.
+* When possible, we defer to MongoDB. For example, there's no Mongomatic query API, instead you use the same query hash syntax you would with the Ruby MongoDB driver.
* No complex relationship management: if you want to model relationships then add your own finder methods.
* Minimal dependencies.
@@ -230,16 +230,6 @@ You can add your own observers to CollectionName using CollectionName.add_observ
It is worth noting that you should be careful the operations you perform on the instance of your class passed to the observer callbacks. Calling operations that invoke callbacks can result in an infinite loop if improperly structured.
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
- future version unintentionally.
-* 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 I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
== Copyright
Copyright (c) 2010 Ben Myles. See LICENSE for details.
View
15 Rakefile
@@ -5,19 +5,14 @@ begin
require 'jeweler'
Jeweler::Tasks.new do |gem|
gem.name = "mongomatic"
- gem.summary = %Q{Mongomatic is a simple Ruby object mapper for Mongo}
- gem.description = %Q{Mongomatic is a simple Ruby object mapper for Mongo}
+ gem.summary = %Q{Mongomatic is a modular Ruby object mapper for Mongo}
+ gem.description = %Q{Mongomatic is a modular Ruby object mapper for Mongo}
gem.email = "ben.myles@gmail.com"
gem.homepage = "http://mongomatic.com/"
- gem.authors = ["Ben Myles"]
- gem.files = ["lib/**/*.rb"]
- gem.add_development_dependency "minitest", "~> 2.0"
- gem.add_dependency "bson", "~> 1.1"
- gem.add_dependency "mongo", "~> 1.1"
- gem.add_dependency "activesupport", ">= 2.3.5"
- # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+ gem.authors = ["Ben Myles", "Justin Smestad"]
+ gem.license = "MIT"
end
- Jeweler::GemcutterTasks.new
+ Jeweler::RubygemsDotOrgTasks.new
rescue LoadError
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
end

0 comments on commit 46ea3a6

Please sign in to comment.