mirror-mirror 0.10.1 → 1.0.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbdfc822f9e30418bfe04090264219eef0c240f3
-  data.tar.gz: d54a42086ae1068ce2c83c5b8e21e8c0cb056d7d
+  metadata.gz: 24a6d3d4634cce53e4a5e7a9b0e8a7cce2ede8ae
+  data.tar.gz: a65cb2c7376ddb3184873bfa840e7068b5016115
 SHA512:
-  metadata.gz: 94f4cb7250db728b04c66f88c2f31b4e0eaabebb2c6613461d498bf7667bf4ad87dd3699ed612fce386a8753fef9a817d64cc824a79869b53f47dbf06b432bb2
-  data.tar.gz: 86c6c9b12c9d9f8b379045d77f0b5505272b4007de46df9799616a688eda9a3130ebc21ddb3b4402dc4d94c4163e3c21e905f6d09e759c567a5963cb9543d3a9
+  metadata.gz: 29d771b7a8343953cbda5cb7f67998ba598e7bfcec17be76d6cac64087fe395275cb796e20dcd0ecac923e511759349188ea975f130a6519e47da44408fd59ad
+  data.tar.gz: df78fb9b32ae335c5ac2d023e13a593bede7d1b3b0caf7ea19261f6224c1164de2ad070baf788741880b30aa3c9ad28d36101bccb1f26f2061eadda8478744d1

data/README.md

@@ -42,6 +42,211 @@ scss -r mirror-mirror/activate ...
 scss -r mirror-mirror/activate/flipped ...
 ```
 
+## Stylesheet API
+
+### Protecting styles from being flipped
+
+If you have styles that should not be flipped when mirror-mirror is
+activated protect them by wrapping those styles in call to the `no-flip`
+mixin.
+
+```scss
+@import "mirror-mirror";
+@include no-flip {
+  // styles that should never be flipped
+}
+```
+
+### Inline flipping
+
+When the stylesheet is not flipped, a call to the inline-flip mixin will
+emit the styles contained therein twice. Once normally and once flipped
+with a selector scope.
+
+```scss
+@import "mirror-mirror";
+@include inline-flip {
+  .foo { float: left; }
+  .bar { border: 1px 2px 3px 4px; }
+}
+```
+
+will compile to:
+
+```css
+  .foo { float: left; }
+  .bar { border: 1px 2px 3px 4px; }
+  *[dir=rtl] .foo { float: right; }
+  *[dir=rtl] .bar { border: 1px 4px 3px 2px; }
+```
+
+#### Changing the inline-flip default context
+
+The `*[dir=rtl]` is prepended by default. The `$mirror-mirror-default-inline-context`
+controls what this selector is and you can change it in your stylesheet
+according to your needs.
+
+```scss
+@import "mirror-mirror";
+$mirror-mirror-default-inline-context: "body.rtl";
+@include inline-flip {
+  .foo { float: left; }
+  .bar { border: 1px 2px 3px 4px; }
+}
+```
+
+will compile to:
+
+```css
+  .foo { float: left; }
+  .bar { border: 1px 2px 3px 4px; }
+  body.rtl .foo { float: right; }
+  body.rtl .bar { border: 1px 4px 3px 2px; }
+```
+
+#### Inline Flipping in a Nested Context
+
+Note that when inline flipping styles in a nested context there are a
+few scenarios to consider.
+
+By default you get the following behavior:
+
+```scss
+@import "mirror-mirror";
+$mirror-mirror-default-inline-context: ".rtl";
+.context {
+  @include inline-flip {
+    .foo { float: left; }
+    .bar { border: 1px 2px 3px 4px; }
+  }
+}
+```
+
+will compile to:
+
+```css
+  .context .foo { float: left; }
+  .context .bar { border: 1px 2px 3px 4px; }
+  .context .rtl .foo { float: right; }
+  .context .rtl .bar { border: 1px 4px 3px 2px; }
+```
+
+To append to the current selector context:
+
+
+```scss
+@import "mirror-mirror";
+.context {
+  @include inline-flip("&.rtl") {
+    .foo { float: left; }
+    .bar { border: 1px 2px 3px 4px; }
+  }
+}
+```
+
+will compile to:
+
+```css
+  .context .foo { float: left; }
+  .context .bar { border: 1px 2px 3px 4px; }
+  .context.rtl .foo { float: right; }
+  .context.rtl .bar { border: 1px 4px 3px 2px; }
+```
+
+To prepend the rtl selector context:
+
+```scss
+@import "mirror-mirror";
+.context {
+  @include inline-flip($prepend-context: true) {
+    .foo { float: left; }
+    .bar { border: 1px 2px 3px 4px; }
+  }
+}
+```
+
+will compile to:
+
+```css
+  .context .foo { float: left; }
+  .context .bar { border: 1px 2px 3px 4px; }
+  *[dir=rtl] .context .foo { float: right; }
+  *[dir=rtl] .context .bar { border: 1px 4px 3px 2px; }
+```
+
+Using selector combinators:
+
+```scss
+@import "mirror-mirror";
+.context {
+  @include inline-flip(".rtl > ", $prepend-context: true) {
+    .foo { float: left; }
+    .bar { border: 1px 2px 3px 4px; }
+  }
+  @include inline-flip("&.rtl > ") {
+    .bip { float: left; }
+    .baz { border: 1px 2px 3px 4px; }
+  }
+}
+```
+
+will compile to:
+
+```css
+  .context .foo { float: left; }
+  .context .bar { border: 1px 2px 3px 4px; }
+  .rtl > .context .foo { float: right; }
+  .rtl > .context .bar { border: 1px 4px 3px 2px; }
+  .context .bip { float: left; }
+  .context .baz { border: 1px 2px 3px 4px; }
+  .context.rtl > .bip { float: right; }
+  .context.rtl > .baz { border: 1px 4px 3px 2px; }
+```
+
+Note: I would like to tune the defaults for this mixin according how it
+is used in practice. Please let me know if the defaults seem wrong to
+you.
+
+Note #2: This mixin does not flip LTR when RTL is activated. If you need
+to do this, please talk to me so that we can develop an API for it.
+
+### Flipping an entire stylesheet
+
+```scss
+@import "mirror-mirror";
+@include enable-mirror-flip;
+// stuff to be flipped
+```
+
+Note that if this stylesheet is imported by another stylesheet it will
+affect the rest of that stylesheet. Therefore, it is not recommended to
+use this mixin inside a partial stylesheet.
+
+### Disable flipping an entire stylesheet
+
+```scss
+@import "mirror-mirror";
+@include disable-mirror-flip;
+// stuff that shouldn't be flipped
+```
+
+Note that if this stylesheet is imported by another stylesheet it will
+affect the rest of that stylesheet. Therefore, it is not recommended to
+use this mixin inside a partial stylesheet unless you are using it in
+conjunction with 
+
+### Global Variables
+
+* `$mirror-mirror-enabled` -- whether flipping is currently enabled.
+  this is set to the correct value when mirror-mirror is imported
+  according to whether it was activated at the compiler level.
+* `$mirror-mirror-noflip` -- whether you are currently within a no-flip
+  mixin call.
+* `$mirror-mirror-default-inline-context` -- the selector that is used
+  by inline-flip as a context selector when none is specified.
+* `$mirror-mirror-inline-contexts` -- tracks the currently active inline
+  contexts. Don't mess with it.
+
 ## Contributing
 
 1. Fork it

data/lib/mirror-mirror/mirror_visitor.rb

@@ -22,7 +22,7 @@ module MirrorMirror
     end
 
     def visit(node)
-      method = "visit_#{node_name node}"
+      method = "visit_#{node.class.node_name}"
       if self.respond_to?(method, true)
         self.send(method, node) {node.children = visit_children(node)}
       else
@@ -156,41 +156,25 @@ module MirrorMirror
     end
 
     def parsed_value(value, line, offset)
-      slashify(Sass::Script::Parser.new(value, line, offset).parse)
+      node = Sass::Script::Parser.new(value, line, offset).parse
+      opts(@options) { node.perform(Sass::Environment.new) }
+    end
+
+    def opts(o)
+      v = yield
+      v.options = o
+      v
     end
 
     def literalize(expression)
       case expression
       when Sass::Script::List
-        expression.value.map!{|v| literalize(v) }
-        expression
+        opts(expression.options) { Sass::Script::List.new(expression.value.map{|v| literalize(v) }, expression.separator)}
       when Sass::Script::Funcall
         expression.send(:to_literal, expression.args.map {|a| literalize(a) })
       else
         expression
       end
     end
-
-    def slashify(expression)
-      result = _slashify(expression)
-      if result.is_a?(Array)
-        result = Sass::Script::List.new(result, :space)
-        result.options = expression.options
-      end
-      result
-    end
-
-    def _slashify(expression)
-      if expression.is_a?(Sass::Script::List)
-        expression.value.map! {|v| _slashify(v) }
-        expression.value.flatten!
-      elsif expression.is_a?(Sass::Script::Operation)
-        operator = Sass::Script::String.new(Sass::Script::Lexer::OPERATORS_REVERSE[expression.operator])
-        operator.options = expression.options
-        return [_slashify(expression.operand1), operator, _slashify(expression.operand2)]
-      end
-      expression
-    end
-
   end
 end

data/lib/mirror-mirror/sass_patch.rb

@@ -5,15 +5,8 @@ module MirrorMirror
   # So that we don't have to monkeypatch it.
   module SassPatch
     def self.included(base)
-      if base.respond_to?(:css_tree, true)
-        # Sass >= 3.3
-        base.send(:alias_method, :css_tree_without_mirror_mirror, :css_tree)
-        base.send(:alias_method, :css_tree, :css_tree_with_mirror_mirror)
-      else
-        # Sass < 3.3
-        base.send(:alias_method, :render_without_mirror_mirror, :render)
-        base.send(:alias_method, :render, :render_with_mirror_mirror)
-      end
+      base.send(:alias_method, :css_tree_without_mirror_mirror, :css_tree)
+      base.send(:alias_method, :css_tree, :css_tree_with_mirror_mirror)
     end
 
     def css_tree_with_mirror_mirror
@@ -21,16 +14,6 @@ module MirrorMirror
       MirrorVisitor.visit(root)
       root
     end
-
-    def render_with_mirror_mirror
-      Sass::Tree::Visitors::CheckNesting.visit(self)
-      result = Sass::Tree::Visitors::Perform.visit(self)
-      Sass::Tree::Visitors::CheckNesting.visit(result) # Check again to validate mixins
-      result, extends = Sass::Tree::Visitors::Cssize.visit(result)
-      Sass::Tree::Visitors::Extend.visit(result, extends)
-      MirrorVisitor.visit(result)
-      result.to_s
-    end
   end
 
   module CssizePatch

data/lib/mirror-mirror/transformation/background_position.rb

@@ -20,6 +20,17 @@ module MirrorMirror::Transformation
           Sass::Script::List.new([expression], :space)
         end
       end
+      new_list = expression.value.map do |v|
+        if v.is_a?(Sass::Script::Number) && v.original =~ %r{/}
+          left, right = v.original.split(%r{/})
+          [reparse(left), Sass::Script::String.new("/"), reparse(right)].map{|e| opts(expression.options) {e}}
+        else
+          v
+        end
+      end.flatten
+      expression = opts(expression.options) do
+        Sass::Script::List.new(new_list, :space)
+      end
       positions = []
       position_indices = []
       expression.value.each_with_index do |v, i|
@@ -33,16 +44,22 @@ module MirrorMirror::Transformation
         positions
       end
       return expression unless positions.any?
+
       if positions.size > 2
-        Sass.logger.warn("Line #{expression.line}: malformed background: #{expression.to_sass}")
+        Sass.logger.warn("malformed background: #{expression.to_sass}")
         return expression
       end
       # tranform the background position elements and replace the position
       # section of the shorthand with it
-      transformed = transform_background_position(Sass::Script::List.new(positions, :space))
+      transformed = transform_background_position(opts(expression.options) {Sass::Script::List.new(positions, :space)})
       position_indices << position_indices.first if position_indices.size < 2
-      expression.value[Range.new(*position_indices)] = transformed.value
-      expression
+      new_value = expression.value.dup
+      new_value[Range.new(*position_indices)] = transformed.value
+      opts(expression.options) {Sass::Script::List.new(new_value, expression.separator) }
+    end
+
+    def reparse(string)
+      Sass::Script::Parser.parse(string, 1, 0).perform(Sass::Environment.new)
     end
 
     def transform_background_position(expression)
@@ -53,15 +70,23 @@ module MirrorMirror::Transformation
       end
       if expression.value.size > 2
         # positions with offsets
-        expression.value.each_with_index do |e, i|
-          next if i % 2 == 1
-          expression.value[i] = flip_it(e, i / 2)
-        end
+        i = -1
+        new_value = expression.value.map do |e|
+                      i += 1
+                      if i % 2 == 1
+                        e
+                      else
+                        flip_it(e, i / 2)
+                      end
+                    end
+        expression =  opts(expression.options) {Sass::Script::List.new(new_value, expression.separator) }
       else
         # positions
+        new_value = []
         expression.value.each_with_index do |e, i|
-          expression.value[i] = flip_it(e, i)
+          new_value << flip_it(e, i)
         end
+        expression = opts(expression.options) {Sass::Script::List.new(new_value, expression.separator) }
       end
       expression
     end
@@ -77,7 +102,7 @@ module MirrorMirror::Transformation
         elsif position == 0 && e.numerator_units.first == "%"
           opts(e.options) { ONE_HUNDRED_PERCENT.minus(e) }
         elsif position == 0
-          Sass.logger.warn("Line #{e.line}: Cannot flip background position: #{e}")
+          Sass.logger.warn("Cannot flip background position: #{e}")
           e
         else
           e
@@ -85,9 +110,9 @@ module MirrorMirror::Transformation
       when Sass::Script::String
         case e.value
         when "right"
-          e.value.replace("left")
+          e =  opts(e.options) {Sass::Script::String.new("left", e.type) }
         when "left"
-          e.value.replace("right")
+          e = opts(e.options) {Sass::Script::String.new("right", e.type) }
         end
         e
       else

data/lib/mirror-mirror/transformation/box_shadow.rb

@@ -11,7 +11,9 @@ module MirrorMirror::Transformation
         case e
         when Sass::Script::List
           if e.value[0].is_a?(Sass::Script::Number)
-            e.value[0] = flip_it(e.value[0])
+            new_list_values = e.value.dup
+            new_list_values[0] = flip_it(new_list_values[0])
+            e = opts(expression.options) { Sass::Script::List.new(new_list_values, e.separator) }
           end
         when Sass::Script::Number
           e = flip_it(e)

data/lib/mirror-mirror/transformation/linear_gradient.rb

@@ -15,27 +15,38 @@ module MirrorMirror::Transformation
 
     def transform_expression(name, expression)
       for_each_value(expression) do |e|
-        if grad = find_linear_gradient(e)
-          if direction?(grad.args[0])
-            grad.args[0] = flip(grad.args[0])
+        replace_linear_gradient(e) do |gradient_args|
+          if direction?(gradient_args[0])
+            gradient_args[0] = flip(gradient_args[0])
           end
-          e
-        else
-          e
+          gradient_args
         end
       end
     end
 
-    def find_linear_gradient(expression)
+    def replace_linear_gradient(expression, &block)
       case expression
       when Sass::Script::List
-        expression.value.each do |v|
-          grad = find_linear_gradient(v)
-          return grad if grad
+        new_list = expression.value.map do |v|
+          replace_linear_gradient(v, &block)
+        end
+        opts(expression.options) { Sass::Script::List.new(new_list, expression.separator) }
+      when Sass::Script::String
+        if expression.value =~ /^((?:-(?:moz|webkit|o|ms)-)?(?:repeating-)?linear-gradient)\(([^)]+)\)$/
+          list = Sass::Script::Parser.new($2, 1, 0).parse
+          list = list.perform(Sass::Environment.new)
+          args = unless list.is_a?(Sass::Script::List) && list.separator == :comma
+                     [list]
+                   else
+                     list.value.dup
+                   end
+          new_args = block.call(args)
+          opts(expression.options) { Sass::Script::String.new("#{$1}(#{new_args.join(", ")})")}
+        else
+          expression
         end
-        nil
-      when Sass::Script::Funcall
-        expression if expression.name =~ /^(-(moz|webkit|o|ms)-)?(repeating-)?linear-gradient$/
+      else
+        expression
       end
     end
 
@@ -65,8 +76,8 @@ module MirrorMirror::Transformation
       else
         case direction
         when Sass::Script::List
-          direction.value.map!{|v| flip(v) }
-          direction
+          new_values = direction.value.map{|v| flip(v) }
+          opts(direction.options) { Sass::Script::List.new(new_values, direction.separator) }
         when Sass::Script::String
           if direction.value == "left"
             opts(direction.options) { Sass::Script::String.new("right") }

data/lib/mirror-mirror/transformation/property_transformation.rb

@@ -56,12 +56,13 @@ module MirrorMirror::Transformation
     end
 
     def for_each_value(expression)
-        if expression.is_a?(Sass::Script::List) && expression.separator == :comma
-          expression.value.map! {|e| yield(e) }
-          expression
-        else
-          yield(expression)
-        end
+      if expression.is_a?(Sass::Script::List) && expression.separator == :comma
+        new_values = expression.value.map {|e| yield(opts(expression.options) {e}) }
+        new_values.each {|e| e.options ||= expression.options }
+        opts(expression.options) { Sass::Script::List.new(new_values, :comma) }
+      else
+        yield(expression)
+      end
     end
   end
 end

data/lib/mirror-mirror/transformation/quad_shorthand.rb

@@ -17,7 +17,9 @@ module MirrorMirror::Transformation
       if expression.is_a?(Sass::Script::List) &&
          expression.separator == :space &&
          expression.value.size == 4
-        expression.value[1], expression.value[3] = expression.value[3], expression.value[1]
+        new_value = expression.value.dup
+        new_value[1], new_value[3] = new_value[3], new_value[1]
+        expression = opts(expression.options) { Sass::Script::List.new(new_value, expression.separator) }
       end
       expression
     end

data/lib/mirror-mirror/version.rb

@@ -1,3 +1,3 @@
 module MirrorMirror
-  VERSION = "0.10.1"
+  VERSION = "1.0.0.rc.0"
 end

data/stylesheets/mirror-mirror.scss

@@ -15,7 +15,7 @@ $mirror-mirror-inline-contexts: ();
   @if $mirror-mirror-noflip {
     @warn "Enabled flipping in a no-flip. Ignoring.";
   } @else {
-    $mirror-mirror-enabled: true;
+    $mirror-mirror-enabled: true !global;
     @-mirror-mirror {
       enabled: true;
       @content;
@@ -27,7 +27,7 @@ $mirror-mirror-inline-contexts: ();
   @if $mirror-mirror-noflip {
     @warn "Disabled flipping in a no-flip. Ignoring.";
   } @else {
-    $mirror-mirror-enabled: false;
+    $mirror-mirror-enabled: false !global;
     @-mirror-mirror {
       enabled: false;
       @content;
@@ -39,11 +39,11 @@ $mirror-mirror-inline-contexts: ();
   @if $mirror-mirror-noflip or not $mirror-mirror-enabled {
     @content;
   } @else {
-    $mirror-mirror-noflip: true;
+    $mirror-mirror-noflip: true !global;
     @-mirror-mirror no-flip {
       @content;
     }
-    $mirror-mirror-noflip: false;
+    $mirror-mirror-noflip: false !global;
   }
 }
 
@@ -56,11 +56,11 @@ $mirror-mirror-inline-contexts: ();
     @content;
     @-mirror-mirror inline-flip {
       @if not index($mirror-mirror-inline-contexts, $selector-context) {
-        $mirror-mirror-inline-contexts: append($mirror-mirror-inline-contexts, $selector-context);
+        $mirror-mirror-inline-contexts: append($mirror-mirror-inline-contexts, $selector-context) !global;
         #{$selector-context} #{if($prepend-context, '&', null)} {
           @content;
         }
-        $mirror-mirror-inline-contexts: mm-car($mirror-mirror-inline-contexts);
+        $mirror-mirror-inline-contexts: mm-car($mirror-mirror-inline-contexts) !global;
       }
     }
   }

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mirror-mirror
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 1.0.0.rc.0
 platform: ruby
 authors:
 - Chris Eppstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.3.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.3.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,9 +98,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3