enumize_mongoid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b94cd31450d34f8fdc6a003185b9e48dd0e36d47
+  data.tar.gz: 3373fb392dab45a699ea4dc92f5c4e9b7bed050c
+SHA512:
+  metadata.gz: 07141f242c59d805cf2f772ac01247c85e54bef658a63b07cd64e4f278ffad0ad227994ef07e2c39f846941abeaac68c5f1da717707a19d5ded191503671a4ee
+  data.tar.gz: 171a13e760de206817f68a5925d9eb9be3a256a59f9f5f76b4cd55f4e7c846e7e0d32fb3b663f576edad00eb61d9a3498598de19075adfaa8d73206b789bc5f9

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,112 @@
+# EnumizeMongoid
+
+EnumizeMongoid is a gem aimed for Mongoid users, that lets you create your own classes/types representing/encapsulating an enum. There are other great gems out there dealing with enums for Mongoid (like [simple_enum](https://github.com/lwe/simple_enum)) but this one is approaching the problem from another angle.
+
+Using this gem you are required to create your own classes for your enum types, but on the other hand you will NOT face inconsistencies like this (using simple_enum):
+
+```ruby
+doc = Document.first
+p Document.where(status: doc.status).count
+# 0 - why? because doc.status returns a symbol, but the :status field is actually an Integer
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enumize_mongoid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumize_mongoid
+
+## Usage
+
+Include `EnumizeMongoid::Field` into your class representing the enum, and call `enumize` with the appropriate values:
+
+```ruby
+class Status
+  include EnumizeMongoid::Field
+
+  enumize([:bouncing, :still], create_constants: true)
+end
+```
+
+Set it as the field's type you want to use an enum for:
+
+```ruby
+class RedBall
+  include Mongoid::Document
+
+  field :status, type: Status
+end
+```
+
+After that you can use it in various flexible ways:
+
+### Document creation
+```ruby
+RedBall.create(status: :bouncing) # value as symbol
+RedBall.create(status: Status::BOUNCING) # value as constant
+RedBall.create(status: 0) # value as Integer
+RedBall.create(status: Status.new(:bouncing)) # value as an instance of Status
+```
+
+### Document querying
+```ruby
+rb = RedBall.create(status: :bouncing)
+
+RedBall.where(status: :bouncing).count # 1
+RedBall.where(status: Status::BOUNCING).count # 1
+RedBall.where(status: 0).count # 1
+RedBall.where(status: Status.new(:bouncing)).count # 1
+```
+
+### Comparing values
+```ruby
+RedBall.where(status: :bouncing).first
+
+rb.status == :bouncing # true
+rb.status == Status::BOUNCING # true
+rb.status == 0 # true
+rb.status == Status.new(:bouncing) # true
+```
+
+Of course this solves the problem with inconsistencies mentioned in the introduction:
+```ruby
+rb = RedBall.create(status: :bouncing)
+p RedBall.where(status: rb.status).count
+# 1 - rb.status is an instance of Status, which can be passed as part of a selector
+```
+
+#### How to use `enumize(values, create_constants: false)`
+
+`values`:
+  * array of symbols: `[:bouncing, :still]` - In this case the order matters, as the index of the value will be the value saved in the database: `:bouncing` -> 0, `:still` -> 1
+  * hash: `{ bouncing: 2, still: 4 }` - Order does not matter, you decide what the values will be
+
+`create_constants: true` will create:
+  * a `VALUES` constant: `Status::VALUES` -> `{ bouncing: 0, still: 1 }`
+  * a constant for each value:
+    * `Status::BOUNCING` -> `0`
+    * `Status::STILL` -> `0`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/InnovativeTravel/enumize_mongoid/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 a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "enumize_mongoid"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.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/enumize_mongoid.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enumize_mongoid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enumize_mongoid"
+  spec.version       = EnumizeMongoid::VERSION
+  spec.authors       = ["Elod Peter"]
+  spec.email         = ["bejmuller@gmail.com"]
+
+  spec.summary       = %q{Enum Field for Mongoid}
+  spec.description   = %q{Enum Field for Mongoid}
+  spec.homepage      = "https://github.com/InnovativeTravel/enumize_mongoid"
+
+  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 "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "mongoid"
+end

data/lib/enumize_mongoid/version.rb

@@ -0,0 +1,3 @@
+module EnumizeMongoid
+  VERSION = "0.1.0"
+end

data/lib/enumize_mongoid.rb

@@ -0,0 +1,86 @@
+require "enumize_mongoid/version"
+
+module EnumizeMongoid
+  module Field
+    def self.included(klass)
+
+      klass.instance_eval do
+        def enumize(values, create_constants: false)
+          @@value_map = create_value_map(values)
+
+          if create_constants
+            const_set('VALUES', @@value_map)
+
+            @@value_map.each do |key, value|
+              const_set(key.to_s.upcase, value)
+            end
+          end
+        end
+
+        def create_value_map(opts)
+          return opts if opts.is_a? Hash
+
+          return Hash[opts.zip(0...opts.size)] if opts.is_a? Array
+
+          raise 'Not supported type'
+        end
+
+        def value_of(value)
+          @@value_map.invert[value]
+        end
+
+        # Get the object as it was stored in the database, and instantiate
+        # this custom class from it.
+        def demongoize(object)
+          new(value_of(object))
+        end
+
+        # Takes any possible object and converts it to how it would be
+        # stored in the database.
+        def mongoize(object)
+          case object
+          when self then object.mongoize
+          when Symbol then new(object).mongoize
+          else object
+          end
+        end
+
+        # Converts the object that was supplied to a criteria and converts it
+        # into a database friendly form.
+        def evolve(object)
+          case object
+          when self then object.mongoize
+          when Symbol then mongoize(object)
+          else object
+          end
+        end
+      end
+
+      klass.class_eval do
+        attr_reader :value
+
+        def initialize(value)
+          @value = value
+        end
+
+        def ==(obj)
+          case obj
+          when Symbol then obj == value
+          when self.class then obj.value == value
+          when Numeric then obj == @@value_map[value]
+          else false
+          end
+        end
+
+        # Converts an object of this instance into a database friendly value.
+        def mongoize
+          @@value_map[value]
+        end
+
+        def to_s
+          "<#{self.class}|#{value}>"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: enumize_mongoid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elod Peter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enum Field for Mongoid
+email:
+- bejmuller@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enumize_mongoid.gemspec
+- lib/enumize_mongoid.rb
+- lib/enumize_mongoid/version.rb
+homepage: https://github.com/InnovativeTravel/enumize_mongoid
+licenses: []
+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: Enum Field for Mongoid
+test_files: []