deepsort 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmE0NTViYTFjZWQ4NmRhMDJmZDhhZTMzYzQ0MzhlMzYwNzAyNjM3Mg==
+  data.tar.gz: !binary |-
+    MjhjZGUwM2EwM2QzNjcwYTdhMzhjZDMxNWM0YTMyYzk2OWQ4NDY3Mg==
+SHA512:
+  metadata.gz: !binary |-
+    YWFlMmY1NjcwMjEwYjNiYmQ0YTYxMWJhMDgwYTAzZjY1MGExNzE1ZDU0Mzhj
+    ZjYzODgwOGUzNTFkZGFmYzUxMzlkNjU5M2FjOWZiNTA0MGE2ZDFjZmNmZWY1
+    YzA5NzUyZTcwZTUxODEwZTMyMzYyOTk4Yjg1MTBjNmIzYzBhOWI=
+  data.tar.gz: !binary |-
+    YTZjM2QwN2QyOTI5ZmIwMzZmY2M3ZWJkNzZjZTFlOTQyOGFiODgwNmVjZjg4
+    MjQzMzM5MmJiMzUwYTJlZTAyN2E5YWI0ODI3YTJmOGNkNjUyMWUxNDA5MThm
+    N2Y1ZmJlODRlYjRjMmYzYzk3M2M4NTE4ZTYzYWQ2Mjc0ZGVjNmU=

data/lib/deepsort.rb

@@ -0,0 +1,131 @@
+### Deep Sort Utility
+## Over View
+# when included into a project, this utility gives Arrays and Hashes the ability to deep sort themselves
+# instead of shallow sorts, deep_sort recursively attempts to sort every element of arrays and hashes
+## Usage
+# {2=>4, 1=>[3, 2]}.deep_sort
+#   returns: {1=>[2, 3], 2=>4}
+# [{2=>3}, 1].deep_sort
+#   returns an error because a Fixnum (1) cannot be compared with a Hash ({2=>3})
+# [{2=>3}, 1].deep_sort_by {|obj| obj.to_s}
+#   returns: [1, {2=>3}] # this avoids the error by using string comparison
+# foo = [2, 1]; foo.deep_sort!
+#   returns: [1, 2] # in addition foo has now been sorted in place
+
+
+module DeepSort
+  # inject this method into the Array class to add deep sort functionality to Arrays
+  module DeepSortArray
+    def deep_sort
+      deep_sort_by { |obj| obj }
+    end
+
+    def deep_sort!
+      deep_sort_by! { |obj| obj }
+    end
+
+    def deep_sort_by(&block)
+      self.map do |value|
+        if value.respond_to? :deep_sort_by
+          value.deep_sort_by &block
+        elsif value.respond_to? :sort_by
+          value.sort_by &block
+        else
+          value
+        end
+      end.sort_by &block
+    end
+
+    def deep_sort_by!(&block)
+      self.map! do |value|
+        if value.respond_to? :deep_sort_by!
+          value.deep_sort_by! &block
+        elsif value.respond_to? :sort_by!
+          value.sort_by! &block
+        else
+          value
+        end
+      end.sort_by! &block
+    end
+  end
+
+  # inject this method into the Hash class to add deep sort functionality to Hashes
+  # Note: this cannot sort a hashes keys in place (deep_sort!), only the values
+  module DeepSortHash
+    def deep_sort
+      deep_sort_by { |obj| obj }
+    end
+
+    def deep_sort!
+      deep_sort_by! { |obj| obj }
+    end
+
+    def deep_sort_by(&block)
+      Hash[self.map do |key, value|
+        [if key.respond_to? :deep_sort_by
+          key.deep_sort_by &block
+        elsif key.respond_to? :sort_by
+          key.sort_by &block
+        else
+          key
+        end,
+
+        if value.respond_to? :deep_sort_by
+          value.deep_sort_by &block
+        elsif value.respond_to? :sort_by
+          value.sort_by &block
+        else
+          value
+        end]
+
+      end.sort_by &block]
+    end
+
+    # Ruby Hashes don't have in-place-modification like map!, each!, or sort!
+    # that means that this method won't be able to sort the hash keys in place either.
+    # since Hashes are technically non-sorted key value pairs, this shouldn't be a problem
+    def deep_sort_by!(&block)
+      Hash[self.map do |key, value|
+        if key.respond_to? :deep_sort_by!
+          key.deep_sort_by! &block
+        elsif key.respond_to? :sort_by!
+          key.sort_by! &block
+        end
+
+        if value.respond_to? :deep_sort!
+          value.deep_sort_by! &block
+        elsif value.respond_to? :sort_by!
+          value.sort_by! &block
+        end
+
+        [key, value]
+      end]
+    end
+  end
+end
+Array.send(:include, DeepSort::DeepSortArray)
+Hash.send(:include, DeepSort::DeepSortHash)
+
+
+# and if you don't like calling member methods on objects, these two functions do it for you.
+# if the object cannot be deep sorted, it will simply return the sorted object or the object itself if sorting isn't available.
+def deep_sort(obj)
+  if obj.respond_to? :deep_sort
+    obj.deep_sort
+  elsif obj.respond_to? :sort
+    obj.sort
+  else
+    obj
+  end
+end
+
+# similar to the deep_sort method, but performs the deep sort in place
+def deep_sort!(obj)
+  if obj.respond_to? :deep_sort!
+    obj.deep_sort!
+  elsif obj.respond_to? :sort!
+    obj.sort!
+  else
+    obj
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: deepsort
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Crossen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-10 00:00:00.000000000 Z
+dependencies: []
+description: deepsort recursively sorts nested ruby Arrays and Hashes.
+email: markcrossen@studentbody.byu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/deepsort.rb
+homepage: https://github.com/mcrossen/deepsort
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A utility to deep sort arrays and hashes.
+test_files: []