easy_orderable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8a4f7e80bf010be7f63cb3abe11932fb6ed8089
+  data.tar.gz: 15635b6bcece75b05c0107c2a8004787cab26eed
+SHA512:
+  metadata.gz: c4e477d87c2761a4563d957ac2ac9c5cd66747b20b9e4b8ccc4da84727e90f290745452aaa8f3361503f33cc8d3c6847946dce3f2d573a7c7ac3a434d53a3bed
+  data.tar.gz: 451218c1355be0b9682331f5ae9b641fb53f081918bca309c9357e46da3bc5dfc2d297a026f15b033cf26d388f145ac076ac4fc0f83819eded25b8d90d6939dc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Filip Pavic
+
+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,87 @@
+# EasyOrderable
+Easy ordering of Active Record objects
+
+## Usage
+```ruby
+class User < ApplicationRecord
+  has_many :bookings
+  has_many :requests
+end
+
+class Booking < ApplicationRecord
+  belongs_to :user
+end
+
+class Request < ApplicationRecord
+  belongs_to :renter, class_name: 'User', foreign_key: :user_id
+end
+
+#<User id: 1, first_name: 'A'>
+#<User id: 2, first_name: 'B'>
+#<User id: 3, first_name: 'C'>
+```
+
+### Sort by column name asc
+```ruby
+>> User.assort('first_name')
+=> [#<User first_name: 'A'>, #<User first_name: 'B'>, #<User first_name: 'B'>]
+```
+
+### Sort by column name desc
+```ruby
+>> User.assort('-first_name')
+=> [#<User first_name: 'C'>, #<User first_name: 'B'>, #<User first_name: 'A'>]
+```
+
+### Sort by joined column name
+```ruby
+>> Booking.assort('-user.first_name')
+```
+
+### Sort by joined column name when associations name is custom
+```ruby
+>> Request.assort('-user.first_name', user: :renter)
+```
+
+### Sort by multiple params
+```ruby
+>> Booking.assort('-user.first_name,slot_places')
+```
+
+### You can use it from rails controller to handle json api compliant sort requests
+```ruby
+class UsersController < ApplicationController
+  def index
+    @users = User.assort(order_param)
+  end
+
+  private
+
+  def order_param
+    params[:order]
+  end
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_orderable'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install easy_orderable
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,25 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EasyOrderable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/lib/easy_orderable/assorter.rb

@@ -0,0 +1,28 @@
+module EasyOrderable
+  class Assorter
+    def initialize(relation, args, custom_association_names)
+      @relation = relation
+      @args = args
+      @custom_association_names = custom_association_names
+    end
+
+    def call
+      joined_relation.order(*order_args)
+    end
+
+    private
+
+    attr_reader :relation, :args, :custom_association_names
+
+    def joined_relation
+      Joiner.new(relation, args, custom_association_names).call
+    end
+
+    def order_args
+      OrderArgumentsTransformer.new(args).call
+    end
+  end
+end
+
+require 'easy_orderable/joiner'
+require 'easy_orderable/order_arguments_transformer'

data/lib/easy_orderable/base.rb

@@ -0,0 +1,17 @@
+module EasyOrderable
+  module Base
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def assort(arg, custom_association_names=nil)
+        return all unless arg
+
+        parsed_args = Parser.new(arg.delete(' ')).call
+        Assorter.new(self, parsed_args, custom_association_names).call
+      end
+    end
+  end
+end
+
+require 'easy_orderable/assorter'
+require 'easy_orderable/parser'

data/lib/easy_orderable/engine.rb

@@ -0,0 +1,17 @@
+require 'easy_orderable/base'
+module EasyOrderable
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec
+      g.factory_bot dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+    initializer 'easy_orderable.insert_assort_into_active_record' do |_app|
+      ActiveSupport.on_load :active_record do
+        include EasyOrderable::Base
+      end
+    end
+  end
+end

data/lib/easy_orderable/joiner.rb

@@ -0,0 +1,34 @@
+module EasyOrderable
+  class Joiner
+    def initialize(relation, args, custom_association_names)
+      @relation = relation
+      @args = args
+      @custom_association_names = custom_association_names
+    end
+
+    def call
+      association_names.present? ? relation.joins(*association_names) : relation
+    end
+
+    private
+
+    attr_reader :relation, :args, :custom_association_names
+
+    def association_names
+      table_names.map do |name|
+        if custom_association_names && custom_association_names.keys.include?(name.to_sym)
+          custom_association_names[name.to_sym].to_sym
+        else
+          name.to_sym
+        end
+      end
+    end
+
+    def table_names
+      args
+        .keys
+        .select{ |e| e.include?('.') }
+        .map { |e| e.split('.').first }
+    end
+  end
+end

data/lib/easy_orderable/order_arguments_transformer.rb

@@ -0,0 +1,22 @@
+module EasyOrderable
+  class OrderArgumentsTransformer
+    def initialize(args)
+      @args = args
+    end
+
+    def call
+      args.to_a.map do |e|
+        if e.first.include?('.')
+          table_name, column_name = e.first.split('.')
+          "#{table_name.pluralize}.#{column_name} #{e.second}"
+        else
+          "#{e.first} #{e.second}"
+        end
+      end
+    end
+
+    private
+
+    attr_reader :args
+  end
+end

data/lib/easy_orderable/parser.rb

@@ -0,0 +1,23 @@
+module EasyOrderable
+  class Parser
+    def initialize(arg)
+      @arg = arg
+    end
+
+    def call
+      elems = arg.split(',')
+
+      elems.each_with_object({}) do |e, memo|
+        if e.start_with?('-')
+          memo[e[1..-1]] = :desc
+        else
+          memo[e] = :asc
+        end
+      end
+    end
+
+    private
+
+    attr_reader :arg
+  end
+end

data/lib/easy_orderable/version.rb

@@ -0,0 +1,3 @@
+module EasyOrderable
+  VERSION = '0.1.0'
+end

data/lib/easy_orderable.rb

@@ -0,0 +1,5 @@
+require "easy_orderable/engine"
+require "easy_orderable/base"
+
+module EasyOrderable
+end

data/lib/tasks/orderable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :orderable do
+#   # Task goes here
+# end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/models/booking.rb

@@ -0,0 +1,3 @@
+class Booking < ApplicationRecord
+  belongs_to :user
+end

data/spec/dummy/app/models/request.rb

@@ -0,0 +1,3 @@
+class Request < ApplicationRecord
+  belongs_to :renter, class_name: 'User', foreign_key: :user_id
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,4 @@
+class User < ApplicationRecord
+  has_many :bookings
+  has_many :requests
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path('..', __dir__)
+Dir.chdir(APP_ROOT) do
+  begin
+    exec "yarnpkg", *ARGV
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,30 @@
+require_relative 'boot'
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "easy_orderable"
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.2
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!