activerecord-pg_collation 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 398383f3e3a1e99867910103a6256203ba0a2123b5357a3930c448af26529731
-  data.tar.gz: d6d648a2b6a67a2179a6b9f1ff27cb7fafbdb0380b7c237994c21d9ad0721528
+  metadata.gz: 60ae02aa38548a2088a52acfddddd24cac4d4f05f8cb0e43c841078adc4fe3c0
+  data.tar.gz: 0661777b08f3641a240282190704526c371625be2c148ad262a937386edc5f44
 SHA512:
-  metadata.gz: ac837afd30918e39010b9a0e08980c875de1e22993281ec72cdce44c1bed767bbd1d581b52de896c8c5d071088ce3dedcc571b6bae8962f425e81cf4df6d8474
-  data.tar.gz: bf11b8b6a64bf998d46ad91299a3dcf886440afa9966eb992925e2b8c5561683ca410ec9c78dbfd0128b4f85272747c19cc55940b758d67154689bd127ad3019
+  metadata.gz: 7df3e00404e4ec49e1530152bbacd4a1685e859b0a1cae0d23aa690b89c618ad8a7645a89fa9a130eaa80a9febefded0d0b8770af26f0fe9b8e0e4b81739b425
+  data.tar.gz: d8debd5687be23b79657b683b13afeb2becf99cfddbf9766e4d7fe1a08444672ba81cdaa736c024c8414ba512859b4687d1012d56c576ff306b13c8ee0fdd3d1

data/Gemfile

@@ -5,12 +5,15 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in activerecord-pg_collation.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.21"
 gem "pg", "~> 1.2", ">= 1.2.3"
 gem "activerecord", "~> 6.1", ">= 6.1.4.1"
 gem "activesupport", "~> 6.1", ">= 6.1.4.1"
-gem 'appraisal', '~> 2.4', '>= 2.4.1'
-gem 'bundler', '~> 2.2', '>= 2.2.32'
-gem "pry"
+
+group :development, :test do
+  gem "rubocop", "~> 1.21"
+  gem 'appraisal', '~> 2.4', '>= 2.4.1'
+  gem 'bundler', '~> 2.2', '>= 2.2.32'
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+  gem "pry"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-pg_collation (0.1.1)
+    activerecord-pg_collation (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,21 @@
-# Activerecord::PgCollation
+# Activerecord::PGCollation
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activerecord/pg_collation`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem adds support for creating and deleting collations. The collation feature allows specifying the sort order and character classification behavior of data per-column, or even per-operation. This alleviates the restriction that the LC_COLLATE and LC_CTYPE settings of a database cannot be changed after its creation.
 
-TODO: Delete this and the text above, and describe your gem
+## schema.rb Support
+
+The motivation of this gem is to integrate postgres collations into your `schema.rb` file without switching to `structure.sql`.
+
+```ruby
+ActiveRecord::Schema.define(version: 2021_12_01_213707) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  # These are collations that must be created before they can be used in the schema definition
+  create_collation "case_insensitive", lc_collate: "und-u-ks-level2", lc_ctype: "und-u-ks-level2", provider: "icu", deterministic: false
+end
+```
 
 ## Installation
 
@@ -22,22 +35,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Create a collation
 
-## Development
+This gem adds the `create_collation` migration helper for creating collations:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+create_collation "collation_name", options
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+For more information about available options visit: https://www.postgresql.org/docs/current/sql-createcollation.html
 
-## Contributing
+For example, this migration creates a case insensitive collation:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activerecord-pg_collation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/activerecord-pg_collation/blob/master/CODE_OF_CONDUCT.md).
+```ruby
+class CreateCaseInsensitiveCollation < ActiveRecord::Migration[6.1]
+  def change
+    create_collation "case_insensitive", provider: "icu", locale: "und-u-ks-level2", deterministic: false
+  end
+end
+```
 
-## License
+### Delete a collation
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This gem adds the `drop_collation` migration helper for deleting collations:
+
+```ruby
+drop_collation "collation_name", option
+```
 
-## Code of Conduct
+By default `option` is equals to `"RESTRICT"`. For more information visit https://www.postgresql.org/docs/current/sql-dropcollation.html
 
-Everyone interacting in the Activerecord::PgCollation project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/activerecord-pg_collation/blob/master/CODE_OF_CONDUCT.md).
+For example, this migration deletes the case insensitive collation previously created:
+
+```ruby
+class DropCaseInsensitiveCollation < ActiveRecord::Migration[6.1]
+  def change
+    drop_collation "case_insensitive"
+  end
+end
+```
+
+### Use a collation with an index
+
+```ruby
+class AddIndexToSomeTable < ActiveRecord::Migration[6.1]
+  def change
+    add_index :some_table, "some_string_field COLLATE case_insensitive, another_string_field COLLATE case_insensitive", unique: true
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/active_record/pg_collation/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module PGCollation
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg_collation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Axel Pontetto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-04 00:00:00.000000000 Z
+date: 2021-12-06 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: