sortable-for-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2d4bbc350e99a47d9970db6c37b5d89e47bf6a0f26fd4fccd1e8dec71757d84
+  data.tar.gz: 966cc6ebac6496a4632c886830068c7e9e30a3bead23344f94ead732e75369a1
+SHA512:
+  metadata.gz: d07d2354242f3cea174566598705962d955189f86facb9a6c0691e4b49ed3ebc65b1ca73df48ee77d6fb894cc78a9cb8e588c4dc3cb2545ddb537e7ddca44324
+  data.tar.gz: 4d9c3a6b109ba6d9b180843e73f2c24d90cb5d381ecb81ccb60cc1a0f8e3b0b11a9ca5e46742efa9e2f1b388ca8d0dd3fe1aa76c20ad02cfe1d6cb2fbbd78ba3

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at grzegorz.derebecki@fdb.pl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Grzegorz Derebecki
+
+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,64 @@
+# SortableForRails
+
+## Description
+Simple gem for sorting data in HTML tables
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sortable-for-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sortable-for-rails
+
+## Usage
+
+```
+class User < ApplicationRecord
+  include Sortable::Model
+
+  sortable :id, :updated_at, :email
+  sortable :profile_name, -> { joins(:profile) }, column: "profiles.name"
+
+end
+```
+
+In Views
+
+```
+<th><%= sortable :email, default: true %></th>
+<th><%= sortable :updated_at, direction: :desc %></th>
+<th>
+  <%= sortable :profile_name do %>
+    Custom label
+  <% end %>
+</th>
+```
+If you want customize how arrows are generated copy `views/sortable/_label.html.erb`
+and change how you want.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/madmax/sortable-for-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SortableForRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/madmax/sortable-for-rails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/app/helpers/sortable/sortable_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sortable::SortableHelper
+  def sortable(column, default: false, direction: :asc, scope: nil, **options, &block)
+    current = column.to_s == params[:sort] || params[:sort].blank? && default
+    current_direction = (params[:direction] || direction).to_s
+
+    new_direction = direction.to_s
+    if current
+      new_direction = current_direction.to_s == "asc" ? "desc" : "asc"
+    end
+
+    link_to(url_for(sort: column, direction: new_direction), options) do
+      label = block_given? ? capture(&block) : column
+      sortable_label_for(label, current, current_direction, scope)
+    end
+  end
+
+  def sortable_label_for(label, active, direction, scope)
+    render "sortable/label", label: label, active: active, direction: direction, scope: scope
+  end
+end

data/app/views/sortable/_label.html.erb

@@ -0,0 +1,13 @@
+<% if label.is_a?(Symbol) %>
+  <%= t label, scope: scope %>
+<% else %>
+  <%= label %>
+<% end %>
+
+<% if active %>
+  <% if direction == "asc" %>
+    <i class="fas fa-chevron-up"></i>
+  <% else %>
+    <i class="fas fa-chevron-down"></i>
+  <% end %>
+<% end %>

data/bin/console

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "sortable"
+
+module SortableForRails
+  class Engine < Rails::Engine
+  end
+end

data/lib/sortable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+module Sortable
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def sortable(*args)
+        @sortable ||= []
+        @sortable << args unless args.empty?
+        @sortable
+      end
+
+      def sorting(column, direction = :asc)
+        Sortable::Sort.new(self, column, direction).all
+      end
+    end
+  end
+
+  class Column
+    attr_reader :name, :column, :scope
+    def initialize(name, scope = nil, column: name)
+      @name = name
+      @column = column
+      @scope = scope
+    end
+  end
+
+  class Sort
+    attr_reader :scope
+
+    def initialize(scope, column, direction)
+      @scope = scope
+      @column = column
+      @direction = direction
+    end
+
+    def columns
+      @columns = create_columns
+    end
+
+    def all
+      all = scope.all
+
+      if column
+        all = all.merge(column.scope) if column.scope.present?
+        all = all.order("#{column.column} #{direction}")
+      end
+
+      all
+    end
+
+    def direction
+      @direction.to_s == "desc" ? "desc" : "asc"
+    end
+
+    def column
+      columns[@column.to_s]&.first
+    end
+
+    def create_columns
+      scope.sortable.flat_map do |columns|
+        columns = [columns] unless columns.all? { |column| column.is_a?(Symbol) }
+        columns.map { |column| Column.new(*column) }
+      end.group_by { |column| column.name.to_s }
+    end
+  end
+end

data/sortable-for-rails.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "sortable-for-rails"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Grzegorz Derebecki"]
+  spec.email         = ["grzegorz.derebecki@fdb.pl"]
+
+  spec.summary       = %q{Allow easy sorting tables tables in rails}
+  spec.description   = %q{Allow easy sorting tables tables in rails}
+  spec.homepage      = "https://github.com/madmax/sortable-for-rails"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/madmax/sortable-for-rails"
+  spec.metadata["changelog_uri"] = "https://github.com/madmax/sortable-for-rails"
+
+  # 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 "rails", ">= 5.2"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sortable-for-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Grzegorz Derebecki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Allow easy sorting tables tables in rails
+email:
+- grzegorz.derebecki@fdb.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/sortable/sortable_helper.rb
+- app/views/sortable/_label.html.erb
+- bin/console
+- bin/setup
+- lib/sortable-for-rails.rb
+- lib/sortable.rb
+- sortable-for-rails.gemspec
+homepage: https://github.com/madmax/sortable-for-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/madmax/sortable-for-rails
+  source_code_uri: https://github.com/madmax/sortable-for-rails
+  changelog_uri: https://github.com/madmax/sortable-for-rails
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Allow easy sorting tables tables in rails
+test_files: []