SassySort 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+* `0.0.1`: initial commit

data/README.md

@@ -0,0 +1,47 @@
+Sass sort
+=========
+
+Here are a couple of ways to sort values (including strings) in Sass (~> 3.3).
+
+**Disclaimer!** While it can be useful to sort numbers in Sass in case of the making of a modular scale or something, it is rarely the case for strings. The main idea behind this repository is to push Sass' syntax to its limit. Long story short: *because we can*.
+
+## Available algorithms
+
+* [Comb sort](http://en.wikipedia.org/wiki/Comb_sort)
+* [Quick sort](http://en.wikipedia.org/wiki/Quicksort)
+* [Shell sort](http://en.wikipedia.org/wiki/Shellsort)
+* [Bubble sort](http://en.wikipedia.org/wiki/Bubble_sort)
+* [Selection sort](http://en.wikipedia.org/wiki/Selection_sort)
+* [Insertion sort](http://en.wikipedia.org/wiki/Insertion_sort)
+
+## Benchmark
+
+### 50 items long list
+* quick     -> 0.238s / 0.226s / 0.202s / 0.206s / 0.226s => **0.2195s**
+* comb      -> 0.350s / 0.323s / 0.330s / 0.324s / 0.328s => **0.3310s**
+* shell     -> 0.412s / 0.355s / 0.359s / 0.372s / 0.437s => **0.3869s**
+* insertion -> 0.400s / 0.42s  / 0.406s / 0.399s / 0.468s => **0.4185s**
+* selection -> 0.635s / 0.579s / 0.580s / 0.601s / 0.611s => **0.6012s**
+* bubble    -> 0.976s / 0.830s / 0.802s / 0.824s / 0.936s => **0.8736s**
+
+### 100 items long list
+* quick     -> 0.592s / 0.547s / 0.569s / 0.541s / 0.548s => **0.5594s**
+* comb      -> 0.946s / 0.903s / 0.897s / 0.902s / 0.905s => **0.9106s**
+* shell     -> 1.413s / 1.435s / 1.425s / 1.489s / 1.408s => **1.4340s**
+* insertion -> 1.744s / 1.625s / 1.583s / 1.572s / 1.608s => **1.6263s**
+* selection -> 2.605s / 2.462s / 2.502s / 2.490s / 2.477s => **2.5072s**
+* bubble    -> 3.828s / 3.699s / 3.704s / 3.672s / 3.743s => **3.7292s**
+
+`quicksort` is well named since it is by far the fastest algorithm: about 3 times faster than `shellsort` and `insertionsort` implementations, 4 times faster than `selectionsort` and 7 times faster than `bubblesort`.
+
+## Install as a Compass extension
+
+1. `gem install SassySort`
+2. Add `require 'SassySort'` to your `config.rb`
+3. Import it in your stylesheets with `@import 'SassySort'`
+
+## Credits
+
+Thanks to [mgechev](https://github.com/mgechev) for [his work on sorting algorithms](https://github.com/mgechev/javascript-algorithms/tree/master/src/sorting) in JavaScript which has been a great help for implementing sorting algorithms in Sass.
+
+More informations about sorting algorithms at [http://www.sorting-algorithms.com/](http://www.sorting-algorithms.com/).

data/lib/SassySort.rb

@@ -0,0 +1,15 @@
+require 'compass'
+
+extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Compass::Frameworks.register('SassySort', :path => extension_path)
+
+#  Version is a number. If a version contains alphas, it will be created as a prerelease version
+#  Date is in the form of YYYY-MM-DD
+module SassySort
+  VERSION = "0.0.1"
+  DATE = "2014-02-19"
+end
+
+module Sass::Script::Functions
+
+end

data/stylesheets/_SassySort.scss

@@ -0,0 +1,17 @@
+// Order to deal with
+@import "settings/order";
+
+// Helpers
+@import "helpers/str-compare";
+@import "helpers/swap";
+
+// Sorting algorithms
+@import "algorithms/comb-sort";
+@import "algorithms/quick-sort";
+@import "algorithms/shell-sort";
+@import "algorithms/bubble-sort";
+@import "algorithms/selection-sort";
+@import "algorithms/insertion-sort";
+
+// Sort function
+@import "helpers/sort";

data/stylesheets/algorithms/_bubble-sort.scss

@@ -0,0 +1,11 @@
+@function bubble-sort($list, $order: $default-order) {
+  @for $i from 1 through length($list) {
+    @for $j from $i * -1 through -1 {
+      $j: abs($j);
+      @if $j > 1 and _str-compare(nth($list, $j), nth($list, $j - 1), $order) {
+        $list: _swap($list, $j, $j - 1);
+      }
+    }
+  }
+  @return $list;
+}

data/stylesheets/algorithms/_comb-sort.scss

@@ -0,0 +1,21 @@
+@function comb-sort($list, $order: $default-order) {
+  $gap: length($list);
+  $shrink: 1.3;
+  $swapped: false;
+
+  @while $gap != 1 or $swapped != false {
+    $gap: floor($gap / $shrink);
+    @if $gap < 1 { $gap: 1 }
+    $i: 1;
+    $swapped: false;
+    @while $i + $gap <= length($list) {
+      @if not _str-compare(nth($list, $i), nth($list, $i + $gap), $order) {
+        $list: _swap($list, $i, $i + $gap);
+        $swapped: true;
+      }
+      $i: $i + 1;
+    }
+  }
+
+  @return $list;
+}

data/stylesheets/algorithms/_insertion-sort.scss

@@ -0,0 +1,12 @@
+@function insertion-sort($list, $order: $default-order) {
+  @for $i from 1 through length($list) {
+    $current: nth($list, $i);
+    $j: $i - 1;
+    @while $j > 0 and not _str-compare(nth($list, $j), $current, $order) {
+      $list: set-nth($list, $j + 1, nth($list, $j));
+      $j: $j - 1;
+    }
+    $list: set-nth($list, $j + 1, $current);
+  }
+  @return $list;
+}

data/stylesheets/algorithms/_quick-sort.scss

@@ -0,0 +1,21 @@
+@function quick-sort($list, $order: $default-order) {
+  $less:  ();
+  $equal: ();
+  $large: ();
+  @if length($list) > 1 {
+    $seed: nth($list, ceil(length($list) / 2));
+    @each $item in $list {
+      @if $item == $seed {
+        $equal: append($equal, $item, list-separator($list));
+      }
+      @else if _str-compare($item, $seed, $order) {
+        $less: append($less, $item, list-separator($list));
+      }
+      @else if not _str-compare($item, $seed, $order) {
+        $large: append($large, $item, list-separator($list));
+      }
+    }
+    @return join(join(quick-sort($less, $order), $equal), quick-sort($large, $order));
+  }
+  @return $list;
+}

data/stylesheets/algorithms/_selection-sort.scss

@@ -0,0 +1,14 @@
+@function selection-sort($list, $order: $default-order) {
+  @for $i from 1 through length($list) {
+    $idx: $i;
+    $min: nth($list, $i);
+    @for $j from $i + 1 through length($list) {
+      @if not _str-compare($min, nth($list, $j), $order) {
+        $min: nth($list, $j);
+        $idx: $j;
+      }
+    }
+    $list: _swap($list, $i, $idx);
+  }
+  @return $list;
+}

data/stylesheets/algorithms/_shell-sort.scss

@@ -0,0 +1,18 @@
+@function shell-sort($list, $order: $default-order) {
+  $gaps: 701, 301, 132, 57, 23, 10, 4, 1;
+  @for $k from 1 through length($gaps) {
+    $gap: nth($gaps, $k);
+    $i: $gap;
+    @while $i <= length($list) {
+      $current: nth($list, $i);
+      $j: $i;
+      @while $j >= $gap and $j - $gap > 0 and not _str-compare(nth($list, $j - $gap), $current, $order) {
+        $list: set-nth($list, $j, nth($list, $j - $gap));
+        $j: $j - $gap;
+      }
+      $list: set-nth($list, $j, $current);
+      $i: $i + $gap;
+    }
+  }
+  @return $list;
+}

data/stylesheets/helpers/_sort.scss

@@ -0,0 +1,12 @@
+// Sort function
+// Delaying to an algorithm-specific function
+// depending on the algorithm specified
+//
+// @param $list: list to sort
+// @param $order: order to deal with
+// @param $algorithm: algorithm to use
+//
+// @return [list]: sorted list
+@function sort($list, $order: $default-order, $algorithm: "quick") {
+  @return call("#{$algorithm}-sort", $list, $order);
+}

data/stylesheets/helpers/_str-compare.scss

@@ -0,0 +1,22 @@
+// Compares two string to determine which comes first
+//
+// @param $a: first string
+// @parem $b: second string
+// @param $order: order to deal with
+//
+// @return $boolean
+@function _str-compare($a, $b, $order) {
+  @if type-of($a) == number and type-of($b) == number {
+    @return $a < $b;
+  }
+  $a: to-lower-case($a + unquote(""));
+  $b: to-lower-case($b + unquote(""));
+  @for $i from 1 through min(str-length($a), str-length($b)) {
+    $char-a: str-slice($a, $i, $i);
+    $char-b: str-slice($b, $i, $i);
+    @if $char-a and $char-b and index($order, $char-a) != index($order, $char-b) {
+      @return index($order, $char-a) < index($order, $char-b);
+    }
+  }
+  @return str-length($a) < str-length($b);
+}

data/stylesheets/helpers/_swap.scss

@@ -0,0 +1,16 @@
+// Swaps values at indexes $a and $b from $list
+//
+// @param $list: list to update
+// @param $a: index of first element
+// @param $b: index of second element
+//
+// @return list
+@function _swap($list, $a, $b) {
+  @if abs($a) > length($list) or abs($b) > length($list) {
+    @return $list;
+  }
+  $tmp: nth($list, $a);
+  $list: set-nth($list, $a, nth($list, $b));
+  $list: set-nth($list, $b, $tmp);
+  @return $list;
+}

data/stylesheets/settings/_order.scss

@@ -0,0 +1,4 @@
+$default-order:
+	"!" "#" "$" "%" "&" "'" "(" ")" "*" "+" "," "-" "." "/" "[" "\\" "]" "^" "_" "{" "|" "}" "~"
+	"0" "1" "2" "3" "4" "5" "6" "7" "8" "9"
+	"a" "b" "c" "d" "e" "f" "g" "h" "i" "j" "k" "l" "m" "n" "o" "p" "q" "r" "s" "t" "u" "v" "w" "x" "y" "z" !default;

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: SassySort
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Hugo Giraudel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-19 00:00:00.000000000 Z
+dependencies: []
+description: Sass sorting function
+email:
+- hugo.giraudel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- CHANGELOG.md
+- lib/SassySort.rb
+- stylesheets/algorithms/_bubble-sort.scss
+- stylesheets/algorithms/_comb-sort.scss
+- stylesheets/algorithms/_insertion-sort.scss
+- stylesheets/algorithms/_quick-sort.scss
+- stylesheets/algorithms/_selection-sort.scss
+- stylesheets/algorithms/_shell-sort.scss
+- stylesheets/helpers/_sort.scss
+- stylesheets/helpers/_str-compare.scss
+- stylesheets/helpers/_swap.scss
+- stylesheets/settings/_order.scss
+- stylesheets/_SassySort.scss
+homepage: https://github.com/HugoGiraudel/SassySort/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: SassySort
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A collection of famous sorting algorithms implemented in Sass for Sass.
+test_files: []