modelize 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7074f96efe0898fbde97d9780de506d39b4a941d
-  data.tar.gz: 17c5d43d44a05431fa75e18650cdf4175c95c417
+  metadata.gz: 9f857eb7b855f5aa821498911f415a582a359d84
+  data.tar.gz: 308f8449a4d2035ff19893f15e3a35ae1818df76
 SHA512:
-  metadata.gz: f3e66f0329ec8bc5d629ac8f1ec2a8a3847d926aba34ab5bde3dfca13268e6202b3ccf9e62db2c1dc84895108b4d50606822cbb7d6127fea829d2714fa4ff86d
-  data.tar.gz: 736d68b79c10c1767a43ae362880a51a07445a8f26772251cf55679bd43d7878fdfda74b53bde95cac27cb583289c712f0ef65db3a406feb519a21aaca92a6c7
+  metadata.gz: 1f1d2367a81949c4b8551462067caab4e5b985efabf9ab94e77dd3264ed764ca3383cb453637cc7a89ccb3b90f66927b1f3b1de3c795bcc70a7d98c6407670a3
+  data.tar.gz: d2dc9f4fef900564345e83732908c474ba46ccea15ae57d3588e1bad3bc54fa8b35dd1bb8141c6088e885b86d67e5d1964d0644d3d9a7261c4720e4f6b7d2214

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+**Version 0.1.0** - *2017-01-05*
+
+- Fixed gemspec issues

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rerun'
+  gem 'rb-fsevent'
+  gem 'terminal-notifier'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Fugroup
+
+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.md

@@ -0,0 +1,85 @@
+# Modelize MongoDB Documents
+Automatically turn MongoDB BSON Documents into custom models.
+
+Works with the official [Ruby MongoDB driver](https://docs.mongodb.com/ruby-driver/master/quick-start/), or the [truly great Minimongo.](https://github.com/fugroup/minimongo)
+
+### Installation
+```ruby
+gem install modelize
+```
+or add to your Gemfile. That's it!
+
+### Settings
+```ruby
+# Enable / disable Modelize on the fly
+Modelize.enable = true
+
+# Tell Modelize in which module to find your model class
+Modelize.module = ''
+
+# If your model class is in the Fu::Models module
+Modelize.module = 'Fu::Models'
+
+# Debug option
+Modelize.debug = false
+```
+
+### Usage
+If your MongoDB collection is named "models", then your model class should be named "Model", and it'll automatically be picked up.
+
+The gem works by adding some spice to the Mongo::Collection::View "to_a" and "first" methods.
+
+```ruby
+# If you don't have bundler set up
+require 'modelize'
+
+# Create your model, no includes necessary
+class Model
+  # Your model definitions here ...
+end
+
+# Without Modelize, just pure Ruby driver
+models = find(:models).to_a     # => [BSON::Document, BSON::Document]
+model = first(:models)          # => BSON::Document
+
+# With Modelize and Minimongo
+models = find(:models).to_a     # => [Model, Model]
+model = first(:models)          # => Model
+
+# With Modelize and the Mongodb Ruby driver
+models = $db[:models].find.to_a # => [Model, Model]
+model = $db[:models].find.first # => Model
+```
+The models will be of type "Model" if you've defined such as class. You can then do:
+```ruby
+model = first(:models)
+
+# The original BSON::Document
+model.doc # => BSON::Document instance
+
+# The model class accepts any method that BSON::Document accepts
+model.to_h # => {'_id' => BSON::ObjectId('586c4ac80aec08424e3a5287')}
+
+# You can read and write variables
+model.description = 'we need truth'
+model.light = 'yes'
+model.description # => 'we need truth'
+model.light # => 'yes'
+
+# And then save the changes (Minimongo)
+model.earth = 'undiscovered'
+update(:models, {:_id => m._id}, m.to_h)
+
+# Refetch it and it's saved
+model = first(:models, :_id => m._id)
+m.earth # => 'undiscovered'
+
+# Returns nil if not found, doesn't raise an error
+model.darkness # => nil
+```
+You can now add validations or whatever you want to your model, it's just a normal Ruby class. Enjoy!
+
+### Contribute
+Created and maintained by [Fugroup Ltd.](https://www.fugroup.net) We are the creators of [CrowdfundHQ.](https://crowdfundhq.com)
+
+`@authors: Vidar`

data/config/boot.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+MODE = ENV['RACK_ENV'] || 'development'
+
+require './lib/modelize.rb'
+require './models/model.rb'
+require './models/flat.rb'
+
+# Connect to DB
+Minimongo.db = Mongo::Client.new(['127.0.0.1:27017'], :database => "modelize_#{MODE}")
+
+include Minimongo::Query

data/lib/modelize.rb

@@ -1,3 +1,5 @@
+require 'mongo'
+
 module Modelize
 
   # # # # # #

data/lib/modelize/core.rb

@@ -0,0 +1,18 @@
+module Modelize
+  module Core
+
+    attr_accessor :doc
+
+    # Read and write to the BSON::Document
+    def method_missing(name, *args, &block)
+      # Extract name and write mode
+      name =~ /([^=]+)(=)?/
+
+      # Call methods before instance variables
+      return args[0] ? @doc.send($1, args[0]) : @doc.send($1) if @doc.respond_to?($1)
+
+      # Write or read the BSON::Document, nil if nothing found
+      return args[0] ? @doc[$1] = args[0] : @doc[$1]
+    end
+  end
+end

data/lib/modelize/ext.rb

@@ -0,0 +1,34 @@
+# # # # # # # # #
+# Patch the Mongo::Collection::View class to return documents as models
+# If you query the :models collection, if a Model class exists
+# and the setting Minimongo.enable = true
+#
+# Set Minimongo.modules = 'Fu::Models' if your models is inside a module,
+# default module is root '::'
+#
+
+module Mongo
+  class Collection
+    class View
+
+      # To a BSON::Documents or models
+      def to_a
+        Modelize.enable ? super.map{|doc| modelize(doc)} : super
+      end
+
+      # First BSON::Document or model
+      def first
+        Modelize.enable ? modelize(super) : super
+      end
+
+      private
+
+      # Get the model class, BSON::Document if it doesn't exist
+      def modelize(doc)
+        Object.const_get("#{Modelize.module}::#{collection.name[0..-2].capitalize}").include(::Modelize::Core).new.tap{|m| m.doc = doc} rescue doc
+      end
+
+    end
+  end
+end
+

data/modelize.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = 'modelize'
+  s.version     = '0.1.0'
+  s.date        = '2017-01-05'
+  s.summary     = "Modelize MongoDB Documents"
+  s.description = "Automatically turn MongoDB BSON Documents into custom models"
+  s.authors     = ["Fugroup Limited"]
+  s.email       = 'mail@fugroup.net'
+
+  s.add_runtime_dependency 'mongo', '~> 2.2'
+  s.add_development_dependency 'futest', '>= 0'
+  s.add_development_dependency 'minimongo', '>= 0'
+
+  s.homepage    = 'https://github.com/fugroup/modelize'
+  s.license     = 'MIT'
+
+  s.require_paths = ['lib']
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+end

data/models/flat.rb

@@ -0,0 +1,7 @@
+# Example model with modules
+module Fu
+  module Models
+    class Flat
+    end
+  end
+end

data/models/model.rb

@@ -0,0 +1,3 @@
+# Example model, no modules (default)
+class Model
+end

metadata

@@ -1,22 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: modelize
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Fugroup Limited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
-dependencies: []
+date: 2017-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: futest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minimongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Automatically turn MongoDB BSON Documents into custom models
 email: mail@fugroup.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- config/boot.rb
 - lib/modelize.rb
+- lib/modelize/core.rb
+- lib/modelize/ext.rb
+- modelize.gemspec
+- models/flat.rb
+- models/model.rb
 homepage: https://github.com/fugroup/modelize
 licenses:
 - MIT
@@ -37,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Modelize MongoDB Documents