mongoid_enumerable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af51c7b47d1e09b22dd640e385adb4af4222417311bc9e03cedf68e783b8a0d
-  data.tar.gz: 92869fa82757e9fab2ecc95c4721e1ccac09eeb66df1d302132fec2c61ab3b4c
+  metadata.gz: fb530cf42499e51a032c2aa44b278956b0cc9f09a85c51c2327f45e25c00c05f
+  data.tar.gz: cd079294ce92f0455eaf75f87e418aa1637418be8fd0e06914eab79af99f735a
 SHA512:
-  metadata.gz: 4114bf4ea3e50eee951783b9b707fbe5cdcd61fe29c528a0585d77819d61935cd0980e9e63636f91bfd803f0e7250fdbffde7214a79b5f175ef928538125d10a
-  data.tar.gz: a03cfd99dbc231ec593d867781221dc067e165991234293cce6cbb122605f10a42c56a9a0177eb4a763d72df9edb247ddf20e3aa48b534a301e2db2c3d83a22b
+  metadata.gz: add16cbb3e8ddc294a3a2ee5de08f8083e6fe21a63dadba3a0f80ba79e1c7d19abe72d47e8d8d006df451c797a89d1e73cb70368116d1f23017589ec2d8c7d93
+  data.tar.gz: 4b6a175e68056e2cc01664ffd660a9fa133d6e10c9bdab3899e250a1a0bcd2d0a94af2657ab2a714ea7976bbb181071106a8a8ba5bc3ffcec84afec1f173ff56

data/.travis.yml

@@ -6,3 +6,12 @@ rvm:
   - 2.3.6
   - 2.2.9
 before_install: gem install bundler -v 1.16.1
+env:
+  global:
+    - CC_TEST_REPORTER_ID=049baa35735ad9587a7ff016745e67eb057ef79958cb31113d4a19cc504c0216
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    mongoid_enumerable (0.1.0)
-      mongoid
+    mongoid_enumerable (0.1.1)
+      mongoid (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -18,8 +18,10 @@ GEM
     byebug (10.0.2)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
+    docile (1.3.0)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
+    json (2.1.0)
     minitest (5.11.3)
     mongo (2.5.3)
       bson (>= 4.3.0, < 5.0.0)
@@ -43,6 +45,11 @@ GEM
       rspec (>= 3)
       terminal-notifier (>= 1.4)
     rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     terminal-notifier (2.0.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
@@ -59,6 +66,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   rspec-nc
+  simplecov
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,9 +1,37 @@
 # Mongoid Enumerable
 
 [![Build Status](https://travis-ci.org/douglaslise/mongoid_enumerable.svg?branch=master)](https://travis-ci.org/douglaslise/mongoid_enumerable)
+[![Maintainability](https://api.codeclimate.com/v1/badges/bc09bc91c31fed14924a/maintainability)](https://codeclimate.com/github/douglaslise/mongoid_enumerable/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/bc09bc91c31fed14924a/test_coverage)](https://codeclimate.com/github/douglaslise/mongoid_enumerable/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/mongoid_enumerable.svg)](https://badge.fury.io/rb/mongoid_enumerable)
 
-Define custom methods for your MongoId documents:
+Define enumerable fields in your Mongoid documents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_enumerable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_enumerable
+
+## Usage
+Simply include `MongoidEnumerable` in your document.
+After add `enumerable` with:
+ - Field name
+ - An array with possible values
+ - Options (`default` and/or `prefix`)
+
+Example:
+
 ```ruby
 class Task
   include Mongoid::Document
@@ -13,33 +41,50 @@ class Task
 end
 ```
 
-Now we have methods in this model:
+Now we have methods in this document's instance:
 ```ruby
 task = Task.new
 
 task.status   # "waiting"
 task.waiting? # true
 
-task.running!
+task.running! # changes status field to "running"
 task.running? # true
 task.waiting? # false
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
+### Options
+#### Default
+Defines which value is the default for new documents. If not specified the first value is used as default.
 ```ruby
-gem 'mongoid_enumerable'
+enumerable :status, %w(completed running failed waiting), default: "waiting"
 ```
+#### Prefix
+You can define a prefix for your methods that could be useful if you have more than one enumerable with the same values.
+```ruby
+enumerable :build_status, %w(completed running failed waiting), default: "waiting", prefix: "build_"
+enumerable :deploy_status, %w(completed running failed waiting), default: "waiting", prefix: "deploy_"
 
-And then execute:
+task.build_completed?
+task.build_failed!
+task.deploy_running?
+task.deploy_failed!
+```
 
-    $ bundle
 
-Or install it yourself as:
+### Scopes/Criterias
+All values are added as scopes/criterias to your document class:
+```ruby
+Task.waiting # Returns all tasks with waiting status
+Task.running # Returns all tasks with running status
+```
+
+If prefixed, the scopes/criterias are prefixed too:
+```ruby
+Task.build_waiting # Returns all tasks with build waiting status
+Task.deploy_running # Returns all tasks with deploy running status
+```
 
-    $ gem install mongoid_enumerable
 
 ## Development
 

data/lib/mongoid_enumerable/version.rb

@@ -1,3 +1,3 @@
 module MongoidEnumerable
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/mongoid_enumerable.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-nc"
   spec.add_development_dependency "mongoid"
   spec.add_development_dependency "byebug"
-  spec.add_dependency "mongoid"
+  spec.add_dependency "mongoid", ">= 4.0"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_enumerable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Douglas Lise
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-20 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,9 +100,23 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="