mongoid-enum_attribute 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e0c939d3c2c2a5677c00e67b188c2f1121a74b514481a26850ae44132d8b58b
+  data.tar.gz: 7a81b66ee67d78377af402636a31be30594f3558103fc9b4868b5373f6aba3ee
+SHA512:
+  metadata.gz: eb7c9892acf4df44ea84e40019a7db574fe5ce5638707d621e527ca456655d4dede81f56c9c56d8ea6bad1aebf675bf34bd89d2891512fff3759a9f2ab3033cc
+  data.tar.gz: b799c8b3c833c15751ae2e5f8f792232717ebea7a895d63bfbb9b9ff23cce1c478d4ffe415f83d02ce516e970fb087608419b7098dde82962906c70559717fda

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+rvm:
+  - 2.5.0
+services:
+  - mongodb
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never
+
+matrix:
+  include:
+    - rvm: 2.3.3
+      env: MONGOID_VERSION=5
+    - rvm: 2.3.3
+      env: MONGOID_VERSION=6
+    - rvm: 2.5.0
+      env: MONGOID_VERSION=7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+* first release

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mongoid-enum_attribute.gemspec
+gemspec
+
+case version = ENV['MONGOID_VERSION'] || '~> 7.0'
+when /7/ then gem 'mongoid', '~> 7.0'
+when /6/ then gem 'mongoid', '~> 6.0'
+when /5/ then gem 'mongoid', '~> 5.1'
+else gem 'mongoid', version
+end

data/README.md

@@ -0,0 +1,104 @@
+# Mongoid::EnumAttribute
+
+[![Build Status](https://travis-ci.org/tomasc/mongoid-enum_attribute.svg)](https://travis-ci.org/tomasc/mongoid-enum_attribute) [![Gem Version](https://badge.fury.io/rb/mongoid-enum_attribute.svg)](http://badge.fury.io/rb/mongoid-enum_attribute) [![Coverage Status](https://img.shields.io/coveralls/tomasc/mongoid-enum_attribute.svg)](https://coveralls.io/r/tomasc/mongoid-enum_attribute)
+
+Updated and tweaked version of the no-longer-maintained [mongoid_enum](https://github.com/thetron/mongoid-enum).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid-enum_attribute'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-enum_attribute
+
+## Usage
+
+```ruby
+class Payment
+  include Mongoid::Document
+  include Mongoid::Enum
+
+  enum :status, [:pending, :approved, :declined]
+end
+```
+
+Gives you getters,
+
+```ruby
+payment.status
+# => :pending
+```
+
+setters,
+
+```ruby
+payment.approved!
+# => :approved
+```
+
+conditionals,
+
+```ruby
+payment.pending?
+# => :false
+```
+
+and scopes
+
+```ruby
+Payment.approved
+# => Mongoid::Criteria for payments where status is :approved
+```
+
+## Prefix / Suffix
+
+You can use the `:prefix` and `:suffix` options, to prefix or suffix the methods
+of the enum. If the passed value is `true`, the methods are prefixed/suffixed
+with the name of the enum. It is also possible to supply a custom value:
+
+```ruby
+enum :status, [:pending, :approved, :declined], prefix: true
+enum :payments_status, [:pending, :approved, :declined], prefix: :payments
+
+enum :status, [:pending, :approved, :declined], suffix: true
+enum :payments_status, [:pending, :approved, :declined], suffix: :payments
+```
+
+This will result in the following methods:
+
+```ruby
+payment.status_declined! # prefix: true
+payment.payments_declined! # prefix: :payments
+
+payment.declined_status! # suffix: true
+payment.declined_payments! # suffix: :payments
+```
+
+If you want to change the behaviour app-wide you can use the configuration:
+
+```ruby
+Mongoid::EnumAttribute.configure do |config|
+  config.field_name_prefix = '_' # prefix of the field used to store the values in database
+  config.prefix = nil # prefix of the ! & ? method
+  config.suffix = nil # suffix of the ! & ? method
+end
+```
+
+## 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/[USERNAME]/mongoid-enum_attribute.

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 "mongoid/enum/attribute"
+
+# 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/mongoid/enum_attribute/configuration.rb

@@ -0,0 +1,23 @@
+module Mongoid
+  module EnumAttribute
+    class Configuration
+      attr_accessor :field_name_prefix
+      attr_accessor :prefix
+      attr_accessor :suffix
+
+      def initialize
+        self.field_name_prefix = '_'
+        self.prefix = nil
+        self.suffix = nil
+      end
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration) if block_given?
+    end
+  end
+end

data/lib/mongoid/enum_attribute/validators/multiple_validator.rb

@@ -0,0 +1,29 @@
+module Mongoid
+  module EnumAttribute
+    module Validators
+      class MultipleValidator < ActiveModel::EachValidator
+        def validate_each(record, attribute, values)
+          values = Array(values)
+
+          if options[:allow_nil]
+            add_error_message(record, attribute) if !all_included?(values, options[:in])
+          else
+            add_error_message(record, attribute) if values.empty? || !all_included?(values, options[:in])
+          end
+        end
+
+        def add_error_message(record, attribute)
+          record.errors[attribute] << (options[:message] || "is not in #{options[:in].join(', ')}")
+        end
+
+        def all_included?(values, allowed)
+          (values - allowed).empty?
+        end
+
+        def self.kind
+          :custom
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/enum_attribute/version.rb

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

data/lib/mongoid/enum_attribute.rb

@@ -0,0 +1,117 @@
+require "mongoid/enum_attribute/configuration"
+require "mongoid/enum_attribute/validators/multiple_validator"
+require "mongoid/enum_attribute/version"
+
+module Mongoid
+  module EnumAttribute
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def enum(name, values, options = {})
+        field_name = "#{Mongoid::EnumAttribute.configuration.field_name_prefix}#{name}"
+        options = default_options(values).merge(options)
+
+        set_values_constant(name, values)
+        create_field(field_name, options)
+
+        create_validations(field_name, values, options)
+        define_value_scopes_and_accessors(name, field_name, values, options)
+        define_field_accessor(name, field_name, options)
+      end
+
+      private
+
+      def default_options(values)
+        { multiple: false,
+          default: values.first,
+          required: true,
+          validate: true,
+          prefix: Mongoid::EnumAttribute.configuration.prefix,
+          suffix: Mongoid::EnumAttribute.configuration.suffix
+        }
+      end
+
+      def set_values_constant(name, values)
+        const_name = name.to_s.upcase
+        const_set(const_name, values)
+      end
+
+      def create_field(field_name, options)
+        type = options[:multiple] && Array || Symbol
+        field field_name, type: type, default: options[:default]
+      end
+
+      def create_validations(field_name, values, options)
+        if options[:multiple] && options[:validate]
+          validates(
+            field_name,
+            "mongoid/enum_attribute/validators/multiple".to_sym => {
+              in: values.map(&:to_sym),
+              allow_nil: !options[:required]
+            }
+          )
+        elsif options[:validate]
+          validates(
+            field_name,
+            inclusion: { in: values.map(&:to_sym) },
+            allow_nil: !options[:required]
+          )
+        end
+      end
+
+      def define_value_scopes_and_accessors(name, field_name, values, options)
+        values.each do |value|
+          scope(value, -> { where(field_name => value) })
+
+          accessor_name = value
+          accessor_name = apply_prefix(accessor_name, name, value, options[:prefix]) if options[:prefix]
+          accessor_name = apply_suffix(accessor_name, name, value, options[:suffix]) if options[:suffix]
+
+          if options[:multiple]
+            define_array_accessor(accessor_name, field_name, value)
+          else
+            define_string_accessor(accessor_name, field_name, value)
+          end
+        end
+      end
+
+      def apply_prefix(accessor_name, name, value, prefix)
+        return "#{prefix}_#{value}" if prefix.is_a?(String)
+        "#{name}_#{value}"
+      end
+
+      def apply_suffix(accessor_name, name, value, suffix)
+        return "#{value}_#{suffix}" if suffix.is_a?(String)
+        "#{value}_#{name}"
+      end
+
+      def define_field_accessor(name, field_name, options)
+        if options[:multiple]
+          define_array_field_accessor(name, field_name)
+        else
+          define_string_field_accessor(name, field_name)
+        end
+      end
+
+      def define_array_field_accessor(name, field_name)
+        class_eval "def #{name}=(vals) self.write_attribute(:#{field_name}, Array(vals).compact.map(&:to_sym)) end"
+        class_eval "def #{name}() self.send(:#{field_name}).map{ |i| i.try(:to_sym) } end"
+      end
+
+      def define_string_field_accessor(name, field_name)
+        class_eval "def #{name}=(val) self.write_attribute(:#{field_name}, val && val.to_sym || nil) end"
+        class_eval "def #{name}() self.send(:#{field_name}) end"
+      end
+
+      def define_array_accessor(accessor_name, field_name, value)
+        class_eval "def #{accessor_name}?() self.#{field_name}.include?(:#{value}) end"
+        class_eval "def #{accessor_name}!() update_attributes! :#{field_name} => (self.#{field_name} || []) + [:#{value}] end"
+      end
+
+      def define_string_accessor(accessor_name, field_name, value)
+        class_eval "def #{accessor_name}?() self.#{field_name} == :#{value} end"
+        class_eval "def #{accessor_name}!() update_attributes! :#{field_name} => :#{value} end"
+      end
+    end
+  end
+end

data/mongoid-enum_attribute.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mongoid/enum_attribute/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-enum_attribute"
+  spec.version       = Mongoid::EnumAttribute::VERSION
+  spec.authors       = ["Tomáš Celizna"]
+  spec.email         = ["tomas.celizna@gmail.com"]
+
+  spec.summary       = %q{Take on ActiveRecord::Enum in Mongoid}
+  spec.homepage      = "https://github.com/tomasc/mongoid-enum_attribute"
+
+  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_dependency 'mongoid', '>= 5', '< 8'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "database_cleaner"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-enum_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomáš Celizna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: database_cleaner
+  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'
+description: 
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongoid/enum_attribute.rb
+- lib/mongoid/enum_attribute/configuration.rb
+- lib/mongoid/enum_attribute/validators/multiple_validator.rb
+- lib/mongoid/enum_attribute/version.rb
+- mongoid-enum_attribute.gemspec
+homepage: https://github.com/tomasc/mongoid-enum_attribute
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Take on ActiveRecord::Enum in Mongoid
+test_files: []