sql_enum 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2db9bae7e87154948d42ff23710df268a6f942c66aa52b42dd12c78606141c32
-  data.tar.gz: 4ad6e4b93c4ff9bfeaa2b143a96b2b5327c0c2e774320c6e9b2e2c7f569e7155
+  metadata.gz: 77e67bb36b77c10947ed386e5ee8d88b500e2b9e86e62a5b688747b81ad8a3e5
+  data.tar.gz: 99d61ac4776af2d3cf3f7e3c28c7ff8f931aeda99d915a29ae2578495b819b67
 SHA512:
-  metadata.gz: 55105be1538e1f81803acd39b5e202ee0ed685d583fa5c7e99d650edabbe43bf6e13dfdac59a134c5511a00e767a97546e33fd6340f69f0bdc9a0791749bcb12
-  data.tar.gz: f63345f9b4478d15c3138f405c7ab6d0b7952bfa6294761d01db50bf164a231fb74dd8f5f2c86f2cae9f04a348539c02d6f236d991b66e4a30bb37f3736677ec
+  metadata.gz: 930d73715dcdb3ae76416d0600a9fe6ee7b09abaa699a1556cd6c71d88be6e39e4f8413a93c3b009485f2fb0cef63a8a202f2f9c28e2982360f2ae211fe0392d
+  data.tar.gz: 67928721dc4507edf4cf3f677041ffeb29f7c01d2f7808998ae6dc404e2b659f3e73ca05066a3b28c571654b58ce334b087c0e610c1e63fc7e9f30371871dfa8

data/.env.local

@@ -0,0 +1 @@
+DATABASE_URL="mysql2://root:@mysql/"

data/.github/workflows/tests.yml

@@ -2,25 +2,31 @@ name: Tests
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
 
 jobs:
   rspec:
     strategy:
       matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
         rails:
-          - '5.1'
-          - '5.2'
-          - '6.0'
           - '6.1'
-
+          - '7.0'
+          - '7.1'
     runs-on: ubuntu-latest
 
-    name: RSpec (Rails ${{ matrix.rails }})
+    name: RSpec (Rails ${{ matrix.rails }}) (Ruby ${{ matrix.ruby }})
 
     steps:
       - uses: actions/checkout@v2
-
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Test
         run: docker-compose run --rm rspec bundle exec appraisal rails-${{ matrix.rails }} rspec

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 
 gemfiles/*.lock
+.env.local

data/Appraisals

@@ -1,15 +1,11 @@
-appraise "rails-5.1" do
-  gem "rails", "~> 5.1.0"
-end
-
-appraise "rails-5.2" do
-  gem "rails", "~> 5.2.0"
+appraise "rails-6.1" do
+  gem "rails", "~> 6.1"
 end
 
-appraise "rails-6.0" do
-  gem "rails", "~> 6.0.0"
+appraise "rails-7.0" do
+  gem "rails", "~> 7.0"
 end
 
-appraise "rails-6.1" do
-  gem "rails", "~> 6.1.0"
+appraise "rails-7.1" do
+  gem "rails", "~> 7.1"
 end

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.7
+FROM ruby:3.0
 
 WORKDIR /usr/src/app
 
@@ -6,4 +6,5 @@ RUN mkdir -p lib/sql_enum gemfiles
 COPY lib/sql_enum/version.rb  ./lib/sql_enum/
 COPY gemfiles/*.gemfile gemfiles/
 COPY sql_enum.gemspec Gemfile Gemfile.lock Appraisals ./
-RUN bundle install && exec appraisal install
+RUN bundle install && \
+    bundle exec appraisal install

data/Gemfile

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

data/Gemfile.lock

@@ -1,61 +1,66 @@
 PATH
   remote: .
   specs:
-    sql_enum (0.3.1)
-      activerecord (>= 5.1)
-      activesupport (>= 5.1)
+    sql_enum (1.0.0)
+      activerecord (>= 6.1.0)
+      activesupport (>= 6.1.0)
       mysql2
 
 GEM
-  remote: https://gem-proxy.chime.com/
+  remote: https://rubygems.org/
   specs:
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activerecord (6.1.4.1)
-      activemodel (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activesupport (6.1.4.1)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activerecord (7.0.8)
+      activemodel (= 7.0.8)
+      activesupport (= 7.0.8)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    appraisal (2.4.1)
+    appraisal (2.5.0)
       bundler
       rake
       thor (>= 0.14.0)
-    concurrent-ruby (1.1.9)
-    debug (1.3.2)
-      irb (>= 1.3.6)
-      reline (>= 0.2.7)
-    diff-lcs (1.3)
-    i18n (1.8.10)
+    awesome_print (1.9.2)
+    concurrent-ruby (1.2.3)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    io-console (0.5.9)
-    irb (1.3.7)
-      reline (>= 0.2.7)
-    minitest (5.14.4)
-    mysql2 (0.5.3)
-    rake (13.0.3)
-    reline (0.2.7)
+    io-console (0.7.2)
+    irb (1.11.1)
+      rdoc
+      reline (>= 0.4.2)
+    minitest (5.21.2)
+    mysql2 (0.5.5)
+    psych (5.1.2)
+      stringio
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    reline (0.4.2)
       io-console (~> 0.5)
-    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)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    thor (1.1.0)
-    tzinfo (2.0.4)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    stringio (3.1.0)
+    thor (1.3.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -63,6 +68,7 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
+  awesome_print
   bundler
   debug
   rake (~> 13.0)
@@ -70,4 +76,4 @@ DEPENDENCIES
   sql_enum!
 
 BUNDLED WITH
-   2.2.30
+   2.5.5

data/README.md

@@ -2,6 +2,12 @@
 
 Enables usage of native sql enums with ActiveRecord
 
+## NOTE
+
+Version 1.0 of this is compatible with Rails 7 and above.
+
+For Rails versions below Rails 7, use version 0.4
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -66,4 +72,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SqlEnum project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/1debit/sql_enum/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SqlEnum project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/1debit/sql_enum/blob/main/CODE_OF_CONDUCT.md).

data/docker-compose.yml

@@ -12,12 +12,13 @@ services:
 
   mysql:
     image: mysql:5.7
+    platform: linux/amd64
     environment:
       - MYSQL_ALLOW_EMPTY_PASSWORD=yes
       - MYSQL_DATABASE
       - MYSQL_USER
       - MYSQL_PASSWORD
     healthcheck:
-      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
+      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
       timeout: 20s
       retries: 10

data/gemfiles/rails_6.1.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "https://gem-proxy.chime.com"
+source "https://rubygems.org"
 
-gem "rails", "~> 6.1.0"
+gem "rails", "~> 6.1"
 
 gemspec path: "../"

data/gemfiles/{rails_5.1.gemfile → rails_7.0.gemfile}

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "https://gem-proxy.chime.com"
+source "https://rubygems.org"
 
-gem "rails", "~> 5.1.0"
+gem "rails", "~> 7.0"
 
 gemspec path: "../"

data/gemfiles/{rails_5.2.gemfile → rails_7.1.gemfile}

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "https://gem-proxy.chime.com"
+source "https://rubygems.org"
 
-gem "rails", "~> 5.2.0"
+gem "rails", "~> 7.1"
 
 gemspec path: "../"

data/lib/active_record/connection_adapters/abstract_mysql.rb

@@ -1,19 +1,47 @@
 module ActiveRecord
   module ConnectionAdapters
     class AbstractMysqlAdapter
-      def initialize_type_map_with_enum(m = type_map)
-        initialize_without_enum(m)
-        register_enum_type(m)
+      class << self
+        def register_enum_type(mapping)
+          mapping.register_type(%r(enum)i) do |sql_type|
+            Type::Enum.new(limit: sql_type.to_s.scan(/'(.*?)'/).flatten)
+          end
+        end
+      end
+
+      # In Rails 6.1, registering the enum type is an instance method and is
+      # done on initialization, In Rails 7.0 it is a class method and
+      # the registration happens when the class is loaded. So, in Rails 6.1,
+      # we can override the `initialize_type_map` method to register the enum
+      # but in Rails 7.1, we need to call register_enum_type explicitly.
+
+      if SqlEnum.rails_version_match?("6.1")
+        module SqlEnumMapper
+          def initialize_type_map(m = type_map)
+            super(m)
+            AbstractMysqlAdapter.register_enum_type(m)
+          end
+        end
+
+        ActiveRecord::ConnectionAdapters::Mysql2Adapter.prepend(SqlEnumMapper)
       end
 
-      alias_method :initialize_without_enum, :initialize_type_map
-      alias_method :initialize_type_map, :initialize_type_map_with_enum
 
-      def register_enum_type(mapping)
-        mapping.register_type(%r(enum)i) do |sql_type|
-          Type::Enum.new(limit: sql_type.scan(/'(.*?)'/).flatten)
+      if SqlEnum.rails_version_match?("7.0")
+        [
+          ActiveRecord::ConnectionAdapters::Mysql2Adapter::TYPE_MAP,
+          ActiveRecord::ConnectionAdapters::Mysql2Adapter::TYPE_MAP_WITH_BOOLEAN
+        ].each do |m|
+          AbstractMysqlAdapter.register_enum_type(m)
         end
       end
+
+      # Rails 7.1 drops the TYPE_MAP_WITH_BOOLEAN constant
+      if SqlEnum.rails_version_match?("7.1")
+          AbstractMysqlAdapter.register_enum_type(
+            ActiveRecord::ConnectionAdapters::Mysql2Adapter::TYPE_MAP
+          )
+      end
     end
   end
 end

data/lib/active_record/connection_adapters/mysql/column_methods.rb

@@ -5,7 +5,7 @@ module ActiveRecord
     module MySQL
       module ColumnMethods
         def enum(*args, **options)
-          args.each { |name| column(name, :enum, options) }
+          args.each { |name| column(name, :enum, **options) }
         end
       end
     end

data/lib/sql_enum/class_methods.rb

@@ -1,6 +1,9 @@
 module SqlEnum
   module ClassMethods
     def sql_enum(column_name, options = {})
+      # skip redefinitions
+      return if defined_enums.key?(column_name.to_s)
+
       # Query values
       enum_column = EnumColumn.new(table_name, column_name)
       values_map = enum_column.values.to_h { |value| [value.to_sym, value.to_s] }
@@ -14,20 +17,15 @@ module SqlEnum
 
       # Override reader to return symbols
       type_definition = ->(subtype) { EnumType.new(attr, send(column_name.to_s.pluralize), subtype) }
-      case method(:decorate_attribute_type).arity
-      when 2 # Rails 5.1, 5.2, 6.0
-        decorate_attribute_type(column_name, :enum, &type_definition)
-      else
-        decorate_attribute_type(column_name, &type_definition)
-      end
+      attribute(column_name, &type_definition)
 
       prefix_str = format_affix(column_name, prefix, suffix: '_')
       suffix_str = format_affix(column_name, suffix, prefix: '_')
 
       # Fix query methods to compare symbols to symbols
       values_map.each_value do |value|
-        method_name = "#{prefix_str}#{value}#{suffix_str}"
-        define_method("#{method_name}?") { self[column_name] == value.to_sym }
+        method_name = "#{prefix_str}#{value}#{suffix_str}?"
+        define_method(method_name) { self[column_name] == value.to_sym }
       end
     end
 

data/lib/sql_enum/version.rb

@@ -1,3 +1,3 @@
 module SqlEnum
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
 end

data/lib/sql_enum.rb

@@ -7,6 +7,10 @@ module SqlEnum
     self.configuration ||= Configuration.new
     yield(configuration)
   end
+
+  def self.rails_version_match?(version_string)
+    ActiveSupport.version.to_s.start_with?(version_string)
+  end
 end
 
 require 'active_record'

data/sql_enum.gemspec

@@ -13,6 +13,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/1debit/sql_enum"
   spec.license       = "MIT"
 
+  spec.metadata = {
+    'homepage_uri' => spec.homepage,
+    'source_code_uri' => spec.homepage,
+  }
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -20,13 +25,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 5.1"
-  spec.add_dependency "activerecord", ">= 5.1"
   spec.add_dependency "mysql2"
+  spec.add_dependency "activesupport", ">= 6.1.0"
+  spec.add_dependency "activerecord", ">= 6.1.0"
 
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "debug"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "appraisal"
 end

metadata

@@ -1,51 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: sql_enum
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Fletcher Fowler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -95,33 +109,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description:
 email:
 - fletch@fzf.me
@@ -130,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env"
+- ".env.local"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
@@ -145,10 +160,9 @@ files:
 - bin/console
 - bin/setup
 - docker-compose.yml
-- gemfiles/rails_5.1.gemfile
-- gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.1.gemfile
 - lib/active_record/connection_adapters/abstract_mysql.rb
 - lib/active_record/connection_adapters/mysql/column_methods.rb
 - lib/active_record/connection_adapters/mysql2.rb
@@ -164,7 +178,9 @@ files:
 homepage: https://github.com/1debit/sql_enum
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/1debit/sql_enum
+  source_code_uri: https://github.com/1debit/sql_enum
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -180,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Enable using native sql enums

data/gemfiles/rails_6.0.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://gem-proxy.chime.com"
-
-gem "rails", "~> 6.0.0"
-
-gemspec path: "../"