arrangeable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e443aea681f9bb38807114868f0080e82401bf93b7714f267bb17f772391eac2
+  data.tar.gz: ca4fc95848b7c227ac5a4c03d8018b6ccc1b81f05bcf47aba1426e75b3482e19
+SHA512:
+  metadata.gz: 3fdfd1ab819a50f249a08fef218323f7fbffe2947b08d33dd8ea91d0e4273b22a5c386186b3e6f5340e15ae4a46f5ad3dae2c1f7a2fb6c22008e7abfaaf90f9d
+  data.tar.gz: 7d7a989c3eaf26b21d3f75f611713aac9a5c6ff6ae2cdbd61e7483721a3e10821667d5d303bdb97f4de9c8119a51068c88697bf9ac27e9c4dda313335604cd79

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in arrangeable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    arrangeable (0.1.0)
+      activesupport (~> 4.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.11.1)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arrangeable!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Umar Al-Kfaween
+
+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,61 @@
+# Arrangeable
+
+Arrangeable provides an organized and seamless way to sort your model objects by different attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arrangeable', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arrangeable
+
+## Usage
+
+Include Arrangeable inside ApplicationRecord or directly inside your model and override the `arrangeable_fields` method for each model to whitelist the fields you want to use for sorting:
+
+```ruby
+class User < ApplicationRecord
+  include Arrangeable
+
+  concerning :Arranging do
+    class_methods do
+      def arrangeable_fields
+        %w[id first_name last_name]
+      end
+    end
+  end
+end
+```
+
+Failing to override `arrangeable_fields` will raise a `NotImplementedError`.
+
+Now sort your model objects by calling `arrange` on a comma-separated order string. Prepend a negative sign `-` before a key to order by that key descendingly:
+
+```ruby
+
+@users = User.all
+
+order_string = 'first_name,-id'
+@users = @users.arrange(order_string)
+```
+
+The previous example will generate the following SQL order clause: `ORDER BY first_name ASC, id DESC`.
+
+Note that `id` can always be used for sorting regardless of whether you whitelist it or not. Any non whitelisted sorting keys will be ignored.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/umar221b/arrangeable.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/arrangeable.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "arrangeable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "arrangeable"
+  spec.version       = Arrangeable::VERSION
+  spec.authors       = ["Umar Al-Kfaween"]
+  spec.email         = ["omar.ka923@gmail.com"]
+
+  spec.summary       = %q{Arrangeable provides an organized and seamless way to sort your model objects by different attributes }
+  spec.description   = %q{Arrangeable provides an organized and seamless way to sort your model objects by different attributes }
+  spec.homepage      = "https://github.com/umar221b/arrangeable"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/umar221b/arrangeable"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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('..', __FILE__)) 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 "activesupport", ">= 4.2.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "arrangeable"
+
+# 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/arrangeable.rb

@@ -0,0 +1,37 @@
+require "arrangeable/version"
+require "active_support/concern"
+
+module Arrangeable
+  # class Error < StandardError; end
+
+  extend ActiveSupport::Concern
+  included {}
+
+  class_methods do
+    def arrange(order_param)
+      order_by_clause = order_string(order_param)
+      order(order_by_clause)
+    end
+
+    # array of strings of fields that support being sorted by
+    def arrangeable_fields
+      raise NotImplementedError, 'You need to overwrite this method in the calling class'
+    end
+
+    private
+
+    def order_string(sort_string)
+      keys = sort_string.gsub(' ', '').split(',').uniq.reject(&:blank?)
+      keys << 'id' unless keys.include?('id') || keys.include?('-id')
+      keys.map do |key|
+        order = ' ASC'
+        if key[0] == '-'
+          order = ' DESC'
+          key = key[1..-1]
+        end
+        next unless arrangeable_fields.include?(key)
+        key + order
+      end.compact.join(', ')
+    end
+  end
+end

data/lib/arrangeable/version.rb

@@ -0,0 +1,3 @@
+module Arrangeable
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: arrangeable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Umar Al-Kfaween
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Arrangeable provides an organized and seamless way to sort your model
+  objects by different attributes '
+email:
+- omar.ka923@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- arrangeable.gemspec
+- bin/console
+- bin/setup
+- lib/arrangeable.rb
+- lib/arrangeable/version.rb
+homepage: https://github.com/umar221b/arrangeable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/umar221b/arrangeable
+  source_code_uri: https://github.com/umar221b/arrangeable
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Arrangeable provides an organized and seamless way to sort your model objects
+  by different attributes
+test_files: []