mingo 0.3.2 → 0.4.0

data/lib/mingo.rb

@@ -1,7 +1,6 @@
 require 'active_support/core_ext/hash/conversions'
 require 'mongo'
 require 'active_model'
-require 'hashie/dash'
 
 BSON::ObjectId.class_eval do
   def self.[](id)
@@ -13,14 +12,15 @@ BSON::ObjectId.class_eval do
   end
 end
 
-class Mingo < Hashie::Dash
+class Mingo < Hash
   include ActiveModel::Conversion
   extend ActiveModel::Translation
   
+  autoload :Properties,   'mingo/properties'
   autoload :Cursor,       'mingo/cursor'
   autoload :Connection,   'mingo/connection'
   autoload :Finders,      'mingo/finders'
-  autoload :ManyProxy,    'mingo/many_proxy'
+  autoload :Many,         'mingo/many_proxy'
   autoload :Persistence,  'mingo/persistence'
   autoload :Callbacks,    'mingo/callbacks'
   autoload :Changes,      'mingo/changes'
@@ -29,29 +29,20 @@ class Mingo < Hashie::Dash
   
   extend Connection
   extend Finders
-
   # highly experimental stuff
-  def self.many(property, *args, &block)
-    proxy_class = block_given?? Class.new(ManyProxy, &block) : ManyProxy
-    ivar = "@#{property}"
-    
-    define_method(property) {
-      (instance_variable_defined?(ivar) && instance_variable_get(ivar)) ||
-        instance_variable_set(ivar, proxy_class.new(self, property, *args))
-    }
-  end
-  
-  include Module.new {
-    def initialize(obj = nil)
-      if obj and obj['_id'].is_a? BSON::ObjectId
-        # a doc loaded straight from the db
-        merge!(obj)
-      else
-        super
+  extend Many
+
+  def initialize(obj = nil)
+    super()
+    if obj
+      # a doc loaded straight from the db?
+      if obj['_id'].is_a? BSON::ObjectId then merge!(obj)
+      else obj.each { |prop, value| self.send("#{prop}=", value) }
       end
     end
-  }
-  
+  end
+
+  include Properties
   include Persistence
   include Callbacks
   include Changes
@@ -60,219 +51,7 @@ class Mingo < Hashie::Dash
     self['_id']
   end
   
-  # overwrite these to avoid checking for declared properties
-  # (which is default behavior in Dash)
-  def [](property)
-    _regular_reader(property.to_s)
-  end
-
-  def []=(property, value)
-    _regular_writer(property.to_s, value)
-  end
-  
-  # keys are already strings
-  def stringify_keys() self end
-  alias :stringify_keys! :stringify_keys
-  
   def ==(other)
     other.is_a?(self.class) and other.id == self.id
   end
 end
-
-if $0 == __FILE__
-  require 'rspec'
-  
-  Mingo.connect('mingo')
-
-  class User < Mingo
-    property :name
-    property :age
-  end
-  
-  describe User do
-    before :all do
-      User.collection.remove
-    end
-    
-    it "obtains an ID by saving" do
-      user = build :name => 'Mislav'
-      user.should_not be_persisted
-      user.id.should be_nil
-      user.save
-      raw_doc(user.id)['name'].should == 'Mislav'
-      user.should be_persisted
-      user.id.should be_a(BSON::ObjectId)
-    end
-    
-    it "tracks changes attribute" do
-      user = build
-      user.should_not be_changed
-      user.name = 'Mislav'
-      user.should be_changed
-      user.changes.keys.should include(:name)
-      user.name = 'Mislav2'
-      user.changes[:name].should == [nil, 'Mislav2']
-      user.save
-      user.should_not be_changed
-    end
-    
-    it "forgets changed attribute when reset to original value" do
-      user = create :name => 'Mislav'
-      user.name = 'Mislav2'
-      user.should be_changed
-      user.name = 'Mislav'
-      user.should_not be_changed
-    end
-    
-    it "has a human model name" do
-      described_class.model_name.human.should == 'User'
-    end
-    
-    it "can reload values from the db" do
-      user = create :name => 'Mislav'
-      user.update '$unset' => {:name => 1}, '$set' => {:age => 26}
-      user.age.should be_nil
-      user.reload
-      user.age.should == 26
-      user.name.should be_nil
-    end
-    
-    it "saves only changed values" do
-      user = create :name => 'Mislav', :age => 26
-      user.update '$inc' => {:age => 1}
-      user.name = 'Mislav2'
-      user.save
-      user.reload
-      user.name.should == 'Mislav2'
-      user.age.should == 27
-    end
-    
-    it "unsets values set to nil" do
-      user = create :name => 'Mislav', :age => 26
-      user.age = nil
-      user.save
-
-      raw_doc(user.id).tap do |doc|
-        doc.should_not have_key('age')
-        doc.should have_key('name')
-      end
-    end
-    
-    context "existing doc" do
-      before do
-        @id = described_class.collection.insert :name => 'Mislav', :age => 26
-      end
-      
-      it "finds a doc by string ID" do
-        user = described_class.first(@id.to_s)
-        user.id.should == @id
-        user.name.should == 'Mislav'
-        user.age.should == 26
-      end
-    
-      it "is unchanged after loading" do
-        user = described_class.first(@id)
-        user.should_not be_changed
-        user.age = 27
-        user.should be_changed
-        user.changes.keys.should == [:age]
-      end
-    
-      it "doesn't get changed by an inspect" do
-        user = described_class.first(@id)
-        # triggers AS stringify_keys, which dups the Dash and writes to it,
-        # which mutates the @changes hash from the original Dash
-        user.inspect
-        user.should_not be_changed
-      end
-    end
-    
-    it "returns nil for non-existing doc" do
-      doc = described_class.first('nonexist' => 1)
-      doc.should be_nil
-    end
-    
-    it "compares with another record" do
-      one = create :name => "One"
-      two = create :name => "Two"
-      one.should_not == two
-      
-      one_dup = described_class.first(one.id)
-      one_dup.should == one
-    end
-    
-    it "returns a custom cursor" do
-      cursor = described_class.collection.find({})
-      cursor.should respond_to(:empty?)
-    end
-    
-    context "cursor reverse" do
-      it "can't reverse no order" do
-        lambda {
-          described_class.find({}).reverse
-        }.should raise_error
-      end
-
-      it "reverses simple order" do
-        cursor = described_class.find({}, :sort => :name).reverse
-        cursor.order.should == [[:name, -1]]
-      end
-
-      it "reverses simple desc order" do
-        cursor = described_class.find({}, :sort => [:name, :desc]).reverse
-        cursor.order.should == [[:name, 1]]
-      end
-
-      it "reverses simple nested desc order" do
-        cursor = described_class.find({}, :sort => [[:name, :desc]]).reverse
-        cursor.order.should == [[:name, 1]]
-      end
-
-      it "can't reverse complex order" do
-        lambda {
-          described_class.find({}, :sort => [[:name, :desc], [:other, :asc]]).reverse
-        }.should raise_error
-      end
-
-      it "reverses find by ids" do
-        cursor = described_class.find([1,3,5]).reverse
-        cursor.selector.should == {:_id => {"$in" => [5,3,1]}}
-      end
-    end
-    
-    context "find by ids" do
-      before :all do
-        @docs = [create, create, create]
-        @doc1, @doc2, @doc3 = *@docs
-      end
-
-      it "orders results by ids" do
-        results = described_class.find([@doc3.id, @doc1.id, @doc2.id]).to_a
-        results.should == [@doc3, @doc1, @doc2]
-      end
-
-      it "handles limit + skip" do
-        cursor = described_class.find([@doc3.id, @doc1.id, @doc2.id]).limit(1).skip(2)
-        cursor.to_a.should == [@doc2]
-      end
-
-      it "returns correct count" do
-        cursor = described_class.find([@doc3.id, @doc1.id, @doc2.id]).limit(1).skip(2)
-        cursor.next_document
-        cursor.count.should == 3
-      end
-    end
-    
-    def build(*args)
-      described_class.new(*args)
-    end
-    
-    def create(*args)
-      described_class.create(*args)
-    end
-    
-    def raw_doc(selector)
-      described_class.first(selector, :transformer => nil)
-    end
-  end
-end

data/lib/mingo/changes.rb

@@ -10,20 +10,20 @@ class Mingo
       @changes = {}
       super
     end
+
+    def []=(key, value)
+      record_change(key, value)
+      super
+    end
     
     def changed?
       changes.any?
     end
     
     private
-    
-    def _regular_writer(key, value)
-      track_change(key, value)
-      super
-    end
 
-    def track_change(key, value)
-      old_value = _regular_reader(key)
+    def record_change(key, value)
+      old_value = self[key]
       unless value == old_value
         memo = (changes[key.to_sym] ||= [old_value])
         memo[0] == value ? changes.delete(key.to_sym) : (memo[1] = value)
@@ -34,8 +34,6 @@ class Mingo
       changes.clear
     end
     
-    private
-    
     def values_for_update
       changes.inject('$set' => {}, '$unset' => {}) do |doc, (key, values)|
         value = values[1]

data/lib/mingo/many_proxy.rb

@@ -1,4 +1,16 @@
 class Mingo
+  module Many
+    def many(property, *args, &block)
+      proxy_class = block_given?? Class.new(ManyProxy, &block) : ManyProxy
+      ivar = "@#{property}"
+
+      define_method(property) {
+        (instance_variable_defined?(ivar) && instance_variable_get(ivar)) ||
+        instance_variable_set(ivar, proxy_class.new(self, property, *args))
+      }
+    end
+  end
+
   class ManyProxy
     def self.decorate_with(mod = nil, &block)
       if mod or block_given?

data/lib/mingo/properties.rb

@@ -0,0 +1,64 @@
+require 'active_support/concern'
+
+class Mingo
+  module Properties
+    extend ActiveSupport::Concern
+
+    included do
+      instance_variable_set('@properties', Array.new)
+    end
+
+    module ClassMethods
+      attr_reader :properties
+
+      def property(name, options = {})
+        self.properties << name.to_sym
+
+        setter_name = "#{name}="
+        unless method_defined?(setter_name)
+          class_eval <<-RUBY, __FILE__, __LINE__
+            def #{name}(&block)
+              self.[](#{name.to_s.inspect}, &block)
+            end
+
+            def #{setter_name}(value)
+              self.[]=(#{name.to_s.inspect}, value)
+            end
+          RUBY
+        end
+
+        if defined? @subclasses
+          @subclasses.each { |klass| klass.property(property_name, options) }
+        end
+      end
+
+      def inherited(klass)
+        super
+        (@subclasses ||= Array.new) << klass
+        klass.instance_variable_set('@properties', self.properties.dup)
+      end
+    end
+
+    def inspect
+      str = "<##{self.class.to_s}"
+      str << self.class.properties.map { |p| " #{p}=#{self.send(p).inspect}" }.join('')
+      str << '>'
+    end
+
+    def [](field, &block)
+      super(field.to_s, &block)
+    end
+
+    def []=(field, value)
+      super(field.to_s, value)
+    end
+
+    def to_hash
+      Hash.new.replace(self)
+    end
+
+    # keys are already strings
+    def stringify_keys!() self end
+    def stringify_keys() stringify_keys!.dup end
+  end
+end

data/spec/mingo_spec.rb

@@ -0,0 +1,196 @@
+require 'rspec/autorun'
+require 'mingo'
+
+Mingo.connect('mingo')
+
+class User < Mingo
+  property :name
+  property :age
+end
+
+describe User do
+  before :all do
+    User.collection.remove
+  end
+  
+  it "obtains an ID by saving" do
+    user = build :name => 'Mislav'
+    user.should_not be_persisted
+    user.id.should be_nil
+    user.save
+    raw_doc(user.id)['name'].should == 'Mislav'
+    user.should be_persisted
+    user.id.should be_a(BSON::ObjectId)
+  end
+  
+  it "tracks changes attribute" do
+    user = build
+    user.should_not be_changed
+    user.name = 'Mislav'
+    user.should be_changed
+    user.changes.keys.should include(:name)
+    user.name = 'Mislav2'
+    user.changes[:name].should == [nil, 'Mislav2']
+    user.save
+    user.should_not be_changed
+  end
+  
+  it "forgets changed attribute when reset to original value" do
+    user = create :name => 'Mislav'
+    user.name = 'Mislav2'
+    user.should be_changed
+    user.name = 'Mislav'
+    user.should_not be_changed
+  end
+  
+  it "has a human model name" do
+    described_class.model_name.human.should == 'User'
+  end
+  
+  it "can reload values from the db" do
+    user = create :name => 'Mislav'
+    user.update '$unset' => {:name => 1}, '$set' => {:age => 26}
+    user.age.should be_nil
+    user.reload
+    user.age.should == 26
+    user.name.should be_nil
+  end
+  
+  it "saves only changed values" do
+    user = create :name => 'Mislav', :age => 26
+    user.update '$inc' => {:age => 1}
+    user.name = 'Mislav2'
+    user.save
+    user.reload
+    user.name.should == 'Mislav2'
+    user.age.should == 27
+  end
+  
+  it "unsets values set to nil" do
+    user = create :name => 'Mislav', :age => 26
+    user.age = nil
+    user.save
+
+    raw_doc(user.id).tap do |doc|
+      doc.should_not have_key('age')
+      doc.should have_key('name')
+    end
+  end
+  
+  context "existing doc" do
+    before do
+      @id = described_class.collection.insert :name => 'Mislav', :age => 26
+    end
+    
+    it "finds a doc by string ID" do
+      user = described_class.first(@id.to_s)
+      user.id.should == @id
+      user.name.should == 'Mislav'
+      user.age.should == 26
+    end
+  
+    it "is unchanged after loading" do
+      user = described_class.first(@id)
+      user.should_not be_changed
+      user.age = 27
+      user.should be_changed
+      user.changes.keys.should == [:age]
+    end
+  
+    it "doesn't get changed by an inspect" do
+      user = described_class.first(@id)
+      # triggers AS stringify_keys, which dups the Dash and writes to it,
+      # which mutates the @changes hash from the original Dash
+      user.inspect
+      user.should_not be_changed
+    end
+  end
+  
+  it "returns nil for non-existing doc" do
+    doc = described_class.first('nonexist' => 1)
+    doc.should be_nil
+  end
+  
+  it "compares with another record" do
+    one = create :name => "One"
+    two = create :name => "Two"
+    one.should_not == two
+    
+    one_dup = described_class.first(one.id)
+    one_dup.should == one
+  end
+  
+  it "returns a custom cursor" do
+    cursor = described_class.collection.find({})
+    cursor.should respond_to(:empty?)
+  end
+  
+  context "cursor reverse" do
+    it "can't reverse no order" do
+      lambda {
+        described_class.find({}).reverse
+      }.should raise_error
+    end
+
+    it "reverses simple order" do
+      cursor = described_class.find({}, :sort => :name).reverse
+      cursor.order.should == [[:name, -1]]
+    end
+
+    it "reverses simple desc order" do
+      cursor = described_class.find({}, :sort => [:name, :desc]).reverse
+      cursor.order.should == [[:name, 1]]
+    end
+
+    it "reverses simple nested desc order" do
+      cursor = described_class.find({}, :sort => [[:name, :desc]]).reverse
+      cursor.order.should == [[:name, 1]]
+    end
+
+    it "can't reverse complex order" do
+      lambda {
+        described_class.find({}, :sort => [[:name, :desc], [:other, :asc]]).reverse
+      }.should raise_error
+    end
+
+    it "reverses find by ids" do
+      cursor = described_class.find([1,3,5]).reverse
+      cursor.selector.should == {:_id => {"$in" => [5,3,1]}}
+    end
+  end
+  
+  context "find by ids" do
+    before :all do
+      @docs = [create, create, create]
+      @doc1, @doc2, @doc3 = *@docs
+    end
+
+    it "orders results by ids" do
+      results = described_class.find([@doc3.id, @doc1.id, @doc2.id]).to_a
+      results.should == [@doc3, @doc1, @doc2]
+    end
+
+    it "handles limit + skip" do
+      cursor = described_class.find([@doc3.id, @doc1.id, @doc2.id]).limit(1).skip(2)
+      cursor.to_a.should == [@doc2]
+    end
+
+    it "returns correct count" do
+      cursor = described_class.find([@doc3.id, @doc1.id, @doc2.id]).limit(1).skip(2)
+      cursor.next_document
+      cursor.count.should == 3
+    end
+  end
+  
+  def build(*args)
+    described_class.new(*args)
+  end
+  
+  def create(*args)
+    described_class.create(*args)
+  end
+  
+  def raw_doc(selector)
+    described_class.first(selector, :transformer => nil)
+  end
+end

metadata

@@ -1,44 +1,37 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mingo
-version: !ruby/object:Gem::Version
-  version: 0.3.2
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.4.0
 platform: ruby
-authors:
-- Mislav Marohnić
+authors: 
+- "Mislav Marohni\xC4\x87"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-19 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-07-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: mongo
-  requirement: &70206780980160 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
   prerelease: false
-  version_requirements: *70206780980160
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: &70206780979680 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.4.0
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.3"
   type: :runtime
-  prerelease: false
-  version_requirements: *70206780979680
+  version_requirements: *id001
 description: Mingo is a minimal document-object mapper for MongoDB.
 email: mislav.marohnic@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - Rakefile
 - lib/mingo/callbacks.rb
 - lib/mingo/changes.rb
@@ -48,30 +41,36 @@ files:
 - lib/mingo/many_proxy.rb
 - lib/mingo/pagination.rb
 - lib/mingo/persistence.rb
+- lib/mingo/properties.rb
 - lib/mingo/timestamps.rb
 - lib/mingo.rb
+- spec/mingo_spec.rb
 homepage: http://github.com/mislav/mingo
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Minimal Mongo
 test_files: []
+