grape-order 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 947b09b0ddadd7e4f366c2d61369158bab3164d5
-  data.tar.gz: cd69fd5e22df01dcec572e6fc260bcfb1648caee
+SHA256:
+  metadata.gz: 4302de32bb2dbc9600c2c42c31165b5f442ba05add622bb79f98d296fad50824
+  data.tar.gz: e2074e44f9126df0b99cb0bb57e54ce5568c9b320e2358875f4cd8ebfa49cbe7
 SHA512:
-  metadata.gz: 4a0467d1a952f6cf1c0f814ca23e7aa816d48ef0d8afc41c25b88aadd79a7fef499b1287f08d8c090e3f20dfb25272cd52723bc39b880b7ef7308d4dc6ad638d
-  data.tar.gz: 6dc86fe32eb1bbd33bbc4431457f22a1be41dd319da1dbdad0ee52be17b20ebaae7b6491d3420e17f879d3d499fc7d2713c0c1a8750125975e30608195f8f5c0
+  metadata.gz: 1b7d5252dc4d8f68465d9b6ce7621372da10d6c38235251ce4c089985c9404f6ef0694e2a070977bb720ba9920eba2103daa28f23db785cbd11de723867183e5
+  data.tar.gz: ed0c5b8b3f978765705fe5fd92be2c53c6dd03634627ed0eaa3ef9e5c5113b49f41d8b5f7570a00e8b85e14909a5a2ee31cc392e3aaf9f6cc144c499d68b2b9b

data/.gitignore

@@ -1,3 +1,4 @@
 .idea
 Gemfile.lock
-*.gem
+*.gem
+coverage

data/README.md

@@ -1,4 +1,4 @@
-# Grape::Order [![Gem Version](https://badge.fury.io/rb/grape-order.png)]
+# Grape::Order [![Gem Version](https://badge.fury.io/rb/grape-order.png)][![Code Climate](https://codeclimate.com/github/PrositAS/grape-order/badges/gpa.svg)](https://codeclimate.com/github/PrositAS/grape-order)[![Build Status](https://semaphoreci.com/api/v1/prositas/grape-order/branches/master/badge.svg)](https://semaphoreci.com/prositas/grape-order)
 
 Collection ordering for [grape](https://github.com/intridea/grape) API framework.
 
@@ -27,12 +27,12 @@ $ gem install grape-order
 ```ruby
 class MyApi < Grape::API
   # Include Grape::Sort module in your api
-  include Grape::Sort
+  include Grape::Order
 
   resource :comments do
     desc 'Return a list of comments.'
 
-    # Annotate action with `paginate`.
+    # Annotate action with `order`.
     # This will add an optional param: order
     #
     # You can optionally set the default :order setting to the fields of your choice.
@@ -54,6 +54,7 @@ Now you can pass a string `order` param to HTTP request to your endpoint structu
 
 - prepend field name by `-` to get ascending order, like `-created_at`
 - pass multiple fields to order by separating them by comma, like `-created_at, name`
+- ordering on nested resources is also supported, eg: 'posts.created_at, -comments.created_at'
 
 ```
 curl -v http://lvh.me:3000/comments?order=-created_at
@@ -64,4 +65,4 @@ curl -v http://lvh.me:3000/comments?order=-created_at
 The gem structure was based on https://github.com/monterail/grape-kaminari 
 (which can be used for pagination).
 
-Feel free to submit issue with bug report or pull requests on GitHub at https://github.com/PrositAS/grape-order.
+Feel free to submit issue with bug report or pull requests on GitHub at https://github.com/PrositAS/grape-order.

data/grape-order.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "rspec", "~> 2.9"
 end

data/lib/grape/order.rb

@@ -1,30 +1,37 @@
-require "grape"
-require "grape/order/version"
+require 'grape'
+require 'grape/order/version'
 
 module Grape
-  module Order
-    def self.included(base)
-      base.class_eval do
-        helpers do
-          def order(collection)
-            sorters = params[:order].split(',').map do |s|
-              if s[0] == '-'
-                "#{s[1..-1]} asc"
-              else
-                "#{s} desc"
-              end
-            end
-            collection.order(sorters.join(','))
+  module Order # :nodoc:
+    extend ActiveSupport::Concern
+
+    included do
+      helpers HelperMethods
+    end
+
+    module HelperMethods # :nodoc:
+      extend Grape::API::Helpers
+
+      def order(collection)
+        sorters = params[:order].split(',').map do |s|
+          if s[0] == '-'
+            "#{s[1..-1]} asc"
+          else
+            "#{s} desc"
           end
         end
+        collection.order(sorters.join(','))
+      end
+    end
 
-        def self.order(sorter = nil)
-          params do
-            optional :order,     type: String, default: (sorter if sorter.present?),
-                     desc: 'Set sorting order.'
-          end
+    module DSLMethods # :nodoc:
+      def order(sorter = nil)
+        params do
+          optional :order, type: String, default: (sorter if sorter.present?),
+                           desc: 'Set sorting order.'
         end
       end
     end
+    Grape::API.const_defined?(:Instance) ? Grape::API::Instance.extend(DSLMethods) : Grape::API.extend(DSLMethods)
   end
-end
+end

data/lib/grape/order/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Order
-    VERSION = "0.1.1"
+    VERSION = "0.1.2".freeze
   end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,14 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simplecov'
+SimpleCov.start
 require 'rspec'
 require 'grape'
 require 'grape-order'
 require 'active_record'
 require 'rack/test'
 
+
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir['#{File.dirname(__FILE__)}/support/**/*.rb'].each {|f| require f}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-order
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Grzegorz Brzezinka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -146,8 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: collection ordering for grape