persistent_enum 1.2.4

data/lib/persistent_enum/acts_as_enum.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_record'
+
+module PersistentEnum
+  module ActsAsEnum
+    extend ActiveSupport::Concern
+
+    class State
+      attr_reader :enum_spec, :by_name, :by_name_insensitive, :by_ordinal, :required_by_ordinal
+      delegate :required_members, :name_attr, :sql_enum_type, to: :enum_spec
+
+      def initialize(enum_spec, enum_values, required_enum_constants)
+        @enum_spec = enum_spec
+
+        enum_values.each do |val|
+          val.attributes.each_value { |attr| attr.freeze }
+          val.freeze
+        end
+
+        @by_ordinal = enum_values.index_by(&:ordinal).freeze
+
+        @by_name    = enum_values
+                        .index_by { |v| v.read_attribute(enum_spec.name_attr) }
+                        .with_indifferent_access
+                        .freeze
+
+        @by_name_insensitive = enum_values
+                                 .index_by { |v| v.read_attribute(enum_spec.name_attr).downcase }
+                                 .with_indifferent_access
+                                 .freeze
+
+        @required_by_ordinal = required_enum_constants
+                                 .map { |name| by_name.fetch(name) }
+                                 .index_by(&:ordinal)
+                                 .freeze
+
+        @insensitive_lookup  = (by_name.size == by_name_insensitive.size)
+
+        freeze
+      end
+
+      def insensitive_lookup?
+        @insensitive_lookup
+      end
+    end
+
+    module ClassMethods
+      # Overridden in singleton classes to close over acts-as-enum state in an
+      # subclassing-safe way.
+      def _acts_as_enum_state
+        nil
+      end
+
+      def initialize_acts_as_enum(enum_spec)
+        prev_state = _acts_as_enum_state
+
+        if self.methods(false).include?(:_acts_as_enum_state)
+          singleton_class.class_eval do
+            remove_method(:_acts_as_enum_state)
+          end
+        end
+
+        ActsAsEnum.register_acts_as_enum(self) if prev_state.nil?
+
+        required_values = PersistentEnum.cache_constants(
+          self,
+          enum_spec.required_members,
+          name_attr:     enum_spec.name_attr,
+          sql_enum_type: enum_spec.sql_enum_type)
+
+        required_enum_constants = required_values.map { |val| val.read_attribute(enum_spec.name_attr) }
+
+        # Now we've ensured that our required constants are present, load the rest
+        # of the enum from the database (if present)
+        all_values = required_values.dup
+        begin
+          if table_exists?
+            all_values.concat(unscoped { where.not(id: required_values) })
+          end
+        rescue ActiveRecord::NoDatabaseError
+          # Nothing additional to cache.
+        end
+
+        # Normalize values: If we already have a equal value in the previous
+        # state, we want to use that rather than a new copy of it
+        all_values.map! do |value|
+          if prev_state.present? && (prev_value = prev_state.by_name[name]) == value
+            prev_value
+          else
+            value
+          end
+        end
+
+        state = State.new(enum_spec, all_values, required_enum_constants)
+
+        singleton_class.class_eval do
+          define_method(:_acts_as_enum_state) { state }
+        end
+
+        before_destroy { raise ActiveRecord::ReadOnlyRecord }
+      end
+
+      def reinitialize_acts_as_enum
+        current_state = _acts_as_enum_state
+        raise "Cannot refresh acts_as_enum type #{self.name}: not already initialized!" if current_state.nil?
+
+        initialize_acts_as_enum(current_state.enum_spec)
+      end
+
+      def dummy_class
+        PersistentEnum.dummy_class(self, name_attr)
+      end
+
+      def [](index)
+        _acts_as_enum_state.by_ordinal[index]
+      end
+
+      def value_of(name, insensitive: false)
+        if insensitive
+          unless _acts_as_enum_state.insensitive_lookup?
+            raise RuntimeError.new("#{self.name} constants are case-dependent: cannot perform case-insensitive lookup")
+          end
+
+          _acts_as_enum_state.by_name_insensitive[name.downcase]
+        else
+          _acts_as_enum_state.by_name[name]
+        end
+      end
+
+      def value_of!(name, insensitive: false)
+        v = value_of(name, insensitive: insensitive)
+        raise NameError.new("#{self}: Invalid member '#{name}'") unless v.present?
+
+        v
+      end
+
+      alias with_name value_of
+
+      # Currently active ordinals
+      def ordinals
+        _acts_as_enum_state.required_by_ordinal.keys
+      end
+
+      # Currently active enum members
+      def values
+        _acts_as_enum_state.required_by_ordinal.values
+      end
+
+      def active?(member)
+        _acts_as_enum_state.required_by_ordinal.has_key?(member.ordinal)
+      end
+
+      # All ordinals, including of inactive enum members
+      def all_ordinals
+        _acts_as_enum_state.by_ordinal.keys
+      end
+
+      # All enum members, including inactive
+      def all_values
+        _acts_as_enum_state.by_ordinal.values
+      end
+
+      def name_attr
+        _acts_as_enum_state.name_attr
+      end
+    end
+
+    # Enum values should not be mutable: allow creation and modification only
+    # before the state has been initialized.
+    def readonly?
+      !self.class._acts_as_enum_state.nil?
+    end
+
+    def enum_constant
+      read_attribute(self.class.name_attr)
+    end
+
+    def to_sym
+      enum_constant.to_sym
+    end
+
+    def ordinal
+      read_attribute(:id)
+    end
+
+    # Is this enum member still present in the enum declaration?
+    def active?
+      self.class.active?(self)
+    end
+
+    class << self
+      @@known_enumerations = {}
+      LOCK = Monitor.new
+
+      def register_acts_as_enum(clazz)
+        LOCK.synchronize do
+          @@known_enumerations[clazz.name] = clazz
+        end
+      end
+
+      # Reload enumerations from the database: useful if the database contents
+      # may have changed (e.g. fixture loading).
+      def reinitialize_enumerations
+        LOCK.synchronize do
+          @@known_enumerations.each_value do |clazz|
+            clazz.reinitialize_acts_as_enum
+          end
+        end
+      end
+
+      # Ensure that all known_enumerations are loaded by resolving each name
+      # constant and reregistering the resulting class. Raises NameError if a
+      # previously-encountered type cannot be resolved.
+      def rerequire_known_enumerations
+        LOCK.synchronize do
+          @@known_enumerations.keys.each do |name|
+            new_clazz = name.safe_constantize
+            unless new_clazz.is_a?(Class)
+              raise NameError.new("Could not resolve ActsAsEnum type '#{name}' after reload")
+            end
+
+            register_acts_as_enum(new_clazz)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/persistent_enum/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PersistentEnum
+  class Railtie < Rails::Railtie
+    # On ActionDispatch::Reloader prepare!, ensure that registered acts_as_enums
+    # are eager-reloaded. This reduces the chance that they'll be reloaded during
+    # a transaction.
+    config.to_prepare do
+      ActsAsEnum.rerequire_known_enumerations
+    end
+  end
+end

data/lib/persistent_enum/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PersistentEnum
+  VERSION = '1.2.4'
+end

data/persistent_enum.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'persistent_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'persistent_enum'
+  spec.version       = PersistentEnum::VERSION
+  spec.authors       = ['iKnow']
+  spec.email         = ['systems@iknow.jp']
+  spec.summary       = 'Database-backed enums for Rails'
+  spec.description   = 'Provide a database-backed enumeration between indices and symbolic values. This allows us to have a valid foreign key which behaves like a enumeration. Values are cached at startup, and cannot be changed.'
+  spec.license       = 'BSD-2-Clause'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 5.0', '< 7'
+  spec.add_dependency 'activesupport', '>= 5.0', '< 7'
+
+  spec.add_dependency 'activerecord-import'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'mysql2'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_development_dependency 'byebug'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+  require 'support/helpers/database_helper'
+  config.include DatabaseHelper, :database
+
+  unless DatabaseHelper.db_env == 'postgresql'
+    config.filter_run_excluding :postgresql
+  end
+end

data/spec/support/config/database.yml

@@ -0,0 +1,12 @@
+---
+postgresql:
+  adapter: postgresql
+  database: persistent_enum_test
+mysql2:
+  adapter: mysql2
+  database: persistent_enum_test
+  host: <%= ENV.fetch('MYSQL_HOST') { '127.0.0.1' } %>
+  user: <%= ENV.fetch('MYSQL_USER') { 'root' } %>
+sqlite3:
+  adapter: sqlite3
+  database: ":memory:"

data/spec/support/helpers/database_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'active_record'
+
+module DatabaseHelper
+  def self.db_env
+    ENV.fetch('TEST_DATABASE_ENVIRONMENT', 'postgresql')
+  end
+
+  def self.initialize_database
+    db_config_path = File.join(File.dirname(__FILE__), '../config/database.yml')
+    db_config_data = File.read(db_config_path)
+    db_config_data = ERB.new(db_config_data).result
+    db_config = YAML.safe_load(db_config_data)
+    raise 'Test database configuration missing' unless db_config[db_env]
+
+    ActiveRecord::Base.establish_connection(db_config[db_env])
+
+    if ENV['DEBUG']
+      ActiveRecord::Base.logger = Logger.new(STDERR)
+      ActiveRecord::Base.logger.level = Logger::DEBUG
+    end
+    db_env
+  end
+
+  def initialize_test_models
+    @test_models = []
+  end
+
+  def create_test_model(name, columns, create_table: true, &block)
+    if create_table
+      table_name = name.to_s.pluralize
+      ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS #{table_name}")
+      ActiveRecord::Base.connection.create_table(table_name, &columns)
+    end
+
+    model_name = name.to_s.classify
+    clazz = Class.new(ActiveRecord::Base)
+    Object.const_set(model_name, clazz)
+    @test_models << clazz
+    clazz.primary_key = :id
+    clazz.class_eval(&block) if block_given?
+    clazz.reset_column_information
+    clazz
+  end
+
+  def destroy_test_models
+    @test_models.reverse_each do |m|
+      destroy_test_model(m)
+    end
+    @test_models.clear
+  end
+
+  def destroy_test_model(clazz)
+    if Object.const_defined?(clazz.name)
+      Object.send(:remove_const, clazz.name)
+    end
+
+    table_name = clazz.table_name
+    if clazz.connection.data_source_exists?(table_name)
+      clazz.connection.drop_table(table_name, force: :cascade)
+    end
+
+    ActiveSupport::Dependencies::Reference.clear!
+  end
+end