make_taggable 0.6.3 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75e4c687d801738a1e36a15accd18686dd13ed883941e609bbfae23f98eaaae9
-  data.tar.gz: 103971ae8293cbfaaf351c3193022332eb024581c02ca89ea1d95d8bb8a4f154
+  metadata.gz: 656b91c8e3413eb256819e637338927cd744e9502e9208ab2ee983344eeb0dc0
+  data.tar.gz: fc1d7f0e41f254536af79d94a0d42d40afb1f8db2e6a7fc1ff92f7536efe8b39
 SHA512:
-  metadata.gz: eaf416b1f1490f92bf44c1992bbf68519a44ef55068f4183c73fbb19f729d4864e89124a4454e65afe9e164e16c9339f3659ae4d6ed95821ddfd15371649de3d
-  data.tar.gz: 46b07f4697367374b69458d011b6770883ae36b29c519c66dedd1aa070ca22cb08defecc8d80da29d79860a82368592898ba3be5a77d7b33e308f5a4c2d630f3
+  metadata.gz: ebac450ac5fdc36410898fa78e1a8d93453967ffdc4a9326c3438348d462ccff566bb65282ee50b1bf7c3af32a48764f18139bc566635253401f936497670319
+  data.tar.gz: 0662c53dc1f42ef1fd87b3d9ee1d26ab8af286e2f85105ffe9cf6af4fa41eb0b189ecc34fa1e752615107acc3bcaa27186deb19ad7b5cf5978436d4e66965e03

data/.github/workflows/mysql_tests.yml

@@ -0,0 +1,56 @@
+---
+name: MySQL Tests
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+jobs:
+  mysql:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7']
+
+    services:
+      mysql:
+        image: mysql:8
+        env:
+          MYSQL_ROOT_PASSWORD: password
+          MSQL_DATABASE: my_sql_test_db
+        ports: ['3306:3306']
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Cache gems
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gem-
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec appraisal install
+
+      - name: Run tests
+        env:
+          DATABASE_URL: mysql2://root:password@127.0.0.1:3306/my_sql_test_db
+          RAILS_ENV: test
+        run: |
+          cp spec/dummy/config/mysql_database.yml.ci spec/dummy/config/database.yml
+          bundle exec rake test_app
+          bundle exec appraisal rake

data/.github/workflows/pg_tests.yml

@@ -0,0 +1,56 @@
+---
+name: Postgres Tests
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+jobs:
+  postgres:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7']
+
+    services:
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: pg_test
+        ports: ['5432:5432']
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Cache gems
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gem-
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec appraisal install
+
+      - name: Run tests
+        env:
+          DATABASE_URL: postgres://postgres:password@localhost:5432/pg_test
+          RAILS_ENV: test
+        run: |
+          cp spec/dummy/config/pg_database.yml.ci spec/dummy/config/database.yml
+          bundle exec rake test_app
+          bundle exec appraisal rake

data/.github/workflows/{ci.yml → sqlite_tests.yml}

@@ -1,4 +1,5 @@
-name: Tests
+---
+name: SQLite Tests
 
 on:
   pull_request:
@@ -8,26 +9,27 @@ on:
     branches:
       - master
 jobs:
-  test:
+  sqlite:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.7', '2.6', '2.5' ]
+        ruby: ['2.5', '2.6', '2.7']
     steps:
       - uses: actions/checkout@master
 
-      - name: Set up Ruby
+      - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
 
       - name: Cache gems
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: vendor/bundle
-          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
-            ${{ runner.os }}-gem-
+            ${{ runner.os }}-${{ matrix.ruby }}-gem-
+
       - name: Install dependencies
         run: |
           sudo apt-get update
@@ -37,11 +39,9 @@ jobs:
           bundle install --jobs 4 --retry 3
           bundle exec appraisal install
 
-      - name: StandardRb check
-        run: bundle exec standardrb
-
       - name: Run tests
         env:
           RAILS_ENV: test
         run: |
+          bundle exec rake test_app
           bundle exec appraisal rake

data/.github/workflows/standardrb-check.yml

@@ -0,0 +1,37 @@
+name: Standard Rb
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+
+jobs:
+  standard:
+    name: StandardRB Check Action
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+    
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    
+    - name: Bundle install
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    
+    - name: Run StandardRB
+      run: bundle exec standardrb --format progress

data/.gitignore

@@ -11,3 +11,6 @@ tmp
 *.lock
 *.iml
 /.idea
+spec/dummy/db/schema.rb
+spec/dummy/db/migrate/[!0]*
+/gemfiles/*

data/Appraisals

@@ -6,6 +6,10 @@ appraise "rails-6" do
   gem "rails", "~> 6.0.0"
 end
 
+appraise "rails-6-1" do
+  gem "rails", "~> 6.1.0"
+end
+
 appraise "rails-master" do
   gem "rails", github: "rails/rails"
 end

data/README.md

@@ -1,26 +1,20 @@
 # MakeTaggable
 [![Gem Version](https://badge.fury.io/rb/make_taggable.svg)](https://badge.fury.io/rb/make_taggable)
-[![Build Status](https://travis-ci.com/MatthewKennedy/make_taggable.svg?branch=master)](https://travis-ci.com/MatthewKennedy/make_taggable)
-[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+![Postgres Tests](https://github.com/MatthewKennedy/make_taggable/workflows/Postgres%20Tests/badge.svg)
+![MySQL Tests](https://github.com/MatthewKennedy/make_taggable/workflows/MySQL%20Tests/badge.svg)
+![SQLite Tests](https://github.com/MatthewKennedy/make_taggable/workflows/SQLite%20Tests/badge.svg)
+![Standard Rb](https://github.com/MatthewKennedy/make_taggable/workflows/Standard%20Rb/badge.svg)
 
-MakeTaggable is a fork of acts-as-taggable-on v6.5 with code updates and a new set of migrations. All credit goes to those who contributed before acts-as-taggable-on became MakeTaggable: Michael Bleigh & Joost Baaij.
+MakeTaggable is a fork of Acts-As-Taggable-On with code updates, fresh migrations that work on MySQL, and tested against a dummy Rails app.
 
-Why fork acts-as-taggable-on? Act As Taggable On appears stuck with a set of legacy migrations from rails pre [4.2] that added and removed indexes so much that the migrations do not run on a fresh install using MySQL.
-
-For the PostgreSQL users, this is not an issue, but if you have an app or gem that used acts-as-taggable-on, you can no longer test against MySQL, so it seems a fresh start would be useful to clear out any legacy issues and move forward.
+All credit goes to those who contributed to Acts-As-Taggable-On: Michael Bleigh & Joost Baaij.
 
 ## Installation
 
-To use it, add it to your Gemfile:
-
-```ruby
-gem "make_taggable", "~> 0.6.0"
-```
-
-and bundle:
+To use make_taggable, run the followng from the root of your application:
 
 ```shell
-bundle
+bundle add make_taggable
 ```
 
 #### Post Installation
@@ -28,15 +22,30 @@ bundle
 Install migrations
 
 ```shell
-# For the latest versions :
 rails make_taggable_engine:install:migrations
 ```
 
-Review the generated migrations then migrate :
+Review the generated migrations then migrate:
 ```shell
 rails db:migrate
 ```
 
+#### For MySql users
+To make MySQL play nice with spÉcial characters you can setting the following line in an initializer file:
+
+```ruby
+MakeTaggable.force_binary_collation = true
+```
+
+Or by run this rake task:
+
+```shell
+rails make_taggable_engine:tag_names:collate_bin
+```
+
+See the Configuration section for more details.
+
+
 ## Usage
 
 Setup
@@ -167,7 +176,7 @@ MakeTaggable::Tag.least_used(10)
 
 ### Finding Tagged Objects
 
-Make Taggable uses scopes to create an association for tags.
+MakeTaggable uses scopes to create an association for tags.
 This way you can mix and match to filter down your results.
 
 ```ruby
@@ -396,6 +405,7 @@ CSS:
 .css4 { font-size: 1.6em; }
 ```
 
+
 ## Configuration
 
 If you would like to remove unused tag objects after removing taggings, add:
@@ -444,35 +454,69 @@ MakeTaggable.delimiter = ','
 *NOTE 1: SQLite by default can't upcase or downcase multibyte characters, resulting in unwanted behavior. Load the SQLite ICU extension for proper handle of such characters. [See docs](http://www.sqlite.org/src/artifact?ci=trunk&filename=ext/icu/README.txt)*
 
 
-#### Upgrading
-
-see [UPGRADING](UPGRADING.md)
+## Upgrading
 
-## Contributors
+Install new migrations by running:
 
-We have a long list of valued contributors. [Check them all](https://github.com/mbleigh/acts-as-taggable-on/contributors)
+```shell
+rails make_taggable_engine:install:migrations
+```
 
 ## Compatibility
 
-Versions 0.6.x is compatible with Ruby 2.5 + and Rails 6.
+Version 0.7.x is compatible with Ruby 2.5 > and Rails 5.2 >
 
 
-## TODO
-- Review migrations indexes they seem excessive looking at the schema.
-- See if the newer version of ActiveRecord or arel can be used instead of the MySQL workarounds.
-
 ## Testing
 
-Make Taggable uses RSpec for its test coverage. Inside the gem
-directory, you can run the specs with:
+MakeTaggable uses RSpec for its test coverage. Inside the gem directory, you can run the specs by following the steps below:
+
+Install the rquired gems:
+
+```shell
+bundle install
+```
+
+Setup the dummy test app:
+
+```shell
+bundle exec rake test_app
+```
+
+Run the spec tests against SQLite use the followiong command.
+
+```shell
+bundle exec rake
+```
+
+You can also run all the tests across all the Rails versions by running:
+
+```shell
+bundle exec appraisal install
+
+bundle exec appraisal rake
+```
+
+## Contributing
+
+Please use the following Standard Rb commands to format your code before creating a pull request:
+
+Check for code errors:
+
+```shell
+bundle exec standardrb
+```
+
+Fix code errors:
 
 ```shell
-bundle
-rake spec
+bundle exec standardrb --fix
 ```
+For more information please review the [Contributing](https://github.com/MatthewKennedy/make_taggable/blob/master/CONTRIBUTING.md) section.
 
-You can run all the tests across all the Rails versions by running `rake appraise`.  If you'd also like to [run the tests across all rubies and databases as configured for Travis CI, install and run `wwtd`](https://github.com/grosser/wwtd).
+#### Contributors
+List of valued contributors From Acts-As-Taggable-On: [Check them all](https://github.com/mbleigh/acts-as-taggable-on/contributors)
 
 
 ## License
-MIT
+This gem is available as open source under the terms of the [MIT License](https://github.com/MatthewKennedy/make_taggable/blob/master/LICENSE.txt).

data/Rakefile

@@ -1,7 +1,11 @@
 require "bundler/gem_tasks"
 
+import "./lib/tasks/tags_collate_utf8.rake"
+
 APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
 
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec
+
+load "lib/tasks/setup_test_db.rake"

data/UPGRADING.md

@@ -0,0 +1,5 @@
+When upgrading run the migrations generator
+
+    rails make_taggable_engine:install:migrations
+
+This will create any new migrations and skip existing ones

data/db/migrate/3_change_tag_name_collation_mysql.rb

@@ -0,0 +1,7 @@
+class ChangeTagNameCollationMysql < ActiveRecord::Migration[5.2]
+  def change
+    if MakeTaggable::Utils.using_mysql?
+      execute("ALTER TABLE #{MakeTaggable.tags_table} MODIFY name varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;")
+    end
+  end
+end

data/lib/make_taggable.rb

@@ -111,10 +111,10 @@ module MakeTaggable
 
     def self.apply_binary_collation(bincoll)
       if Utils.using_mysql?
-        coll = "utf8_general_ci"
-        coll = "utf8_bin" if bincoll
+        coll = "utf8mb4_general_ci"
+        coll = "utf8mb4_bin" if bincoll
         begin
-          ActiveRecord::Migration.execute("ALTER TABLE #{Tag.table_name} MODIFY name varchar(255) CHARACTER SET utf8 COLLATE #{coll};")
+          ActiveRecord::Migration.execute("ALTER TABLE #{Tag.table_name} MODIFY name varchar(255) CHARACTER SET utf8mb4 COLLATE #{coll};")
         rescue => e
           puts "Trapping #{e.class}: collation parameter ignored while migrating for the first time."
         end