sql_enum 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd16ecd7dbef436bf1613fa7b841e3575db7528778cee563fcb7128ae48ed24b
-  data.tar.gz: 474745a0a9090a1e9203493c6f4864a69fb07f622ece22e3db432142ef2de953
+  metadata.gz: 7ba5a5a0695bc9c11496ca90509646d98e2e005e7c89664aba78acb1de45d270
+  data.tar.gz: 1cb90fe77fcc9b7e2d84c0fe9b9b41ddee264de6e488d5de8dbc9462371a8ecd
 SHA512:
-  metadata.gz: 62b096819785f82af237b66cfe9cab150037e229796dda1e760f52e91140a8bcae092126e5bac5b0f51ea72cd25abad51ee9ad8f68b5ceb70b39682e18e367ce
-  data.tar.gz: 2c702f4de99f2c50513ae2b1cbcf17a349601d63b7e59a09750488358bca93632219924f444270a33befee9a28153970e0d129e1d20f62d30dc94ac028359d46
+  metadata.gz: 795a28c30fc3fddb87865fc82325243c67a009694c409ffe880dace43c0d601cdcc32b4d9806a9d9c3220616dcc82be9b0e57ca8ccb3bb14c2d6562457c588a5
+  data.tar.gz: 67835417b809b63b7d97deb3531d059f3df63d1450406b0216cb81540a7276c691635126da7afdbf1dcf87fb128f7fe63cc8e196073fac55254e321ca1b66b58

data/.env

@@ -0,0 +1,3 @@
+MYSQL_DATABASE=sql_enum_test
+MYSQL_USER=sql_enum
+MYSQL_PASSWORD=sql_enum

data/.github/workflows/tests.yml

@@ -0,0 +1,16 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Test
+        run: docker-compose run --rm rspec

data/Dockerfile

@@ -0,0 +1,12 @@
+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
+COPY lib/sql_enum/version.rb  ./lib/sql_enum/
+COPY sql_enum.gemspec Gemfile Gemfile.lock ./
+RUN bundle install

data/Gemfile.lock

@@ -1,28 +1,31 @@
 PATH
   remote: .
   specs:
-    sql_enum (0.2.2)
+    sql_enum (0.3.0)
       activerecord (>= 5.0)
+      activesupport (>= 5.0)
+      mysql2
 
 GEM
   remote: https://gem-proxy.chime.com/
   specs:
-    activemodel (6.1.3.2)
-      activesupport (= 6.1.3.2)
-    activerecord (6.1.3.2)
-      activemodel (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
-    activesupport (6.1.3.2)
+    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)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
     i18n (1.8.10)
       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)
@@ -39,16 +42,16 @@ GEM
     rspec-support (3.7.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler
   rake (~> 13.0)
   rspec (~> 3.0)
   sql_enum!
 
 BUNDLED WITH
-   1.17.3
+   2.2.30

data/README.md

@@ -48,9 +48,11 @@ class User < ActiveRecord::Base
 end
 ```
 
-## TODO
+## Development
 
-* Enable passing `null` argument
+### Testing
+
+Run `docker-compose run --rm rspec` to run the specs in a docker container alongside Mysql.
 
 ## Contributing
 

data/docker-compose.yml

@@ -0,0 +1,23 @@
+services:
+  rspec:
+    build: .
+    environment:
+      DATABASE_URL: "mysql2://${MYSQL_USER}:${MYSQL_PASSWORD}@mysql/${MYSQL_DATABASE}"
+    volumes:
+      - ./:/usr/src/app/
+    depends_on:
+      mysql:
+        condition: service_healthy
+    command: bundle exec rspec
+
+  mysql:
+    image: mysql:5.7
+    environment:
+      - MYSQL_ALLOW_EMPTY_PASSWORD=yes
+      - MYSQL_DATABASE
+      - MYSQL_USER
+      - MYSQL_PASSWORD
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
+      timeout: 20s
+      retries: 10

data/lib/sql_enum/active_record.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load(:active_record) do
+  extend SqlEnum::ClassMethods
+end

data/lib/sql_enum/class_methods.rb

@@ -0,0 +1,21 @@
+module SqlEnum
+  module ClassMethods
+    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] }
+
+      # 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)
+
+      # Override reader to return symbols
+      concerning "SqlEnum#{column_name.to_s.camelize}" do
+        define_method(column_name) { super()&.to_sym }
+      end
+    end
+  end
+end

data/lib/sql_enum/configuration.rb

@@ -0,0 +1,10 @@
+module SqlEnum
+  class Configuration
+    attr_accessor :default_prefix, :default_suffix
+
+    def initialize
+      @default_prefix = false
+      @default_suffix = false
+    end
+  end
+end

data/lib/sql_enum/enum_column.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SqlEnum
+  EnumColumn = Struct.new(:table_name, :column_name) do
+    def values
+      schema_values.to_s.scan(/\w+/).reject { |v| v == 'enum' }
+    end
+
+    private
+
+    def schema_values
+      ActiveRecord::Base.connection.exec_query(schema_values_query).rows.dig(0, 0)
+    end
+
+    def database_name
+      if ActiveRecord::Base.respond_to?(:connection_db_config)
+        ActiveRecord::Base.connection_db_config.configuration_hash[:database]
+      else
+        ActiveRecord::Base.connection_config.values_at(:database, :database_name).find(&:present?)
+      end
+    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
+    end
+  end
+end

data/lib/sql_enum/version.rb

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

data/lib/sql_enum.rb

@@ -1,5 +1,3 @@
-require 'active_record'
-
 module SqlEnum
   class << self
     attr_accessor :configuration
@@ -9,22 +7,18 @@ module SqlEnum
     self.configuration ||= Configuration.new
     yield(configuration)
   end
-
-  class Configuration
-    attr_accessor :default_prefix, :default_suffix
-
-    def initialize
-      @default_prefix = false
-      @default_suffix = false
-    end
-  end
 end
 
-require_relative 'active_record/enum/enum_type'
+require 'active_record'
+require 'active_support/core_ext/module/concerning'
+
 require_relative 'active_record/type/enum'
-require_relative 'active_record/enum_override'
-require_relative 'active_record/fixtures_override'
 require_relative 'active_record/connection_adapters/mysql2'
 require_relative 'active_record/connection_adapters/abstract_mysql'
 require_relative 'active_record/connection_adapters/mysql/column_methods'
-require_relative "sql_enum/version"
+
+require_relative 'sql_enum/version'
+require_relative 'sql_enum/configuration'
+require_relative 'sql_enum/enum_column'
+require_relative 'sql_enum/class_methods'
+require_relative 'sql_enum/active_record'

data/sql_enum.gemspec

@@ -1,6 +1,6 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require "sql_enum/version"
 
 Gem::Specification.new do |spec|
@@ -20,8 +20,11 @@ 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_development_dependency "bundler", "~> 1.16"
+  spec.add_dependency "mysql2"
+
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sql_enum
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Fletcher Fowler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -24,20 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -73,10 +101,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -84,14 +115,16 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - lib/active_record/connection_adapters/abstract_mysql.rb
 - lib/active_record/connection_adapters/mysql/column_methods.rb
 - lib/active_record/connection_adapters/mysql2.rb
-- lib/active_record/enum/enum_type.rb
-- lib/active_record/enum_override.rb
-- lib/active_record/fixtures_override.rb
 - lib/active_record/type/enum.rb
 - lib/sql_enum.rb
+- lib/sql_enum/active_record.rb
+- lib/sql_enum/class_methods.rb
+- lib/sql_enum/configuration.rb
+- lib/sql_enum/enum_column.rb
 - lib/sql_enum/version.rb
 - sql_enum.gemspec
 homepage: https://github.com/1debit/sql_enum
@@ -113,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Enable using native sql enums

data/lib/active_record/enum/enum_type.rb

@@ -1,41 +0,0 @@
-module ActiveRecord
-  module Enum
-    class EnumType < Type::Value # :nodoc:
-      delegate :type, to: :subtype
-
-      def initialize(name, mapping, subtype)
-        @name = name
-        @mapping = mapping
-        @subtype = subtype
-      end
-
-      def cast(value)
-        return if value.blank?
-
-        if valid?(value)
-          value.to_sym
-        else
-          assert_valid_value(value)
-        end
-      end
-
-      def deserialize(value)
-        value&.to_sym
-      end
-
-      def serialize(value)
-        value ? value.to_s : nil
-      end
-
-      def valid?(value)
-        mapping.include?(value.to_s)
-      end
-
-      def assert_valid_value(value)
-        unless value.blank? || valid?(value)
-          raise ArgumentError, "'#{value}' is not a valid #{name}"
-        end
-      end
-    end
-  end
-end

data/lib/active_record/enum_override.rb

@@ -1,86 +0,0 @@
-require 'active_record/enum'
-
-module ActiveRecord
-  module Enum
-    def sql_enum(name, options={})
-      enum_prefix = options.delete(:_prefix)
-      enum_suffix = options.delete(:_suffix)
-
-      enum_prefix ||= name if SqlEnum.configuration&.default_prefix
-      enum_suffix ||= name if SqlEnum.configuration&.default_suffix
-
-      klass       = self
-      enum_values = Array.new
-      name        = name.to_sym
-
-      detect_enum_conflict!(name, name.to_s.pluralize, true)
-      klass.singleton_class.send(:define_method, name.to_s.pluralize) { enum_values.map(&:to_sym) }
-
-      detect_enum_conflict!(name, name)
-      detect_enum_conflict!(name, "#{name}=")
-
-      attr = attribute_alias?(name) ? attribute_alias(name) : name
-
-      if Rails.version >= '6.1'
-        decorate_attribute_type(name) do |subtype|
-          EnumType.new(attr, enum_values, subtype)
-        end
-      else
-        decorate_attribute_type(attr, :enum) do |subtype|
-          EnumType.new(attr, enum_values, subtype)
-        end
-      end
-
-      enum_values = values(name)
-      enum_values.each do |value|
-        if enum_prefix == true
-          prefix = "#{name}_"
-        elsif enum_prefix
-          prefix = "#{enum_prefix}_"
-        end
-        if enum_suffix == true
-          suffix = "_#{name}"
-        elsif enum_suffix
-          suffix = "_#{enum_suffix}"
-        end
-
-        value_method_name = "#{prefix}#{value}#{suffix}"
-
-        # def active?() status == 0 end
-        klass.send(:detect_enum_conflict!, name, "#{value_method_name}?")
-        define_method("#{value_method_name}?") { self[attr] == value.to_sym }
-
-        # def active!() update! status: :active end
-        klass.send(:detect_enum_conflict!, name, "#{value_method_name}!")
-        define_method("#{value_method_name}!") { update!(attr => value) }
-
-        # scope :active, -> { where status: 0 }
-        klass.send(:detect_enum_conflict!, name, value_method_name, true)
-        klass.scope value_method_name, -> { where(attr => value) }
-      end
-      defined_enums[name.to_s] = enum_values
-    end
-
-    def values(name)
-      schema_values(name).to_s.scan(/\w+/).reject{|v| v == 'enum'}
-    end
-
-    def schema_values(name)
-      ActiveRecord::Base.connection.exec_query(schema_values_query(name)).rows.dig(0,0)
-    end
-
-    def database_name
-      ActiveRecord::Base.connection_config[:database]
-    end
-
-    def schema_values_query(name)
-      %{
-        SELECT column_type
-        FROM information_schema.COLUMNS
-        WHERE TABLE_SCHEMA = '#{database_name}'
-        AND TABLE_NAME = '#{table_name}'
-        AND COLUMN_NAME = '#{name}'
-      }
-    end
-  end
-end

data/lib/active_record/fixtures_override.rb

@@ -1,79 +0,0 @@
-require 'active_record/fixtures'
-
-module ActiveRecord
-  class FixtureSet
-    def table_rows
-      now = config.default_timezone == :utc ? Time.now.utc : Time.now
-
-      # allow a standard key to be used for doing defaults in YAML
-      fixtures.delete('DEFAULTS')
-
-      # track any join tables we need to insert later
-      rows = Hash.new { |h,table| h[table] = [] }
-
-      rows[table_name] = fixtures.map do |label, fixture|
-        row = fixture.to_hash
-
-        if model_class
-          # fill in timestamp columns if they aren't specified and the model is set to record_timestamps
-          if model_class.record_timestamps
-            timestamp_column_names.each do |c_name|
-              row[c_name] = now unless row.key?(c_name)
-            end
-          end
-
-          # interpolate the fixture label
-          row.each do |key, value|
-            row[key] = value.gsub("$LABEL", label.to_s) if value.is_a?(String)
-          end
-
-          # generate a primary key if necessary
-          if has_primary_key_column? && !row.include?(primary_key_name)
-            row[primary_key_name] = ActiveRecord::FixtureSet.identify(label, primary_key_type)
-          end
-
-          # Resolve enums
-          # model_class.defined_enums.each do |name, values|
-          #   if row.include?(name)
-          #     row[name] = values.fetch(row[name], row[name])
-          #   end
-          # end
-
-          # If STI is used, find the correct subclass for association reflection
-          reflection_class =
-            if row.include?(inheritance_column_name)
-              row[inheritance_column_name].constantize rescue model_class
-            else
-              model_class
-            end
-
-          reflection_class._reflections.each_value do |association|
-            case association.macro
-            when :belongs_to
-              # Do not replace association name with association foreign key if they are named the same
-              fk_name = (association.options[:foreign_key] || "#{association.name}_id").to_s
-
-              if association.name.to_s != fk_name && value = row.delete(association.name.to_s)
-                if association.polymorphic? && value.sub!(/\s*\(([^\)]*)\)\s*$/, "")
-                  # support polymorphic belongs_to as "label (Type)"
-                  row[association.foreign_type] = $1
-                end
-
-                fk_type = reflection_class.type_for_attribute(fk_name).type
-                row[fk_name] = ActiveRecord::FixtureSet.identify(value, fk_type)
-              end
-            when :has_many
-              if association.options[:through]
-                add_join_records(rows, row, HasManyThroughProxy.new(association))
-              end
-            end
-          end
-        end
-
-        row
-      end
-      rows
-    end
-  end
-end
-