sql_enum 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ba5a5a0695bc9c11496ca90509646d98e2e005e7c89664aba78acb1de45d270
-  data.tar.gz: 1cb90fe77fcc9b7e2d84c0fe9b9b41ddee264de6e488d5de8dbc9462371a8ecd
+  metadata.gz: b4f885963c1a9b5c4d6612807ea7627f34fc455a730a45ed93fe380bc2a4d0ff
+  data.tar.gz: 8489d2a5a017117bb1d5a0d5bb88ccab8f11e4be19a915374ee3d12222d45f76
 SHA512:
-  metadata.gz: 795a28c30fc3fddb87865fc82325243c67a009694c409ffe880dace43c0d601cdcc32b4d9806a9d9c3220616dcc82be9b0e57ca8ccb3bb14c2d6562457c588a5
-  data.tar.gz: 67835417b809b63b7d97deb3531d059f3df63d1450406b0216cb81540a7276c691635126da7afdbf1dcf87fb128f7fe63cc8e196073fac55254e321ca1b66b58
+  metadata.gz: 6f4ed451ed9dd0d9f6b0e0d5475efadea5bc1de0d3f19e54bfd2066dfb2685cdb7e9f601bd1ca5b977af17b0df19c89860b5ee2bc5791fbdaf19f2644bbd32de
+  data.tar.gz: c27592b8fc57952f8237d8dd19c21e50335b7f9a5de2081074a331b5972f7fa4eacbd61745e3da3424086f5f35e64a2df909d866973d96c3268fa758bdd2f36c

data/.github/workflows/tests.yml

@@ -2,15 +2,31 @@ name: Tests
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
 
 jobs:
   rspec:
+    strategy:
+      matrix:
+        ruby:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+        rails:
+          - '6.0'
+          - '6.1'
+
     runs-on: ubuntu-latest
 
+    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
+        run: docker-compose run --rm rspec bundle exec appraisal rails-${{ matrix.rails }} rspec

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+gemfiles/*.lock

data/Appraisals

@@ -0,0 +1,12 @@
+appraise "rails-6.0" do
+  gem "rails", "~> 6.0.0"
+end
+
+appraise "rails-6.1" do
+  gem "rails", "~> 6.1.0"
+end
+
+# Rails 7.0 doesn't work yet
+# appraise "rails-7.0" do
+#   gem "rails", "~> 7.0"
+# end

data/Dockerfile

@@ -1,12 +1,9 @@
 FROM ruby:3.0
 
-# throw errors if Gemfile has been modified since Gemfile.lock
-RUN bundle config --global frozen 1
-
 WORKDIR /usr/src/app
 
-# Bundler caching
-RUN mkdir -p lib/sql_enum
+RUN mkdir -p lib/sql_enum gemfiles
 COPY lib/sql_enum/version.rb  ./lib/sql_enum/
-COPY sql_enum.gemspec Gemfile Gemfile.lock ./
-RUN bundle install
+COPY gemfiles/*.gemfile gemfiles/
+COPY sql_enum.gemspec Gemfile Gemfile.lock Appraisals ./
+RUN bundle install && exec appraisal install

data/Gemfile.lock

@@ -1,54 +1,70 @@
 PATH
   remote: .
   specs:
-    sql_enum (0.3.0)
-      activerecord (>= 5.0)
-      activesupport (>= 5.0)
+    sql_enum (0.4.0)
+      activerecord (>= 6.0, < 7.0)
+      activesupport (>= 6.0, < 7.0)
       mysql2
 
 GEM
   remote: https://gem-proxy.chime.com/
   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 (6.1.7.6)
+      activesupport (= 6.1.7.6)
+    activerecord (6.1.7.6)
+      activemodel (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+    activesupport (6.1.7.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.3)
-    i18n (1.8.10)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.2.2)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    mysql2 (0.5.3)
-    rake (13.0.3)
-    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)
+    io-console (0.6.0)
+    irb (1.7.4)
+      reline (>= 0.3.6)
+    minitest (5.19.0)
+    mysql2 (0.5.5)
+    rake (13.0.6)
+    reline (0.3.8)
+      io-console (~> 0.5)
+    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)
-    tzinfo (2.0.4)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    thor (1.2.2)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.5.1)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
+  appraisal
   bundler
+  debug
   rake (~> 13.0)
   rspec (~> 3.0)
   sql_enum!

data/README.md

@@ -66,4 +66,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

@@ -8,7 +8,7 @@ services:
     depends_on:
       mysql:
         condition: service_healthy
-    command: bundle exec rspec
+    command: bundle exec appraisal rspec
 
   mysql:
     image: mysql:5.7

data/gemfiles/rails_5.1.gemfile

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

data/gemfiles/rails_5.2.gemfile

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

data/gemfiles/rails_6.0.gemfile

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

data/gemfiles/rails_6.1.gemfile

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

data/gemfiles/rails_7.0.gemfile

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

data/lib/active_record/connection_adapters/abstract_mysql.rb

@@ -1,3 +1,6 @@
+# This module fails in Rails 7.0 becuase the method being modified has been
+# changed to a class method.
+
 module ActiveRecord
   module ConnectionAdapters
     class AbstractMysqlAdapter

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

@@ -3,18 +3,41 @@ module SqlEnum
     def sql_enum(column_name, options = {})
       # Query values
       enum_column = EnumColumn.new(table_name, column_name)
-      values = enum_column.values.to_h { |value| [value.to_sym, value.to_s] }
+      values_map = enum_column.values.to_h { |value| [value.to_sym, value.to_s] }
 
       # Check option defaults
       prefix = options.fetch(:_prefix, !!SqlEnum.configuration&.default_prefix)
       suffix = options.fetch(:_suffix, !!SqlEnum.configuration&.default_suffix)
 
       # Define enum using Rails enum
-      enum(column_name => values, _prefix: prefix, _suffix: suffix)
+      enum(column_name => values_map, _prefix: prefix, _suffix: suffix)
 
       # Override reader to return symbols
-      concerning "SqlEnum#{column_name.to_s.camelize}" do
-        define_method(column_name) { super()&.to_sym }
+      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
+
+      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 }
+      end
+    end
+
+    private
+
+    def format_affix(column_name, affix, prefix: '', suffix: '')
+      if affix == true
+        "#{prefix}#{column_name}#{suffix}"
+      elsif affix
+        "#{prefix}#{affix}#{suffix}"
       end
     end
   end

data/lib/sql_enum/enum_column.rb

@@ -21,13 +21,13 @@ module SqlEnum
     end
 
     def schema_values_query
-      <<~EOSQL
-      SELECT column_type
-      FROM information_schema.COLUMNS
-      WHERE TABLE_SCHEMA = '#{database_name}'
-      AND TABLE_NAME = '#{table_name}'
-      AND COLUMN_NAME = '#{column_name}'
-      EOSQL
+      <<~SQL
+        SELECT column_type
+        FROM information_schema.COLUMNS
+        WHERE TABLE_SCHEMA = '#{database_name}'
+        AND TABLE_NAME = '#{table_name}'
+        AND COLUMN_NAME = '#{column_name}'
+      SQL
     end
   end
 end

data/lib/sql_enum/enum_type.rb

@@ -0,0 +1,12 @@
+module SqlEnum
+  # EnumType that always returns a symbol
+  class EnumType < ActiveRecord::Enum::EnumType
+    def cast(arg)
+      super&.to_sym
+    end
+
+    def deserialize(arg)
+      super&.to_sym
+    end
+  end
+end

data/lib/sql_enum/version.rb

@@ -1,3 +1,3 @@
 module SqlEnum
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/sql_enum.rb

@@ -20,5 +20,6 @@ require_relative 'active_record/connection_adapters/mysql/column_methods'
 require_relative 'sql_enum/version'
 require_relative 'sql_enum/configuration'
 require_relative 'sql_enum/enum_column'
+require_relative 'sql_enum/enum_type'
 require_relative 'sql_enum/class_methods'
 require_relative 'sql_enum/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,11 +25,13 @@ 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.0"
-  spec.add_dependency "activerecord", ">= 5.0"
+  spec.add_dependency "activesupport", ">= 6.0", "< 7.0"
+  spec.add_dependency "activerecord", ">= 6.0", "< 7.0"
   spec.add_dependency "mysql2"
 
+  spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "debug"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_enum
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Fletcher Fowler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-28 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +64,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +92,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +146,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
@@ -116,6 +157,11 @@ 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
 - lib/active_record/connection_adapters/abstract_mysql.rb
 - lib/active_record/connection_adapters/mysql/column_methods.rb
 - lib/active_record/connection_adapters/mysql2.rb
@@ -125,12 +171,15 @@ files:
 - lib/sql_enum/class_methods.rb
 - lib/sql_enum/configuration.rb
 - lib/sql_enum/enum_column.rb
+- lib/sql_enum/enum_type.rb
 - lib/sql_enum/version.rb
 - sql_enum.gemspec
 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:
@@ -146,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Enable using native sql enums