utf8mb4rails 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4954a15b606370a431abdefc253289c341e2d647
-  data.tar.gz: b9a7e416ec58b170053c8e6eccd03ff83730222c
+SHA256:
+  metadata.gz: 56b87fc42083d61b0f0c48437897aef8e01241f672d0b7a2c238952d89a57807
+  data.tar.gz: b927e865f13370247f95ac65bcbb92a95860357b6632740397fed8972721b122
 SHA512:
-  metadata.gz: 25fae3f7ffadec257d586c7ffa29d5d9a6c744a8743065a4acdfddc6277455283da8f3707d80c52ab2f6424c5356ebb064c3120c008150331c10628ba9ef834f
-  data.tar.gz: 8753f0d26b1b4974c7a4c2bd88d0f3748ed0fa2aac832281d30df941827c0531abc3dae92ab34c86ae893bde23ef6e5a8419cb99e1d6fbc6bebe06474021365a
+  metadata.gz: 1919067c8d0592d0b40447c1be880245eca1310c34760749a0a9dfd5bb9ea23360ee985be44fc78d51b9506226fdac897ae50a3910b986f06b63342e6b25f9b9
+  data.tar.gz: c65d92bd56b807ffc7d83e3c557a4ceaccddc27c1500d70b7410401416c6742ad8e85955aca9912789ccbae7794f0d0159e40aee06c6462b32b5f39e034f097b

data/Gemfile.lock

@@ -1,98 +1,103 @@
 PATH
   remote: .
   specs:
-    utf8mb4rails (0.1.0)
-      departure (~> 4.0, >= 4.0.1)
+    utf8mb4rails (0.2.0)
+      departure (~> 6.1)
       mysql2 (~> 0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.9)
-      actionpack (= 4.2.9)
-      actionview (= 4.2.9)
-      activejob (= 4.2.9)
+    actioncable (5.1.7)
+      actionpack (= 5.1.7)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.7)
+      actionpack (= 5.1.7)
+      actionview (= 5.1.7)
+      activejob (= 5.1.7)
       mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.9)
-      actionview (= 4.2.9)
-      activesupport (= 4.2.9)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.7)
+      actionview (= 5.1.7)
+      activesupport (= 5.1.7)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.9)
-      activesupport (= 4.2.9)
+    actionview (5.1.7)
+      activesupport (= 5.1.7)
       builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (4.2.9)
-      activesupport (= 4.2.9)
-      globalid (>= 0.3.0)
-    activemodel (4.2.9)
-      activesupport (= 4.2.9)
-      builder (~> 3.1)
-    activerecord (4.2.9)
-      activemodel (= 4.2.9)
-      activesupport (= 4.2.9)
-      arel (~> 6.0)
-    activesupport (4.2.9)
-      i18n (~> 0.7)
+    activejob (5.1.7)
+      activesupport (= 5.1.7)
+      globalid (>= 0.3.6)
+    activemodel (5.1.7)
+      activesupport (= 5.1.7)
+    activerecord (5.1.7)
+      activemodel (= 5.1.7)
+      activesupport (= 5.1.7)
+      arel (~> 8.0)
+    activesupport (5.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    arel (6.0.4)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    departure (4.0.1)
+    arel (8.0.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    departure (6.1.0)
       mysql2 (~> 0.4.0)
-      rails (~> 4.2.0)
+      rails (~> 5.1.0)
     diff-lcs (1.3)
-    erubis (2.7.0)
-    globalid (0.4.0)
+    erubi (1.9.0)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (0.8.6)
-    loofah (2.0.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.5.0)
+      crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.6.6)
-      mime-types (>= 1.16, < 4)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    mini_portile2 (2.2.0)
-    minitest (5.10.3)
-    mysql2 (0.4.9)
-    nokogiri (1.8.0)
-      mini_portile2 (~> 2.2.0)
-    rack (1.6.8)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (4.2.9)
-      actionmailer (= 4.2.9)
-      actionpack (= 4.2.9)
-      actionview (= 4.2.9)
-      activejob (= 4.2.9)
-      activemodel (= 4.2.9)
-      activerecord (= 4.2.9)
-      activesupport (= 4.2.9)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.9)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.8)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (4.2.9)
-      actionpack (= 4.2.9)
-      activesupport (= 4.2.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    method_source (1.0.0)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    mysql2 (0.4.10)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.1.7)
+      actioncable (= 5.1.7)
+      actionmailer (= 5.1.7)
+      actionpack (= 5.1.7)
+      actionview (= 5.1.7)
+      activejob (= 5.1.7)
+      activemodel (= 5.1.7)
+      activerecord (= 5.1.7)
+      activesupport (= 5.1.7)
+      bundler (>= 1.3.0)
+      railties (= 5.1.7)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.1.7)
+      actionpack (= 5.1.7)
+      activesupport (= 5.1.7)
+      method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.6.0)
       rspec-core (~> 3.6.0)
       rspec-expectations (~> 3.6.0)
@@ -106,26 +111,29 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
-    sprockets (3.7.1)
+    sprockets (4.0.0)
       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.0)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.3)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.12)
-  rake (~> 10.0)
+  rake (>= 12.3.3)
   rspec (~> 3.0)
   utf8mb4rails!
 
 BUNDLED WITH
-   1.12.5
+   1.17.1

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "utf8mb4rails"
+require 'bundler/setup'
+require 'utf8mb4rails'
 
 # 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.
@@ -10,5 +10,5 @@ require "utf8mb4rails"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/utf8mb4rails.rb

@@ -14,6 +14,7 @@ def usage
   puts 'You can also specify the COLLATION (utf8mb4_unicode_520_ci)'
 end
 
+# Top Module
 module Utf8mb4rails
   extend Rake::DSL
 
@@ -21,7 +22,8 @@ module Utf8mb4rails
     desc 'migrates a table[/column] (TABLE, COLUMN env vars) to utf8mb encoding'
     task utf8mb4: :environment do
       require 'departure'
-      Departure.configure do |_config|; end
+      Departure.configure do |_config|
+      end
 
       table = ENV['TABLE']
       unless table

data/lib/utf8mb4rails/migrator/column_info.rb

@@ -5,7 +5,7 @@ module Utf8mb4rails
     # received from the database
     class ColumnInfo
       TEXT_TYPES = %w(CHAR VARCHAR TINYTEXT TEXT MEDIUMTEXT LONGTEXT).freeze
-      attr_accessor :info
+      attr_reader :info
 
       # Receives a hash with (:type, :default, :max_length, :charset)
       def initialize(info)
@@ -19,14 +19,18 @@ module Utf8mb4rails
 
       # @return String : the sql part of the new type of the column definition
       def new_type_for_sql
-        return "#{info[:type]}(#{info[:max_length]})" if info[:type] =~ /CHAR/
-        info[:type]
+        info_type = info[:type]
+        return "#{info_type}(#{info[:max_length]})" if info_type =~ /CHAR/
+
+        info_type
       end
 
       # @return String : the sql part of the default value of the column definition
       def default_value_for_sql
-        return nil unless info[:default]
-        "default '#{info[:default]}'"
+        info_default = info[:default]
+        return nil unless info_default
+
+        "default '#{info_default}'"
       end
 
       # @return Bool : True if the column is of a text type

data/lib/utf8mb4rails/migrator/db_inspector.rb

@@ -1,7 +1,9 @@
 module Utf8mb4rails
   module Migrator
+    # DB introspection (only for columns)
     class DBInspector
       # Initializes AR
+      # :reek:UtilityFunction
       def initialize
         ActiveRecord::Base.establish_connection(
           ActiveRecord::Base.connection_config.merge(adapter: 'percona')
@@ -10,6 +12,7 @@ module Utf8mb4rails
 
       ##
       # @returns [Array<String>] An array with column names
+      # :reek:UtilityFunction
       def columns(table)
         ActiveRecord::Base.connection.columns(table).map(&:name)
       end
@@ -20,6 +23,7 @@ module Utf8mb4rails
       # @param [String] column
       #
       # @returns [Hash] { type: String, default: String or nil, charset: String or nil }
+      # :reek:FeatureEnvy
       def column_info(table, column)
         sql = "SELECT DATA_TYPE, COLUMN_DEFAULT, CHARACTER_SET_NAME, CHARACTER_MAXIMUM_LENGTH
         FROM INFORMATION_SCHEMA.COLUMNS WHERE table_name = '#{table}'
@@ -36,6 +40,7 @@ module Utf8mb4rails
 
       private
 
+      # :reek:UtilityFunction
       def database_name
         ActiveRecord::Base.connection.current_database
       end

data/lib/utf8mb4rails/migrator/runner.rb

@@ -1,14 +1,19 @@
+require 'English'
+
 module Utf8mb4rails
   module Migrator
+    # This class will perform the actual migration, will run sql queries that
+    # alters tables
     class Runner
       NEW_COLLATION = ENV.fetch('COLLATION', 'utf8mb4_unicode_520_ci').freeze
 
-      attr_accessor :inspector
+      attr_reader :inspector
 
       def initialize
         @inspector = DBInspector.new
       end
 
+      # :reek:FeatureEnvy
       def migrate_column!(table, column)
         column_info = inspector.column_info(table, column)
         if column_info.utf8mb4?
@@ -22,22 +27,31 @@ module Utf8mb4rails
         ActiveRecord::Base.connection.execute(sql)
       end
 
-      def migrate_table_schema!(table)
-        sql = "ALTER TABLE `#{table}` CONVERT TO CHARACTER SET utf8mb4 COLLATE #{NEW_COLLATION}"
-        ActiveRecord::Base.connection.execute(sql)
-      end
-
       def migrate_table!(table)
+        sql = []
         inspector.columns(table).each do |column|
-          puts "      migrating #{table}:#{column}"
-          migrate_column!(table, column)
+          column_info = inspector.column_info(table, column)
+          next if column_info.utf8mb4? || !column_info.text_column? || skipped_column?(column)
+          sql << "DROP COLUMN \`#{column}`"
+          sql << "ADD COLUMN \`#{column}`\ #{column_info.new_type_for_sql} \
+CHARACTER SET utf8mb4 COLLATE #{NEW_COLLATION} #{column_info.default_value_for_sql}"
         end
-        migrate_table_schema!(table)
+        sql << "CONVERT TO CHARACTER SET utf8mb4 COLLATE #{NEW_COLLATION}"
+        ActiveRecord::Base.connection.execute("ALTER TABLE `#{table}` #{sql.join(' , ')};")
       rescue
         puts "Problems accesing the table #{table}"
-        puts $!
+        puts $ERROR_INFO
         exit 1
       end
+
+      private
+
+      # :reek:UtilityFunction
+      def skipped_column?(column_name)
+        return false unless ENV.key? 'SKIP_COLUMNS'
+        skipped_columns = ENV['SKIP_COLUMNS'].join(',')
+        skipped_columns.include(column_name)
+      end
     end
   end
 end

data/lib/utf8mb4rails/version.rb

@@ -1,3 +1,3 @@
 module Utf8mb4rails
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'.freeze
 end

data/utf8mb4rails.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'utf8mb4rails/version'
@@ -10,19 +11,22 @@ Gem::Specification.new do |spec|
   spec.email         = ['joseferper@gmail.com']
 
   spec.summary       = 'Adds a task to migrate mysql utf8 tables to utf8mb4 (emojis)'
-  spec.description   = 'Poetry is so XIX century, nowadays we express ourselves using emojis. This gem adds a task to migrate mysql utf8 tables to utf8mb4 in rails projects.'
+  spec.description   = 'Poetry is so XIX century, nowadays we express ourselves using emojis.
+This gem adds a task to migrate mysql utf8 tables to utf8mb4 in rails projects.'
   spec.homepage      = 'https://github.com/magec/utf8mb4rails'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_runtime_dependency 'departure', '~> 4.0', '>= 4.0.1'
+  spec.add_runtime_dependency 'departure', '~> 6.1'
   spec.add_runtime_dependency 'mysql2', '~> 0.4.0'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utf8mb4rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jose Fernandez (magec)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2020-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: departure
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -62,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Poetry is so XIX century, nowadays we express ourselves using emojis.
+description: |-
+  Poetry is so XIX century, nowadays we express ourselves using emojis.
   This gem adds a task to migrate mysql utf8 tables to utf8mb4 in rails projects.
 email:
 - joseferper@gmail.com
@@ -130,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Adds a task to migrate mysql utf8 tables to utf8mb4 (emojis)