mongoid-crud 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7086bf12049b8739ecbc8aeedeefb60c897087d
-  data.tar.gz: 24afb72a0b0710c5e8fde42360515d4f7d506300
+  metadata.gz: fbce96459af1c57f5b98d2bf14e933707ad3ae8d
+  data.tar.gz: 1e31e3cad5d3ba14800bfab0af3091a9f1669ec7
 SHA512:
-  metadata.gz: e1c752a14299e935071f1709c9c37db4da4f7dc865b9680c91ba841acab4fc54a42e85e2a032f0fdb454737e0a08d15b216f721e646118cfbae1927d7e222e76
-  data.tar.gz: b7ba1bb51b0d702657268ee22ad69a0ff10b9ae0538484fd5377bcbd5c19f116ac2df837926c5cfc6221c9b01b733a9a72f6fce2842204939e3eb1181f898391
+  metadata.gz: 0c4ebe35f65019622ab0489d7cd3a07ccd6ffe7b3c42de76291fa6d29b25500bbf2b333ee19f5a53e4ff886039cc55df8a32805b597bda07a685739111498b3c
+  data.tar.gz: 18a995f01c8bb2c14dee9e192d6d39dd5ab90ab633bf9a03efae312c1f2e740c87eb9a26e56d8cb7849e18b31dd64fe28bcaf8662d99afa07b13dc2c620048fe

data/README.md

@@ -1,23 +1,73 @@
 mongoid-crud
 ============
 
-CRUD methods for mongoid
+CRUD methods for mongoid models
+
+## Four method to rule them all!
+
 Four super simple to use method on any mongoid model.
 
+
 ```ruby
+    __create__ || _create
+    __read__   || _read
+    __update__ || _update
+    __delete__ || _delete
+```
+### Behavior
 
-    __create__
-    __read__
-    __update__
-    __delete__
+create:
+* if the model is an embeds it require a parent_id passed by "parent_id" or :parent_id key
+    * same goes for the referenced
+* if the model is a main one it's the same as normaly, pass the hash obj
+
+read:
+* if the model embeds or referenced you MAY tell the parent_id but you dont have to
+    * in that case every doc that match the query hash will be returned in an array
+* if you give _id than it will the object (even if it's embedded deeply in mordor)
+* if you pass parent_id but no _id it will return a mongoid criteria with the collection of finds under the specified parent
+
+update:
+* you must give the _id for the target obj and any other hash tag will be the values to be set
+
+delete:
+* you must give the _id for delete the target obj
+    * if you want drop a collection from a parent i suggest to use read + _id to find that object and give direct order to drop the embeds/reference collection
 
-```
 
 ### Example
 
+short example:
+
+```ruby
+    require "mongoid-crud"
+
+    require_relative "helper/connection"
+    require_relative "helper/models"
+
+    test_a= TestA.__create__( hello: "world" )
+    test_b= TestB.__create__( hello: "world", world: "no", parent_id: test_a['_id'] )
+    test_C= TestC.__create__( hello: "embeds one", parent_id: test_a['_id'] )
+
+    #> puts into json
+    puts TestA._read( _id: test_a['_id'] ).to_json
+```
+
+produce:
+
+```json
+  [{"_id":"536b298b241548e55a000001","created_at":"2014-05-08T08:51:55+02:00","hello":"world","test_b":[{"_id":"536b298b241548e55a000002","created_at":"2014-05-08T08:51:55+02:00","hello":"world","updated_at":"2014-05-08T08:51:55+02:00","world":"no"}],"test_c":{"_id":"536b298b241548e55a000003","created_at":"2014-05-08T08:51:55+02:00","hello":"embeds one","updated_at":"2014-05-08T08:51:55+02:00"},"updated_at":"2014-05-08T08:51:55+02:00"}]
+```
+
+#### Complex example
+
 ```ruby
+    require "mongoid-crud"
 
-    test_a= TestA.__create__ hello: "world"
+    require_relative "helper/connection"
+    require_relative "helper/models"
+
+    test_a= TestA.__create__( hello: "world" )
     #> TestA obj return
 
     test_b= TestB.__create__( hello: "world", world: "no", parent_id: test_a['_id'] )
@@ -43,5 +93,4 @@ Four super simple to use method on any mongoid model.
 
     TestB.__read__(  _id: test_b['_id'] )
     #> nil
-
 ```

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/examples/create.rb

@@ -0,0 +1,15 @@
+require "mongoid-crud"
+
+require_relative "helper/connection"
+require_relative "helper/models"
+
+test_a= TestA.__create__( hello: "world" )
+test_b= TestB.__create__( hello: "world", world: "no", parent_id: test_a['_id'] )
+test_c= TestC.__create__( hello: "embeds one", parent_id: test_a['_id'] )
+test_d= TestD.__create__( hello: "embeds many in embeded one", parent_id: test_c['_id'] )
+
+#> puts into json
+puts TestA._read( _id: test_a['_id'] )
+
+# [{"_id":"536b298b241548e55a000001","created_at":"2014-05-08T08:51:55+02:00","hello":"world","test_b":[{"_id":"536b298b241548e55a000002","created_at":"2014-05-08T08:51:55+02:00","hello":"world","updated_at":"2014-05-08T08:51:55+02:00","world":"no"}],"test_c":{"_id":"536b298b241548e55a000003","created_at":"2014-05-08T08:51:55+02:00","hello":"embeds one","updated_at":"2014-05-08T08:51:55+02:00"},"updated_at":"2014-05-08T08:51:55+02:00"}]
+

data/examples/crud.rb

@@ -1,10 +1,11 @@
-require_relative "../lib/mongoid-crud"
+require "mongoid-crud"
+
 require_relative "helper/connection"
 require_relative "helper/models"
 
 test_a= TestA.__create__( hello: "world" )
 test_b= TestB.__create__( hello: "world", world: "no", parent_id: test_a['_id'] )
-test_C= TestC.__create__( hello: "embeds one", parent_id: test_a['_id'] )
+test_c= TestC.__create__( hello: "embeds one", parent_id: test_a['_id'] )
 
 #> puts into json
 puts TestA._read( _id: test_a['_id'] ).to_json
@@ -24,5 +25,3 @@ puts TestB.__update__ _id: test_b['_id'], hello: "sup!"
 puts TestB.__read__(  _id: test_b['_id'] ).inspect
 puts TestB.__delete__(  _id: test_b['_id'] ).inspect
 puts TestB.__read__(  _id: test_b['_id'] ).inspect
-
-Mongoid.purge!

data/examples/helper/models.rb

@@ -30,5 +30,18 @@ class TestC
   include Mongoid::CRUD
 
   embedded_in :TestA.mongoid_name
+  embeds_many :TestD.mongoid_name
 
-end
+end
+
+class TestD
+
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  #> if auto extended the CRUD methods, it require not to include / extend here
+
+  embedded_in :TestC.mongoid_name
+
+end
+
+::Kernel.at_exit {Mongoid.purge!}

data/lib/mongoid-crud/auto.rb

@@ -0,0 +1,10 @@
+begin
+
+  require 'mongoid-crud/ext'
+  Mongoid::Config.inject_singleton_method :register_model, add: :before do |klass|
+    klass.__send__ :extend, Mongoid::CRUD::Extend
+  end
+
+rescue Exception
+  STDOUT.puts("mongoid-dsl")
+end

data/lib/mongoid-crud/ext.rb

@@ -0,0 +1,109 @@
+require 'mongoid'
+require 'mongoid-dsl'
+
+module Mongoid
+  module CRUD
+
+    module Extend
+
+      @@parent_sym= :parent_id
+
+      def __create__ *args
+
+        query   = Hash[*args.select{|e| e.class <= ::Hash }]
+        classes = args.select{|e| e.class <= ::Class }
+
+        if self.embedded?
+
+          parent_id = query.delete(@@parent_sym) || query.delete(@@parent_sym.to_s)
+          raise(ArgumentError,"for embeded document, you need :#{@@parent_sym}") if parent_id.nil?
+          parent_model= self._get_class_path(*classes).pinch.last
+
+          case parent_model.relation_connection_type(self).to_s.downcase.split('::').last.to_sym
+
+            when :many
+              return self._get_class_path(*classes).pinch.last._find(parent_id).__send__(self.mongoid_name).create!(query)
+
+            when :one
+              return self._get_class_path(*classes).pinch.last._find(parent_id).__send__("create_#{self.mongoid_name}",query)
+
+          end
+
+        else
+          return self.create!(query)
+        end
+
+      end
+      alias _create __create__
+
+      def __read__ *args
+
+        query     = Hash[*args.select{|e| e.class <= ::Hash }]
+        classes   = args.select{|e| e.class <= ::Class }
+        _id       = query.delete(:_id) || query.delete('_id')
+
+        if self.embedded?
+
+          parent_id = query.delete(@@parent_sym) || query.delete(@@parent_sym.to_s)
+
+          if !_id.nil?
+            return self._find(_id)#.__send__(self.mongoid_name).create(query)
+          elsif !parent_id.nil?
+            return self._get_class_path(*classes).pinch.last._find(parent_id).__send__(self.mongoid_name).where(query)
+          else
+            return self._where(query)
+          end
+
+        else
+
+          if !_id.nil?
+            return self.find(_id)
+          else
+            return self.where(query)
+          end
+
+        end
+
+      end
+      alias _read __read__
+
+      def __update__ *args
+
+        query   = Hash[*args.select{|e| e.class <= ::Hash }]
+        classes = args.select{|e| e.class <= ::Class }
+
+        raise(ArgumentError,"to #{__method__} document, you need :_id") if query[:_id].nil?
+        var= self._find(query.delete(:_id))
+        query.each{|k,v| var[k]= v }
+        return var.save!
+
+      end
+      alias _update __update__
+
+      def __delete__ *args
+
+        query   = Hash[*args.select{|e| e.class <= ::Hash }]
+        classes = args.select{|e| e.class <= ::Class }
+
+        raise(ArgumentError,"to #{__method__} document, you need :_id") if query[:_id].nil?
+        return self._find(query[:_id]).delete
+
+      end
+      alias _delete __delete__
+
+    end
+
+    class << self
+
+      def included klass
+        klass.__send__ :extend, self::Extend
+      end
+
+      def extended klass
+        klass.__send__ :extend, self::Extend
+      end
+
+    end
+
+  end
+end

data/lib/mongoid-crud.rb

@@ -1,103 +1 @@
-require 'mongoid'
-require 'mongoid-dsl'
-
-module Mongoid
-
-  module CRUD
-
-    module Extend
-
-      @@parent_sym= :parent_id
-
-      def __create__ *args
-
-        query   = Hash[*args.select{|e| e.class <= ::Hash }]
-        classes = args.select{|e| e.class <= ::Class }
-
-        if self.embedded?
-
-          raise(ArgumentError,"for embeded document, you need :#{@@parent_sym}") if query[@@parent_sym].nil?
-          parent_model= self._get_class_path(*classes).pinch.last
-
-          case parent_model.relation_connection_type(self).to_s.downcase.split('::').last.to_sym
-
-            when :many
-              return self._get_class_path(*classes).pinch.last._find(query.delete(@@parent_sym)).__send__(self.mongoid_name).create!(query)
-
-            when :one
-              return self._get_class_path(*classes).pinch.last._find(query.delete(@@parent_sym)).__send__("create_#{self.mongoid_name}",query)
-
-          end
-
-        else
-          return self.create!(query)
-        end
-
-      end
-      alias _create __create__
-
-      def __read__ *args
-
-        query   = Hash[*args.select{|e| e.class <= ::Hash }]
-        classes = args.select{|e| e.class <= ::Class }
-
-        if self.embedded?
-
-          parent_id = query.delete(@@parent_sym)
-          _id       = query.delete('_id')
-
-          if !_id.nil?
-            return self._find(_id)#.__send__(self.mongoid_name).create(query)
-          elsif !query[@@parent_sym].nil?
-            return self._get_class_path(*classes).pinch.last._find(parent_id).__send__(self.mongoid_name).where(query)
-          else
-            return self._where(query)
-          end
-
-        else
-          return self.where(query)
-        end
-
-      end
-      alias _read __read__
-
-      def __update__ *args
-
-        query   = Hash[*args.select{|e| e.class <= ::Hash }]
-        classes = args.select{|e| e.class <= ::Class }
-
-        raise(ArgumentError,"to #{__method__} document, you need :_id") if query[:_id].nil?
-        var= self._find(query.delete(:_id))
-        query.each{|k,v| var[k]= v }
-        return var.save!
-
-      end
-      alias _update __update__
-
-      def __delete__ *args
-
-        query   = Hash[*args.select{|e| e.class <= ::Hash }]
-        classes = args.select{|e| e.class <= ::Class }
-
-        raise(ArgumentError,"to #{__method__} document, you need :_id") if query[:_id].nil?
-        return self._find(query[:_id]).delete
-
-      end
-      alias _delete __delete__
-
-    end
-
-    class << self
-
-      def included klass
-        klass.__send__ :extend, self::Extend
-      end
-
-      def extended klass
-        klass.__send__ :extend, self::Extend
-      end
-
-    end
-
-  end
-end
+require 'mongoid-crud/auto'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-crud
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Adam Luzsi
@@ -65,11 +65,14 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- examples/create.rb
 - examples/crud.rb
 - examples/helper/connection.rb
 - examples/helper/models.rb
 - examples/helper/mongoid.yml
 - lib/mongoid-crud.rb
+- lib/mongoid-crud/auto.rb
+- lib/mongoid-crud/ext.rb
 - mongoid-crud.gemspec
 homepage: 
 licenses: []