sortiri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c6e2f133cbd4f3d2e2be7a72ac383bc8e5e4098a0baa7cc9960fad805bdf9e4
+  data.tar.gz: a85d69d4ced33fa35f2f5f9e5c42b6c2ea8bc62453891020955df2ad92810551
+SHA512:
+  metadata.gz: 3978d8f94465d7c292e91e706c8dda6c65868b31685c3cb13c09a9b59e7835287ce2238db8a075172a56f9ccbb5697df60fa99ea2ddd50e1b10a9777eb70bbb4
+  data.tar.gz: c886e096946103f324a73a65242b500f59db5fc78483b81dd80c26e55402091503c5c1825ffb081a89f0a6c5d674af2173a229c46b537ca04412b3b38d21e3eb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,58 @@
+require: rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'test/**/*_test.rb'
+    - '*.md'
+    - 'bin/**'
+
+Metrics/BlockLength:
+  Max: 36
+  Exclude:
+    - sortiri.gemspec
+
+Metrics/BlockNesting:
+  Max: 2
+
+Layout/LineLength:
+  AllowURI: true
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 15
+
+Metrics/ModuleLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    collect:  'map'
+    collect!: 'map!'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+    delete:   'gsub'
+
+Style/Documentation:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Naming/FileName:
+  Enabled: false
+
+Layout/AccessModifierIndentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: 
+  - gem install bundler -v 2.1.4
+script:
+  - bundle exec rake test
+  - bundle exec rubocop --config .rubocop.yml

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sortiri.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    sortiri (0.1.0)
+      activerecord (>= 4.2)
+      activesupport (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.0)
+      activesupport (= 6.1.0)
+    activerecord (6.1.0)
+      activemodel (= 6.1.0)
+      activesupport (= 6.1.0)
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.6)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    mocha (1.12.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.4.2)
+    temping (3.10.0)
+      activerecord (>= 4.2)
+      activesupport (>= 4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  mocha (~> 1.12)
+  rake (~> 12.0)
+  rubocop (~> 1.7)
+  rubocop-rake (~> 0.5.1)
+  sortiri!
+  sqlite3 (~> 1.4.0)
+  temping (~> 3.10)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Fabrikatör
+Copyright (c) 2021 H. Can Yıldırım
+
+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,175 @@
+# Description
+
+Sortiri is a clean and lightweight solution for making ActiveRecord::Base objects sortable.
+
+## Getting started
+
+Sortiri is supported for ActiveRecord 4.2+ on Ruby 2.6.0 and later.
+
+In your Gemfile, for the last officially released gem:
+
+```ruby
+gem 'sortiri'
+```
+
+## Usage
+
+To add Sortiri to an ActiveRecord::Base object, simply include the Sortiri module.
+
+```ruby
+class User < ActiveRecord::Base
+  include Sortiri::Model
+end
+```
+
+### Ascending
+
+Sorting is ascending by default and can be reversed by adding a hyphen (-) to the start of the property name.
+
+```ruby
+# GET /users?sort=name
+
+class User < ActiveRecord::Base
+  include Sortiri::Model
+
+  sortable against: %i[name age weight], default_sort: 'age'
+end
+
+# users will be sorted by name and ascending (A -> Z)
+```
+
+### Descending
+
+To sort by descending, simply add a hypen (-) to the start of the property name.
+
+```ruby
+# GET /users?sort=-name
+
+class User < ActiveRecord::Base
+  include Sortiri::Model
+
+  sortable against: %i[name age weight], default_sort: 'age'
+end
+
+# users will be sorted by name and descending (Z -> A)
+```
+
+### Default sort option
+
+It is mandatory to provide a default sort option for the model. If nothing is passed, the default sort option will be applied.
+
+```ruby
+# GET /users
+
+class User < ActiveRecord::Base
+  include Sortiri::Model
+
+  sortable against: %i[name age weight], default_sort: '-age'
+end
+
+# users will be sorted by age and descending
+```
+
+### Sorting through associations
+
+It is possible to sort columns on associated models.
+
+You can pass a Hash into the :associated_against option to set up sorting through associations. The keys are the names of the associations and the value works just like an :against option for the other model. Right now, sorting deeper than one association away is not supported.
+
+```ruby
+class Company < ActiveRecord::Base
+  has_many :users
+end
+
+# GET /users?sort=-company.name
+
+class User < ActiveRecord::Base
+  include Sortiri::Model
+
+  belongs_to :company
+
+  sortable against: %i[name age weight], associated_against: { company: [:name] }, default_sort: '-age'
+end
+
+# users will be sorted by their companies name and descending (Z -> A)
+```
+
+### Controller
+
+#### Sorted
+
+Allows to specify an order string.
+
+```ruby
+class UsersController < ApplicationController
+  def index
+    @users = User.sorted(params[:sort])
+  end
+end
+```
+
+#### Sorted!
+
+Replaces any existing order defined on the relation with the specified order.
+
+```ruby
+class UsersController < ApplicationController
+  def index
+    if params[:sort].present?
+        @users = User.sorted!(params[:sort])
+    else
+        @users = User.sorted(params[:sort])
+    end
+  end
+end
+```
+
+### Sortiri's sort_link helper creates table headers that are sortable links
+
+To use Sortiri's sort_link helper, simply include the Sortiri module on your ApplicationHelper.
+
+```ruby
+module ApplicationHelper
+  include Sortiri::ViewHelpers::TableSorter
+end
+```
+
+```erb
+<%= sort_link(@users, :name, 'First Name') %>
+```
+
+```haml
+= sort_link @users, :name, 'First Name'
+```
+
+Additionally css classes can be passed after the title attribute.
+
+```erb
+<%= sort_link(@users, :name, 'First Name', 'd-flex justify-content-center') %>
+```
+
+```haml
+= sort_link @users, :name, 'First Name', 'd-flex justify-content-center'
+```
+
+### Configuration
+
+Sortiri uses default up and down arrows for the view helper. This may be changed by
+setting them in a Sortiri initializer file (typically `config/initializers/sortiri.rb`):
+
+```ruby
+Sortiri.configure do |c|
+  c.up_arrow = 'fas fa-angle-up'
+  c.down_arrow = 'fas fa-angle-down'
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fabrikatorio/sortiri.
+
+## License
+
+Copyright © 2019–2021 [Fabrikatör](https://fabrikator.io).
+
+Licensed under the MIT license, see [License](https://github.com/fabrikatorio/sortiri/blob/master/LICENSE.txt).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sortiri'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sortiri.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support/concern'
+
+require 'sortiri/version'
+require 'sortiri/configuration'
+
+require 'sortiri/active_record/column'
+require 'sortiri/active_record/foreign_column'
+require 'sortiri/generators/order_by_generator'
+require 'sortiri/view_helpers/table_sorter'
+require 'sortiri/column'
+require 'sortiri/missing_column'
+require 'sortiri/model'
+require 'sortiri/parser'
+require 'sortiri/utils'
+
+module Sortiri
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/sortiri/active_record/column.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Sortiri
+  module ActiveRecord
+    class Column
+      attr_reader :name, :association_name
+
+      def initialize(name:, model:, association_name: nil)
+        @name = name.to_s
+        @model = model
+        @association_name = association_name
+      end
+
+      def name_with_table_name
+        [table_name, name].join('.')
+      end
+
+      def matches_with?(column_object)
+        return false unless column_object.is_a?(Sortiri::Column)
+
+        name == column_object.name && association_name.to_s == column_object.association.to_s
+      end
+
+      def table_name
+        @model.table_name
+      end
+    end
+  end
+end

data/lib/sortiri/active_record/foreign_column.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Sortiri
+  module ActiveRecord
+    class ForeignColumn < Column
+      def initialize(name:, model:, association_name:)
+        super(name: name, model: model, association_name: association_name)
+      end
+
+      def foreign_key
+        @model.reflect_on_association(association_name).foreign_key
+      end
+
+      def table_name
+        @model.reflect_on_association(association_name).table_name
+      end
+    end
+  end
+end

data/lib/sortiri/column.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Sortiri
+  class Column
+    ASCENDING_SIGN = ''
+    DESCENDING_SIGN = '-'
+    ASCENDING_SQL = 'ASC'
+    DESCENDING_SQL = 'DESC'
+    ASSOCIATION_DELIMITER = '.'
+
+    attr_reader :name_with_sign
+
+    def initialize(column:)
+      @name_with_sign = column.to_s
+    end
+
+    def name
+      raw_name = name_with_sign
+      raw_name = raw_name[1..] if raw_name.start_with?(DESCENDING_SIGN)
+      raw_name = raw_name.split(ASSOCIATION_DELIMITER)[1] if foreign_column?
+
+      raw_name
+    end
+
+    def name_with_association
+      return [association, name].join(ASSOCIATION_DELIMITER) if foreign_column?
+
+      name
+    end
+
+    def association
+      return unless foreign_column?
+
+      # name might have '-' sign, delete_prefix removes that
+      # if no sign in there, it just returns the whole string
+      name_with_sign.delete_prefix(DESCENDING_SIGN).split(ASSOCIATION_DELIMITER).first
+    end
+
+    def direction
+      return DESCENDING_SIGN if name_with_sign.start_with?(DESCENDING_SIGN)
+
+      ASCENDING_SIGN
+    end
+
+    def direction_sql
+      return DESCENDING_SQL if direction == DESCENDING_SIGN
+
+      ASCENDING_SQL
+    end
+
+    def toggle_direction
+      return ASCENDING_SIGN if desc?
+
+      DESCENDING_SIGN
+    end
+
+    def toggle_icon_class
+      return Sortiri.configuration.down_arrow if desc?
+
+      Sortiri.configuration.up_arrow
+    end
+
+    def asc?
+      direction == ASCENDING_SIGN
+    end
+
+    def desc?
+      direction == DESCENDING_SIGN
+    end
+
+    def foreign_column?
+      name_with_sign.include?(ASSOCIATION_DELIMITER)
+    end
+  end
+end

data/lib/sortiri/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sortiri
+  class Configuration
+    attr_accessor :up_arrow, :down_arrow
+
+    def initialize
+      @up_arrow = 'fas fa-angle-up'
+      @down_arrow = 'fas fa-angle-down'
+    end
+  end
+end

data/lib/sortiri/generators/order_by_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Sortiri
+  module Generators
+    class OrderByGenerator
+      attr_reader :sortable_columns, :whitelisted_columns, :columns_hash, :foreign_columns
+
+      def initialize(sortable_columns:, whitelisted_columns:)
+        @sortable_columns = sortable_columns # array of Sortiri::ActiveRecord::Column
+        @whitelisted_columns = whitelisted_columns # array of Sortiri::Column
+        @columns_hash = map_columns_and_active_record_columns
+        @foreign_columns = select_unique_foreign_columns
+      end
+
+      def sort(model, reorder: false)
+        query = if reorder
+                  model.reorder(generate_order_by_clauses)
+                else
+                  model.order(generate_order_by_clauses)
+                end
+        query = query.joins(generate_joins(model)) if needs_join?
+        query
+      end
+
+      private
+
+      def needs_join?
+        foreign_columns.present?
+      end
+
+      def generate_order_by_clauses
+        columns_hash.map do |column_hash|
+          concatenate_column_and_direction(column_hash)
+        end.join(',')
+      end
+
+      def generate_joins(model)
+        source_arel_table = model.arel_table
+
+        foreign_columns.map do |hash|
+          active_record_column = hash[:active_record_column]
+          target_arel_table = Arel::Table.new(active_record_column.table_name)
+
+          # TODO: find a way to get primary key from target_arel_table
+          source_arel_table.join(target_arel_table, Arel::Nodes::OuterJoin).
+            on(source_arel_table[active_record_column.foreign_key.to_sym].eq(target_arel_table[:id]))
+        end.map(&:join_sources)
+      end
+
+      def concatenate_column_and_direction(column_hash)
+        Arel.sql("#{column_hash[:active_record_column].name_with_table_name} #{column_hash[:column].direction_sql}")
+      end
+
+      def map_columns_and_active_record_columns
+        whitelisted_columns.map do |column|
+          sortable_column = sortable_columns.detect { |c| c.matches_with?(column) }
+
+          { active_record_column: sortable_column, column: column }
+        end
+      end
+
+      def select_unique_foreign_columns
+        columns_hash.select { |c| c[:active_record_column].is_a?(Sortiri::ActiveRecord::ForeignColumn) }.
+          uniq { |c| c[:active_record_column].association_name }
+      end
+    end
+  end
+end

data/lib/sortiri/missing_column.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Sortiri
+  class MissingColumn < Sortiri::Column
+    def initialize
+      super(column: 'no name')
+    end
+
+    def direction
+      ''
+    end
+
+    def direction_sql
+      ''
+    end
+
+    def asc?
+      false
+    end
+
+    def desc?
+      false
+    end
+
+    def toggle_direction
+      ''
+    end
+
+    def toggle_icon_class
+      ''
+    end
+
+    def foreign_column?
+      false
+    end
+  end
+end

data/lib/sortiri/model.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sortiri
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      attr :sortable_columns, :default_sort
+
+      def sortable(against:, default_sort:, associated_against: {})
+        @sortable_columns ||= []
+
+        columns = against.map do |column|
+          Sortiri::ActiveRecord::Column.new(name: column, model: self)
+        end
+
+        association_columns = associated_against.map do |association_name, columns_array|
+          columns_array.map do |column|
+            Sortiri::ActiveRecord::ForeignColumn.new(name: column, model: self, association_name: association_name)
+          end
+        end.flatten
+
+        @sortable_columns = columns + association_columns
+        @default_sort = default_sort
+      end
+
+      def parse_sorting(sort_query_string)
+        sort_string = (sort_query_string.presence || default_sort)
+        whitelisted_columns = Sortiri::Parser.new(sortable_columns: sortable_columns, sort_string: sort_string).whitelisted_columns
+        Sortiri::Generators::OrderByGenerator.new(sortable_columns: sortable_columns, whitelisted_columns: whitelisted_columns)
+      end
+
+      # sort_query_string is a string seperated by comma and takes - sign
+      # when it's descending. all of the examples below are valid.
+      # request => GET /users?sort=-id,name,email || params => '-id,name,email'
+      # request => GET /users?sort=name,email || params => 'name,email'
+      # request => GET /users || params => nil
+      def sorted(sort_query_string = nil)
+        generator = parse_sorting(sort_query_string)
+        generator.sort(self)
+      end
+
+      # this function will override order by clauses which defined
+      # before sorted! call and force them to use its way.
+      # every example above are still valid for this function.
+      def sorted!(sort_query_string = nil)
+        generator = parse_sorting(sort_query_string)
+        generator.sort(self, reorder: true)
+      end
+    end
+  end
+end

data/lib/sortiri/parser.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sortiri
+  class Parser
+    DELIMITER = ','
+
+    attr_reader :sortable_columns, :sort_string
+
+    def initialize(sortable_columns:, sort_string:)
+      @sortable_columns = sortable_columns # Array of Sortiri::ActiveRecord::Column
+      @sort_string = sort_string
+    end
+
+    def whitelisted_columns
+      columns = self.class.parse(sort_string: sort_string)
+
+      columns.select do |column|
+        sortable_columns.any? { |c| c.matches_with?(column) }
+      end
+    end
+
+    def self.parse(sort_string:)
+      return [] if sort_string.blank?
+
+      sort_string.split(DELIMITER).map do |s|
+        Sortiri::Column.new(column: s)
+      end
+    end
+  end
+end

data/lib/sortiri/utils.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sortiri
+  class Utils
+    attr_reader :sort_string, :column_name, :column
+
+    def initialize(sort_string:, column_name:)
+      @sort_string = sort_string
+      @column_name = column_name.to_s
+      @column = find_column
+    end
+
+    def direction
+      column.toggle_direction
+    end
+
+    def icon_class
+      column.toggle_icon_class
+    end
+
+    private
+
+    def find_column
+      columns = Sortiri::Parser.parse(sort_string: sort_string)
+      columns.detect { |column| column.name_with_association == column_name } || MissingColumn.new
+    end
+  end
+end

data/lib/sortiri/version.rb

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

data/lib/sortiri/view_helpers/table_sorter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Sortiri
+  module ViewHelpers
+    module TableSorter
+      def sort_link(activerecord_relation_object, column, title, css_class = nil)
+        sort_string = params[:sort].presence || activerecord_relation_object.klass.default_sort
+        sorter = Sortiri::Utils.new(sort_string: sort_string, column_name: column)
+
+        link_to(request.query_parameters.merge({ sort: "#{sorter.direction}#{column}" }), class: css_class) do
+          concat title
+          concat content_tag(:i, '', class: sorter.icon_class)
+        end
+      end
+    end
+  end
+end

data/sortiri.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/sortiri/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sortiri'
+  spec.version       = Sortiri::VERSION
+  spec.authors       = ['H. Can Yıldırım']
+  spec.email         = ['huseyin@fabrikator.io']
+
+  spec.summary       = 'Sortiri is a clean and lightweight solution for making ActiveRecord::Base objects sortable.'
+  spec.homepage      = 'https://github.com/fabrikatorio/sortiri'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fabrikatorio/sortiri'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 4.2'
+  spec.add_dependency 'activesupport', '>= 4.2'
+
+  spec.add_development_dependency 'mocha', '~> 1.12'
+  spec.add_development_dependency 'rubocop', '~> 1.7'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5.1'
+  spec.add_development_dependency 'sqlite3', '~> 1.4.0'
+  spec.add_development_dependency 'temping', '~> 3.10'
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: sortiri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- H. Can Yıldırım
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-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: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description:
+email:
+- huseyin@fabrikator.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sortiri.rb
+- lib/sortiri/active_record/column.rb
+- lib/sortiri/active_record/foreign_column.rb
+- lib/sortiri/column.rb
+- lib/sortiri/configuration.rb
+- lib/sortiri/generators/order_by_generator.rb
+- lib/sortiri/missing_column.rb
+- lib/sortiri/model.rb
+- lib/sortiri/parser.rb
+- lib/sortiri/utils.rb
+- lib/sortiri/version.rb
+- lib/sortiri/view_helpers/table_sorter.rb
+- sortiri.gemspec
+homepage: https://github.com/fabrikatorio/sortiri
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fabrikatorio/sortiri
+  source_code_uri: https://github.com/fabrikatorio/sortiri
+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.0.8
+signing_key:
+specification_version: 4
+summary: Sortiri is a clean and lightweight solution for making ActiveRecord::Base
+  objects sortable.
+test_files: []