utf8mb4rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc9eaa8412f0244ac69818e4cbdc16c3377c270f
+  data.tar.gz: 7a709d08a0b45673c9361b4cdc29460195d4c30b
+SHA512:
+  metadata.gz: 353b22f722ddc2bd6952a738f20fe363e8bd694127e00d09cd3de0d021189930e058619722951db699cd2f5f500b8f072e73f0316f49312a0dcdb75dd62feb10
+  data.tar.gz: 3e46c8ed9491b05e916177a717d1dd4a350f895f9e6a9102a180ccce211636efa5e406c10d5442b8b1604921b96e9b4bf2e83d30c0ea4d61101ab9b112231b8d

data/.gitignore

@@ -0,0 +1,47 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+*log
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+*~

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in utf8mb4rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,131 @@
+PATH
+  remote: .
+  specs:
+    utf8mb4rails (0.1.0)
+      departure (~> 4.0, >= 4.0.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)
+      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-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.9)
+      activesupport (= 4.2.9)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      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)
+      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)
+      mysql2 (~> 0.4.0)
+      rails (~> 4.2.0)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
+    loofah (2.0.3)
+      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)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    sprockets (3.7.1)
+      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)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  utf8mb4rails!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jose Fernández
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jose Fernandez (magec)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Utf8mb4rails
+
+A simple gem that adds a rake task to deal with utf8 to utf8mb4 migrations for mysql.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'utf8mb4rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install utf8mb4rails
+
+## Usage
+
+This gem will add in your rails project a new task called utf8mb4. This tast is aimed to easily convert tables in utf8 into
+utf8mb4 without truncating column contents and maintaining its original schema (without changing max sizes).
+
+**USE AT YOUR OWN RISK!!!**
+
+    $ rake -T
+
+```
+...
+rake db:utf8mb4                          # migrates a table[/column] (TABLE, COLUMN env vars) to utf8mb encoding
+...
+
+```
+
+You can modify its behavior using env vars.
+
+- **TABLE**: The table you want to migrate, if no column is specified every single column will be migrated, also the default charset
+of the table is altered.
+- **COLUMN**: The column to be migrated (needs TABLE defined). It will only migrate that column definition.
+- **COLLATION**: The collation (utf8mb4_unicode_520_ci by default)
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/magec/utf8mb4rails.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/utf8mb4rails/migrator/column_info.rb

@@ -0,0 +1,38 @@
+module Utf8mb4rails
+  module Migrator
+
+    # Abstraction for dealing with column information
+    # received from the database
+    class ColumnInfo
+      TEXT_TYPES = %w(CHAR VARCHAR TINYTEXT TEXT MEDIUMTEXT LONGTEXT).freeze
+      attr_accessor :info
+
+      # Receives a hash with (:type, :default, :max_length, :charset)
+      def initialize(info)
+        @info = info
+      end
+
+      # @return Bool : True if the column is in utf8mb4
+      def utf8mb4?
+        info[:charset] =~ /utf8mb4/
+      end
+
+      # @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]
+      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]}'"
+      end
+
+      # @return Bool : True if the column is of a text type
+      def text_column?
+        TEXT_TYPES.include?(info[:type])
+      end
+    end
+  end
+end

data/lib/utf8mb4rails/migrator/db_inspector.rb

@@ -0,0 +1,44 @@
+module Utf8mb4rails
+  module Migrator
+    class DBInspector
+      # Initializes AR
+      def initialize
+        ActiveRecord::Base.establish_connection(
+          ActiveRecord::Base.connection_config.merge(adapter: 'percona')
+        )
+      end
+
+      ##
+      # @returns [Array<String>] An array with column names
+      def columns(table)
+        ActiveRecord::Base.connection.columns(table).map(&:name)
+      end
+
+      # Returns a hash with information about the column
+      #
+      # @param [String] table
+      # @param [String] column
+      #
+      # @returns [Hash] { type: String, default: String or nil, charset: String or nil }
+      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}'
+        AND COLUMN_NAME = '#{column}'
+        AND TABLE_SCHEMA='#{database_name}'"
+        result = ActiveRecord::Base.connection.execute(sql).first
+        ColumnInfo.new(
+          type: result[0].upcase,
+          default: result[1],
+          charset: result[2],
+          max_length: result[3]
+        )
+      end
+
+      private
+
+      def database_name
+        ActiveRecord::Base.connection.current_database
+      end
+    end
+  end
+end

data/lib/utf8mb4rails/migrator/runner.rb

@@ -0,0 +1,43 @@
+module Utf8mb4rails
+  module Migrator
+    class Runner
+      NEW_COLLATION = ENV.fetch('COLLATION', 'utf8mb4_unicode_520_ci').freeze
+
+      attr_accessor :inspector
+
+      def initialize
+        @inspector = DBInspector.new
+      end
+
+      def migrate_column!(table, column)
+        column_info = inspector.column_info(table, column)
+        if column_info.utf8mb4?
+          puts "          Skipping column #{column} (already in utf8mb4)'"
+          return
+        end
+        return unless column_info.text_column?
+        sql = "ALTER TABLE `#{table}` DROP COLUMN \`#{column}`\ ,
+       ADD COLUMN \`#{column}`\ #{column_info.new_type_for_sql} CHARACTER SET utf8mb4
+       COLLATE #{NEW_COLLATION} #{column_info.default_value_for_sql}"
+        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)
+        inspector.columns(table).each do |column|
+          puts "      migrating #{table}:#{column}"
+          migrate_column!(table, column)
+        end
+        migrate_table_schema!(table)
+      rescue
+        puts "Problems accesing the table #{table}"
+        puts $!
+        exit 1
+      end
+    end
+  end
+end

data/lib/utf8mb4rails/migrator.rb

@@ -0,0 +1,4 @@
+# Use percona
+require_relative 'migrator/db_inspector'
+require_relative 'migrator/runner'
+require_relative 'migrator/column_info'

data/lib/utf8mb4rails/version.rb

@@ -0,0 +1,3 @@
+module Utf8mb4rails
+  VERSION = "0.1.0"
+end

data/lib/utf8mb4rails.rb

@@ -0,0 +1,43 @@
+require 'utf8mb4rails/version'
+require 'utf8mb4rails/migrator'
+require 'departure'
+
+Departure.configure do |_config|; end
+def usage
+  puts
+  puts 'Usage: '
+  puts
+  puts 'For migrating an entire table use:'
+  puts '$ TABLE=table_name rake db:utf8mb4'
+  puts
+  puts 'For migrating an specified column table:'
+  puts '$ TABLE=table_name COLUMN=column_name rake db:utf8mb4'
+  puts
+  puts 'You can also specify the COLLATION (utf8mb4_unicode_520_ci)'
+end
+
+module Utf8mb4rails
+  extend Rake::DSL
+
+  namespace :db do
+    desc 'migrates a table[/column] (TABLE, COLUMN env vars) to utf8mb encoding'
+    task utf8mb4: :environment do
+      table = ENV['TABLE']
+      unless table
+        puts 'Please specify a table with TABLE='
+        usage
+        exit 1
+      end
+
+      column = ENV['COLUMN']
+      runner = Migrator::Runner.new
+      if column
+        puts 'Migrating #{table}.#{column}'
+        runner.migrate_column!(table, column)
+      else
+        puts 'No column specified, will migrate the entire table'
+        runner.migrate_table!(table)
+      end
+    end
+  end
+end

data/utf8mb4rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'utf8mb4rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'utf8mb4rails'
+  spec.version       = Utf8mb4rails::VERSION
+  spec.authors       = ['Jose Fernandez (magec)']
+  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.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.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 'mysql2', '~> 0.4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: utf8mb4rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose Fernandez (magec)
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: departure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.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
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/utf8mb4rails.rb
+- lib/utf8mb4rails/migrator.rb
+- lib/utf8mb4rails/migrator/column_info.rb
+- lib/utf8mb4rails/migrator/db_inspector.rb
+- lib/utf8mb4rails/migrator/runner.rb
+- lib/utf8mb4rails/version.rb
+- utf8mb4rails.gemspec
+homepage: https://github.com/magec/utf8mb4rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Adds a task to migrate mysql utf8 tables to utf8mb4 (emojis)
+test_files: []