naturalsorter 0.0.1 → 0.1.0

data/README.markdown

@@ -1,14 +1,54 @@
 # NaturalSorter
 
+## The Mission
+
 This open source project is sorting arrays in a natural way. Assume you have an string array like this here
 
-["init30", "init20", "init200"]
+`["init30", "init20", "init200"]`
 
 If you are sorting this in ruby with ".sort" you will get this result
 
-["init20", "init200", "init30"]
+`["init20", "init200", "init30"]`
 
 Because the default sort method does not recognize the numbers in the string. The NaturalSorter will return this result. 
 
-["init20", "init30", "init200"]
+`["init20", "init30", "init200"]`
+
+## API
+
+This GEM has just 2 methods
+
+`Naturalsorter::Sorter.sort(array, caseinsesitive)`
+
+And this here for more advanced sorting
+
+`Naturalsorter::Sorter.sort_by_method(array, method, caseinsesitive)`
+
+## Installation 
+
+You should add this line to your Gemfile
+
+`gem 'naturalsorter', '0.1.0'`
+
+and run this command in your app root directory
+
+`bundle install`
+
+## How To Use - Examples
+
+After the installation you can use it like this: 
+
+`Naturalsorter::Sorter.sort(["a400", "a5", "a1"], true)`
+
+it will return the array ["a1", "a5", "a400"]. 
+
+If you have more advanced objects you want to sort, you should use the second method. Assume you have a Class User with 3 attributes: "firstname", "lastname", "age" and you want to sort an array of class Users by "firstname". 
+
+`Naturalsorter::Sorter.sort_by_method(users, "firstname", true)`
+
+that's it!
+
+## Alan Davies
+
+This project uses internal the natcmp implementation from Alan Davies. All glorry to him for his awesome work. 
 

data/lib/naturalsorter/version.rb

@@ -1,3 +1,3 @@
 module Naturalsorter
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/naturalsorter.rb

@@ -1,10 +1,33 @@
 require "naturalsorter/version"
 require "natcmp"
 
+# naturalsorter.rb
+#
+# Natural order sorting for an array of strings or more advanced objects
+#
+# This implementation is Copyright (C) 2012 by Robert Reiz
+#
+# This software is provided 'as-is', without any express or implied
+# warranty.  In no event will the authors be held liable for any damages
+# arising from the use of this software.
+#
+# Permission is granted to anyone to use this software for any purpose,
+# including commercial applications, and to alter it and redistribute it
+# freely, subject to the following restrictions:
+#
+# 1. The origin of this software must not be misrepresented; you must not
+#    claim that you wrote the original software. If you use this software
+#    in a product, an acknowledgment in the product documentation would be
+#    appreciated but is not required.
+# 2. Altered source versions must be plainly marked as such, and must not be
+#    misrepresented as being the original software.
+# 3. This notice may not be removed or altered from any source distribution.
+
 module Naturalsorter
   
   class Sorter
   
+    # 'Natural order' sort for an simple string array
     def self.sort(array, caseinsesitive)
       if (array.nil? || array.empty?)
         return nil
@@ -12,6 +35,7 @@ module Naturalsorter
       array.sort { |a,b| Natcmp.natcmp(a,b,caseinsesitive) }
     end
     
+    # 'Natural order' sort for an array of objects. 
     def self.sort_by_method(array, method, caseinsesitive)
       if (array.nil? || array.empty?)
         return nil

data/naturalsorter.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Naturalsorter::VERSION
   s.authors     = ["reiz"]
   s.email       = ["robert.reiz@gmx.com"]
-  s.homepage    = "http://robert-reiz.com"
+  s.homepage    = "https://github.com/reiz/naturalsorter"
   s.summary     = %q{Sorting arrays in natural order}
   s.description = %q{This GEM is sorting Arrays in a natural order. a2 < a10}
 
@@ -22,4 +22,4 @@ Gem::Specification.new do |s|
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
   s.add_development_dependency "rspec", "~> 2.6"
-end
+end

data/spec/naturalsorter_spec.rb

@@ -7,11 +7,11 @@ describe Naturalsorter::Sorter do
   end
   
   it "c400b5a1 is a1b5c400" do
-    Naturalsorter::Sorter.sort(["c400", "b5", "a1"], true).should eql(["a1", "b5", "c400"])
+    Naturalsorter::Sorter.sort(["a400", "a5", "a1"], true).should eql(["a1", "a5", "a400"])
   end
   
   it "c400b5a1 is a1b5c400" do
-    Naturalsorter::Sorter.sort_by_method(["c400", "b5", "a1"], "to_s", true).should eql(["a1", "b5", "c400"])
+    Naturalsorter::Sorter.sort_by_method(["a400", "a5", "a1"], "to_s", true).should eql(["a1", "a5", "a400"])
   end
 
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - reiz
@@ -50,7 +50,7 @@ files:
 - naturalsorter.gemspec
 - spec/naturalsorter_spec.rb
 has_rdoc: true
-homepage: http://robert-reiz.com
+homepage: https://github.com/reiz/naturalsorter
 licenses: []
 
 post_install_message: