sort_in 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7998cdbbd6965179b974c20e8e17433c352693d24d15446ef8cfaa6b839394db
+  data.tar.gz: 917c73ec148e589cab617c63ee11bc5805506d41962c3d3e87dbe8e8185c4a9a
+SHA512:
+  metadata.gz: b83a218c80a7798106958a6ce03904f7a20f42e75b2cb10fb69d283cfd0ba9e78ac8b868682606a462b90b792adae5089ef6a486b079d6566724919690e3dadc
+  data.tar.gz: 4032249d33db643e5c4e220f2bd507537b8908b548f3027e3f6a25aa83b908d37325e01cc99e1b3aa7889ee19dabd1f2e4117fdc154da7dc3fa12225f2fb6410

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2023 Naoyuki Kojima
+
+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,54 @@
+# SortIn
+
+This gem provides a method that allows you to sort and retrieve values in the order they were passed to the IN clause when the IN clause is issued from the where method of ActiveRecord.
+
+## Language
+
+- [Japanese](https://github.com/KojimaNaoyuki/sort_in/tree/master/document/ja)
+- [English](https://github.com/KojimaNaoyuki/sort_in/tree/master/document/en)
+
+## Installation
+
+Add sort_in to your project's Gemfile:
+
+```ruby
+gem 'sort_in'
+```
+
+Then, execute the installation:
+
+```
+$ bundle
+```
+
+You can also install sort_in standalone:
+
+```
+$ gem install sort_in
+```
+
+## Usage
+
+You can use it in a natural flow by using ActiveRecord methods and method chaining. In the example below, the filtering conditions of the where clause specify id: 3, 2, 1. In a regular where clause, an IN clause is issued, and the results are returned in ascending order of id, filtered by 3, 2, 1. By using the where_sort_in provided by this gem, you can not only filter by id 3, 2, 1 but also retrieve records in the order specified by the IN clause.
+
+```ruby
+Post.where_sort_in(id: [3, 2, 1])
+=> [#<Post:~~~ id: 3, ~~~>, #<Post:~~~ id: 2, ~~~>, #<Post:~~~ id: 1, ~~~>]
+```
+
+If you want to sort by a column other than id, use the keyword argument sort_key. You can specify the column to be used for sorting.
+
+```ruby
+Post.where_sort_in(sort_key: :content, content: ['third', 'second', 'first'])
+=> [#<Post:~~~ id: 3, content: 'third', ~~~>, #<Post:~~~ id: 2, content: 'second', ~~~>, #<Post:~~~ id: 1, content: 'first', ~~~>]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake ` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sort_in.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3"
+services:
+  ruby:
+    build: ./spec/
+    volumes:
+      - ./:/app
+    depends_on:
+      - db
+    tty: true
+    stdin_open: true
+  db:
+    build: ./spec/db
+    command: mysqld --character-set-server=utf8 --collation-server=utf8_unicode_ci
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: "sample"
+    ports:
+      - "3306:3306"

data/document/en/README.md

@@ -0,0 +1,54 @@
+# SortIn
+
+This gem provides a method that allows you to sort and retrieve values in the order they were passed to the IN clause when the IN clause is issued from the where method of ActiveRecord.
+
+## Language
+
+- [Japanese](https://github.com/KojimaNaoyuki/sort_in/tree/master/document/ja)
+- [English](https://github.com/KojimaNaoyuki/sort_in/tree/master/document/en)
+
+## Installation
+
+Add sort_in to your project's Gemfile:
+
+```ruby
+gem 'sort_in'
+```
+
+Then, execute the installation:
+
+```
+$ bundle
+```
+
+You can also install sort_in standalone:
+
+```
+$ gem install sort_in
+```
+
+## Usage
+
+You can use it in a natural flow by using ActiveRecord methods and method chaining. In the example below, the filtering conditions of the where clause specify id: 3, 2, 1. In a regular where clause, an IN clause is issued, and the results are returned in ascending order of id, filtered by 3, 2, 1. By using the where_sort_in provided by this gem, you can not only filter by id 3, 2, 1 but also retrieve records in the order specified by the IN clause.
+
+```ruby
+Post.where_sort_in(id: [3, 2, 1])
+=> [#<Post:~~~ id: 3, ~~~>, #<Post:~~~ id: 2, ~~~>, #<Post:~~~ id: 1, ~~~>]
+```
+
+If you want to sort by a column other than id, use the keyword argument sort_key. You can specify the column to be used for sorting.
+
+```ruby
+Post.where_sort_in(sort_key: :content, content: ['third', 'second', 'first'])
+=> [#<Post:~~~ id: 3, content: 'third', ~~~>, #<Post:~~~ id: 2, content: 'second', ~~~>, #<Post:~~~ id: 1, content: 'first', ~~~>]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake ` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sort_in.

data/document/ja/README.md

@@ -0,0 +1,57 @@
+# SortIn
+
+ActiveRecord の where メソッドから IN 句が発行された場合、その IN 句に渡された順番で値がソートされ取得することができるメソッドを提供します。
+
+## Language
+
+- [Japanese](https://github.com/KojimaNaoyuki/sort_in/tree/master/document/ja)
+- [English](https://github.com/KojimaNaoyuki/sort_in/tree/master/document/en)
+
+## Installation
+
+使用したいプロジェクトの Gemfile に sort_in を記載してください。
+
+```ruby
+gem 'sort_in'
+```
+
+インストールを実行してください。
+
+```
+$ bundle
+```
+
+単体で sort_in をインストールすることもできます。
+
+```
+$ gem install sort_in
+```
+
+## Usage
+
+ActiveRecord のメソッドとメソッドチェインをすることで自然な流れで使用することができます。
+下記の例では where 句の絞り込み条件に id: 3, 2, 1 を指定しています。通常の where 句では IN 句が発行され id の 3, 2, 1 で絞られた状態で id の昇順で返却されます。
+この gem が提供する`where_sort_in`を使用することで、id の 3, 2, 1 で絞ると共に、レコードを取得する順番も IN 句で指定した通りの順番で取得することができます。
+
+```ruby
+Post.where_sort_in(id: [3, 2, 1])
+=> [#<Post:~~~ id: 3, ~~~>, #<Post:~~~ id: 2, ~~~>, #<Post:~~~ id: 1, ~~~>]
+```
+
+id 以外でソートしたい場合は、キーワード引数(sort_key)を利用してください。
+sort_key に指定したカラムを利用して並び替えられます。
+
+```ruby
+Post.where_sort_in(sort_key: :content, content: ['third', 'second', 'first'])
+=> [#<Post:~~~ id: 3, content: 'third', ~~~>, #<Post:~~~ id: 2, content: 'second', ~~~>, #<Post:~~~ id: 1, content: 'first', ~~~>]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake ` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sort_in.

data/lib/sort_in/extension.rb

@@ -0,0 +1,21 @@
+require 'sort_in/model_extension'
+
+module SortIn
+  module Extension
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def inherited(kls)
+        super
+        kls.public_send(:include, SortIn::ModelExtension) if kls.superclass == ActiveRecord::Base
+      end
+    end
+
+    included do
+      descendants.each do |kls|
+        kls.public_send(:include, SortIn::ModelExtension) if kls.superclass == ApplicationRecord
+      end
+    end
+
+  end
+end

data/lib/sort_in/model_extension.rb

@@ -0,0 +1,30 @@
+module SortIn
+  module ModelExtension
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def where_sort_in(sort_key: nil, **args)
+        targets = where(args)
+        sort_in(targets: targets, args: args, sort_key: sort_key)
+      end
+
+      private
+
+      def sort_in(targets:, args:, sort_key:)
+        unless sort_key
+          sorted_targets = args[:id].map do |id|
+            targets.find { |sort_target| sort_target.id.to_i == id.to_i }
+          end
+
+          return sorted_targets.compact
+        end
+
+        sorted_targets = args[sort_key].map do |value|
+          targets.find { |sort_target| sort_target[sort_key] == value }
+        end
+
+        sorted_targets.compact
+      end
+    end
+  end
+end

data/lib/sort_in/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SortIn
+  VERSION = "0.1.0"
+end

data/lib/sort_in.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require 'active_record'
+require_relative "sort_in/version"
+
+module SortIn
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+ActiveSupport.on_load(:active_record) do
+  require 'sort_in/extension'
+  ActiveRecord::Base.send(:include, SortIn::Extension)
+end

data/sig/sort_in.rbs

@@ -0,0 +1,4 @@
+module SortIn
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: sort_in
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- KojimaNaoyuki
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-05 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'
+- !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: pry-rails
+  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: mysql2
+  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: Gem to be sorted in the order specified in the in clause
+email:
+- programkoji213@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE
+- README.md
+- Rakefile
+- docker-compose.yml
+- document/en/README.md
+- document/ja/README.md
+- lib/sort_in.rb
+- lib/sort_in/extension.rb
+- lib/sort_in/model_extension.rb
+- lib/sort_in/version.rb
+- sig/sort_in.rbs
+homepage: https://github.com/KojimaNaoyuki/sort_in
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/KojimaNaoyuki/sort_in
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Gem to be sorted in the order specified in the in clause
+test_files: []