sass 3.3.0.alpha.256 → 3.3.0.alpha.353

data/lib/sass/script/tree/interpolation.rb

@@ -31,7 +31,10 @@ module Sass::Script::Tree
     # @param wb [Boolean] See {Interpolation#whitespace_before}
     # @param wa [Boolean] See {Interpolation#whitespace_after}
     # @param originally_text [Boolean] See {Interpolation#originally_text}
+    # @comment
+    #   rubocop:disable ParameterLists
     def initialize(before, mid, after, wb, wa, originally_text = false)
+      # rubocop:enable ParameterLists
       @before = before
       @mid = mid
       @after = after
@@ -81,7 +84,8 @@ module Sass::Script::Tree
     # Evaluates the interpolation.
     #
     # @param environment [Sass::Environment] The environment in which to evaluate the SassScript
-    # @return [Sass::Script::Value::String] The SassScript string that is the value of the interpolation
+    # @return [Sass::Script::Value::String]
+    #   The SassScript string that is the value of the interpolation
     def _perform(environment)
       res = ""
       res << @before.perform(environment).to_s if @before

data/lib/sass/script/tree/list_literal.rb

@@ -31,7 +31,8 @@ module Sass::Script::Tree
       precedence = Sass::Script::Parser.precedence_of(separator)
       elements.reject {|e| e.is_a?(Sass::Script::Value::Null)}.map do |v|
         if v.is_a?(ListLiteral) && Sass::Script::Parser.precedence_of(v.separator) <= precedence ||
-            separator == :space && v.is_a?(UnaryOperation) && (v.operator == :minus || v.operator == :plus)
+            separator == :space && v.is_a?(UnaryOperation) &&
+            (v.operator == :minus || v.operator == :plus)
           "(#{v.to_sass(opts)})"
         else
           v.to_sass(opts)
@@ -60,16 +61,16 @@ module Sass::Script::Tree
       list.line = line
       list.source_range = source_range
       list.filename = filename
-      list.options = self.options
+      list.options = options
       list
     end
 
     private
 
-    def sep_str(opts = self.options)
+    def sep_str(opts = options)
       return ' ' if separator == :space
       return ',' if opts && opts[:style] == :compressed
-      return ', '
+      ', '
     end
   end
 end

data/lib/sass/script/tree/map_literal.rb

@@ -57,7 +57,7 @@ module Sass::Script::Tree
         keys << k
         [k, v]
       end))
-      map.options = self.options
+      map.options = options
       map
     end
   end

data/lib/sass/script/tree/node.rb

@@ -32,7 +32,7 @@ module Sass::Script::Tree
       @options = options
       children.each do |c|
         if c.is_a? Hash
-          c.values.each {|v| v.options = options }
+          c.values.each {|v| v.options = options}
         else
           c.options = options
         end
@@ -80,7 +80,7 @@ module Sass::Script::Tree
     # Converts underscores to dashes if the :dasherize option is set.
     def dasherize(s, opts)
       if opts[:dasherize]
-        s.gsub(/_/,'-')
+        s.gsub(/_/, '-')
       else
         s
       end

data/lib/sass/script/tree/operation.rb

@@ -74,7 +74,8 @@ module Sass::Script::Tree
 
       if (value1.is_a?(Sass::Script::Value::Null) || value2.is_a?(Sass::Script::Value::Null)) &&
           @operator != :eq && @operator != :neq
-        raise Sass::SyntaxError.new("Invalid null operation: \"#{value1.inspect} #{@operator} #{value2.inspect}\".")
+        raise Sass::SyntaxError.new(
+          "Invalid null operation: \"#{value1.inspect} #{@operator} #{value2.inspect}\".")
       end
 
       begin

data/lib/sass/script/tree/selector.rb

@@ -12,13 +12,14 @@ module Sass::Script::Tree
     end
 
     def deep_copy
-      self.dup
+      dup
     end
 
     protected
 
     def _perform(environment)
-      return opts(Sass::Script::Value::Null.new) unless selector = environment.selector
+      selector = environment.selector
+      return opts(Sass::Script::Value::Null.new) unless selector
       opts(Sass::Script::Value::List.new(selector.members.map do |seq|
         Sass::Script::Value::List.new(seq.members.map do |component|
           Sass::Script::Value::String.new(component.to_s)

data/lib/sass/script/tree/string_interpolation.rb

@@ -74,7 +74,8 @@ module Sass::Script::Tree
     # Evaluates the interpolation.
     #
     # @param environment [Sass::Environment] The environment in which to evaluate the SassScript
-    # @return [Sass::Script::Value::String] The SassScript string that is the value of the interpolation
+    # @return [Sass::Script::Value::String]
+    #   The SassScript string that is the value of the interpolation
     def _perform(environment)
       res = ""
       before = @before.perform(environment)

data/lib/sass/script/tree/variable.rb

@@ -14,7 +14,7 @@ module Sass::Script::Tree
     # @param name [String] See \{#name}
     def initialize(name)
       @name = name
-      @underscored_name = name.gsub(/-/,"_")
+      @underscored_name = name.gsub(/-/, "_")
       super()
     end
 
@@ -45,12 +45,13 @@ module Sass::Script::Tree
     # @return [Sass::Script::Value] The SassScript object that is the value of the variable
     # @raise [Sass::SyntaxError] if the variable is undefined
     def _perform(environment)
-      raise Sass::SyntaxError.new("Undefined variable: \"$#{name}\".") unless val = environment.var(name)
+      val = environment.var(name)
+      raise Sass::SyntaxError.new("Undefined variable: \"$#{name}\".") unless val
       if val.is_a?(Sass::Script::Value::Number)
         val = val.dup
         val.original = nil
       end
-      return val
+      val
     end
   end
 end

data/lib/sass/script/value/base.rb

@@ -38,9 +38,7 @@ module Sass::Script::Value
     # See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
     #
     # @param options [{Symbol => Object}] The options
-    def options=(options)
-      @options = options
-    end
+    attr_writer :options
 
     # Returns the options hash for this node.
     #
@@ -66,7 +64,7 @@ MSG
     # @return [Sass::Script::Value::Bool] True if this value is the same as the other,
     #   false otherwise
     def eq(other)
-      Sass::Script::Value::Bool.new(self.class == other.class && self.value == other.value)
+      Sass::Script::Value::Bool.new(self.class == other.class && value == other.value)
     end
 
     # The SassScript `!=` operation.
@@ -98,7 +96,7 @@ MSG
     # @return [Script::Value::String] A string containing both values
     #   separated by `"="`
     def single_eq(other)
-      Sass::Script::Value::String.new("#{self.to_s}=#{other.to_s}")
+      Sass::Script::Value::String.new("#{to_s}=#{other.to_s}")
     end
 
     # The SassScript `+` operation.
@@ -108,9 +106,9 @@ MSG
     #   without any separation
     def plus(other)
       if other.is_a?(Sass::Script::Value::String)
-        return Sass::Script::Value::String.new(self.to_s + other.value, other.type)
+        return Sass::Script::Value::String.new(to_s + other.value, other.type)
       end
-      Sass::Script::Value::String.new(self.to_s + other.to_s)
+      Sass::Script::Value::String.new(to_s + other.to_s)
     end
 
     # The SassScript `-` operation.
@@ -119,7 +117,7 @@ MSG
     # @return [Script::Value::String] A string containing both values
     #   separated by `"-"`
     def minus(other)
-      Sass::Script::Value::String.new("#{self.to_s}-#{other.to_s}")
+      Sass::Script::Value::String.new("#{to_s}-#{other.to_s}")
     end
 
     # The SassScript `/` operation.
@@ -128,7 +126,7 @@ MSG
     # @return [Script::Value::String] A string containing both values
     #   separated by `"/"`
     def div(other)
-      Sass::Script::Value::String.new("#{self.to_s}/#{other.to_s}")
+      Sass::Script::Value::String.new("#{to_s}/#{other.to_s}")
     end
 
     # The SassScript unary `+` operation (e.g. `+$a`).
@@ -137,7 +135,7 @@ MSG
     # @return [Script::Value::String] A string containing the value
     #   preceded by `"+"`
     def unary_plus
-      Sass::Script::Value::String.new("+#{self.to_s}")
+      Sass::Script::Value::String.new("+#{to_s}")
     end
 
     # The SassScript unary `-` operation (e.g. `-$a`).
@@ -146,7 +144,7 @@ MSG
     # @return [Script::Value::String] A string containing the value
     #   preceded by `"-"`
     def unary_minus
-      Sass::Script::Value::String.new("-#{self.to_s}")
+      Sass::Script::Value::String.new("-#{to_s}")
     end
 
     # The SassScript unary `/` operation (e.g. `/$a`).
@@ -155,7 +153,7 @@ MSG
     # @return [Script::Value::String] A string containing the value
     #   preceded by `"/"`
     def unary_div
-      Sass::Script::Value::String.new("/#{self.to_s}")
+      Sass::Script::Value::String.new("/#{to_s}")
     end
 
     # Returns the hash code of this value. Two objects' hash codes should be
@@ -191,7 +189,7 @@ MSG
     # @return [Fixnum] The integer value of this value
     # @raise [Sass::SyntaxError] if this value isn't an integer
     def to_i
-      raise Sass::SyntaxError.new("#{self.inspect} is not an integer.")
+      raise Sass::SyntaxError.new("#{inspect} is not an integer.")
     end
 
     # @raise [Sass::SyntaxError] if this value isn't an integer
@@ -218,7 +216,7 @@ MSG
     # @return [Hash<Value, Value>] This value as a hash
     # @raise [Sass::SyntaxError] if this value doesn't have a hash representation
     def to_h
-      raise Sass::SyntaxError.new("#{self.inspect} is not a map.")
+      raise Sass::SyntaxError.new("#{inspect} is not a map.")
     end
 
     # Returns the string representation of this value

data/lib/sass/script/value/color.rb

@@ -248,6 +248,24 @@ module Sass::Script::Value
       @attrs[:alpha] = Sass::Util.check_range("Alpha channel", 0..1, @attrs[:alpha])
     end
 
+    # Create a new color from a valid CSS hex string.
+    #
+    # The leading hash is optional.
+    #
+    # @return [Color]
+    def self.from_hex(hex_string, alpha = nil)
+      unless hex_string =~ /^#?([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/i ||
+             hex_string =~ /^#?([0-9a-f])([0-9a-f])([0-9a-f])$/i
+        raise ArgumentError.new("#{hex_string.inspect} is not a valid hex color.")
+      end
+      red   = $1.ljust(2, $1).to_i(16)
+      green = $2.ljust(2, $2).to_i(16)
+      blue  = $3.ljust(2, $3).to_i(16)
+      attrs = {:red => red, :green => green, :blue => blue}
+      attrs[:alpha] = alpha if alpha
+      new(attrs)
+    end
+
     # The red component of the color.
     #
     # @return [Fixnum]
@@ -520,7 +538,7 @@ module Sass::Script::Value
     def to_s(opts = {})
       return smallest if options[:style] == :compressed
       return COLOR_NAMES_REVERSE[rgba] if COLOR_NAMES_REVERSE[rgba]
-      return alpha? ? rgba_str : hex_str
+      alpha? ? rgba_str : hex_str
     end
     alias_method :to_sass, :to_s
 
@@ -537,7 +555,7 @@ module Sass::Script::Value
       small_explicit_str = alpha? ? rgba_str : hex_str.gsub(/^#(.)\1(.)\2(.)\3$/, '#\1\2\3')
       return small_explicit_str unless (color = COLOR_NAMES_REVERSE[rgba]) &&
         color.size <= small_explicit_str.size
-      return color
+      color
     end
 
     def rgba_str
@@ -546,20 +564,21 @@ module Sass::Script::Value
     end
 
     def hex_str
-      red, green, blue = rgb.map { |num| num.to_s(16).rjust(2, '0') }
+      red, green, blue = rgb.map {|num| num.to_s(16).rjust(2, '0')}
       "##{red}#{green}#{blue}"
     end
 
     def piecewise(other, operation)
       other_num = other.is_a? Number
       if other_num && !other.unitless?
-        raise Sass::SyntaxError.new("Cannot add a number with units (#{other}) to a color (#{self}).")
+        raise Sass::SyntaxError.new(
+          "Cannot add a number with units (#{other}) to a color (#{self}).")
       end
 
       result = []
-      for i in (0...3)
+      (0...3).each do |i|
         res = rgb[i].send(operation, other_num ? other.value : other.rgb[i])
-        result[i] = [ [res, 255].min, 0 ].max
+        result[i] = [[res, 255].min, 0].max
       end
 
       if !other_num && other.alpha != alpha
@@ -580,9 +599,9 @@ module Sass::Script::Value
       m2 = l <= 0.5 ? l * (s + 1) : l + s - l * s
       m1 = l * 2 - m2
       @attrs[:red], @attrs[:green], @attrs[:blue] = [
-        hue_to_rgb(m1, m2, h + 1.0/3),
+        hue_to_rgb(m1, m2, h + 1.0 / 3),
         hue_to_rgb(m1, m2, h),
-        hue_to_rgb(m1, m2, h - 1.0/3)
+        hue_to_rgb(m1, m2, h - 1.0 / 3)
       ].map {|c| (c * 0xff).round}
     end
 
@@ -591,8 +610,8 @@ module Sass::Script::Value
       h -= 1 if h > 1
       return m1 + (m2 - m1) * h * 6 if h * 6 < 1
       return m2 if h * 2 < 1
-      return m1 + (m2 - m1) * (2.0/3 - h) * 6 if h * 3 < 2
-      return m1
+      return m1 + (m2 - m1) * (2.0 / 3 - h) * 6 if h * 3 < 2
+      m1
     end
 
     def rgb_to_hsl!
@@ -607,20 +626,20 @@ module Sass::Script::Value
       h =
         case max
         when min; 0
-        when r; 60 * (g-b)/d
-        when g; 60 * (b-r)/d + 120
-        when b; 60 * (r-g)/d + 240
+        when r; 60 * (g - b) / d
+        when g; 60 * (b - r) / d + 120
+        when b; 60 * (r - g) / d + 240
         end
 
-      l = (max + min)/2.0
+      l = (max + min) / 2.0
 
       s =
         if max == min
           0
         elsif l < 0.5
-          d/(2*l)
+          d / (2 * l)
         else
-          d/(2 - 2*l)
+          d / (2 - 2 * l)
         end
 
       @attrs[:hue] = h % 360

data/lib/sass/script/value/helpers.rb

@@ -0,0 +1,146 @@
+module Sass::Script::Value
+  # Provides helper functions for creating sass values from within ruby methods.
+  # @since `3.3.0`
+  module Helpers
+    # Construct a Sass Boolean.
+    #
+    # @param value [Object] A ruby object that will be tested for truthiness.
+    # @return [Sass::Script::Value::Bool] whether the ruby value is truthy.
+    def bool(value)
+      Bool.new(value)
+    end
+
+    # Construct a Sass Color from a hex color string.
+    #
+    # @param value [::String] A string representing a hex color.
+    #   The leading hash ("#") is optional.
+    # @param alpha [::Number] The alpha channel. A number between 0 and 1.
+    # @return [Sass::Script::Value::Color] the color object
+    def hex_color(value, alpha = nil)
+      Color.from_hex(value, alpha)
+    end
+
+    # Construct a Sass Color from hsl values.
+    #
+    # @param hue [::Number] The hue of the color in degrees.
+    #   A non-negative number, usually less than 360.
+    # @param saturation [::Number] The saturation of the color.
+    #   Must be between 0 and 100 inclusive.
+    # @param lightness [::Number] The lightness of the color.
+    #   Must be between 0 and 100 inclusive.
+    # @param alpha [::Number] The alpha channel. A number between 0 and 1.
+    #
+    # @return [Sass::Script::Value::Color] the color object
+    def hsl_color(hue, saturation, lightness, alpha = nil)
+      attrs = {:hue => hue, :saturation => saturation, :lightness => lightness}
+      attrs[:alpha] = alpha if alpha
+      Color.new(attrs)
+    end
+
+    # Construct a Sass Color from rgb values.
+    #
+    # @param red [::Number] The red component. Must be between 0 and 255 inclusive.
+    # @param green [::Number] The green component. Must be between 0 and 255 inclusive.
+    # @param blue [::Number] The blue component. Must be between 0 and 255 inclusive.
+    # @param alpha [::Number] The alpha channel. A number between 0 and 1.
+    #
+    # @return [Sass::Script::Value::Color] the color object
+    def rgb_color(red, green, blue, alpha = nil)
+      attrs = {:red => red, :green => green, :blue => blue}
+      attrs[:alpha] = alpha if alpha
+      Color.new(attrs)
+    end
+
+    # Construct a Sass Number from a ruby number.
+    #
+    # @param number [::Number] A numeric value.
+    # @param unit_string [::String] A unit string of the form
+    #   `numeral_unit1 * numeral_unit2 ... / denominator_unit1 * denominator_unit2 ...`
+    #   this is the same format that is returned by
+    #   {Sass::Script::Value::Number#unit_str the `unit_str` method}
+    #
+    # @see Sass::Script::Value::Number#unit_str
+    #
+    # @return [Sass::Script::Value::Number] The sass number representing the given ruby number.
+    def number(number, unit_string = nil)
+      Number.new(number, *parse_unit_string(unit_string))
+    end
+
+    # @overload list(*elements, separator)
+    #   Create a space-separated list from the arguments given.
+    #   @param elements [Array<Sass::Script::Value::Base>] Each argument will be a list element.
+    #   @param separator [Symbol] Either :space or :comma.
+    #   @return [Sass::Script::Value::List] The space separated list.
+    #
+    # @overload list(array, separator)
+    #   Create a space-separated list from the array given.
+    #   @param array [Array<Sass::Script::Value::Base>] A ruby array of Sass values
+    #     to make into a list.
+    #   @return [Sass::Script::Value::List] The space separated list.
+    def list(*elements)
+      unless elements.last.is_a?(Symbol)
+        raise ArgumentError.new("A list type of :space or :comma must be specified.")
+      end
+      separator = elements.pop
+      if elements.size == 1 && elements.first.is_a?(Array)
+        elements = elements.first
+      end
+      Sass::Script::Value::List.new(elements, separator)
+    end
+
+    # Create a sass null value.
+    #
+    # @return [Sass::Script::Value::Null]
+    def null
+      Sass::Script::Value::Null.new
+    end
+
+    # Create a quoted string.
+    #
+    # @param str [::String] A ruby string.
+    # @return [Sass::Script::Value::String] A quoted string.
+    def quoted_string(str)
+      Sass::Script::String.new(str, :string)
+    end
+
+    # Create an unquoted string.
+    #
+    # @param str [::String] A ruby string.
+    # @return [Sass::Script::Value::String] An unquoted string.
+    def unquoted_string(str)
+      Sass::Script::String.new(str, :identifier)
+    end
+    alias_method :identifier, :unquoted_string
+
+    private
+
+    # @private
+    VALID_UNIT = /#{Sass::SCSS::RX::NMSTART}#{Sass::SCSS::RX::NMCHAR}|%*/
+
+    # @example
+    #   parse_unit_string("em*px/in*%") # => [["em", "px], ["in", "%"]]
+    #
+    # @param unit_string [String] A string adhering to the output of a number with complex
+    #   units. E.g. "em*px/in*%"
+    # @return [Array<Array<String>>] A list of numerator units and a list of denominator units.
+    def parse_unit_string(unit_string)
+      denominator_units = numerator_units = Sass::Script::Value::Number::NO_UNITS
+      return numerator_units, denominator_units unless unit_string && unit_string.length > 0
+      num_over_denominator = unit_string.split(/ *\/ */)
+      unless (1..2).include?(num_over_denominator.size)
+        raise ArgumentError.new("Malformed unit string: #{unit_string}")
+      end
+      numerator_units = num_over_denominator[0].split(/ *\* */)
+      denominator_units = (num_over_denominator[1] || "").split(/ *\* */)
+      [[numerator_units, "numerator"], [denominator_units, "denominator"]].each do |units, name|
+        if unit_string =~ /\// && units.size == 0
+          raise ArgumentError.new("Malformed unit string: #{unit_string}")
+        end
+        if units.any? {|unit| unit !~ VALID_UNIT}
+          raise ArgumentError.new("Malformed #{name} in unit string: #{unit_string}")
+        end
+      end
+      [numerator_units, denominator_units]
+    end
+  end
+end