mongorilla 0.1.2

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Takeshi Morita
+
+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,189 @@
+= mongorilla
+
+mongorilla is very small Object Document Mapper for mongo.
+mongorilla can update atomic  with condition.
+mongorilla accept single server or Master/Slave or Replica Set
+
+=== sample
+  Mongorilla::Collection.build("/var/www/mongo_config.yml") #only one time when boot
+  class User 
+    UserFields = [:_id,:name,:password,:logs,:log_count]
+    include Mongorilla::Document
+  end
+  user = User.create(:name => "morita",:password => "pass")
+  u = User.find(user.id)   # find by id
+  u = User.find({:name => "morita"},:master=>true)[0] #find user named morita for master db (if you want avoid slave time lag)
+  u.password = "hello"   #change attribute whithout update db yet 
+  u.push("logs","ooooo") #$push whithout update db yet 
+  u.inc("log_count",1)   #$inc whithout update db yet 
+  u.save                 #update above change to db
+  u.push("logs","bb")    #$push whithout update db yet 
+  u.push("logs","cc")    #$push whithout update db yet 
+  p u.logs               # ["ooooo","bb","cc"]
+  u.inc("log_count",2)   #$inc +2 whithout update db yet 
+  p u.log_count          # 3
+  ret = u.save({:log_count => {"$lt" => 1}},Mongorilla::Document::SYNC) #update failed because log_count was 1.
+  p ret                  # false
+  p u.logs               # ["ooooo"]
+  p u.log_count          # 1
+  u.pull("logs","ooooo") #$pull whithout update db yet 
+  p u.logs               #["ooooo"] $pull is not reflect object because pull can be complex when embedded or $gt etc.
+  ret = u.save(Mongorilla::Document::RELOAD) #update success and reflect object because reload was specified.
+  p ret                  #true
+  p user.logs            # []                    
+
+=== config
+  #single server
+  host: localhost
+  port: 27017
+  database: dev
+  
+  #Master/Slave
+  host: localhost
+  port: 27017
+  database: dev
+  slaves:
+    - host: localhost
+      port: 27018
+  
+  #replica Set
+  hosts
+    - -  localhost
+      -  27017
+    - -  localhost
+      -  27018
+  database: dev
+
+=== syntax
+  1. Connect Server below statement when boot application
+    Mongorilla::Collection.build("/var/www/mongo_config.yml")
+  2. create document class and define constant class name + Fields with document fields and include Mongorilla::Document.
+    class Class
+      ClassNameFields = [:_id,...]
+      include Mongorilla::Document
+    end
+
+==== Class.create(attributes)
+  args:
+    attributes     hash for document
+
+  description:
+    set attributes to db and return new Object
+
+==== Class.collection
+  description:
+    get mongodb collection
+
+=== Class.find_one(cond,opt)
+  args:
+    cond    condition {:logcount => {"$gt" => 2}} etc. 
+    opt     option master => true then find master db other option see mongo driver  {:master => true,:fields => [:name]} etc.
+  description:
+    find one match object. if not exitst,return nil
+
+=== Class.find(cond,opt)
+  args:
+    cond    condition {:logcount => {"$gt" => 2}} etc. if cond is String or BSON::ObjectId then search _id and return one object.
+    opt     option master => true then find master db other option see mongo driver  {:master => true,:fields => [:name]} etc.
+  description:
+    return  match objects array. if not exitst,return nil
+
+=== #set(k,v)
+  args:
+    k   field name for $set
+    v   value for $set
+  description:
+    modify object attribute and modify @change for save. this method does not reflect db.
+  
+=== #inc(k,v)
+  args:
+    k   field name for $inc
+    v   amount for $inc. it is possible less than 0.
+  description:
+    modify object attribute and modify @change for save. this method does not reflect db.
+
+=== #push(k,v)
+  args:
+    k   field name for $push
+    v   value for $push
+  description:
+    modify object attribute and modify @change for save. this method does not reflect db.
+
+=== #unset(k)
+  args:
+    k   field name for $unset
+  description:
+    modify object attribute and modify @change for save. this method does not reflect db.
+
+=== #push_all(k,v)
+  args:
+    k   field name for $pushAll
+    v   value for $pushAll
+  description:
+    modify object attribute and modify @change for save. this method does not reflect db.
+
+=== #add_to_set(k,v)
+  args:
+    k   field name for $addToSet
+    v   value for $addToSet
+  description:
+    modify object attribute and modify @change for save. this method does not reflect db.
+
+=== #pop(k,v)
+  args:
+    k   field name for $pop
+    v   value if less than 0 remove first else remove tail
+  description:
+    modify object attribute and modify @change for save. this method does not reflect db.
+
+=== #pull(k,v)
+  args:
+    k   field name for $pull
+    v   value for $pull
+  description:
+    modify @change for save. this method does not reflect object and db.
+
+=== #pull_all(k,v)
+  args:
+    k   field name for $pullAll
+    v   value for $pullAll
+  description:
+    modify @change for save. this method does not reflect object and db.
+
+=== #save(cond,opt,mode)
+  args:
+    cond  condition(optional) {:count => {$lt => 20}} etc.
+    opt   option(optional) see mongdb driver {:upsert => true} etc.
+    mode  Mongorilla::Document::SYNC(default) or Mongorilla::Document::ASYNC or Mongorilla::Document::RELOAD
+          SYNC  is specified,check result,RELOAD is specified,check result and fetch update record from db,
+          ASYNC is specified,does not check result.
+
+  description:
+    reflect @change to DB
+
+=== #delete
+  description:
+    remove object from db
+
+=== #reset
+  description:
+    discard @changes and reset object to original
+
+=== #reload
+  description:
+    fetch record from db.
+
+== Contributing to mongorilla
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Takeshi Morita. See LICENSE.txt for
+further details.

data/lib/mongorilla/collection.rb

@@ -0,0 +1,132 @@
+require 'yaml'
+require 'mongo'
+module Mongorilla
+  class Collection
+    @@master = nil
+    @@slaves = nil
+    @@slave_index = 0
+    @@config = nil
+
+    def self.master
+      @@master
+    end
+
+    def self.slaves
+      @@slaves
+    end
+
+    def self.config
+      @@config
+    end
+
+    def self.load_config(path)
+      @@config = YAML.load(File.read(path))
+    end
+
+    def self.build(path=File.expand_path("../config.yml",__FILE__))
+      load_config(path)
+      @@config["max_retries"] ||= 10
+      @@config["meantime"] ||= 0.5
+      if @@config["hosts"]
+        @@master = Mongo::ReplSetConnection.new(*@@config["hosts"]).db(@@config["database"])
+      elsif @@config["slaves"]
+        @@master = Mongo::Connection.new(@@config["host"],@@config["port"]).db(@@config["database"])
+        @@slaves = @@config["slaves"].map{|s| Mongo::Connection.new(s["host"],s["port"]).db(@@config["database"])}
+      else
+        host = @@config["host"] ? @@config["host"] : "localhost"
+        port = @@config["port"] ? @@config["port"].to_i : 27017
+        @@master = Mongo::Connection.new(host,port).db(@@config["database"])
+      end
+    end
+
+    def r_col
+      if @@slaves
+        @@slave_index += 1
+        @@slaves[@@slave_index % @@slaves.length][@name]
+      else
+        @@master[@name]
+      end
+    end
+
+    def w_col
+      @@master[@name]
+    end
+
+    def initialize(collection_name)
+      @name = collection_name
+    end
+
+    def find_one(cond={},opt={})
+      opt[:limit] = 1
+      if cond.is_a?(String) || cond.is_a?(BSON::ObjectId)
+        cond = BSON::ObjectId(cond) if cond.is_a?(String)
+        cond = {:_id => cond}
+      end
+      ret = find(cond,opt)
+      ret.first
+    end
+
+    def count(cond={},opt={})
+      find(cond,opt).count
+    end
+
+    def find(cond={},opt={})
+      if opt[:master] || opt["master"]
+        opt.delete(:master)
+        opt.delete("master")
+        if @@config["hosts"]
+          opt[:read] = :primary
+        end
+        rescue_connection_failure do
+          w_col.find(cond,opt)
+        end
+      else
+        if @@config["hosts"] && @@config["read_secondary"]
+          opt[:read] = :secondary
+        end
+        begin
+          rescue_connection_failure do
+            r_col.find(cond,opt)
+          end
+        rescue
+          w_col.find(cond,opt)
+        end
+      end
+    end
+
+    def insert(data,opt={})
+      rescue_connection_failure do
+        w_col.insert(data,opt)
+      end
+    end
+
+    def update(cond,data,opt)
+      rescue_connection_failure do
+        w_col.update(cond,data,opt)
+      end
+    end
+
+    def remove(cond={},opt={})
+      if cond.is_a? String
+        cond = {:_id => BSON::ObjectId(cond)}
+      elsif cond.is_a? BSON::ObjectId
+        cond = {:_id => cond}
+      end
+      rescue_connection_failure do
+        w_col.remove(cond,opt)
+      end
+    end
+
+    def rescue_connection_failure(max_retries=@@config["max_retries"])
+      retries = 0
+      begin
+        yield
+      rescue Mongo::ConnectionFailure => ex
+        retries += 1
+        raise ex if retries > max_retries
+        sleep(@@config["meantime"])
+        retry
+      end
+    end
+  end
+end

data/lib/mongorilla/document.rb

@@ -0,0 +1,217 @@
+require File.expand_path("../collection.rb",__FILE__)
+module Mongorilla
+  module Document
+    RELOAD = :reload
+    SYNC = :sync
+    ASYNC = :async
+    def self.pluralize(name)
+      underscore_name = name.gsub(/^[A-Z]/){|m| "_" + m.downcase}[1 .. -1]
+      case underscore_name
+      when /(s|ss|sh|ch|o|x)$/
+        underscore_name + "es"
+      when /[^aeiou]y$/
+        underscore_name[0 .. -2] + "ies"
+      when /(f|fe)$/
+        underscore_name.gsub(/(f|fe)$/){|m| "ves"}
+      when /child$/
+        underscore_name + "en"
+      when /foot$/
+        underscore_name.gsub(/foot$/){|m| "feet"}
+      when /tooth$/
+        underscore_name.gsub(/tooth$/){|m| "teeth"}
+      when /man$/
+        underscore_name.gsub(/man$/){|m| "men"}
+      when /woman$/
+        underscore_name.gsub(/woman$/){|m| "women"}
+      else
+        underscore_name + "s"
+      end
+    end
+
+    def self.included(c)
+      fields = c.const_get("#{c}Fields")
+      fields.each do |f|
+        define_method(f) {@doc[f.to_s] }
+        define_method(f.to_s + "="){|v| set(f.to_s,v);}
+      end
+      alias_method :id,:_id
+      col_name = pluralize(c.to_s)
+      @@col = Collection.new(col_name)
+
+      def initialize(doc)
+        @orig = doc.dup
+        @doc = doc
+        @changes={}
+      end
+
+      def changes
+        @changes
+      end
+
+      def set(f,v)
+        send(f)
+        @doc[f] = v
+        @changes["$set"] ||= {}
+        @changes["$set"][f] = v
+      end
+
+      def inc(f,v)
+        @doc[f] = 0 unless send(f)
+        @doc[f] += v
+        @changes["$inc"] ||= {}
+        @changes["$inc"][f] = v
+      end
+
+      def push(f,v)
+        @doc[f] = [] unless send(f)
+        @doc[f].push(v)
+        @changes["$push"] ||= {}
+        @changes["$push"][f] = v
+      end
+
+      def unset(f)
+        @doc.delete(f)
+        @changes["$unset"] ||= {}
+        @changes["$unset"][f] = 1
+      end
+
+      def push_all(f,v)
+        if send(f)
+          @doc[f] += v
+        else
+          @doc[f] = v
+        end
+        @changes["$pushAll"] ||= {}
+        @changes["$pushAll"][f] = v
+      end
+
+      def add_to_set(f,v)
+        if v.is_a? Hash
+          values = v["$each"]
+        else
+          values = [v]
+        end
+        values.each do|val|
+          if send(f)
+            @doc[f].push(val) unless @doc[f].find{|r| r == val}
+          else
+            @doc[f] = [val]
+          end
+        end
+        @changes["$addToSet"] ||= {}
+        @changes["$addToSet"][f] = v
+      end
+
+      def pop(f,v)
+        @changes["$pop"] ||= {}
+        @changes["$pop"][f] = v
+        if v > 0
+          send(f).pop
+        else
+          send(f).shift
+        end
+      end
+
+      def pull(f,v)
+        @changes["$pull"] ||= {}
+        @changes["$pull"][f] = v
+      end
+
+      def pull_all(f,v)
+        @changes["$pull_all"] ||= {}
+        @changes["$pull_all"][f] = v
+      end
+
+      def save(*args)
+        cond = {}
+        opt = {}
+        mode = SYNC
+        args.each do|arg|
+          if arg.is_a?(Symbol)
+            mode = arg
+          elsif cond == {} 
+            cond = arg
+          else
+            opt = arg
+          end
+        end
+        opt[:safe] = true if [SYNC,RELOAD].include?(mode)
+        if @changes
+          ret = @@col.update(cond,@changes,opt)
+          if opt[:safe] && ret["n"] != 1
+            reset
+            return false
+          end
+        end
+        if mode == RELOAD
+          reload
+        end
+        @orig = @doc.dup
+        @changes={}
+        true
+      end
+
+      def reset
+        @changes={}
+        @doc = @orig.dup
+      end
+
+      def delete
+        self.class.remove(:_id => id)
+      end
+
+      def reload
+        @changes={}
+        @doc = @@col.find_one(id,:master => true)
+        @orig = @doc.dup
+      end
+
+      def c.collection
+        @@col
+      end
+
+      def c.create(data,opt={})
+        if opt == {}
+          opt[:safe] = true
+        end
+        ret = @@col.insert(data,opt)
+        if ret.is_a? Array
+          ret.map{|uid| find(uid,:master=>true)}
+        elsif ret
+          find(ret,:master=>true)
+        end
+      end
+
+      def c.find_one(cond,opt={})
+        ret = @@col.find_one(cond,opt)
+        if ret
+          return self.new(ret)
+        else
+          return nil
+        end
+      end
+
+      def c.count(cond={},opt={})
+        @@col.count(cond,opt)
+      end
+
+      def c.find(cond={},opt={})
+        if !cond.is_a? Hash
+          find_one(cond,opt)
+        else
+          ret = @@col.find(cond,opt)
+          return nil if ret.count == 0
+          ret.map{|r| self.new(r)}
+        end
+      end
+
+      def c.update(cond,data,opt={})
+        @@col.update(cond,data,opt)
+      end
+
+      def c.remove(cond={},opt={})
+        @@col.remove(cond,opt)
+      end
+    end
+  end
+end

data/lib/mongorilla.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mongorilla/collection'
+require 'mongorilla/document'
+module Mongorilla
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: mongorilla
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Takeshi Morita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: &16529460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *16529460
+- !ruby/object:Gem::Dependency
+  name: mongo_ext
+  requirement: &16528040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *16528040
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &16526160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *16526160
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &16540780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *16540780
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &16538560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *16538560
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &16535020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16535020
+description: Small Object Document Mapper for Mongo. you can update atomic  with condition
+email: laten@nifty.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- lib/mongorilla.rb
+- lib/mongorilla/collection.rb
+- lib/mongorilla/document.rb
+- LICENSE.txt
+- README.rdoc
+homepage: http://github.com/takeshy/mongorilla
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1915061905546845040
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Small Object Document Mapper for Mongo
+test_files: []