mini_mongo 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+services: mongodb
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx
+branches:
+  only:
+    - master
+matrix:
+  include:
+    - rvm: jruby
+      env: JRUBY_OPTS="--1.9 --server -Xcext.enabled=true"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--1.9 --server -Xcext.enabled=true"

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 robertomiranda
+Copyright (c) 2012-2013 robertomiranda
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,16 +1,25 @@
+[![Build Status](https://secure.travis-ci.org/robertomiranda/mini_mongo.png)](http://travis-ci.org/robertomiranda/mini_mongo)
 # MiniMongo
 
 A Ruby Object Mapper for Mongo
 
 ## Installation
 
+### Ruby Versions
+
+This ODM works and is consistently tested on: CRuby 1.9.x, JRuby (in 1.9 mode) and Rubinius (in 1.9 mode). CRuby 2.0 isn't supported right now since bson_ext dependency is failing during install.
+
+We don't have plans to support 1.8.x rubies
+
+### Gems
+
 Add this line to your application's Gemfile:
 
     gem 'mini_mongo'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -18,7 +27,60 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuring
+
+To get started configure the ODM with your db info using your database url
+
+```ruby
+MiniMongo.configure do |config|
+  config.database_url = "mongodb://:@localhost:27017/posts"
+  config.slave_ok = true # by default is false
+end
+```
+
+or passing directly all the params
+
+```ruby
+MiniMongo.configure do |config|
+  config.db_name = "posts"
+  config.db_user = ""
+  config.db_password = ""
+  config.db_host = "localhost"
+  config.db_port = "27017"
+end
+```
+
+### Mapping
+
+```ruby
+require "mini_mongo"
+MiniMongo.configure do|config|
+  config.database_url = "mongodb://:@localhost:27017/posts"
+end
+
+class Post < MiniMongo::Base
+  maps :posts
+end
+
+# Post.insert({:author => "Chuck Norris"})
+# => #<Post:0x007fe5240f42c0 @id="5016af53bda74305f1000002", @author="Chuck Norris">
+
+# Post.find("id" => "5016af53bda74305f1000002")
+# => #<Post:0x007fe5240cc360 @id="5016af53bda74305f1000002", @author="Chuck Norris">
+#
+# Post.update("5016af53bda74305f1000002", "author" => "chuck norris")
+# => #<Post:0x007fdc7c171c80 @author="chuck norris", @id="5016af53bda74305f1000002">
+#
+#Post.count
+# => 1
+#
+#Post.remove("5016af53bda74305f1000002")
+# => true
+#
+#Post.remove_all
+# => true
+```
+
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,24 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+task :console do
+  puts "Loading development console..."
+  system("irb -r mini_mongo")
+end
+
+task :help do
+  puts "Available rake tasks: "
+  puts "rake console - Run a IRB console with all enviroment loaded"
+  puts "rake spec - Run specs"
+end
+
+task :spec do
+  desc "Run all specs with rcov"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = "spec/**/*_spec.rb"
+  end
+end
+
+task :default => [:spec]

data/examples/post.rb

@@ -0,0 +1,30 @@
+require "mini_mongo"
+MiniMongo.configure do|config|
+  config.database_url = "mongodb://:@localhost:27017/posts"
+end
+
+class Post < MiniMongo::Base
+  maps :posts
+end
+
+# Post.insert({:author => "Chuck Norris"})
+# => #<Post:0x007fe5240f42c0 @id="5016af53bda74305f1000002", @author="Chuck Norris">
+
+# Post.find("id" => "5016af53bda74305f1000002")
+# => #<Post:0x007fe5240cc360 @id="5016af53bda74305f1000002", @author="Chuck Norris">
+#
+# Post.update("5016af53bda74305f1000002", "author" => "chuck norris")
+# => #<Post:0x007fdc7c171c80 @author="chuck norris", @id="5016af53bda74305f1000002">
+#
+#Post.count
+# => 1
+#
+#Post.remove("5016af53bda74305f1000002")
+# => true
+#
+#Post.remove_all
+# => true
+#
+class Answer < MiniMongo::Base
+  maps :answers
+end

data/lib/mini_mongo/attribute_assignment.rb

@@ -0,0 +1,28 @@
+module MiniMongo
+  module AttributeAssignment
+    def assign_attributes(attributes)
+      @attributes["id"] = attributes.delete("_id").to_s || attributes.delete(:_id).to_s
+      attributes.each do |key, value|
+        @attributes[key] = value
+        define_accessors(key) unless self.respond_to? :key
+      end
+    end
+
+    alias_method :attributes=, :assign_attributes
+
+    def id
+      @attributes["id"]
+    end
+
+    private
+      def define_accessors(key)
+        define_singleton_method(key) do
+          @attributes[key]
+        end
+
+        define_singleton_method("#{key}=") do |value|
+          @attributes[key] = value
+        end
+      end
+  end
+end

data/lib/mini_mongo/base.rb

@@ -1,13 +1,9 @@
-class MiniMongo::Base
-  include MiniMongo::Mapper
-
-  def initialize(attrs = {})
-    attrs["id"] = attrs["_id"].to_s
-    attrs.delete("_id")
-    attrs.each do |key, value|
-      instance_variable_set("@#{key}", value)
-      self.instance_eval("def #{key};@#{key};end")
-      self.instance_eval("def #{key}=(val);@#{key}=val;end")
-    end
+module MiniMongo
+  class Base
+    include MiniMongo::Core
+    include MiniMongo::Mapper
+    include MiniMongo::AttributeAssignment
+    include MiniMongo::Comparable
+    include MiniMongo::Serialization
   end
 end

data/lib/mini_mongo/comparable.rb

@@ -0,0 +1,41 @@
+module MiniMongo
+  module Comparable
+    include ::Comparable
+
+    # Default comparison is via the string version of the id.
+    #
+    # @example Compare two documents.
+    #   person <=> other_person
+    #
+    # @param [ Document ] other The document to compare with.
+    #
+    # @return [ Integer ] -1, 0, 1.
+    def <=>(other)
+      attributes["id"] <=> other.attributes["id"]
+    end
+
+    # Performs class equality checking.
+    #
+    # @example Compare the classes.
+    #   document === other
+    #
+    # @param [ Document, Object ] other The other object to compare with.
+    #
+    # @return [ true, false ] True if the classes are equal, false if not.
+    def ===(other)
+      other.class == Class ? self.class === other : self == other
+    end
+
+    # Delegates to ==. Used when needing checks in hashes.
+    #
+    # @example Perform equality checking.
+    #   document.eql?(other)
+    #
+    # @param [ Document, Object ] other The object to check against.
+    #
+    # @return [ true, false ] True if equal, false if not.
+    def eql?(other)
+      self == (other)
+    end
+  end
+end

data/lib/mini_mongo/configuration.rb

@@ -0,0 +1,34 @@
+module MiniMongo
+  # Stores runtime configuration information.
+  #
+  # @example Standard settings
+  #     MiniMongo.configure do |config|
+  #       config.database_url          = "mongodb://user:pass@localhost:27017/posts"
+  #     end
+  #
+  # @see MiniMongo.configure
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :slave_ok, :db_name, :db_user, :db_host, :db_port, :db_password
+    attr_reader :database_url
+
+    def database_url=(url)
+      @database_url = url
+      db_info = URI.parse(@database_url)
+      @db_name = db_info.path.gsub(/^\//, '')
+      @db_user = db_info.user
+      @db_password = db_info.password
+      @db_host = db_info.host
+      @db_port = db_info.port
+    end
+
+  end
+end

data/lib/mini_mongo/connection.rb

@@ -1,17 +1,27 @@
 require "uri"
 require "mongo"
+
 module MiniMongo
   module Connection
-    def database_url=(url)
-      @@database_url = url
-    end
 
     def db_connection
-      db = URI.parse(@@database_url)
-      db_name = db.path.gsub(/^\//, '')
-      @@db_connection ||= Mongo::Connection.new(db.host, db.port, :slave_ok => true).db(db_name)
-      @@db_connection.authenticate(db.user, db.password) if db.user && !db.user.empty?
+      @@db_connection ||= Mongo::Connection.new(
+        MiniMongo.configuration.db_host,
+        MiniMongo.configuration.db_port,
+        :slave_ok => MiniMongo.configuration.slave_ok)
+        .db(MiniMongo.configuration.db_name)
+      authenticate_user
       @@db_connection
     end
+
+    def drop
+      self.db_connection.drop_database(@@db_name)
+    end
+
+    def authenticate_user
+      @@db_connection.authenticate(
+        MiniMongo.configuration.db_user,
+        MiniMongo.configuration.db_password)if MiniMongo.configuration.db_user&& !MiniMongo.configuration.db_user.empty?
+    end
   end
 end

data/lib/mini_mongo/core.rb

@@ -0,0 +1,47 @@
+module MiniMongo
+  module Core
+
+    attr_reader :attributes
+
+    alias_method :to_hash, :attributes
+
+    def initialize(attributes = {})
+      @attributes = {}
+      assign_attributes(attributes.dup)
+    end
+
+    # Return an array with this +Document+ only in it.
+    #
+    # @example Return the document in an array.
+    #   document.to_a
+    #
+    def to_a
+      attributes.to_a
+    end
+
+
+    def inspect
+      inspection = if attributes
+                     attributes.collect { |key, value|
+                       "#{key}: #{value_for_inspect(value)}"
+                     }.compact.join(", ")
+                   else
+                     "not initialized"
+                   end
+      "#<#{self.class} #{inspection}>"
+    end
+
+    private
+
+    def value_for_inspect(value)
+      if value.is_a?(String) && value.length > 50
+        "#{value[0..50]}...".inspect
+      elsif value.is_a?(Date) || value.is_a?(Time)
+        %("#{value.to_s(:db)}")
+      else
+        value.inspect
+      end
+    end
+
+  end
+end

data/lib/mini_mongo/errors.rb

@@ -0,0 +1,7 @@
+module MiniMongo
+  class MiniMongoError < StandardError
+  end
+
+  class DocumentNotFound < MiniMongoError
+  end
+end

data/lib/mini_mongo/mapper.rb

@@ -1,36 +1,72 @@
 require "uri"
 require "mongo"
+
 module MiniMongo
   module Mapper
     def self.included(base)
       base.send :extend, ClassMethods
     end
 
-
     module ClassMethods
-      def find(id, attrs={})
-        doc = @@collection.find("_id" => BSON::ObjectId(id))
-        self.class_eval("new(#{doc})")
+      def find(attrs={})
+        attrs["_id"] = BSON::ObjectId(attrs["id"]) if attrs["id"]
+        attrs.delete("id")
+        docs = self.collection.find(attrs).to_a
+        if docs.empty?
+          raise DocumentNotFound, "Couldn't find #{self.collection_name.capitalize}, with #{attrs.to_a.collect {|p| p.join(' = ')}.join(', ')}"
+        else
+          result = []
+          docs.each do |doc|
+            result << self.class_eval("new(#{doc})") if doc
+          end
+          result
+        end
       end
 
       def insert(attrs={})
-        doc = @@collection.insert(attrs)
-        self.class_eval("new(#{doc})")
+        doc = {}
+        doc["_id"] = self.collection.insert(attrs).to_s
+        doc.merge!(attrs)
+        self.new(doc)
       end
 
       def update(id, attrs={})
-        doc = @@collection.update({"_id" => BSON::ObjectId(id)}, attrs)
-        self.class_eval("new(#{doc})")
+        self.collection.update({"_id" => BSON::ObjectId(id)}, attrs)
       end
 
       def remove(id)
-        @@collection.remove("_id" => BSON::ObjectId(id))
+        self.collection.remove("_id" => BSON::ObjectId(id))
+      end
+
+      def count
+        self.collection.count
+      end
+
+      def remove_all
+        self.collection.remove
       end
 
       def maps(name)
-        @@collection_name = name.to_s
-        @@collection = MiniMogo.db_connection.collection(name.to_s)
+        self.collection_name = name.to_s
+        self.collection = MiniMongo.db_connection.collection(name.to_s)
+      end
+
+      def collection
+        @@collection
       end
+
+      def collection=(collection)
+        @@collection = collection
+      end
+
+      def collection_name
+        @@collection_name
+      end
+
+      def collection_name=(collection_name)
+        @@collection_name = collection_name
+      end
+
     end
   end
 end

data/lib/mini_mongo/serialization.rb

@@ -0,0 +1,7 @@
+module MiniMongo
+  module Serialization
+    def to_json
+      to_hash.to_json
+    end
+  end
+end

data/lib/mini_mongo/version.rb

@@ -1,3 +1,3 @@
 module MiniMongo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/mini_mongo.rb

@@ -1,6 +1,13 @@
+require "mini_mongo/configuration"
 module MiniMongo
   autoload :Connection, 'mini_mongo/connection'
+  autoload :MiniMongoError, 'mini_mongo/errors'
+  autoload :DocumentNotFound, 'mini_mongo/errors'
   autoload :Mapper, 'mini_mongo/mapper'
   autoload :Base, 'mini_mongo/base'
+  autoload :Core, 'mini_mongo/core'
+  autoload :AttributeAssignment, 'mini_mongo/attribute_assignment'
+  autoload :Comparable, 'mini_mongo/comparable'
+  autoload :Serialization, 'mini_mongo/serialization'
   extend Connection
 end

data/mini_mongo.gemspec

@@ -17,4 +17,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "mongo", "~> 1.6.4"
   gem.add_dependency "bson_ext", "~> 1.6.4"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency "rake"
 end

data/spec/base_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe "Base" do
+
+  before do
+    @post1 = Post.insert({:author => "Chuck Norris"})
+    @post2 = Post.find(:author => "Chuck Norris").first
+  end
+
+  describe "<=>" do
+    it "return  Integer  -1, 0, 1" do
+      (@post1 <=> @post2).should == 0
+    end
+  end
+
+  describe "==" do
+    it "return True if the ids are equal, false if not" do
+      @post1.should == @post2
+    end
+  end
+
+  describe "===" do
+    it "return True if the classes are equal, false if not" do
+      @post1.should === @post2
+    end
+  end
+
+  describe "eql?" do
+    it "return True if equal, false if not" do
+      @post1.eql?(@post2).should == true
+    end
+  end
+end

data/spec/configutation_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe "Configuration" do
+  it "should set the configuration vars from database url" do
+    MiniMongo.configure do |config|
+      config.database_url = "mongodb://:@localhost:27017/posts"
+    end
+    MiniMongo.configuration.db_name.should == "posts"
+  end
+
+  it "should set configuration vars" do
+    MiniMongo.configure do |config|
+      config.db_user = "roberto"
+    end
+    MiniMongo.configuration.db_user.should == "roberto"
+  end
+end

data/spec/mapper_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+describe "Mapper" do
+  def post_attributes
+    {:author => "Chuck Norris"}
+  end
+
+  let!(:post){ Post.insert(post_attributes) }
+
+  describe "#insert" do
+    it "create a new Document" do
+      expect do
+        post = Post.insert(post_attributes)
+      end.to change(Post, :count).by(1)
+    end
+  end
+
+  describe "#find" do
+    it "returns the document" do
+      Post.find(:author => "Chuck Norris").should == [post]
+    end
+
+    it "raise Document not found" do
+      proc { Post.find(:author => "Chuck Norri") }.should raise_error(MiniMongo::DocumentNotFound)
+    end
+  end
+
+  describe "#update" do
+    pending
+  end
+
+  describe "#remove" do
+    it "destroy the document" do
+      expect do
+        Post.remove(post.id)
+      end.to change(Post, :count).by(-1)
+    end
+  end
+
+  describe "count" do
+    it "return the number of document" do
+      post
+      Post.count.should == 1
+    end
+  end
+
+  describe "remove_all" do
+    it "destroy all the documents" do
+      post
+      expect do
+        Post.remove_all
+      end.to change(Post, :count).by(-1)
+    end
+  end
+
+end

data/spec/models/post.rb

@@ -0,0 +1,4 @@
+class Post < MiniMongo::Base
+  maps :posts
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$: << File.dirname(__FILE__)
+ENV['RACK_ENV'] = "test"
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+Dir["./lib/*.rb"].each {|file| require file }
+
+MiniMongo.configure do |config|
+  config.database_url = "mongodb://:@localhost:27017/posts"
+end
+
+Dir["./spec/models/*.rb"].each {|file| require file }
+
+RSpec.configure do |config|
+
+  config.before(:each) do
+    Post.remove_all
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mini_mongo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-25 00:00:00.000000000 Z
+date: 2013-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -44,6 +44,54 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Basics Object Mapper for Mongo
 email:
 - rjmaltamar@gmail.com
@@ -53,17 +101,31 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- examples/post.rb
 - lib/mini_mongo.rb
+- lib/mini_mongo/attribute_assignment.rb
 - lib/mini_mongo/base.rb
+- lib/mini_mongo/comparable.rb
+- lib/mini_mongo/configuration.rb
 - lib/mini_mongo/connection.rb
+- lib/mini_mongo/core.rb
+- lib/mini_mongo/errors.rb
 - lib/mini_mongo/mapper.rb
+- lib/mini_mongo/serialization.rb
 - lib/mini_mongo/version.rb
 - mini_mongo.gemspec
+- spec/base_spec.rb
+- spec/configutation_spec.rb
+- spec/mapper_spec.rb
+- spec/models/post.rb
+- spec/spec_helper.rb
 homepage: https://github.com/robertomiranda/mini_mongo
 licenses: []
 post_install_message: 
@@ -88,4 +150,9 @@ rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: A Ruby Object Mapper for Mongo
-test_files: []
+test_files:
+- spec/base_spec.rb
+- spec/configutation_spec.rb
+- spec/mapper_spec.rb
+- spec/models/post.rb
+- spec/spec_helper.rb