mongoid_collation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8b80c69bc61252c0fb8b6bc6d8a85ddd4aac064
+  data.tar.gz: cb7e0fe01839f033e30c2a15ea4112e2d4a9a384
+SHA512:
+  metadata.gz: 77e3574dbf049031e0d890c1be52e0a32d63468ac4beaf8974c3b6863e3b298a8d3594f9555d3b3bb3c25e9990985c93fbe9f9b93718d1f895cccc755099e32d
+  data.tar.gz: c6662e28f89b409701f6fd2ced2843dfd6eda4e2dc374627e7160fc0d2012f6aedce7f378fd87d5f11c46c00497a0e256db219bb43c36628ddb8b3be21e9e697

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Maciej Majewski
+
+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,26 @@
+mongoid_collation
+=================
+[![Build Status](https://travis-ci.org/maciejmajewski/mongoid_collation.svg?branch=master)](https://travis-ci.org/maciejmajewski/mongoid_collation)
+
+Support for sorting by collation for Mongoid
+
+### Problem description
+* [Natural Language Sorting with MongoDB, Derick Rethans](http://derickrethans.nl/mongodb-collation.html)
+* [SERVER-1920 in mongoDB JIRA (4 years old)](https://jira.mongodb.org/browse/SERVER-1920)
+* http://www.unicode.org/reports/tr10/#Step_3
+
+### Contributing to mongoid_collation
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+### Copyright
+
+Copyright (c) 2014 Maciej Majewski. See LICENSE.txt for
+further details.
+

data/lib/mongoid/collation/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Collation
+    VERSION = '0.1.0'
+  end
+end

data/lib/mongoid_collation.rb

@@ -0,0 +1,88 @@
+require 'twitter_cldr'
+
+module Mongoid
+  module Contextual
+    class Mongo
+      def sort_with_collation(values = nil, &block)
+        if klass.respond_to?(:collation_aliases)
+          values = replace_collation_aliases(values)
+        end
+
+        sort_without_collation(values, &block)
+      end
+
+      alias_method_chain :sort, :collation
+
+      private
+
+      def replace_collation_aliases(values)
+        case values
+          when Hash
+            values.dup.tap do |values_copy|
+              values_copy.keys.each do |key|
+                if is_collated?(key)
+                  values_copy[collated_alias(key)] = values[key]
+                  values_copy.delete(key)
+                end
+              end
+            end
+          else
+            Array(values).dup.tap do |values_copy|
+              values_copy.each do |key|
+                if key.is_a?(Origin::Key)
+                  if is_collated?(key.name)
+                    values_copy.delete(key)
+
+                    values_copy <<
+                      rebuild_origin_key(key, collated_alias(key.name))
+                  end
+                end
+              end
+            end
+        end
+      end
+
+      def is_collated?(key)
+        klass.collation_aliases.has_key?(key.to_s)
+      end
+
+      def collated_alias(key)
+        klass.collation_aliases[key.to_s]
+      end
+
+      def rebuild_origin_key(key, name)
+        ::Origin::Key.new(name, key.strategy, key.operator, key.expanded,
+                          &key.block)
+      end
+    end
+  end
+
+  module Collation
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :collation_aliases
+      self.collation_aliases = {}
+    end
+
+    module ClassMethods
+      def collation(field, options = {})
+        raise ':locale option is required' unless options[:locale]
+
+        options[:suffix] ||= :collated
+
+        field_collated = "#{field}_#{options[:suffix]}"
+        field field_collated, type: String
+
+        self.collation_aliases[field.to_s] = field_collated
+
+        collator = TwitterCldr::Collation::Collator.new(options[:locale])
+
+        before_save do
+          sort_key = collator.get_sort_key(send(field))
+          send("#{field_collated}=", sort_key.map { |i| i.to_s(16) }.join)
+        end
+      end
+    end
+  end
+end

data/spec/mongoid_collation_spec.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe Mongoid::Collation do
+  describe '.collation' do
+    before do
+      class Container
+        include Mongoid::Document
+        include Mongoid::Collation
+
+        field :string, type: String
+        collation :string, locale: :pl
+      end
+    end
+
+    after do
+      Object.send(:remove_const, :Container)
+    end
+
+    context 'given multiple strings' do
+      let(:strings) { ['Ą', 'A', 'Ś', 'Ł', 'Ó', 'W'] }
+      let(:strings_ordered) { ['A', 'Ą', 'Ł', 'Ó', 'Ś', 'W'] }
+
+      before do
+        strings.shuffle.each do |string|
+          Container.create!(string: string)
+        end
+      end
+
+      context 'given sorting by hash' do
+        let(:sorted_by_string) { Container.all.sort(string: 1).to_a }
+
+        it 'sorts according to collation' do
+          expect(sorted_by_string.map(&:string)).
+            to eq(strings_ordered)
+        end
+      end
+
+      context 'given sorting by Origin::Key' do
+        let(:sorted_by_string) { Container.all.sort(:string.asc).to_a }
+
+        it 'sorts according to collation' do
+          expect(sorted_by_string.map(&:string)).
+            to eq(strings_ordered)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'mongoid'
+require 'mongoid_collation'
+require 'database_cleaner'
+
+Mongoid::Config.connect_to('mongoid_collation', {read: :primary,
+                                                 write: {fsync: true}})
+
+Mongoid.logger = Logger.new(STDOUT)
+Moped.logger = Mongoid.logger
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_collation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maciej Majewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: twitter_cldr
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mongoid support for sorting with collation
+email:
+- maciej.majewski@gooddesign.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/mongoid/collation/version.rb
+- lib/mongoid_collation.rb
+- spec/mongoid_collation_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/maciejmajewski/mongoid_collation
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Mongoid collation support
+test_files:
+- spec/mongoid_collation_spec.rb
+- spec/spec_helper.rb