candy 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Stephen Eley
+
+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.rdoc

@@ -0,0 +1,17 @@
+= candy
+
+Description goes here.
+
+== 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 Stephen Eley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "candy"
+    gem.summary = %Q{The simplest MongoDB ORM}
+    gem.description = <<DESCRIPTION
+Candy is a lightweight ORM for the MongoDB database. If MongoMapper is Rails, Candy is Sinatra. 
+It provides a module you mix into any class, enabling the class to connect to Mongo on its own
+and push its objects into a collection. Candied objects act like OpenStructs, allowing attributes
+to be defined and updated in Mongo immediately without having to be declared in the class. 
+Mongo's atomic operators are used whenever possible, and a smart serializer (Candy::Wrapper) 
+converts almost any object for assignment to any attribute.
+DESCRIPTION
+
+    gem.email = "sfeley@gmail.com"
+    gem.homepage = "http://github.com/SFEley/candy"
+    gem.authors = ["Stephen Eley"]
+    gem.add_dependency "mongo", ">= 0.18"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/candy.rb

@@ -0,0 +1,26 @@
+require 'candy/exceptions'
+require 'candy/crunch'
+
+# Mix me into your classes and Mongo will like them!
+module Candy
+  module ClassMethods
+    
+  end
+  
+  module InstanceMethods
+    def initialize(*args, &block)
+      @__candy = self.class.collection.insert({})
+      super
+    end
+
+    def id
+      @id
+    end
+    
+  end
+  
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+end

data/lib/candy/crunch.rb

@@ -0,0 +1,109 @@
+require 'mongo'
+require 'etc'
+
+module Candy
+  
+  # All of the hard crunchy bits that connect us to a collection within a Mongo database.
+  module Crunch
+    module ClassMethods
+      
+      # Passed to the default connection.  It uses the $MONGO_HOST global if that's set and you don't override it.
+      def host
+        @host ||= $MONGO_HOST
+      end
+
+      # Passed to the default connection.  It uses the $MONGO_PORT global if that's set and you don't override it.
+      def port
+        @port ||= $MONGO_PORT
+      end
+      
+      # A hash passed to the default connection. It uses the $MONGO_OPTIONS global if that's set and you don't override it.
+      def options
+        @options ||= ($MONGO_OPTIONS || {})
+      end
+      
+      # Overrides the host and resets the connection, db, and collection.
+      def host=(val)
+        @connection = nil
+        @host = val
+      end
+      
+      # Overrides the port and resets the connection, db, and collection.
+      def port=(val)
+        @connection = nil
+        @port = val
+      end
+
+      # Overrides the options hash and resets the connection, db, and collection.
+      def options=(val)
+        @connection = nil
+        @options = val
+      end
+      
+      # Returns the connection you gave, or creates a default connection to the default host and port.
+      def connection
+        @connection ||= Mongo::Connection.new(host, port, options)
+      end
+       
+      # First clears any collection and database we're talking to, then accepts a connection you provide.
+      # You're responsible for your own host, port and options if you use this.
+      def connection=(val)
+        self.db = nil
+        @connection = val
+      end
+      
+      # First clears any collection we're talking to, then accepts a database you provide. You can provide a 
+      # Mongo::DB object or a string with the database name. If you provide a Mongo::DB object, the default
+      # connection is not used, and the :strict flag should be false or default collection lookup will fail.
+      def db=(val)
+        self.collection = nil
+        case val
+        when Mongo::DB
+          @db = val
+        when String
+          @db = Mongo::DB.new(val, connection)
+        when nil
+          @db = nil
+        else 
+          raise ConnectionError, "The db attribute needs a Mongo::DB object or a name string."
+        end
+      end
+      
+      # Returns the database you gave, or creates a default database named for your username (or 'candy' if it
+      # can't find a username).
+      def db
+        @db ||= Mongo::DB.new($MONGO_DB || Etc.getlogin || 'candy', connection, :strict => false)
+      end
+      
+      # Accepts either a Mongo::Collection object or a string with the collection name.  If you provide a 
+      # Mongo::Collection object, the default database and connection are not used.
+      def collection=(val)
+        case val
+        when Mongo::Collection
+          @collection = val
+        when String
+          @collection = db.create_collection(val)
+        when nil
+          @collection = nil
+        else
+          raise ConnectionError, "The collection attribute needs a Mongo::Collection object or a name string."
+        end
+      end
+      
+      # Returns the collection you gave, or creates a default collection named for the current class.
+      def collection
+        @collection ||= db.create_collection(name)
+      end
+      
+    end
+    
+    module InstanceMethods
+      
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  end
+end

data/lib/candy/exceptions.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+module Candy
+  # Every other exception type falls under CandyError for easy catching.
+  class CandyError < StandardError; end
+    
+  class ConnectionError < CandyError; end
+end

data/spec/candy/crunch_spec.rb

@@ -0,0 +1,151 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'logger'
+
+describe Candy::Crunch do
+  
+  class PeanutBrittle
+    include Candy::Crunch
+  end
+  
+  
+  describe "connection" do
+    before(:each) do
+      # Make sure we don't waste time making bogus connections
+      PeanutBrittle.options[:connect] = false
+    end
+
+    it "takes yours if you give it one" do
+      c = Mongo::Connection.new('example.org', 11111, :connect => false)
+      PeanutBrittle.connection = c
+      PeanutBrittle.connection.nodes.should == [["example.org", 11111]]
+    end
+
+    it "creates the default connection if you don't give it one" do
+      PeanutBrittle.connection.nodes.should == [["localhost", 27017]]
+    end
+    
+    it "uses the host you provide" do
+      PeanutBrittle.host = 'example.org'
+      PeanutBrittle.connection.nodes.should == [["example.org", 27017]]
+    end
+
+    it "uses the port you provide" do
+      PeanutBrittle.host = 'localhost'
+      PeanutBrittle.port = 3000
+      PeanutBrittle.connection.nodes.should == [["localhost", 3000]]
+    end
+
+    it "uses any options you provide" do
+      l = Logger.new(STDOUT)
+      PeanutBrittle.options[:logger] = l
+      PeanutBrittle.connection.logger.should == l
+    end
+
+    it "uses the $MONGO_HOST setting if you don't override it" do
+      $MONGO_HOST = 'example.net'
+      PeanutBrittle.connection.nodes.should == [["example.net", 27017]]
+    end
+
+    it "uses the $MONGO_PORT setting if you don't override it" do
+      PeanutBrittle.host = 'localhost'
+      $MONGO_PORT = 33333
+      PeanutBrittle.connection.nodes.should == [["localhost", 33333]]
+    end
+
+    it "uses the $MONGO_OPTIONS setting if you don't override it" do
+      l = Logger.new(STDOUT)
+      PeanutBrittle.options = nil  # Gotta be careful of our order on this one
+      $MONGO_OPTIONS = {:logger => l, :connect => false}
+      PeanutBrittle.connection.logger.should == $MONGO_OPTIONS[:logger]
+    end   
+    
+    it "clears the database when you set it" do
+      PeanutBrittle.db.name.should == 'candy_test'
+      PeanutBrittle.connection = nil
+      PeanutBrittle.instance_variable_get(:@db).should be_nil
+    end
+
+    after(:each) do
+      $MONGO_HOST = nil
+      $MONGO_PORT = nil
+      $MONGO_OPTIONS = nil
+      PeanutBrittle.host = nil
+      PeanutBrittle.port = nil
+      PeanutBrittle.options = nil
+    end
+  end
+  
+  describe "database" do
+    before(:each) do
+      $MONGO_DB = nil
+    end
+    
+    it "takes yours if you give it one" do
+      d = Mongo::DB.new('test', PeanutBrittle.connection)
+      PeanutBrittle.db = d
+      PeanutBrittle.db.name.should == 'test'
+    end
+  
+    it "takes a name if you give it one" do
+      PeanutBrittle.db = 'crunchy'
+      PeanutBrittle.db.name.should == 'crunchy'
+    end
+  
+    it "throws an exception if you give it a database type it can't recognize" do
+      lambda{PeanutBrittle.db = 5}.should raise_error(Candy::ConnectionError, "The db attribute needs a Mongo::DB object or a name string.")
+    end
+  
+    it "uses the $MONGO_DB setting if you don't override it" do
+      $MONGO_DB = 'foobar'
+      PeanutBrittle.db.name.should == 'foobar'
+    end
+  
+    it "uses your username if you don't give it a default database" do
+      Etc.stubs(:getlogin).returns('nummymuffin')
+      PeanutBrittle.db.name.should == 'nummymuffin'
+    end
+  
+    it "uses 'candy' for a DB name if it can't find a username" do
+      Etc.expects(:getlogin).returns(nil)
+      PeanutBrittle.db.name.should == 'candy'
+    end
+    
+    it "clears the collection when you set it" do
+      PeanutBrittle.db = 'candy_test'
+      PeanutBrittle.collection.name.should == PeanutBrittle.name
+      PeanutBrittle.db = nil
+      PeanutBrittle.instance_variable_get(:@collection).should be_nil
+    end
+    
+    after(:all) do
+      $MONGO_DB = 'candy_test'  # Get back to our starting point
+    end
+  end
+  
+  describe "collection" do
+    it "takes yours if you give it one" do
+      c = Mongo::Collection.new(PeanutBrittle.db, 'blah')
+      PeanutBrittle.collection = c
+      PeanutBrittle.collection.name.should == 'blah'
+    end
+  
+    it "takes a name if you give it one" do
+      PeanutBrittle.collection = 'bleh'
+      PeanutBrittle.collection.name.should == 'bleh'
+    end
+  
+    it "defaults to the class name" do
+      PeanutBrittle.collection.name.should == PeanutBrittle.name
+    end
+  
+    it "throws an exception if you give it a type it can't recognize" do
+      lambda{PeanutBrittle.collection = 17.3}.should raise_error(Candy::ConnectionError, "The collection attribute needs a Mongo::Collection object or a name string.")
+    end
+  
+  end
+  
+  after(:each) do
+    PeanutBrittle.connection = nil
+  end
+  
+end

data/spec/candy_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Candy" do
+  # An example class to contain our methods
+  class Zagnut
+    include Candy
+  end
+  
+  before(:each) do
+    @this = Zagnut.new
+  end
+  
+  it "inserts a document immediately" do
+    @this.id.should be_a(Mongo::ObjectID)
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec.watchr

@@ -0,0 +1,12 @@
+# See: http://github.com/mynyml/watchr/
+
+require 'redgreen'
+require 'autowatchr'
+
+Autowatchr.new(self) do |config|
+  config.test_dir = 'spec'
+  config.test_re = "^#{config.test_dir}/(.*)_spec\.rb$"
+  config.test_file = '%s_spec.rb'
+end
+# watch ( 'spec/.*_spec\.rb' ) { |spec| system("ruby #{spec[0]}")}
+# watch ( 'lib/(.*).rb' ) { |lib| system("ruby spec/#{spec[1]}_spec.rb")}

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'candy'
+require 'spec'
+require 'spec/autorun'
+require 'mocha'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+  
+  config.before(:all) do
+    $MONGO_DB = 'candy_test'
+  end
+    
+  config.after(:all) do
+    c = Mongo::Connection.new
+    c.drop_database('candy_test')
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: candy
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stephen Eley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-20 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.18"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+description: |
+  Candy is a lightweight ORM for the MongoDB database. If MongoMapper is Rails, Candy is Sinatra. 
+  It provides a module you mix into any class, enabling the class to connect to Mongo on its own
+  and push its objects into a collection. Candied objects act like OpenStructs, allowing attributes
+  to be defined and updated in Mongo immediately without having to be declared in the class. 
+  Mongo's atomic operators are used whenever possible, and a smart serializer (Candy::Wrapper) 
+  converts almost any object for assignment to any attribute.
+
+email: sfeley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/candy.rb
+- lib/candy/crunch.rb
+- lib/candy/exceptions.rb
+- spec/candy/crunch_spec.rb
+- spec/candy_spec.rb
+- spec/spec.opts
+- spec/spec.watchr
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/SFEley/candy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: The simplest MongoDB ORM
+test_files: 
+- spec/candy/crunch_spec.rb
+- spec/candy_spec.rb
+- spec/spec_helper.rb