mongoid_enum_mapper 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26b3b43fed1a77165990d18dff6678c7646228bb66ec14c1c8dc18dea6faf120
+  data.tar.gz: '06683302772ad3c1ea70ad16cd0e59eb33bdc0bd7146940c7e0b5f6e208f5d9b'
+SHA512:
+  metadata.gz: 1be85951a46d41c97b9bf4c4bfdba4373f2838f4d0b070b454eb39348e1a03f09b8cf690a816e380cd69dd8dbfd7d8a7ac675d637842a8acbf445c6c2cc1c0a9
+  data.tar.gz: d4d75bf8d5513629704768e5916097ec69c9b76d0c77ae511a5a716f5536f4d8bd6f8f6944be5026e5f88c07deb2a2315eb8f35ab477ab45e4334ca82994ea92

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=ccb61f4c66dd4eadf6646e35d63dc123133dc37dabc0bd5eb0c002c21abe5628
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+before_install:
+  - gem install bundler
+  - gem update --system
+  - gem --version
+  - 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
+script:
+  - bundle exec rake test
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mongoid_enum_mapper.gemspec
+gemspec
+
+group :test do
+  gem "simplecov", "~> 0.15.1"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bernie Chiu
+
+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,63 @@
+[![Maintainability](https://api.codeclimate.com/v1/badges/919d0459a7ffdfa9a221/maintainability)](https://codeclimate.com/github/berniechiu/mongoid_enum_mapper/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/919d0459a7ffdfa9a221/test_coverage)](https://codeclimate.com/github/berniechiu/mongoid_enum_mapper/test_coverage)
+[![Build Status](https://travis-ci.org/berniechiu/mongoid_enum_mapper.svg?branch=master)](https://travis-ci.org/berniechiu/mongoid_enum_mapper)
+
+# Mongoid Enum Mapper
+
+Inspired by [ActiveRecord::Enum](http://api.rubyonrails.org/v5.1/classes/ActiveRecord/Enum.html), the library supports a lightweight solution to map enum key value
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_enum_mapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_enum_mapper
+
+## Usage
+
+```ruby
+# Allow Mongoid to have ActiveRecord like Enum type of Mapping
+
+#=> OrderDelivery.rb Model
+include Mongoid::EnumMapper
+define_enum :status, { pending: 0, shipping: 1, shipped: 2 }
+
+# Examples
+od = OrderDelivery.new
+od.status             #=> Default :pending
+od.status = :shipping #=> :shipping
+od.status             #=> :shipping
+od[:status]           #=> 1
+
+od.status = :invalid  #=> :invalid
+od.status             #=> :shipping
+
+od.update(status: :pending)
+od.status             #=> :pending
+
+OrderDelivery::STATUS #=> { pending: 0, shipping: 1, shipped: 2 }
+OrderDelivery.update_all(OrderDelivery::STATUS[:shipping])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/berniechiu/mongoid_enum_mapper.
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "enum_mapper"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/enum_mapper.rb

@@ -0,0 +1,7 @@
+module Mongoid
+  module EnumMapper
+  end
+end
+
+require "mongoid/enum_mapper/version"
+require "mongoid/enum_mapper/define_enum"

data/lib/mongoid/enum_mapper/define_enum.rb

@@ -0,0 +1,60 @@
+module Mongoid
+  module EnumMapper
+    extend ActiveSupport::Concern
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def reload
+      super
+      reset_enum_mapping_cache
+      self
+    end
+
+    def reset_enum_mapping_cache(enum_field: nil, key: nil)
+      if enum_field
+        # Reset certain enum field
+        enum_mapper = self.class.const_get(enum_field.to_s.upcase)
+        key ||= enum_mapper.key(self[:"#{enum_field}"])  # If key not found, grep from current db value
+        return self[enum_field] unless enum_mapper[key]
+        instance_variable_set(:"@#{enum_field}", nil)
+        self[enum_field] = enum_mapper[key]
+      else
+        # Reset all enum field
+        self.class.instance_variable_get(:'@current_enums').each do |field|
+          reset_enum_mapping_cache(enum_field: field) 
+        end
+      end
+    end
+
+    module ClassMethods
+      def define_enum(enum_field, enum_mapping = {})
+        field :"#{enum_field}", type: Integer, default: 0
+        set_enum_mapping_constant(enum_field, enum_mapping)
+        set_current_enum_fields(enum_field)
+
+        enum_value = :"@#{enum_field}"
+
+        define_method(enum_field) do
+          instance_variable_get(enum_value) ||
+          instance_variable_set(enum_value, enum_mapping.find { |_, value| value == self[enum_field] }.try(:[], 0))
+        end
+
+        define_method(:"#{enum_field}=") do |key|
+          reset_enum_mapping_cache(enum_field: enum_field, key: key)
+        end
+      end
+
+      def set_enum_mapping_constant(name, value)
+        const_name = name.to_s.upcase
+        const_set(const_name, value.freeze)
+      end
+
+      def set_current_enum_fields(name)
+        @current_enums ||= []
+        @current_enums << name.to_s
+      end
+    end
+  end
+end

data/lib/mongoid/enum_mapper/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module EnumMapper
+    VERSION = "0.5.0"
+  end
+end

data/mongoid_enum_mapper.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mongoid/enum_mapper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_enum_mapper"
+  spec.version       = Mongoid::EnumMapper::VERSION
+  spec.authors       = ["Bernie Chiu"]
+  spec.email         = ["bernie_chiu@hotmail.com"]
+
+  spec.summary       = %q{This library supports a lightweight enum suger for Mongoid field.}
+  spec.description   = %q{Enum mapper for Mongoid field}
+  spec.homepage      = "https://github.com/berniechiu/mongoid_enum_mapper"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.5", ">= 3.5.1"
+
+  spec.add_dependency "mongoid", "<= 5.2.1"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_enum_mapper
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Bernie Chiu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+description: Enum mapper for Mongoid field
+email:
+- bernie_chiu@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/enum_mapper.rb
+- lib/mongoid/enum_mapper/define_enum.rb
+- lib/mongoid/enum_mapper/version.rb
+- mongoid_enum_mapper.gemspec
+homepage: https://github.com/berniechiu/mongoid_enum_mapper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.4
+signing_key: 
+specification_version: 4
+summary: This library supports a lightweight enum suger for Mongoid field.
+test_files: []