seek 0.0.2 → 0.1.0

data/README.md

@@ -13,20 +13,20 @@ gem install seek
 # Examples
 
 ```ruby
-params = { page: '4', sort_order: 'desc', per_page: '1000' }
+params = { page: '4', sort_direction: 'desc', per_page: '1000' }
 
 seek = Seek.new params,
        valid_sort_bys: %w{ first_name, last_name, age },
        max_per_page: 50,
        default_per_page: 10,
        default_sort_by: :age,
-       default_sort_order: :asc
+       default_sort_direction: :asc
 
-seek.page       #=> 4
-seek.per_page   #=> 50
-seek.sort_by    #=> 'age'
-seek.sort_order #=> 'desc
-seek.order      #=> 'age desc'
+seek.page           #=> 4
+seek.per_page       #=> 50
+seek.sort_by        #=> 'age'
+seek.sort_direction #=> 'desc
+seek.order          #=> 'age desc'
 
 seek.to_hash    #=> Returns a Hash with all the parameters listed above.
 ```

data/lib/seek.rb

@@ -16,12 +16,12 @@ class Seek
     self.page         = params[:page]
     self.per_page     = params[:per_page]
     self.sort_by      = params[:sort_by]
-    self.sort_order   = params[:sort_order]
+    self.sort_direction   = params[:sort_direction]
     self.max_per_page       = options[:max_per_page]
     self.valid_sort_bys     = options[:valid_sort_bys]
     self.default_per_page   = options[:default_per_page]
     self.default_sort_by    = options[:default_sort_by]
-    self.default_sort_order = options[:default_sort_order]
+    self.default_sort_direction = options[:default_sort_direction]
   end
 
   def to_hash
@@ -29,7 +29,7 @@ class Seek
       page: page,
       per_page: per_page,
       sort_by: sort_by,
-      sort_order: sort_order,
+      sort_direction: sort_direction,
       order: order,
     }
   end

data/lib/seek/sorting.rb

@@ -1,9 +1,9 @@
 class Seek
   module Sorting
 
-    attr_writer :sort_by, :sort_order, :valid_sort_bys, :default_sort_by, :default_sort_order
+    attr_writer :sort_by, :sort_direction, :valid_sort_bys, :default_sort_by, :default_sort_direction
 
-    # Returns true if sort_by and sort_order are present.
+    # Returns true if sort_by and sort_direction are present.
     #
     def sortable?
       !!order
@@ -17,9 +17,9 @@ class Seek
       default_sort_by
     end
 
-    def sort_order
-      result = @sort_order.to_s.downcase
-      valid_sort_orders.include?(result) ? result : valid_sort_orders.first
+    def sort_direction
+      result = @sort_direction.to_s.downcase
+      valid_sort_directions.include?(result) ? result : valid_sort_directions.first
     end
 
     # Useful for queries that require the format "first_name desc" (such as SQL or lucene)
@@ -28,7 +28,7 @@ class Seek
     #
     def order
       return if sort_by.to_s.empty?
-      [sort_by, sort_order].join(' ')
+      [sort_by, sort_direction].join(' ')
     end
 
     def valid_sort_bys
@@ -42,14 +42,14 @@ class Seek
       valid_sort_bys.include?(result) ? result : valid_sort_bys.first
     end
 
-    def default_sort_order
-      result = @default_sort_order.to_s.downcase
-      valid_sort_orders.include?(result) ? result : valid_sort_orders.first
+    def default_sort_direction
+      result = @default_sort_direction.to_s.downcase
+      valid_sort_directions.include?(result) ? result : valid_sort_directions.first
     end
 
     private
 
-    def valid_sort_orders
+    def valid_sort_directions
       %w{ asc desc }
     end
 

data/lib/seek/version.rb

@@ -1,8 +1,8 @@
 class Seek
   module VERSION
     MAJOR = 0
-    MINOR = 0
-    TINY  = 2
+    MINOR = 1
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/lib/seek_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Seek do
 
-  let(:params)  { { page: 4, per_page: 20, 'sort_by' => :first_name, sort_order: 'DESC' } }
+  let(:params)  { { page: 4, per_page: 20, 'sort_by' => :first_name, sort_direction: 'DESC' } }
   let(:options) { { 'max_per_page' => 30, valid_sort_bys: %w{ age first_name last_name } } }
 
   let(:seek)    { Seek.new params, options }
@@ -76,23 +76,23 @@ describe Seek do
       end
     end
 
-    describe '#sort_order' do
+    describe '#sort_direction' do
       it 'comes from the params and is a String' do
-        seek.sort_order.should == 'desc'
+        seek.sort_direction.should == 'desc'
       end
 
       it 'is ascending if nothing is specified' do
-        Seek.new.sort_order.should == 'asc'
+        Seek.new.sort_direction.should == 'asc'
       end
 
       it 'is ascending if something invalid is specified' do
-        Seek.new(sort_order: 'vertically').sort_order.should == 'asc'
+        Seek.new(sort_direction: 'vertically').sort_direction.should == 'asc'
       end
     end
   end
 
   describe '#order' do
-    it 'is sort_by and sort_order separated by a space' do
+    it 'is sort_by and sort_direction separated by a space' do
       seek.order.should == 'first_name desc'
     end
 
@@ -102,7 +102,7 @@ describe Seek do
   end
 
   describe '#sortable?' do
-    it 'is true if there is sort_by and sort_order' do
+    it 'is true if there is sort_by and sort_direction' do
       seek.should be_sortable
     end
 
@@ -113,7 +113,7 @@ describe Seek do
 
   describe '#to_hash' do
     it 'contains all params' do
-      seek.to_hash.should == { page: 4, per_page: 20, sort_by: 'first_name', sort_order: 'desc', order: 'first_name desc' }
+      seek.to_hash.should == { page: 4, per_page: 20, sort_by: 'first_name', sort_direction: 'desc', order: 'first_name desc' }
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seek
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors: