mongoid_extended 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f161200559e0992710c083b3d5ccb3e53cfcfa5
+  data.tar.gz: 8262c4f5e071c729ecc5cb69a692cb50fde6478e
+SHA512:
+  metadata.gz: 974734865d57e9761f3d7b1651776799caf6116fc14be4636875ce6150b68eb0798024d899b7f0a863029212fa5490d32be1bcc4127fb2a9e9b37c214aa87a02
+  data.tar.gz: 10349d53834bbe2f80370f65e736c6cee5e01b07b1beffe2de046acf38f4d36e5735671211c73857e37c5f826ab55603bee85b9a4eeea34e0c1dc12723a58a32

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,9 @@
+# coding: utf-8
+if ENV['USE_OFFICIAL_GEM_SOURCE']
+  source 'https://rubygems.org'
+else
+  source 'https://ruby.taobao.org'
+end
+
+# Specify your gem's dependencies in mongoid_extended.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Spirit
+
+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,97 @@
+# MongoidExtended
+
+Mongoid extended, Support EpochTime, ObjectId, Serializer, SoftDelete
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_extended'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_extended
+
+## Usage
+
+```ruby
+require 'mongoid_extended'
+
+MongoidExtended.configure :EpochTime, :ObjectId, :Serializer, :SoftDelete
+```
+
+### EpochTime
+
+```ruby
+MongoidExtended.configure :EpochTime
+
+class User
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :locked_at, type: DateTime, default: -> { Time.now.utc }
+end
+
+user = User.create
+#<User _id: 5614eb9b908c4f0828000007, created_at: 2015-10-07 09:53:31 UTC, updated_at: 2015-10-07 09:53:31 UTC, locked_at: 2015-10-07 09:53:31 UTC>
+
+user.created_at # => 1444211611
+user.updated_at # => 1444211611
+user.locked_at  # => 1444211611
+```
+
+### ObjectId
+
+```ruby
+MongoidExtended.configure :ObjectId
+
+User.create.to_json
+
+{
+  "_id": "5614eb9b908c4f0828000007"
+}
+```
+
+### Serializer
+
+```ruby
+# add active_model_serializers support for mongoid
+MongoidExtended.configure :Serializer
+```
+
+### SoftDelete
+
+```ruby
+MongoidExtended.configure :SoftDelete
+
+class User
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include MongoidExtended::SoftDelete
+end
+
+@user = User.create
+@user.destroy
+@user.deleted? # => true
+@user.deleted_at # => 2015-10-07 18:09:19 +0800
+@user.touch  # => RuntimeError, can't modify frozen Hash
+
+User.count # => 1
+User.undeleted.count # => 0
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/NaixSpirit/mongoid_extended. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mongoid_extended'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/concern.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+module ActiveSupport
+  # A typical module looks like this:
+  #
+  #   module M
+  #     def self.included(base)
+  #       base.extend ClassMethods
+  #       base.class_eval do
+  #         scope :disabled, -> { where(disabled: true) }
+  #       end
+  #     end
+  #
+  #     module ClassMethods
+  #       ...
+  #     end
+  #   end
+  #
+  # By using <tt>ActiveSupport::Concern</tt> the above module could instead be
+  # written as:
+  #
+  #   require 'active_support/concern'
+  #
+  #   module M
+  #     extend ActiveSupport::Concern
+  #
+  #     included do
+  #       scope :disabled, -> { where(disabled: true) }
+  #     end
+  #
+  #     class_methods do
+  #       ...
+  #     end
+  #   end
+  #
+  # Moreover, it gracefully handles module dependencies. Given a +Foo+ module
+  # and a +Bar+ module which depends on the former, we would typically write the
+  # following:
+  #
+  #   module Foo
+  #     def self.included(base)
+  #       base.class_eval do
+  #         def self.method_injected_by_foo
+  #           ...
+  #         end
+  #       end
+  #     end
+  #   end
+  #
+  #   module Bar
+  #     def self.included(base)
+  #       base.method_injected_by_foo
+  #     end
+  #   end
+  #
+  #   class Host
+  #     include Foo # We need to include this dependency for Bar
+  #     include Bar # Bar is the module that Host really needs
+  #   end
+  #
+  # But why should +Host+ care about +Bar+'s dependencies, namely +Foo+? We
+  # could try to hide these from +Host+ directly including +Foo+ in +Bar+:
+  #
+  #   module Bar
+  #     include Foo
+  #     def self.included(base)
+  #       base.method_injected_by_foo
+  #     end
+  #   end
+  #
+  #   class Host
+  #     include Bar
+  #   end
+  #
+  # Unfortunately this won't work, since when +Foo+ is included, its <tt>base</tt>
+  # is the +Bar+ module, not the +Host+ class. With <tt>ActiveSupport::Concern</tt>,
+  # module dependencies are properly resolved:
+  #
+  #   require 'active_support/concern'
+  #
+  #   module Foo
+  #     extend ActiveSupport::Concern
+  #     included do
+  #       def self.method_injected_by_foo
+  #         ...
+  #       end
+  #     end
+  #   end
+  #
+  #   module Bar
+  #     extend ActiveSupport::Concern
+  #     include Foo
+  #
+  #     included do
+  #       self.method_injected_by_foo
+  #     end
+  #   end
+  #
+  #   class Host
+  #     include Bar # It works, now Bar takes care of its dependencies
+  #   end
+  module Concern
+    class MultipleIncludedBlocks < StandardError #:nodoc:
+      def initialize
+        super "Cannot define multiple 'included' blocks for a Concern"
+      end
+    end
+
+    def self.extended(base) #:nodoc:
+      base.instance_variable_set(:@_dependencies, [])
+    end
+
+    def append_features(base)
+      if base.instance_variable_defined?(:@_dependencies)
+        base.instance_variable_get(:@_dependencies) << self
+        return false
+      else
+        return false if base < self
+        @_dependencies.each { |dep| base.send(:include, dep) }
+        super
+        base.extend const_get(:ClassMethods) if const_defined?(:ClassMethods)
+        base.class_eval(&@_included_block) if instance_variable_defined?(:@_included_block)
+      end
+    end
+
+    def included(base = nil, &block)
+      if base.nil?
+        fail MultipleIncludedBlocks if instance_variable_defined?(:@_included_block)
+
+        @_included_block = block
+      else
+        super
+      end
+    end
+
+    def class_methods(&class_methods_module_definition)
+      if const_defined?(:ClassMethods, false)
+        mod = const_get(:ClassMethods)
+      else
+        mod = const_set(:ClassMethods, Module.new)
+      end
+
+      mod.module_eval(&class_methods_module_definition)
+    end
+  end
+end

data/lib/mongoid_extended/epoch_time.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module MongoidExtended
+  module EpochTime
+    class << self
+      def configured
+        ::Time.send(:extend, TimeDemongoize)
+        ::DateTime.send(:extend, DateTimeDemongoize)
+
+        @configured = true
+      end
+
+      def configured?
+        !!@configured
+      end
+    end
+
+    # Convert the object from its mongo friendly ruby type to this type.
+    #
+    # @example Demongoize the object.
+    #   Time.demongoize(object)
+    #
+    # @param [ Time ] object The time from Mongo.
+    #
+    # @return [ Integer ] The object as a integer.
+    #
+    # @since 3.0.0
+    module TimeDemongoize
+      def demongoize(object)
+        result = super
+        result.nil? ? nil : result.to_i
+      end
+    end
+
+    # Convert the object from its mongo friendly ruby type to this type.
+    #
+    # @example Demongoize the object.
+    #   DateTime.demongoize(object)
+    #
+    # @param [ DateTime ] object The time from Mongo.
+    #
+    # @return [ Integer ] The object as a integer.
+    #
+    # @since 3.0.0
+    module DateTimeDemongoize
+      def demongoize(object)
+        ::Time.demongoize(object)
+      end
+    end
+  end
+end

data/lib/mongoid_extended/object_id.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module MongoidExtended
+  module ObjectId
+    class << self
+      def configured
+        ::BSON::ObjectId.send(:prepend, HashRepresentation)
+
+        @configured = true
+      end
+
+      def configured?
+        !!@configured
+      end
+    end
+
+    # rewrite methods `BSON::ObjectId#as_json` & `BSON::ObjectId#to_json`
+    # Return the object id as a JSON hash representation.
+    #
+    # @example Get the object id as JSON.
+    #   object_id.as_json
+    #
+    # @return [ String ] The object id as a JSON string.
+    #
+    # @since 2.0.0
+    module HashRepresentation
+      def to_json
+        to_s
+      end
+
+      def as_json
+        to_s
+      end
+    end
+  end
+end

data/lib/mongoid_extended/serializer.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module MongoidExtended
+  module Serializer
+    class << self
+      # add active_model_serializers support for mongoid
+      def configured
+        unless defined?(::ActiveModel::SerializerSupport)
+          raise MongoidExtended::GemsLoadError.new(:active_model_serializers)
+        end
+
+        ::Mongoid::Document.send(:include, ActiveModel::SerializerSupport)
+        ::Mongoid::Criteria.delegate(:active_model_serializer, to: :to_a)
+
+        @configured = true
+      end
+
+      def configured?
+        !!@configured
+      end
+    end
+  end
+end

data/lib/mongoid_extended/soft_delete.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module MongoidExtended
+  module SoftDelete
+    class << self
+      def configured
+        add_class_method
+        add_instance_method
+
+        @configured = true
+      end
+
+      def configured?
+        !!@configured
+      end
+
+      def add_class_method
+        instance_eval do
+          extend ActiveSupport::Concern
+
+          included do
+            field :deleted_at, type: DateTime
+            index({ deleted_at: -1 }, { background: true })
+            scope :undeleted, -> { where(deleted_at: nil) }
+
+            alias_method :destroy!, :destroy
+          end
+        end
+      end
+
+      # Object.destroy is soft deleted
+      # Object.delete is hard deleted
+      def add_instance_method
+        class_eval do
+          define_method :destroy do
+            run_callbacks(:destroy) do
+              if persisted?
+                set(deleted_at: Time.now.utc)
+                set(updated_at: Time.now.utc) if respond_to?(:updated_at)
+              end
+              @destroyed = true
+            end
+            freeze
+          end
+
+          define_method :deleted? do
+            !deleted_at.blank?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_extended/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module MongoidExtended
+  VERSION = '0.1.1'
+end

data/lib/mongoid_extended.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'mongoid' unless defined?(Mongoid)
+
+require_relative './concern' unless defined?(ActiveSupport::Concern)
+require_relative './mongoid_extended/epoch_time'
+require_relative './mongoid_extended/object_id'
+require_relative './mongoid_extended/serializer'
+require_relative './mongoid_extended/soft_delete'
+
+module MongoidExtended
+  class GemsLoadError < StandardError #:nodoc:
+    def initialize(gem_name)
+      super("`#{gem_name}` gem must be required first")
+    end
+  end
+
+  class << self
+    # configure method is used for select extend modules
+    # @example Use soft delete module and object id module
+    #   MongoidExtended.configure(:SoftDelete, :ObjectId)
+    def configure *module_names
+      module_names.each do |module_name|
+        if const_defined?(module_name)
+          klass = ::Object.const_get("MongoidExtended::#{module_name}")
+          klass.configured unless klass.configured?
+        else
+          raise NameError, "uninitialized constant `#{module_name}` in MongoidExtended"
+        end
+      end
+    end
+  end
+end

data/mongoid_extended.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_extended/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mongoid_extended'
+  spec.version       = MongoidExtended::VERSION
+  spec.authors       = ['Spirit']
+  spec.email         = ['neverlandxy.naix@gmail.com']
+
+  spec.summary       = %q{Mongoid Extended}
+  spec.description   = %q{Support EpochTime, ObjectId, Serializer, SoftDelete}
+  spec.homepage      = 'https://github.com/NaixSpirit/mongoid_extended'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'mongoid', '~> 4.0'
+  spec.add_development_dependency 'active_model_serializers', '~> 0.9'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_extended
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Spirit
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Support EpochTime, ObjectId, Serializer, SoftDelete
+email:
+- neverlandxy.naix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/concern.rb
+- lib/mongoid_extended.rb
+- lib/mongoid_extended/epoch_time.rb
+- lib/mongoid_extended/object_id.rb
+- lib/mongoid_extended/serializer.rb
+- lib/mongoid_extended/soft_delete.rb
+- lib/mongoid_extended/version.rb
+- mongoid_extended.gemspec
+homepage: https://github.com/NaixSpirit/mongoid_extended
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Mongoid Extended
+test_files: []