mongo-sugar 0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2012 Endel Dreyer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,51 @@
+Mongo Sugar [![Build Status](https://secure.travis-ci.org/endel/mongo-sugar.png)](http://travis-ci.org/endel/mongo-sugar)
+===
+
+Provide a syntatic sugar for MongoDB ruby driver, similar to an ORM.
+
+But it isn't another ORM. If you need relationship features, you should use
+[MongoID](http://mongoid.org/), [MongoMapper](http://mongomapper.com/), or, why
+not - a relational database.
+
+Usage
+===
+
+Add mongo-sugar to your gemfile:
+
+    gem 'mongo-sugar'
+
+Require it on your code:
+
+    require 'mongo-sugar'
+
+Define classes as collections. By default, collection names are the class name
+underscored. On the following example, the collection name is `my_collection`.
+
+    class MyCollection < Mongo::Sugar::Collection
+      #
+      # Define your custom methods, like this:
+      #
+      def do_upsert(hash)
+        @collection.update({
+          key: hash[:key]
+        }, {
+          :$addToSet => {
+            :value => hash[:value]
+          }
+        }, :upsert => true)
+      end
+    end
+
+You can customize the collection names using `store_in`, which is similar to mongoid
+syntax.
+
+    class MyCollection < Mongo::Sugar::Collection
+      store_in :collection => 'custom_collection'
+    end
+
+For more details, read the [documentation](http://endel.github.com/mongo-sugar) here.
+
+License
+===
+
+This library is released under MIT License. Please see LICENSE file.

data/lib/mongo-sugar.rb

@@ -0,0 +1,8 @@
+
+module Mongo
+  module Sugar
+    autoload :Connection,  'mongo-sugar/connection'
+    autoload :Collection,  'mongo-sugar/collection'
+    autoload :VERSION,     'mongo-sugar/version'
+  end
+end

data/lib/mongo-sugar/collection.rb

@@ -0,0 +1,50 @@
+require 'singleton'
+require 'delegate'
+
+module Mongo
+  module Sugar
+    class Collection < Delegator
+      include Singleton
+      attr_reader :database
+
+      #
+      # Class methods
+      #
+
+      class << self
+        attr_reader :store_in_options
+        alias :collection :instance
+
+        def database
+          self.instance.database
+        end
+
+        def store_in(options)
+          @store_in_options = options
+        end
+      end
+
+      #
+      # Instance methods
+      #
+
+      def initialize(store_in={})
+        __setobj__(self.class.store_in_options || {})
+      end
+
+      def __setobj__(store_in_options)
+        conn = store_in_options.delete(:connection) || 'default'
+        db = store_in_options.delete(:database)
+        coll = store_in_options.delete(:collection) || self.class.name.delete(':').gsub(/(.)([A-Z])/,'\1_\2').downcase
+
+        @database = Mongo::Sugar::Connection::Manager.database(conn, db)
+        @collection = @database[coll]
+      end
+
+      def __getobj__
+        @collection
+      end
+
+    end
+  end
+end

data/lib/mongo-sugar/connection.rb

@@ -0,0 +1,33 @@
+require 'mongo'
+
+module Mongo
+  module Sugar
+    module Connection
+      autoload :Config,  'mongo-sugar/connection/config'
+      autoload :Manager, 'mongo-sugar/connection/manager'
+
+      class Connection
+        attr_reader :conn, :default_db
+
+        def initialize(uri)
+          raise "Connection#initialize: you must create a config/mongodb.yml file, or set ENV['MONGODB_URI']." if uri.nil?
+          @conn = Mongo::Connection.from_uri(uri)
+
+          # If URI doens't contain database part, get default connection's database name
+          default_db = File.basename(uri)
+          @default_db = default_db.index(':') ? @conn.db.name : default_db
+        end
+
+        # Get database reference from connection
+        #
+        # @param [String] database name
+        #
+        # @return [Mongo::DB] datbase reference
+        def database(name=nil)
+          @conn.db(name || @default_db)
+        end
+      end
+
+    end
+  end
+end

data/lib/mongo-sugar/connection/config.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+module Mongo
+  module Sugar
+    module Connection
+
+      #
+      # Config file reader
+      #
+      class Config
+        include Singleton
+
+        def initialize(config=ENV['MONGODB_CONFIG'], environment=ENV['RACK_ENV'])
+          config ||= 'config/mongo.yml'
+          @config = (File.exists?(config)) ? YAML.load_file(config)[environment] : {}
+        end
+
+        # Retrieve a configuration key
+        # @param [String] key
+        # @return [String] database uri
+        def get(name)
+          @config[name]
+        end
+
+      end
+    end
+  end
+end
+

data/lib/mongo-sugar/connection/manager.rb

@@ -0,0 +1,50 @@
+require 'singleton'
+
+module Mongo
+  module Sugar
+    module Connection
+
+      #
+      # Manages multiple database connections
+      #
+      class Manager
+        include Singleton
+        attr_reader :connections
+
+        def initialize
+          @connections = {}
+        end
+
+        # Create MongoDB connection
+        #
+        # @param [String] connection name
+        # @param [String] connection URI (optional. default: ENV['MONGODB_URI'])
+        #
+        # @return [Mongo::Sugar::Connection] connection instance
+        def self.create(name, uri=nil)
+          self.instance.connections[name] = Connection.new(Config.instance.get(name) || ENV['MONGODB_URI'])
+        end
+
+        # Get MongoDB connection
+        #
+        # @param [String] connection name
+        #
+        # @return [Mongo::Connection, nil] connection or nil, if connection doesn't have been created
+        def self.get(name)
+          self.instance.connections[name] or self.create(name)
+        end
+
+        # Get database instance
+        #
+        # @param [String] connection name
+        # @param [String] database to connect. (optional, inherit from your database URI, if specified)
+        #
+        # return [Mongo::DB] database instance
+        def self.database(name, database=nil)
+          self.get(name).database(database)
+        end
+      end
+
+    end
+  end
+end

data/lib/mongo-sugar/version.rb

@@ -0,0 +1,6 @@
+
+module Mongo
+  module Sugar
+    VERSION = '0.1'
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,4 @@
+test:
+  default: mongodb://localhost:27017/mongo_sugar_test
+  second: mongodb://localhost:27017/mongo_sugar_test_2
+  third: mongodb://localhost:27017/mongo_sugar_test_3

data/spec/functional/collection.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Mongo::Sugar::Collection do
+  subject { Mongo::Sugar::Collection }
+
+  before(:all) do
+    ENV['MONGODB_URI'] = 'mongodb://localhost:27017/mongo_sugar_test'
+    ENV['MONGODB_CONFIG'] = 'spec/fixtures/config.yml'
+  end
+
+  context "defining collections" do
+
+    it "without #store_in call" do
+      class DummyCollection < subject; end
+      DummyCollection.collection.name.should == 'dummy_collection'
+      DummyCollection.database.name.should == 'mongo_sugar_test'
+    end
+
+    it "change database and collection with #store_in call" do
+      class CustomCollection < subject
+        store_in :collection => 'custom'
+      end
+      CustomCollection.collection.name.should == 'custom'
+      CustomCollection.database.name.should == 'mongo_sugar_test'
+
+      class CustomDatabaseCollection < subject
+        store_in :collection => 'custom', :database => 'mongo_sugar_two'
+      end
+      CustomDatabaseCollection.collection.name.should == 'custom'
+      CustomDatabaseCollection.database.name.should == 'mongo_sugar_two'
+    end
+
+    it "has @collection visible for custom methods" do
+      class IHateFooExamples < subject
+        store_in :collection => 'bazinga_bar'
+        def respond_to_find?
+          @collection.respond_to?(:find)
+        end
+      end
+      IHateFooExamples.collection.name.should == 'bazinga_bar'
+      IHateFooExamples.collection.respond_to_find?.should == true
+    end
+
+    it "specifying another connection" do
+      class AnotherConnection < subject
+        store_in :collection => "another", :connection => 'second'
+      end
+      AnotherConnection.collection.name.should == 'another'
+      AnotherConnection.database.name.should == 'mongo_sugar_test_2'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$: << 'lib'
+
+ENV['RACK_ENV'] = 'test'
+
+require 'bundler/setup'
+require 'simplecov'
+
+SimpleCov.start
+
+require 'rspec'
+require 'mongo-sugar'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: mongo-sugar
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Endel Dreyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Provide a syntatic sugar for MongoDB ruby driver, similar to an ORM.
+email:
+- endel.dreyer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongo-sugar/collection.rb
+- lib/mongo-sugar/connection/config.rb
+- lib/mongo-sugar/connection/manager.rb
+- lib/mongo-sugar/connection.rb
+- lib/mongo-sugar/version.rb
+- lib/mongo-sugar.rb
+- LICENSE
+- README.md
+- spec/fixtures/config.yml
+- spec/functional/collection.rb
+- spec/spec_helper.rb
+homepage: https://github.com/endel/mongo-sugar
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sugar Syntatic for Official MongoDB Driver
+test_files:
+- spec/fixtures/config.yml
+- spec/functional/collection.rb
+- spec/spec_helper.rb
+has_rdoc: