activerecord-collation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b08951bb81767158f2bb2182f468a658c763879c00f03a3173f7ed7fdb82dac4
+  data.tar.gz: 63d6d457800220ab6962bf1d201febdcdfa1f4d71128fb4ed7db2a3c28109a48
+SHA512:
+  metadata.gz: f0c2107d45f7d6f5878494e91716e96f4853c6403c8c423eec5b0c61f1156567609417179ec4b2a39b6ef577a18466c0f9d6414b06b893eb4086e2159493e776
+  data.tar.gz: 85bdcf26363009c077c105eac437ee6cd0d5f8710a5f927f66c3b9e247c919278017c40dd02dd31e0d7ff246e701593ead7b93f3bcff90031c9c415447917a73

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © Fingertips <manfred@fngtps.com>
+
+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,55 @@
+# Active Record – Collations
+
+Allows basic management of ICU collations in Postgres.
+
+```ruby
+class UpdateNaturalDeCollation < ActiveRecord::Migration[8.1]
+  def change
+    drop_collation(:natural_de)
+	create_collation(
+      :natural_de,
+      'de-u-kn-true-ks-level1-ka-shifted-kv-symbol'
+  	)
+  end
+end
+```
+
+See [Postgres collation documentation](https://www.postgresql.org/docs/current/collation.html) on how to write  ICU locale strings.
+
+## Setup
+
+Add `activerecord-collations` to your dependencies. If you also want the `collate` class method on your model you also include the collation module:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  include ActiveRecord::Collation
+end
+```
+
+The collate method creates an ARel expression for the column with a certain collation.
+
+```ruby
+scope :ordered, -> { order(collate(:title, "natural_#{I18n.locale}") }
+scope :ordered_de, -> { order(collate(:title, :natural_de)) }
+```
+
+Alternatively you can build it yourself:
+
+```ruby
+Arel::Nodes::InfixOperation.new(
+  'COLLATE',
+  arel_table[:title],
+  Arel.sql('natural_de')
+)
+```
+
+## Testing
+
+The Dummy application uses the gem so you can load the schema and run migrations there:
+
+```
+cd test/dummy
+RAILS_ENV=test rake db:migrate
+```

data/lib/active_record/collation/railtie.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Collation
+    class Railtie < Rails::Railtie # :nodoc:
+      initializer 'active_record.collation' do
+        ActiveSupport.on_load(:active_record_postgresqladapter) do
+          ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.include(
+            ActiveRecord::Collation::SchemaDumper
+          )
+          ActiveSupport.on_load(:active_record) do
+            ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements.include(
+              ActiveRecord::Collation::SchemaStatements
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/collation/schema_dumper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Collation
+    # Overrides the PostgresAdapter schema dumper to include collations.
+    module SchemaDumper
+      extend ActiveSupport::Concern
+
+      def collations(stream)
+        collations = @connection.collations
+        return unless collations.any?
+
+        stream.puts
+        collations.each do |row|
+          stream.puts(
+            "  create_collation(#{row['collname'].inspect}, #{row['colllocale'].inspect})"
+          )
+        end
+      end
+
+      def trailer(stream)
+        collations(stream)
+        super
+      end
+    end
+  end
+end

data/lib/active_record/collation/schema_statements.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Collation
+    # Defines methods to create, drop, and inspect collations on a schema in Postgres.
+    module SchemaStatements
+      def create_collation(name, icu_locale)
+        execute(
+          'CREATE COLLATION IF NOT EXISTS ' \
+          "#{name} (provider = icu, locale = #{quote(icu_locale)})"
+        )
+      end
+
+      def drop_collation(name)
+        execute(
+          "DROP COLLATION IF EXISTS #{name}"
+        )
+      end
+
+      def collations
+        internal_exec_query(<<~SQL, 'SCHEMA')
+          SELECT
+            pg_collation.collname,
+            pg_collation.colllocale
+          FROM pg_collation
+          JOIN pg_namespace
+          ON pg_collation.collnamespace = pg_namespace.oid AND pg_namespace.nspname = 'public'
+        SQL
+      end
+    end
+  end
+end

data/lib/active_record/collation/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Collation
+    VERSION = '0.0.1'
+  end
+end

data/lib/active_record/collation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  # Implements tools to manage and use collations in Postgres.
+  module Collation
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def collate(column, collation)
+        Arel::Nodes::InfixOperation.new('COLLATE', arel_table[column], Arel.sql(collation.to_s))
+      end
+    end
+  end
+end
+
+require 'active_record/collation/schema_dumper'
+require 'active_record/collation/schema_statements'
+require 'active_record/collation/version'

data/lib/activerecord-collation.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'active_record/collation'
+require 'active_record/collation/railtie'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-collation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Manfred Stienstra
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+description: "  Adds methods like create_collation to manage collations in your Ruby
+  on Rials project.\n"
+email:
+- manfred@fngtps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/active_record/collation.rb
+- lib/active_record/collation/railtie.rb
+- lib/active_record/collation/schema_dumper.rb
+- lib/active_record/collation/schema_statements.rb
+- lib/active_record/collation/version.rb
+- lib/activerecord-collation.rb
+homepage: https://github.com/Fingertips/activerecord-collation
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.0
+specification_version: 4
+summary: Collation support for Active Record.
+test_files: []