configurable_enum 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d809d91c40c38f3ef9f422c4c1ff1835c4bd3650
+  data.tar.gz: e98415ca4cdfb34f86f5b1a2e9c8c181485fefac
+SHA512:
+  metadata.gz: 649753c19bb0abdb85552c5f329628d12e1b8cbd189ccf89cd82f609042d9c71c29944e00fc6f8ef46537f4dae465fbba69f7a06e14e09e2b33057d62a17b693
+  data.tar.gz: '0676958d78e37fb0dd6302048dc63d519685d778e837a16529c4c9937acb938b0b22c40e518f114b1ce51d70560f11c55313607c0509d050cc18b1b292884aa7'

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at xy@xiayouwang.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in configurable_enum.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: .
+  specs:
+    configurable_enum (1.0.0)
+      rails (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.3)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  configurable_enum!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 zhandao
+
+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 @@
+# ConfigurableEnum
+
+Make ActiveRecord `enum` configurable: store the mapping in database instead of hard code
+
+**Only Support `Integer` Value Currently**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'configurable_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+1. Setup: Generate mapping model and migration:  
+   `rails g configurable_enum:setup <model_column>`  
+   For example, you want to make `Book`'s column `category` to be enum: `rails g configurable_enum:setup book_category`  
+   It will Generate a model `BookCategroyMapping`
+   
+2. `rails db:migrate`
+   
+3. Declare in the model, like:
+    ```ruby
+    class Book < ActiveRecord
+      configurable_enum :category
+    end
+    ```
+    
+4. You may want to init the enum mapping data, use:
+    ```ruby
+    hash = { science: 1 } # or { science: [1, 'remarks'] }
+    Book.set_categories(hash)
+    ```
+
+That's all!
+
+Other methods:
+
+1. `Book.categories`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/configurable_enum. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ConfigurableEnum project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/configurable_enum/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "configurable_enum"
+
+# 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/configurable_enum.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "configurable_enum/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "configurable_enum"
+  spec.version       = ConfigurableEnum::VERSION
+  spec.authors       = ["zhandao"]
+  spec.email         = ["x@skippingcat.com"]
+
+  spec.summary       = 'Make ActiveRecord `enum` configurable: store the mapping in database instead of hard code'
+  spec.description   = 'Make ActiveRecord `enum` configurable: store the mapping in database instead of hard code'
+  spec.homepage      = 'https://github.com/zhandao'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'rails', '>= 3.0'
+end

data/lib/configurable_enum.rb

@@ -0,0 +1,44 @@
+require 'configurable_enum/version'
+require 'configurable_enum/enum_type'
+
+module ConfigurableEnum
+  def configurable_enum column_name,
+                        mapping_class: [name, column_name.to_s.camelize, 'Mapping'].join
+    mapping_model = mapping_class.to_s.constantize
+    query_method = column_name.to_s.pluralize
+
+    decorate_attribute_type(column_name, :enum) do |subtype|
+      EnumType.new(column_name, self, subtype)
+    end
+
+    cache_key = "configurable_enum/#{self.name}/#{column_name}"
+    # === Example for model `Book`'s column `category` ===
+    # `Book.categories` returns the hash mapping from the stored data
+    define_singleton_method query_method do
+      Rails.cache.fetch(cache_key) do
+        ActiveSupport::HashWithIndifferentAccess.new(
+            mapping_model.all.map { |record| [ record.label, record.value ] }.to_h
+        )
+      end
+    end
+
+    # `Book.set_categories` will update or create the mapping records
+    # that is specified by keys of the hash you provided
+    define_singleton_method "set_#{query_method}" do |mapping|
+      mapping.each_pair do |label, value|
+        value, remarks = value if value.is_a?(Array)
+        mapping_model.find_by(label: label)&.update(value: value, remarks: remarks) ||
+            mapping_model.create(label: label, value: value, remarks: remarks)
+      end
+    end
+
+    mapping_model.class_eval do
+      default_scope { order(value: :asc) }
+      after_commit { Rails.cache.delete(cache_key) }
+    end
+  end
+end
+
+# ActiveSupport.on_load(:active_record_base) do
+  ActiveRecord::Base.extend ConfigurableEnum
+# end

data/lib/configurable_enum/enum_type.rb

@@ -0,0 +1,43 @@
+module ConfigurableEnum
+  class EnumType < ActiveRecord::Type::Value # :nodoc:
+    delegate :type, to: :subtype
+    attr_reader :col_name, :mapping, :subtype
+
+    def initialize(col_name, kls, subtype)
+      @col_name = col_name
+      @kls = kls
+      @subtype = subtype
+    end
+
+    def mapping
+      @kls.send(col_name.to_s.pluralize)
+    end
+
+    def cast(value)
+      return if value.blank?
+
+      if mapping.has_key?(value)
+        value.to_s
+      elsif mapping.has_value?(value)
+        mapping.key(value)
+      else
+        assert_valid_value(value)
+      end
+    end
+
+    def deserialize(value)
+      return if value.nil?
+      mapping.key(subtype.deserialize(value))
+    end
+
+    def serialize(value)
+      mapping.fetch(value, value)
+    end
+
+    def assert_valid_value(value)
+      unless value.blank? || mapping.has_key?(value) || mapping.has_value?(value)
+        raise ArgumentError, "'#{value}' is not a valid #{col_name}"
+      end
+    end
+  end
+end

data/lib/configurable_enum/version.rb

@@ -0,0 +1,3 @@
+module ConfigurableEnum
+  VERSION = '1.0.0'
+end

data/lib/generators/configurable_enum/setup_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module ConfigurableEnum
+  module Generators
+    class SetupGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      desc 'Generates migrations for mapping data'
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def setup_migrations
+        migration_template 'migrations/mapping.erb', "db/migrate/#{name_u}.rb"
+      end
+
+      def setup_models
+        template 'models/mapping.erb', "app/models/#{name_u}.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def name_u; name.underscore + '_mapping' end
+      def name_c; name_u.camelize end
+      def name_up; name_u.pluralize end
+    end
+  end
+end

data/lib/generators/configurable_enum/templates/migrations/mapping.erb

@@ -0,0 +1,14 @@
+class Create<%= name_c %> < ActiveRecord::Migration::Current
+  def change
+    create_table :<%= name_up %>, force: :cascade do |t|
+      t.string  :label,   null: false
+      t.integer :value,   null: false
+      t.string  :remarks
+
+      t.timestamps
+    end
+
+    add_index :<%= name_up %>, :label, unique: true
+    add_index :<%= name_up %>, :value, unique: true
+  end
+end

data/lib/generators/configurable_enum/templates/models/mapping.erb

@@ -0,0 +1,2 @@
+class <%= name_c %> < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: configurable_enum
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- zhandao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-27 00:00:00.000000000 Z
+dependencies:
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Make ActiveRecord `enum` configurable: store the mapping in database
+  instead of hard code'
+email:
+- x@skippingcat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- configurable_enum.gemspec
+- lib/configurable_enum.rb
+- lib/configurable_enum/enum_type.rb
+- lib/configurable_enum/version.rb
+- lib/generators/configurable_enum/setup_generator.rb
+- lib/generators/configurable_enum/templates/initializers/configurable_enum.erb
+- lib/generators/configurable_enum/templates/migrations/mapping.erb
+- lib/generators/configurable_enum/templates/models/mapping.erb
+homepage: https://github.com/zhandao
+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.6.12
+signing_key: 
+specification_version: 4
+summary: 'Make ActiveRecord `enum` configurable: store the mapping in database instead
+  of hard code'
+test_files: []