order_order 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 385eef577f3ac59c140a2acc2cc2dc87e02e6d23
-  data.tar.gz: 72a973ad20e5bf28f3047d72181ec6299ee20298
+  metadata.gz: 023a7eab91c2213d2dd45cc9af4243812b6bbbb3
+  data.tar.gz: 9a5efb7ad508841777b3524dff0b58ec53bee98d
 SHA512:
-  metadata.gz: ae6708c35065f7c31cab2539b466bab454a5da9ad5eef6ef80656029f4d180d844aed1a5be1c314cbf8bc44acd89400f2a023963eaafa511c50f12724111cc98
-  data.tar.gz: c862b50aeb63a06355e393b01752d0a51226ff4528ccd7ba8e1861d4b1796e1977b89d030ad3e3ed53bcecac24a5190de0ef5aa4e347e9f614a61ba9a23362ff
+  metadata.gz: 9ff10890ef74e884be12bbeb77d0dfc62c49a52ba8e3667e2dbc307b2cc4b4e541861930ae60a7b5cb91b6836e49abc5f99734c6db9d64837f100c619f6bb92c
+  data.tar.gz: d05497e3a5c8b37b22fa514fec8176aa6e7971e2d17613a086d747aa7e2a219c4a91aec53bbfcf8c7004736e1df1de1fca41f0c1b1116f91425a333856da3af5

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+Changelog
+=========
+
+## 1.2.0
+
+- Added `case_sensitive` option to `.alphabetical` or `.reverse_alphabetical`.
+
+## 1.1.0
+
+- Added `.since`

data/README.md

@@ -46,6 +46,25 @@ There is also a finder method called `since`:
     new_users.include?(user_1) # => true
     new_users.include?(user_2) # => true
 
+`.alphabetical` and `.reverse_alphabetical` take an optional parameter 'case_sensitive'
+(true by default):
+
+    person_1 = Person.create(name: "Steve")
+    person_2 = Person.create(name: "Bill")
+    person_3 = Person.create(name: "dave")
+
+    puts Post.alphabetical.pluck(:name)
+    # => Bill
+    # => Steve
+    # => dave
+    puts Post.alphabetical.pluck(:name, case_sensitive: false)
+    # => Bill
+    # => dave
+    # => Steve
+
+Note that `case_sensitive` has only been tested on PostgreSQL. Feel free to add
+it for one of the other SQL adapters if you need it.
+
     
 ## Contributing
 

data/lib/order_order/extensions.rb

@@ -5,11 +5,14 @@
 module OrderOrder
   module Extensions
 
+    DEFAULT_ALPHABETICAL_COLUMN  = :name
+    DEFAULT_CHRONOLOGICAL_COLUMN = :created_at
+
     # Order records by date, with the newest records first.
     #
     # @param column [String] the name of the column which represents the object's
     # date. Defaults to `created_at`
-    def chronological(column=:created_at)
+    def chronological(column=DEFAULT_CHRONOLOGICAL_COLUMN)
       order("#{column} ASC")
     end
 
@@ -17,23 +20,31 @@ module OrderOrder
     #
     # @param column [String] the name of the column which represents the object's
     # date. Defaults to `created_at`
-    def reverse_chronological(column=:created_at)
+    def reverse_chronological(column=DEFAULT_CHRONOLOGICAL_COLUMN)
       order("#{column} DESC")
     end
 
     # Order records alphabetically.
     #
-    # @param column [String] the name of the column which represents the object's
-    #   name. Defaults to `name`
-    def alphabetical(column=:name)
+    # @param column_or_options [String] the name of the column which represents the object's
+    #   name, or a hash of options. Defaults to `"name"`.
+    #
+    # @option case_sensitive [Boolean] order case-sensitively, e.g. "C" will go
+    #   before "b". True by default
+    def alphabetical(column_or_options=DEFAULT_ALPHABETICAL_COLUMN, options={})
+      column = get_alphabetical_column(column_or_options, options)
       order("#{column} ASC")
     end
 
-    # Order records reverse alphabetically.
+    # Order records alphabetically.
     #
-    # @param column [String] the name of the column which represents the object's
-    #   name. Defaults to `name`
-    def reverse_alphabetical(column=:name)
+    # @param column_or_options [String] the name of the column which represents the object's
+    #   name, or a hash of options. Defaults to `"name"`.
+    #
+    # @option case_sensitive [Boolean] order case-sensitively, e.g. "C" will go
+    #   after "b". True by default
+    def reverse_alphabetical(column_or_options=DEFAULT_ALPHABETICAL_COLUMN, options={})
+      column = get_alphabetical_column(column_or_options, options)
       order("#{column} DESC")
     end
 
@@ -49,6 +60,21 @@ module OrderOrder
     def since(time)
       where("created_at > ?", time)
     end
+
+
+    private
+
+    def get_alphabetical_column(column_or_options, options)
+      if column_or_options.is_a?(Hash)
+        options = column_or_options
+        column  = DEFAULT_ALPHABETICAL_COLUMN
+      else
+        column  = column_or_options
+      end
+
+      column = "lower(#{column})" if !options.fetch(:case_sensitive, true)
+      column
+    end
   end
 end
 

data/lib/order_order/version.rb

@@ -1,3 +1,3 @@
 module OrderOrder
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: order_order
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - George Millo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md