mongocore 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 930f0c5ba53f15b7014cb473803554975acf1679
-  data.tar.gz: 6d84ab1c806b72b558641f89cbb3608d7ee34c79
+  metadata.gz: 55808be92e72f178a15d79162ce306e93697af46
+  data.tar.gz: 616b1fa1123ee89dae66153e1b5702679a829310
 SHA512:
-  metadata.gz: 750dcd341fee0a1266951f93705d6aeb02a03f5b0ef44af2c439ccc5d2db0d284da1d241a325393982662b88a436b61cecf768850547d252e0842dfd1fc6b42c
-  data.tar.gz: 9a98403d956ae87fec94e8833a6bdd6acd9d0ed9ea2c4979629b84ce0f69ff72b6542b04da5b87cd6dfb657f239cdccea37c371d9574647959714080d65a902e
+  metadata.gz: c3ca71c855ad06198b6d4d05c8a5abf8816868c53d649caeeb81b9063f72657ce70f6e773d4c7d4a171a06c291279d1524e1153376ba3670f841e748c23eb91b
+  data.tar.gz: e33647c2848cc8d04dc6db9db061c2009637e6e1714c7a74996744efd2ad64e62a60feda4d1137d4f5257a0e7c033c9a79e43a9938df11fcafc43de86d33eea5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+**Version 0.1.0** - *2017-01-06*
+
+- Fixed gemspec issues
+
 **Version 0.1.0** - *2017-01-05*
 
 - Automatic saving of created_at and updated_at keys if they exist

data/README.md

@@ -7,11 +7,11 @@ The perfect companion for Sinatra or other Rack-based web frameworks.
 With Mongocore you can do:
 
 * Insert, update and delete
-* Finding, sorting, limit, defaults
-* Scopes, associations, validations
+* Finding, sorting, limit, skip, defaults
+* Scopes, associations, validations, pagination
 * Read and write access control for each key
 * Request cache, counter cache, track changes
-* Automatic timestamps, tagged keys
+* Automatic timestamps, tagged keys, json
 
 The schema is specified with a YAML file which supports default values, data types, and security levels for each key.
 
@@ -21,10 +21,9 @@ Please read [the source code](https://github.com/fugroup/mongocore/tree/master/l
 | -------------------------------------- | ----- | ------- | ------------- |
 | [Mongoid](http://mongoid.com)          | 256   | 14371   | 10590         |
 | [MongoMapper](http://mongomapper.com)  | 91    | 200     | 4070          |
-| [Mongocore](http://mongocore.com)      | 7     | 224     | 354           |
+| [Mongocore](http://mongocore.com)      | 8     | 224     | 354           |
 
 <br>
-If you are looking for something even lighter, we also [have Minimongo,](https://github.com/fugroup/minimongo) the world's tiniest MongoDB library.
 
 The tests are written [using Futest,](https://github.com/fugroup/futest) try it out if you haven't, it makes testing so much fun.
 
@@ -57,6 +56,9 @@ Mongocore.access = true
 # Enable timestamps, auto-save created_at and updated_at keys
 Mongocore.timestamps = true
 
+# Pagination results per page
+Mogocore.per_page = 20
+
 # Enable debug to see caching information and help
 Mongocore.debug = false
 ```
@@ -64,6 +66,9 @@ Mongocore.debug = false
 ### Usage
 
 ```ruby
+# Set up connection to database engine
+Mongocore.db = Mongo::Client.new(['127.0.0.1:27017'], :database => "mongocore_#{ENV['RACK_ENV']}")
+
 # Create a new document
 m = Model.new
 m.duration = 59
@@ -93,6 +98,11 @@ f = query.first
 # All
 m = Model.find.all
 
+# Pagination returns an array
+m = Model.find.paginate
+m = Model.find.paginate(:per_page => 10, :page => 5)
+m.total # => Total number of results
+
 # All of these can be used:
 # https://docs.mongodb.com/manual/reference/operator/query-comparison
 m = Model.find(:house => {:$ne => nil, :$eq => 'Nice'}).last
@@ -193,10 +203,17 @@ Mongocore.db[:models].indexes.create_one({:key => 1})
 Mongocore.db[:models].indexes.create_one({:key => 1}, :unique => true)
 ```
 
-### Schema
-For keys, defaults, description, counters, associations, scopes and accessors, use a schema file written in [YAML.](http://yaml.org)
+### Schema and models
+Each model defined using a [YAML.](http://yaml.org) schema file. This is where you define keys, defaults, description, counters, associations, access, tags, scopes and accessors.
+
+The default schema file location is `APP_ROOT/config/db/schema/*.yml`, so if you have a model called Parent, create a yml file called parent.yml.
+
+You can change the shema file location like this:
+```ruby
+Mongocore.schema = File.join(Dir.pwd, 'your', 'schema', 'path')
+```
 
-#### Parent example schema
+#### Parent example schema, has many Models
 ```yml
 
 # The meta is information about your model
@@ -206,7 +223,8 @@ meta:
 
 keys:
 
-  # Use the _id everywhere. The id can be used for whatever you want.
+  # Define the _id field for all your models. The id field (without _)
+  # is an alias to _id, but always returns a string instead of a BSON::ObjectId
   # @desc: Describes the key, can be used for documentation.
   # @type: object_id, string, integer, float, boolean, time, hash, array
   # @default: the default value for the key when you call .new
@@ -253,7 +271,7 @@ many:
 ```
 
 
-#### Model example schema
+#### Model example schema, belongs to Parent
 
 ```yml
 meta:

data/lib/mongocore/document.rb

@@ -57,7 +57,7 @@ module Mongocore
         a[:_id] ? @saved = true : a[:_id] = BSON::ObjectId.new
 
         # The errors hash
-        @errors = Hash.new{|h, k| h[k] = []}
+        @errors = Mongocore::Errors.new{|h, k| h[k] = []}
 
         # Defaults
         self.class.schema.defaults.each{|k, v| write(k, v)}
@@ -79,15 +79,15 @@ module Mongocore
       # Save attributes to db
       def save(o = {})
         # Send :validate => true to validate
-        return nil unless valid? if o[:validate]
+        return false unless valid? if o[:validate]
 
         # Create a new query
-        filter(:save){mq(self.class, {:_id => @_id}).update(attributes)}
+        filter(:save){mq(self.class, {:_id => @_id}).update(attributes).ok?}
       end
 
       # Update document in db
       def update(a = {})
-        a.each{|k, v| write(k, v)}; filter(:update){single.update(a)}
+        a.each{|k, v| write(k, v)}; filter(:update){single.update(a).ok?}
       end
 
       # Delete a document in db
@@ -132,9 +132,10 @@ module Mongocore
 
       # JSON format, pass tags as symbols: to_json(:badge, :gun)
       def to_json(*args)
-        attributes(*args).to_json
+        a = attributes(*args); a.delete(:_id); {:id => id}.merge(a).to_json
       end
 
+
       # # # # # # # # # # # # # # # #
       # Validation methods
       #
@@ -225,6 +226,11 @@ module Mongocore
         super
       end
 
+      # Alias for _id but returns string
+      def id
+        @_id ? @_id.to_s : nil
+      end
+
     end
 
 
@@ -269,6 +275,17 @@ module Mongocore
         find({}, {}, :limit => n)
       end
 
+      # Skip
+      def skip(n = 0)
+        find({}, {}, :skip => n)
+      end
+
+      # Fields (projection)
+      def fields(o = {})
+        find({}, {}, :fields => o)
+      end
+
+
       # # # # # # # # #
       # After, before and validation filters
       # Pass a method name as symbol or a block

data/lib/mongocore/errors.rb

@@ -0,0 +1,5 @@
+module Mongocore
+  class Errors < Hash
+
+  end
+end

data/lib/mongocore/ext.rb

@@ -0,0 +1,8 @@
+# Extensions for ruby classes
+
+class Array
+
+  # Holds the total number of pagination results
+  attr_accessor :total
+
+end

data/lib/mongocore/query.rb

@@ -12,11 +12,18 @@ module Mongocore
 
     attr_accessor :model, :collection, :colname, :query, :options, :store, :cache
 
-    # These options will be deleted before doing the find
+    # Mongocore query initializer
     def initialize(m, q = {}, o = {}, s = {})
-      # Support find passing a ID
+
+      # Support find passing an ID
       q = {:_id => oid(q)} unless q.is_a?(Hash)
 
+      # Support passing :id as :_id
+      q[:_id] = q.delete(:id) if q[:id]
+
+      # Support passing _id as a string
+      q[:_id] = oid(q[:_id]) if q[:_id].is_a?(String)
+
       # Storing model class. The instance can be found in store[:source]
       @model = m
 
@@ -27,7 +34,7 @@ module Mongocore
       @collection = Mongocore.db[@colname]
 
       # Storing query and options. Sort and limit is stored in options
-      s[:sort] ||= {}; s[:limit] ||= 0; s[:chain] ||= []; s[:source] ||= nil
+      s[:sort] ||= {}; s[:limit] ||= 0; s[:chain] ||= []; s[:source] ||= nil; s[:fields] ||= {}; s[:skip] ||= 0
       @query, @options, @store = q, o, s
 
       # Set up cache
@@ -41,7 +48,7 @@ module Mongocore
 
     # Cursor
     def cursor
-      @collection.find(@query, @options).sort(@store[:sort]).limit(@store[:limit])
+      @collection.find(@query, @options).projection(@store[:fields]).skip(@store[:skip]).sort(@store[:sort]).limit(@store[:limit])
     end
 
     # Update
@@ -85,6 +92,28 @@ module Mongocore
       fetch(:to_a).map{|d| first(d)}
     end
 
+    # Paginate
+    def paginate(o = {})
+
+      # Get total count before applying pagination
+      total = fetch(:count)
+
+      # Set page, defaults to 1
+      o[:page] = o[:page].to_i; o[:page] = 1 if o[:page] < 1
+
+      # Set results per page, defaults to 20 in Mongocore.per_page setting
+      o[:per_page] = o[:per_page].to_i; o[:per_page] = Mongocore.per_page if o[:per_page] < 1
+
+      # Skip results
+      store[:skip] = o[:per_page] * (o[:page] - 1)
+
+      # Apply limit
+      store[:limit] = o[:per_page]
+
+      # Fetch the result as array
+      fetch(:to_a).map{|d| first(d)}.tap{|r| r.total = total}
+    end
+
     # Fetch docs, pass type :first, :to_a or :count
     def fetch(t)
       cache.get(t) if Mongocore.cache
@@ -95,7 +124,7 @@ module Mongocore
 
     # Sort
     def sort(o = {})
-      find(@query, options, @store.tap{store[:sort].merge!(o)})
+      find(@query, @options, @store.tap{store[:sort].merge!(o)})
     end
 
     # Limit
@@ -103,6 +132,16 @@ module Mongocore
       find(@query, @options, @store.tap{store[:limit] = n})
     end
 
+    # Skip
+    def skip(n = 0)
+      find(@query, @options, @store.tap{store[:skip] = n})
+    end
+
+    # Fields (projection)
+    def fields(o = {})
+      find(@query, @options, @store.tap{store[:fields].merge!(o)})
+    end
+
     # Cache key
     def key
       @key ||= "#{@model}#{@query.sort}#{@options.sort}#{@store.values}"

data/lib/mongocore.rb

@@ -15,7 +15,7 @@ module Mongocore
   # @license:  MIT, contributions are welcome.
   # # # # # #
 
-  class << self; attr_accessor :db, :schema, :cache, :access, :timestamps, :debug; end
+  class << self; attr_accessor :db, :schema, :cache, :access, :timestamps, :per_page, :debug; end
 
   # Schema path is $app_root/config/db/schema/:model_name.yml
   @schema = File.join(Dir.pwd, 'config', 'db', 'schema')
@@ -29,10 +29,15 @@ module Mongocore
   # Enable timestamps, auto-save created_at and updated_at fields
   @timestamps = true
 
+  # Pagination results per page
+  @per_page = 20
+
   # Debug option
   @debug = false
 end
 
+require_relative 'mongocore/ext'
+require_relative 'mongocore/errors'
 require_relative 'mongocore/document'
 require_relative 'mongocore/query'
 require_relative 'mongocore/schema'

data/mongocore.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'mongocore'
-  s.version     = '0.1.1'
-  s.date        = '2017-01-05'
+  s.version     = '0.1.2'
+  s.date        = '2017-10-11'
   s.summary     = "MongoDB ORM implementation on top of the Ruby MongoDB driver"
-  s.description = "Does validations, associations, scopes, filters, counter cache, request cache, and nested queries. Using a YAML schema file, which supports default values, data types, and security levels for each key."
+  s.description = "Does validations, associations, scopes, filters, pagination, counter cache, request cache, and nested queries. Using a YAML schema file, which supports default values, data types, and security levels for each key."
   s.authors     = ["Fugroup Limited"]
   s.email       = 'mail@fugroup.net'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongocore
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Fugroup Limited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-05 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -66,9 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Does validations, associations, scopes, filters, counter cache, request
-  cache, and nested queries. Using a YAML schema file, which supports default values,
-  data types, and security levels for each key.
+description: Does validations, associations, scopes, filters, pagination, counter
+  cache, request cache, and nested queries. Using a YAML schema file, which supports
+  default values, data types, and security levels for each key.
 email: mail@fugroup.net
 executables: []
 extensions: []
@@ -86,6 +86,8 @@ files:
 - lib/mongocore/access.rb
 - lib/mongocore/cache.rb
 - lib/mongocore/document.rb
+- lib/mongocore/errors.rb
+- lib/mongocore/ext.rb
 - lib/mongocore/filters.rb
 - lib/mongocore/query.rb
 - lib/mongocore/schema.rb
@@ -112,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: MongoDB ORM implementation on top of the Ruby MongoDB driver