ordy 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a18d7ee28d5acf5e956eda544faceca2a4adfbcdac6cbf336321e122d4a1289
+  data.tar.gz: b66298976ba46066cd502c42285a1d329df9323759c2290a750ab221153dd285
+SHA512:
+  metadata.gz: 2c0ffebb475c6cf9d2474704f3351d29196c1961a8c63d1d561af143e5e79671723d20050b5add6df2aa3ab47c6ed2c8e86a14066bd6fb0308ad24ad4cde2c56
+  data.tar.gz: a99c583ae31449767d042dbfaccfc0f2bef34289cb2ee2f9c7bfb519786565ce1b077e86a5a1693ce66d3a31a90c7ae73404f3ecd4c9f77c4a5487132a48315c

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.2
+  - 2.2.5
+  - 2.3.1
+  - 2.3.4
+  - 2.4.1
+gemfile:
+  - gemfiles/rails_4.gemfile
+  - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_5_2.gemfile
+script:
+  - bundle exec rake spec
+before_install:
+  - gem cleanup bundler
+  - gem install bundler -v 1.17.3
+matrix:
+  exclude:
+  - rvm: 2.1.2
+    gemfile: gemfiles/rails_5_0.gemfile
+  - rvm: 2.1.2
+    gemfile: gemfiles/rails_5_2.gemfile

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "rails_4" do
+  gem "activerecord", "4.2.0"
+  gem "actionview", "4.2.0"
+end
+
+appraise "rails_5_0" do
+  gem "activerecord", "5.0.0"
+  gem "actionview", "5.0.0"
+end
+
+appraise "rails_5_2" do
+  gem "activerecord", "5.2.0"
+  gem "actionview", "5.2.0"
+end

data/Dockerfile

@@ -0,0 +1,18 @@
+ARG RUBY_VERSION=2.3.4
+FROM ruby:${RUBY_VERSION}
+LABEL maintainer="engineering@nine.ch"
+
+# Setup sqlite3 db
+RUN apt-get update
+RUN apt-get install -y sqlite3 libsqlite3-dev
+
+# Copy gemfile
+COPY Gemfile Gemfile.lock ordy.gemspec Appraisals ./
+COPY gemfiles ./gemfiles
+
+# Cache bundle install
+RUN bundle install -j $(nproc)
+RUN bundle exec appraisal install
+
+# Copy the main application.
+COPY . /app/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    ordy (0.0.0)
+      actionview (>= 4.0.0)
+      activerecord (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.2.1.1)
+      activesupport (= 5.2.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.1.1)
+      activesupport (= 5.2.1.1)
+    activerecord (5.2.1.1)
+      activemodel (= 5.2.1.1)
+      activesupport (= 5.2.1.1)
+      arel (>= 9.0)
+    activesupport (5.2.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    i18n (1.3.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler
+  ordy!
+  pry
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 nine
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '3'
+services:
+  app: &app
+    build: .
+    volumes:
+    - .:/app

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.2.0"
+gem "actionview", "4.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_4.gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: ..
+  specs:
+    ordy (0.0.0)
+      actionview (>= 4.0.0)
+      activerecord (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.4)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (1.8.6)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.9)
+      activesupport (>= 4.2.0, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionview (= 4.2.0)
+  activerecord (= 4.2.0)
+  appraisal
+  bundler
+  ordy!
+  pry
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   1.3.0

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "5.0.0"
+gem "actionview", "5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: ..
+  specs:
+    ordy (0.0.0)
+      actionview (>= 4.0.0)
+      activerecord (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.0.0)
+      activesupport (= 5.0.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activemodel (5.0.0)
+      activesupport (= 5.0.0)
+    activerecord (5.0.0)
+      activemodel (= 5.0.0)
+      activesupport (= 5.0.0)
+      arel (~> 7.0)
+    activesupport (5.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.4)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionview (= 5.0.0)
+  activerecord (= 5.0.0)
+  appraisal
+  bundler
+  ordy!
+  pry
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   1.3.0

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "5.2.0"
+gem "actionview", "5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: ..
+  specs:
+    ordy (0.0.0)
+      actionview (>= 4.0.0)
+      activerecord (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    i18n (1.3.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionview (= 5.2.0)
+  activerecord (= 5.2.0)
+  appraisal
+  bundler
+  ordy!
+  pry
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   1.3.0

data/lib/config/settings.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+module Ordy
+  CONFIG_PATH = 'lib/config/settings.yml'
+
+  def self.config
+    @config ||= JSON.parse(YAML::load_file(CONFIG_PATH).to_json, object_class: OpenStruct)
+  end
+end

data/lib/config/settings.yml

@@ -0,0 +1,5 @@
+icon:
+  sort: sort
+  up: caret-up
+  down: caret-down
+  inactive: inactive-order-icon

data/lib/ordy/helpers/action_view/orderable_link_helper.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Ordy
+  module Helpers
+    module ActionView
+      module OrderableLinkHelper
+        ORDER_ASC = 'asc'
+        ORDER_DESC = 'desc'
+
+        # order_link(Alert, :event, :asc)
+        #
+        # @param [String] title
+        # @param [Symbol] order_by
+        # @param [Symbol] direction
+        def order_link(title, order_by, direction = ORDER_ASC)
+          current_orderable, current_direction = request_params.values_at(:order_by, :direction)
+
+          direction = if current_direction.present?
+                        current_direction == ORDER_ASC ? ORDER_DESC : ORDER_ASC
+                      else
+                        direction
+                      end
+
+          icon_html = if current_orderable.present? && order_by.to_s == current_orderable
+                        icon(direction)
+                      else
+                        icon(nil)
+                      end
+
+          title = "#{title} #{icon_html}".html_safe
+          url_params = request_params.merge(order_by: "#{order_by}-#{direction}")
+
+          link_to(title, url_params)
+        end
+
+        # NOTE: In case you don't use Awesome Font override this method
+        #
+        # icon('asc')
+        #
+        # @param [String] direction
+        # @return [String]
+        def icon(direction = nil)
+          icon, html_class = if direction.nil?
+                               [config.icon.sort, class: config.icon.inactive]
+                             else
+                               [direction == ORDER_DESC ? config.icon.up : config.icon.down, nil]
+                             end
+          icon_class = "fa-#{icon}"
+
+          "<i class=\"fa #{icon_class} #{html_class}\"></i>"
+        end
+
+        private
+
+        def request_params
+          request.params
+        end
+      end
+    end
+  end
+end

data/lib/ordy/orm/active_record/orderable/by_association.rb

@@ -0,0 +1,17 @@
+module Ordy
+  module Orm
+    module ActiveRecord
+      module Orderable
+        class ByAssociation
+          # @param [Model::ActiveRecord_Relation] scope
+          # @param [Hash] args (:table, :column, :direction)
+          def self.call(scope, args)
+            table, column, direction = args.values_at(:table, :column, :direction)
+            
+            scope.includes(args[:association]).order("#{table}.#{column} #{direction}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ordy/orm/active_record/orderable/by_column.rb

@@ -0,0 +1,17 @@
+module Ordy
+  module Orm
+    module ActiveRecord
+      module Orderable
+        class ByColumn
+          # @param [Model::ActiveRecord_Relation] scope
+          # @param [Hash] args (:table, :column, :direction)
+          def self.call(scope, args)
+            table, column, direction = args.values_at(:table, :column, :direction)
+
+            scope.order("#{table}.#{column} #{direction}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ordy/orm/active_record/orderable/by_specified.rb

@@ -0,0 +1,23 @@
+module Ordy
+  module Orm
+    module ActiveRecord
+      module Orderable
+        class BySpecified
+          # @param [Model::ActiveRecord_Relation] scope
+          # @param [Hash] args (:table, :column)
+          def self.call(scope, args)
+            connection = scope.connection
+            table = connection.quote_table_name(args[:table])
+            column = connection.quote_column_name(args[:column])
+            values = args[:values].map { |value| connection.quote(value) }
+
+            sql = values.map { |value| "#{table}.#{column}=#{value} DESC" }.join(',')
+
+            connection.quote(sql)
+            scope.order(Arel.sql(sql))
+          end
+        end
+      end
+    end
+  end
+end