mongoid-simple-userstamps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23fc551a807ce53504bc27bf5fee96c47f75e4c4
+  data.tar.gz: e6a2fa15f28b7bfc24d5d331272f52a95cd90014
+SHA512:
+  metadata.gz: 712547f7c22ab893ca5f5bc8687272e3eaa1a9888935575d4eab42ac284f862ef8ae633e9fc006ac6f8ede6d728a02cee75ddba768bfc07753a12c6900b5912c
+  data.tar.gz: ab2cf7aaabe14c84d9894de176d355c735cbc13988b66ccee22e33d5cabf1c0b6b183566937f15263f05ba844e47e0bda76e2dc27fd549c8de88f8517e0af5ce

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-normalize-strings.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rafael Jurado
+
+MIT License
+
+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,77 @@
+# Mongoid::Userstamps
+
+Adds stamps relations to mongoid models.
+
+## Version Support
+
+Mongoid 5.x
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-simple-userstamps'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-simple-userstamps
+
+## Usage
+
+* Include `Mongoid::Userstamps::User` in your 'User' model.
+* Include `Mongoid::Userstamps::Model` in your models you want user stamps.
+* Define current user.
+
+```ruby
+  class User
+    include Mongoid::Document
+    include Mongoid::Userstamps::User
+  end
+
+  class Post
+    include Mongoid::Document
+    include Mongoid::Userstamps::Model
+
+    field :title
+  end
+
+  user = User.create
+  Mongoid::Userstamps::Config.set_current(user)
+
+  pòst = Post.create
+  post.created_by # <User _id: 57305c268675c32e1c70a17e >
+  post.updated_by # nil
+  
+  post.title = 'title'
+  post.save
+  post.updated_by # <User _id: 57305c268675c32e1c70a17e >
+```
+
+### Rails
+
+* Define current user in your `application_controller.rb`
+
+```ruby
+  class ApplicationController < ActionController::Base
+    before_action :define_userstamps_current
+
+    protected
+
+    def define_userstamps_current
+      Mongoid::Userstamps::Config.set_current(current_user)
+    end
+  end
+```
+
+## Contributing
+
+1. Fork it (
+   http://github.com/<my-github-username>/mongoid-simple-userstamps/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mongoid-simple-userstamps/config.rb

@@ -0,0 +1,27 @@
+##
+# This module store Userstamps config
+#
+module Mongoid
+  module Userstamps
+    module Config
+      @@model = nil
+      @@current = nil
+
+      def self.current
+        @@current
+      end
+
+      def self.model
+        @@model
+      end
+
+      def self.set_current(current)
+        @@current = current
+      end
+
+      def self.set_model(user_class)
+        @@user_class = user_class
+      end
+    end
+  end
+end

data/lib/mongoid-simple-userstamps/model.rb

@@ -0,0 +1,21 @@
+##
+# This module add user stamps to class
+#
+module Mongoid
+  module Userstamps
+    module Model
+      def self.included(base)
+        base.send(:belongs_to, :created_by, {polymorphic: true})
+        base.send(:belongs_to, :updated_by, {polymorphic: true})
+
+        base.send(:before_create) do
+          self.created_by = Mongoid::Userstamps::Config.current
+        end
+
+        base.send(:before_update) do
+          self.updated_by = Mongoid::Userstamps::Config.current
+        end
+      end
+    end
+  end
+end

data/lib/mongoid-simple-userstamps/user.rb

@@ -0,0 +1,12 @@
+##
+# This module define stamps model
+#
+module Mongoid
+  module Userstamps
+    module User
+      def self.included(base)
+        Mongoid::Userstamps::Config.set_model(self)
+      end
+    end
+  end
+end

data/lib/mongoid-simple-userstamps/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Userstamps
+    VERSION = "0.1.0"
+  end
+end

data/lib/mongoid-simple-userstamps.rb

@@ -0,0 +1,4 @@
+require "mongoid-simple-userstamps/version"
+require "mongoid-simple-userstamps/config"
+require "mongoid-simple-userstamps/user"
+require "mongoid-simple-userstamps/model"

data/mongoid-simple-userstamps.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid-simple-userstamps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-simple-userstamps"
+  spec.version       = Mongoid::Userstamps::VERSION
+  spec.authors       = ["Rafael Jurado"]
+  spec.email         = ["rjurado@nosolosoftware.es"]
+  spec.summary       = %q{Simple way to add user stamps to your models.}
+  spec.description   = %q{Simple way to add user stamps to your models.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency 'rspec'
+  spec.add_dependency 'mongoid', "~> 5.0.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'mongoid'
+require 'mongoid-simple-userstamps'
+
+Mongoid.load!("spec/support/mongoid.yml", :test)
+
+Mongoid.logger.level = Logger::ERROR
+Mongo::Logger.logger.level = Logger::ERROR

data/spec/support/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  clients:
+    default:
+      database: userstamps_test
+      hosts:
+        - localhost:27017

data/spec/userstamps_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'Mongoid::Userstamp' do
+  class User
+    include Mongoid::Document
+    include Mongoid::Userstamps::User
+  end
+
+  class Post
+    include Mongoid::Document
+    include Mongoid::Userstamps::Model
+
+    field :title
+  end
+
+  before :all do
+    @user = User.create
+    Mongoid::Userstamps::Config.set_current(@user)
+  end
+
+  context 'when include Mongoid::Userstamps::Model' do
+    it 'add user stamps relations' do
+      post = Post.new
+      expect(post.created_by).to eq nil
+      expect(post.updated_by).to eq nil
+    end
+  end
+
+  context 'when create Post' do
+    it 'should save user stamps relations' do
+      post = Post.create
+      expect(post.created_by).to eq(@user)
+    end
+  end
+
+  context 'when update Post' do
+    it 'should save user stamps relations' do
+      post = Post.create
+      post.title = "title"
+      post.save
+      expect(post.updated_by).to eq(@user)
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-simple-userstamps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafael Jurado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: Simple way to add user stamps to your models.
+email:
+- rjurado@nosolosoftware.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid-simple-userstamps.rb
+- lib/mongoid-simple-userstamps/config.rb
+- lib/mongoid-simple-userstamps/model.rb
+- lib/mongoid-simple-userstamps/user.rb
+- lib/mongoid-simple-userstamps/version.rb
+- mongoid-simple-userstamps.gemspec
+- spec/spec_helper.rb
+- spec/support/mongoid.yml
+- spec/userstamps_spec.rb
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple way to add user stamps to your models.
+test_files:
+- spec/spec_helper.rb
+- spec/support/mongoid.yml
+- spec/userstamps_spec.rb
+has_rdoc: