SassyBitwise 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb3b64daed2bfc06498a4da5a3dca09d27a422d0
-  data.tar.gz: 7f4e8d21885e229cda01dd981d546bda85a48e9a
+  metadata.gz: b82ee8e952de819d97e3e9d100d4023d23f2da61
+  data.tar.gz: 3ae28fe7d979975646d86bc9c0a1a12292b80a41
 SHA512:
-  metadata.gz: d1518a2072ca0c2f2ffe2eeba7847301edd746c782e888f181cf11f87bc37a5b627b79d05377102e18aa472f211842fb0cd3d997f6833f12662695f519d55fda
-  data.tar.gz: d15d5f8c4c3a56612c7fac5d7068dfa573294d65ebff9caf0ad30c88cc4b632620324c13cae8850d6786228c421e1020a920f50221bbb34a78b97b3bc2cb894a
+  metadata.gz: 7b0d9ed7bbd080f53e0602fd789772c6f98b4283d244ff19358b3cc4c6ae01cbd0bce9a3dfd7db8765c232535d6cf55e29eed9b4a1a4e796e7a52f772d5dd3a7
+  data.tar.gz: 456500ff5e3ed88fcc8d356ddcb3f4ab2d99cb651b88fbb75462352bf31dc8e96e9a4978624623ce6554b1d8af8bfa17064b44c38c867fa229b08ea9fd957d2d

data/CHANGELOG.md

@@ -1,5 +1,6 @@
-# Changelog
-
-* `1.0.1`: fixing important issue in `^`, `|` and `&`
-* `1.0.0`: stable API, gem release
-* `0.0.1`: initial commit
+# Changelog
+
+* `1.1.0`: new API accepting multiple bitwise operation simultaneously
+* `1.0.1`: fixing important issue in `^`, `|` and `&`
+* `1.0.0`: stable API, gem release
+* `0.0.1`: initial commit

data/lib/SassyBitwise.rb

@@ -1,14 +1,14 @@
-require 'compass'
-extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-Compass::Frameworks.register('SassyBitwise', :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 SassyBitwise
-  VERSION = "1.0.1"
-  DATE = "2014-06-04"
-end
-
-module Sass::Script::Functions
-
+require 'compass'
+extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Compass::Frameworks.register('SassyBitwise', :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 SassyBitwise
+  VERSION = "1.1.0"
+  DATE = "2014-06-05"
+end
+
+module Sass::Script::Functions
+
 end

data/stylesheets/SassyBitwise/api/_bitwise.scss

@@ -1,46 +1,67 @@
-// Bitwise helper function
-// ---
-// @param [list] $args: list of parameters
-// ---
-// @return [number]
-// ---
-@function bitwise($args) {
-  @if not arguments-validator($args) {
-    @return false;
-  }
-
-  // Handling not first
-  @if nth($args, 1) == "~" {
-    @return bw-not(nth($args, 2));
-  }
-
-  // Then all others
-  $operator: to-lower-case(nth($args, 2));
-  $x: nth($args, 1);
-  $y: nth($args, 3);
-
-  @if $operator == "^" {
-    @return bw-xor($x, $y);
-  }
-
-  @else if $operator == "|" {
-    @return bw-or($x, $y);
-  }
-
-  @else if $operator == "&" {
-    @return bw-and($x, $y);
-  }
-
-  @else if $operator == "<<" {
-    @return bw-shift-left($x, $y);
-  }
-
-  @else if $operator == ">>" {
-    @return bw-shift-right($x, $y);
-  }
-
-  @else {
-    @warn "Wrong operator `#{$operator}` for `bitwise` function.";
-    @return false
-  }
-}
+// Bitwise helper function
+// ---
+// @param [list] $args: list of parameters
+// ---
+// @return [number]
+// ---
+@function bitwise($args) {
+  @if not arguments-validator($args) {
+    @return false;
+  }
+
+  $result: null;
+  $operator: null;
+  $not-operator: false;
+  $operators: (
+    '&'  : 'and',
+    '|'  : 'or',
+    '^'  : 'xor',
+    '<<' : 'shift-left',
+    '>>' : 'shift-right'
+  );
+
+  // Loop through all arguments
+  @each $current in $args {
+
+    // If current argument is an operator
+    // Store it while waiting for next value
+    @if map-has-key($operators, $current) {
+      $operator: $current;
+    }
+
+    // If current argument is `not` bitwise operator
+    // Pass $not boolean to true
+    @else if $current == '~' {
+      $not-operator: true;
+    }
+
+    // If current argument is not an operator
+    @else {
+      // If $not is true
+      // Compute not first
+      @if $not-operator {
+        $current: bw-not($current);
+        $not-operator: false;
+      }
+
+      // Then the operation
+      @if $operator {
+        $result: call('bw-' + map-get($operators, $operator), $result, $current);
+        $operator: null;
+      }
+
+      @else {
+        $result: $current;
+      }
+    }
+  }
+
+  @return $result;
+}
+
+
+// Alias for `bitwise`
+// ---
+@function bw($args) {
+  @return bitwise($args);
+}

data/stylesheets/SassyBitwise/helpers/_binary-length.scss

@@ -1,9 +1,9 @@
-// Returns binary length
-// ---
-// @param [number] $value: value
-// ---
-// @return [number]
-// ---
-@function binary-length($value) {
-  @return str-length(decimal-to-binary($value) + unquote(""))
-}
+// Returns binary length
+// ---
+// @param [number] $value: value
+// ---
+// @return [number]
+// ---
+@function binary-length($value) {
+  @return str-length(decimal-to-binary($value) + unquote(""));
+}

data/stylesheets/SassyBitwise/helpers/_binary-to-decimal.scss

@@ -1,27 +1,27 @@
-// Convert from base 2 to base 10
-// ---
-// @param [number] $value: binary to convert
-// ---
-// @return [number]
-// ---
-@function binary-to-decimal($value) {
-  $value: $value + unquote('');
-  $result: if(str-slice($value, 1, 1) == "0", 0, 1);
-
-  @for $i from 2 through str-length($value) {
-    $c: str-slice($value, $i, $i);
-
-    @if not index("0" "1", $c) {
-      @warn "Not binary.";
-      @return false
-    }
-
-    $result: $result * 2;
-
-    @if $c == "1" {
-      $result: $result + 1
-    }
-  }
-
-  @return $result
-}
+// Convert from base 2 to base 10
+// ---
+// @param [number] $value: binary to convert
+// ---
+// @return [number]
+// ---
+@function binary-to-decimal($value) {
+  $value: $value + unquote('');
+  $result: if(str-slice($value, 1, 1) == "0", 0, 1);
+
+  @for $i from 2 through str-length($value) {
+    $c: str-slice($value, $i, $i);
+
+    @if not index("0" "1", $c) {
+      @warn "Not binary.";
+      @return false;
+    }
+
+    $result: $result * 2;
+
+    @if $c == "1" {
+      $result: $result + 1;
+    }
+  }
+
+  @return $result;
+}

data/stylesheets/SassyBitwise/helpers/_decimal-to-binary.scss

@@ -1,24 +1,24 @@
-// Convert from base 10 to base 2
-// ---
-// @param [number] $value: decimal to convert
-// ---
-// @return [number]
-// ---
-@function decimal-to-binary($value) {
-  $largest: largest-power-of-2($value);
-  $result: 0;
-
-  @while $largest >= 1 {
-    @if $value - $largest >= 0 {
-      $value: $value - $largest;
-      $result: $result * 10 + 1
-    }
-    @else {
-      $result: $result * 10
-    }
-
-    $largest: $largest / 2
-  }
-
-  @return $result
-}
+// Convert from base 10 to base 2
+// ---
+// @param [number] $value: decimal to convert
+// ---
+// @return [number]
+// ---
+@function decimal-to-binary($value) {
+  $largest: largest-power-of-2($value);
+  $result: 0;
+
+  @while $largest >= 1 {
+    @if $value - $largest >= 0 {
+      $value: $value - $largest;
+      $result: $result * 10 + 1;
+    }
+    @else {
+      $result: $result * 10;
+    }
+
+    $largest: $largest / 2;
+  }
+
+  @return $result;
+}

data/stylesheets/SassyBitwise/helpers/_largest-power-of-2.scss

@@ -1,16 +1,16 @@
-// Returns largest power of 2 lesser than $value
-// ---
-// @param [number] $value: value
-// ---
-// @return [number]
-// ---
-@function largest-power-of-2($value) {
-  $result: 1;
-  @while $result <= $value {
-    @if $result * 2 > $value {
-      @return $result
-    }
-    $result: $result * 2
-  }
-  @return $result
-}
+// Returns largest power of 2 lesser than $value
+// ---
+// @param [number] $value: value
+// ---
+// @return [number]
+// ---
+@function largest-power-of-2($value) {
+  $result: 1;
+  @while $result <= $value {
+    @if $result * 2 > $value {
+      @return $result;
+    }
+    $result: $result * 2;
+  }
+  @return $result;
+}

data/stylesheets/SassyBitwise/helpers/_order-args.scss

@@ -1,15 +1,15 @@
-// Order arguments decreasing
-// ---
-// @param [number] $x: first value
-// @param [number] $y: second value
-// ---
-// @return [number]
-// ---
-@function order-args($x, $y) {
-  @if $x >= $y {
-    @return $x $y;
-  }
-  @else {
-    @return $y $x;
-  }
-}
+// Order arguments decreasing
+// ---
+// @param [number] $x: first value
+// @param [number] $y: second value
+// ---
+// @return [number]
+// ---
+@function order-args($x, $y) {
+  @if $x >= $y {
+    @return $x $y;
+  }
+  @else {
+    @return $y $x;
+  }
+}

data/stylesheets/SassyBitwise/helpers/_power.scss

@@ -1,25 +1,27 @@
-// Power function
-// Using Compass if defined
-// ---
-// @param [number] $x: first value
-// @param [number] $y: second value
-// ---
-// @return [number]
-// ---
-@function power($x, $y) {
-  @if function-exists('pow') == true {
-    @return pow($x, $y)
-  }
-
-  $ret: 1;
-  @if $y >= 0 {
-      @for $i from 1 through $y {
-          $ret: $ret * $x
-      }
-  } @else {
-      @for $i from $y to 0 {
-          $ret: $ret / $x
-      }
-  }
-  @return $ret
-}
+// Power function
+// Using Compass if defined
+// ---
+// @param [number] $x: first value
+// @param [number] $y: second value
+// ---
+// @return [number]
+// ---
+@function power($x, $y) {
+  @if function-exists('pow') == true {
+    @return pow($x, $y);
+  }
+
+  $ret: 1;
+
+  @if $y > 0 {
+    @for $i from 1 through $y {
+        $ret: $ret * $x;
+    }
+  } @else {
+    @for $i from $y to 0 {
+        $ret: $ret / $x;
+    }
+  }
+
+  @return $ret;
+}

data/stylesheets/SassyBitwise/helpers/_sign.scss

@@ -1,9 +1,9 @@
-// Returns sign of $x
-// ---
-// @param [number] $x: value
-// ---
-// @return [number]
-// ---
-@function sign($x) {
-  @return if($x > 0, 1, if($x < 0, -1, 0))
-}
+// Returns sign of $x
+// ---
+// @param [number] $x: value
+// ---
+// @return [number]
+// ---
+@function sign($x) {
+  @return if($x > 0, 1, if($x < 0, -1, 0));
+}

data/stylesheets/SassyBitwise/operators/_and.scss

@@ -1,22 +1,22 @@
-// `and` bitwise operator
-// $x & $y
-// ---
-// @param [number] $x: first value
-// @param [number] $y: second value
-// ---
-// @return [number]
-// ---
-@function bw-and($x, $y) {
-  $args: order-args($x, $y);
-  $x: nth($args, 1);
-  $y: nth($args, 2);
-  $b: binary-length($x);
-  $res: 0;
-
-  @for $i from 0 through $b {
-    $h: power(2, $i);
-    $res: $res + $h * (floor($x / $h) % 2) * (floor($y / $h) % 2)
-  }
-
-  @return $res
-}
+// `and` bitwise operator
+// $x & $y
+// ---
+// @param [number] $x: first value
+// @param [number] $y: second value
+// ---
+// @return [number]
+// ---
+@function bw-and($x, $y) {
+  $args: order-args($x, $y);
+  $x: nth($args, 1);
+  $y: nth($args, 2);
+  $b: binary-length($x);
+  $res: 0;
+
+  @for $i from 0 through $b {
+    $h: power(2, $i);
+    $res: $res + $h * (floor($x / $h) % 2) * (floor($y / $h) % 2)
+  }
+
+  @return $res;
+}

data/stylesheets/SassyBitwise/operators/_not.scss

@@ -1,10 +1,10 @@
-// `not` bitwise operator
-// ~ $x
-// ---
-// @param [number] $x: value
-// ---
-// @return [number]
-// ---
-@function bw-not($x) {
-  @return ($x + sign($x)) * -1
-}
+// `not` bitwise operator
+// ~ $x
+// ---
+// @param [number] $x: value
+// ---
+// @return [number]
+// ---
+@function bw-not($x) {
+  @return ($x + sign($x)) * -1;
+}

data/stylesheets/SassyBitwise/operators/_or.scss

@@ -1,24 +1,24 @@
-// `or` bitwise operator
-// $x | $y
-// ---
-// @param [number] $x: first value
-// @param [number] $y: second value
-// ---
-// @return [number]
-// ---
-@function bw-or($x, $y) {
-  $args: order-args($x, $y);
-  $x: nth($args, 1);
-  $y: nth($args, 2);
-  $b: binary-length($x);
-  $res: 0;
-
-  @for $i from 0 through $b {
-    $h: power(2, $i);
-    $tx: floor($x / $h) % 2;
-    $ty: floor($y / $h) % 2;
-    $res: $res + $h * (($tx + $ty + $tx * $ty % 2) % 2)
-  }
-
-  @return $res
-}
+// `or` bitwise operator
+// $x | $y
+// ---
+// @param [number] $x: first value
+// @param [number] $y: second value
+// ---
+// @return [number]
+// ---
+@function bw-or($x, $y) {
+  $args: order-args($x, $y);
+  $x: nth($args, 1);
+  $y: nth($args, 2);
+  $b: binary-length($x);
+  $res: 0;
+
+  @for $i from 0 through $b {
+    $h: power(2, $i);
+    $tx: floor($x / $h) % 2;
+    $ty: floor($y / $h) % 2;
+    $res: $res + $h * (($tx + $ty + $tx * $ty % 2) % 2);
+  }
+
+  @return $res;
+}

data/stylesheets/SassyBitwise/operators/_shift-left.scss

@@ -1,11 +1,11 @@
-// `<<` bitwise operator
-// $x << $y
-// ---
-// @param [number] $x: first value
-// @param [number] $y: second value
-// ---
-// @return [number]
-// ---
-@function bw-shift-left($x, $y) {
-  @return $x * power(2, $y)
-}
+// `<<` bitwise operator
+// $x << $y
+// ---
+// @param [number] $x: first value
+// @param [number] $y: second value
+// ---
+// @return [number]
+// ---
+@function bw-shift-left($x, $y) {
+  @return $x * power(2, $y);
+}

data/stylesheets/SassyBitwise/operators/_shift-right.scss

@@ -1,11 +1,11 @@
-// `>>` bitwise operator
-// $x >> $y
-// ---
-// @param [number] $x: first value
-// @param [number] $y: second value
-// ---
-// @return [number]
-// ---
-@function bw-shift-right($x, $y) {
-  @return floor($x / power(2, $y))
-}
+// `>>` bitwise operator
+// $x >> $y
+// ---
+// @param [number] $x: first value
+// @param [number] $y: second value
+// ---
+// @return [number]
+// ---
+@function bw-shift-right($x, $y) {
+  @return floor($x / power(2, $y));
+}

data/stylesheets/SassyBitwise/operators/_xor.scss

@@ -1,22 +1,22 @@
-// `xor` bitwise operator
-// $x ^ $y
-// ---
-// @param [number] $x: first value
-// @param [number] $y: second value
-// ---
-// @return [number]
-// ---
-@function bw-xor($x, $y) {
-  $args: order-args($x, $y);
-  $x: nth($args, 1);
-  $y: nth($args, 2);
-  $b: binary-length($x);
-  $res: 0;
-
-  @for $i from 0 through $b {
-    $h: power(2, $i);
-    $res: $res + $h * (((floor($x / $h) % 2) + (floor($y / $h) % 2)) % 2)
-  }
-
-  @return $res
-}
+// `xor` bitwise operator
+// $x ^ $y
+// ---
+// @param [number] $x: first value
+// @param [number] $y: second value
+// ---
+// @return [number]
+// ---
+@function bw-xor($x, $y) {
+  $args: order-args($x, $y);
+  $x: nth($args, 1);
+  $y: nth($args, 2);
+  $b: binary-length($x);
+  $res: 0;
+
+  @for $i from 0 through $b {
+    $h: power(2, $i);
+    $res: $res + $h * (((floor($x / $h) % 2) + (floor($y / $h) % 2)) % 2);
+  }
+
+  @return $res;
+}

data/stylesheets/SassyBitwise/validators/_arguments-validator.scss

@@ -1,45 +1,51 @@
-// Checks whether argument list is valid
-// ---
-// @param [list] $args: argument list
-// ---
-// @return [bool]
-// ---
-@function arguments-validator($args) {
-  $valid-operators: "^", "|", "&", "<<", ">>";
-
-  @if length($args) == 2 {
-    @if nth($args, 1) != "~" {
-      @warn "Only 2 arguments specified but first is not `~`.";
-      @return false;
-    }
-
-    @if not is-number(nth($args, 2)) {
-      @warn "Only 2 arguments specified but second is not a valid unitless number.";
-      @return false;
-    }
-  }
-
-  @else if length($args) == 3 {
-    @if not index($valid-operators, nth($args, 2)) {
-      @warn "Invalid operator: `#{nth($args, 2)}` given, one of #{inspect($valid-operators)} expected.";
-      @return false;
-    }
-
-    @if not is-number(nth($args, 1)) {
-      @warn "Invalid number as first argument: `#{nth($args, 1)} given, valid unitless number expected.";
-      @return false;
-    }
-
-    @if not is-number(nth($args, 3)) {
-      @warn "Invalid number as third argument: `#{nth($args, 3)} given, valid unitless number expected.";
-      @return false;
-    }
-  }
-
-  @else {
-    @warn "Invalid number of arguments: #{length($args)} given, 2 or 3 expected.";
-    @return false;
-  }
-
-  @return true;
-}
+// Checks whether argument list is valid
+// ---
+// @param [list] $args: argument list
+// ---
+// @return [bool]
+// ---
+@function arguments-validator($args) {
+  $last: null;
+  $operators: (
+    '&'  : 'and',
+    '|'  : 'or',
+    '^'  : 'xor',
+    '<<' : 'shift-left',
+    '>>' : 'shift-right'
+  );
+
+  @if length($args) < 2 {
+    @return false;
+  }
+
+  @each $current in $args {
+    @if map-has-key($operators, $current) {
+      @if not $last {
+        @warn "You can't start with another operator than `~`.";
+        @return false;
+      }
+    }
+
+    @else if $current == '~' {
+      @if type-of($last) == "number" {
+        @warn "Operator `~` can't follow a number.";
+        @return false;
+      }
+    }
+
+    @else if type-of($current) == "number" {
+      @if type-of($last) == "number" {
+        @warn "A number can't follow a number. They must be separated by an operator";
+        @return false;
+      }
+    }
+
+    @else {
+      @return false;
+    }
+
+    $last: $current;
+  }
+
+  @return true;
+}

data/stylesheets/_SassyBitwise.scss

@@ -1,16 +1,15 @@
-@import "SassyBitwise/helpers/power";
-@import "SassyBitwise/helpers/sign";
-@import "SassyBitwise/helpers/order-args";
-@import "SassyBitwise/helpers/largest-power-of-2";
-@import "SassyBitwise/helpers/binary-to-decimal";
-@import "SassyBitwise/helpers/decimal-to-binary";
-@import "SassyBitwise/helpers/binary-length";
-@import "SassyBitwise/validators/is-number";
-@import "SassyBitwise/validators/arguments-validator";
-@import "SassyBitwise/operators/and";
-@import "SassyBitwise/operators/not";
-@import "SassyBitwise/operators/or";
-@import "SassyBitwise/operators/xor";
-@import "SassyBitwise/operators/shift-left";
-@import "SassyBitwise/operators/shift-right";
-@import "SassyBitwise/api/bitwise";
+@import "SassyBitwise/helpers/order-args";
+@import "SassyBitwise/helpers/power";
+@import "SassyBitwise/helpers/sign";
+@import "SassyBitwise/helpers/binary-to-decimal";
+@import "SassyBitwise/helpers/decimal-to-binary";
+@import "SassyBitwise/helpers/largest-power-of-2";
+@import "SassyBitwise/helpers/binary-length";
+@import "SassyBitwise/validators/arguments-validator";
+@import "SassyBitwise/operators/or";
+@import "SassyBitwise/operators/xor";
+@import "SassyBitwise/operators/and";
+@import "SassyBitwise/operators/not";
+@import "SassyBitwise/operators/shift-left";
+@import "SassyBitwise/operators/shift-right";
+@import "SassyBitwise/api/bitwise";

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: SassyBitwise
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Hugo Giraudel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2014-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -47,7 +47,6 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - lib/SassyBitwise.rb
-- stylesheets/_SassyBitwise.scss
 - stylesheets/SassyBitwise/api/_bitwise.scss
 - stylesheets/SassyBitwise/helpers/_binary-length.scss
 - stylesheets/SassyBitwise/helpers/_binary-to-decimal.scss
@@ -63,7 +62,7 @@ files:
 - stylesheets/SassyBitwise/operators/_shift-right.scss
 - stylesheets/SassyBitwise/operators/_xor.scss
 - stylesheets/SassyBitwise/validators/_arguments-validator.scss
-- stylesheets/SassyBitwise/validators/_is-number.scss
+- stylesheets/_SassyBitwise.scss
 homepage: http://github.com/HugoGiraudel/SassyBitwise
 licenses: []
 metadata: {}
@@ -83,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: SassyBitwise
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An implementation of bitwise operators in Sass without the use of Ruby.

data/stylesheets/SassyBitwise/validators/_is-number.scss

@@ -1,9 +0,0 @@
-// Checks whether $value is valid number
-// ---
-// @param [number] $value
-// ---
-// @return [bool]
-// ---
-@function is-number($value) {
-  @return type-of($value) == "number" and unitless($value)
-}