sassc 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 400e2204f0a92e520fb185afaa0fd63514065b2b
-  data.tar.gz: 1b6c396aaf27bbd1823245d10c544ae9f8a82180
+  metadata.gz: bac3ffe63156b284a72c2c8496c06a5b14bccc62
+  data.tar.gz: 55a875b297d4253f639461174e5ddd33dbe464e6
 SHA512:
-  metadata.gz: c8fb262c7f5bf9aa3f1dc4ee6fdee6e9e65dcc8e839257089abb3c449d3b55dfb3c6a621bd421538ffed5cb79e59c8c9ae7cfd8ff96c9e94c5215fe538a40702
-  data.tar.gz: 646e9431d13e7bff22f1209193ab0a5c1f63ddafd1aaf36318719c1a6d7009039de1ff00fedf1ed78d356b4bbdb3497bdf1e7896087679274b95ba420c9ffab0
+  metadata.gz: fe168c4733030c3fe7132a38c3ea09ebf03113e665cbb3df82abfdf114a32a361dc1673083037b8c9d1d6174b87e7f86e75ecdfacf23a4c3144fe1d2e7b3c499
+  data.tar.gz: 3159f2ef6faf4f214b1a788104f1d14511fe3d4e50503e81843821e0a05959e339b1b98514b8e8d502e278003557c0bdacb31015909d6aa440f5a79d1725dbb4

data/README.md

@@ -18,11 +18,22 @@ to CSS.  To compile, use a `SassC::Engine`.
 
 Additionally, you can use `SassC::Sass2Scss` to convert Sass syntax to Scss syntax.
 
+## Credits
+
+This gem is maintained by [Ryan Boland](https://ryanboland.com)
+and [awesome contributors](https://github.com/bolandrm/sassc-ruby/graphs/contributors).
+
 ## Changelog
 
+- **1.6.0**
+  - [Support Sass Color types](https://github.com/bolandrm/sassc-ruby/pull/14)
+  - [Support quoted strings](https://github.com/bolandrm/sassc-ruby/pull/13)
+  - [Improve custom function error handling](https://github.com/bolandrm/sassc-ruby/pull/15)
+- **1.5.1**
+  - 2nd attempt at fixing compilation bug (issue [#12](https://github.com/bolandrm/sassc-ruby/issues/12))
 - **1.5.0**
   - Add support for inline source maps
-  - Fix compilation bug (issue #12[](https://github.com/bolandrm/sassc-ruby/issues/12))
+  - Fix compilation bug (issue [#12](https://github.com/bolandrm/sassc-ruby/issues/12))
 - **1.4.0**
   - Add support for line number comments
 - **1.3.0**

data/lib/sassc/error.rb

@@ -1,7 +1,9 @@
 require 'sass/error'
 
 module SassC
-  class SyntaxError < StandardError; end
-  class NotRenderedError < StandardError; end
-  class InvalidStyleError < StandardError; end
+  class BaseError < StandardError; end
+  class SyntaxError < BaseError; end
+  class NotRenderedError < BaseError; end
+  class InvalidStyleError < BaseError; end
+  class UnsupportedValue < BaseError; end
 end

data/lib/sassc/functions_handler.rb

@@ -15,46 +15,13 @@ module SassC
 
       Script.custom_functions.each_with_index do |custom_function, i|
         @callbacks[custom_function] = FFI::Function.new(:pointer, [:pointer, :pointer]) do |native_argument_list, cookie|
-          native_argument_list_length = Native.list_get_length(native_argument_list)
-          custom_function_arguments = []
-          error_tag = nil
-
-          (0...native_argument_list_length).each do |i|
-            native_value = Native.list_get_value(native_argument_list, i)
-
-            case value_tag = Native.value_get_tag(native_value)
-            when :sass_null
-              # no-op
-            when :sass_string
-              native_string = Native.string_get_value(native_value)
-              argument = Script::String.new(Script::String.unquote(native_string), Script::String.type(native_string))
-
-              custom_function_arguments << argument
-            when :sass_color
-              red, green, blue, alpha = Native.color_get_r(native_value), Native.color_get_g(native_value), Native.color_get_b(native_value), Native.color_get_a(native_value)
-
-              argument = Script::Color.new([red, green, blue, alpha])
-              argument.options = @options
-
-              custom_function_arguments << argument
-            else
-              error_tag = error("Sass argument of type #{value_tag} unsupported")
-              break
-            end
-          end
-
-          next error_tag if error_tag
-
           begin
-            value = functions.send(custom_function, *custom_function_arguments)
-
-            if value
-              value = Script::String.new(Script::String.unquote(value.to_s), value.type)
-              value.to_native
-            else
-              Script::String.new("").to_native
-            end
+            function_arguments = arguments_from_native_list(native_argument_list)
+            result = functions.send(custom_function, *function_arguments)
+            to_native_value(result)
           rescue StandardError => exception
+            # This rescues any exceptions that occur either in value conversion
+            # or during the execution of a custom function.
             error(exception.message)
           end
         end
@@ -75,19 +42,27 @@ module SassC
 
     private
 
-    def error(message)
-      value = Native::SassValue.new
-      value[:unknown] = Native::SassUnknown.new
+    def arguments_from_native_list(native_argument_list)
+      native_argument_list_length = Native.list_get_length(native_argument_list)
 
-      error = Native::SassError.new
-      error[:tag] = :sass_error
+      (0...native_argument_list_length).map do |i|
+        native_value = Native.list_get_value(native_argument_list, i)
+        Script::ValueConversion.from_native(native_value, @options)
+      end.compact
+    end
 
-      Native.error_set_message(error, Native.native_string(message))
-      $stderr.puts "[SassC::FunctionsHandler] #{message}"
+    def to_native_value(sass_value)
+      # if the custom function returns nil, we provide a "default" return
+      # value of an empty string
+      sass_value ||= Script::String.new("")
 
-      value[:unknown][:tag] = :sass_error
-      value[:error] = error
-      value.pointer
+      sass_value.options = @options
+      Script::ValueConversion.to_native(sass_value)
+    end
+
+    def error(message)
+      $stderr.puts "[SassC::FunctionsHandler] #{message}"
+      Native.make_error(message)
     end
 
     class FunctionWrapper

data/lib/sassc/native/native_functions_api.rb

@@ -14,8 +14,18 @@ module SassC
 
     # ADDAPI union Sass_Value* ADDCALL sass_make_number  (double val, const char* unit);
     attach_function :sass_make_number, [:double, :string], :sass_value_ptr
+
+    # ADDAPI union Sass_Value* ADDCALL sass_make_string  (const char* val);
     attach_function :sass_make_string, [:string], :sass_value_ptr
 
+    # ADDAPI union Sass_Value* ADDCALL sass_make_qstring (const char* val);
+    attach_function :sass_make_qstring, [:string], :sass_value_ptr
+
+    # ADDAPI union Sass_Value* ADDCALL sass_make_color   (double r, double g, double b, double a);
+    attach_function :sass_make_color, [:double, :double, :double, :double], :sass_value_ptr
+
+    # ADDAPI union Sass_Value* ADDCALL sass_make_error   (const char* msg);
+    attach_function :sass_make_error, [:string], :sass_value_ptr
 
     # ADDAPI enum Sass_Tag ADDCALL sass_value_get_tag (const union Sass_Value* v);
     attach_function :sass_value_get_tag, [:sass_value_ptr], SassTag
@@ -24,6 +34,13 @@ module SassC
     # ADDAPI const char* ADDCALL sass_string_get_value (const union Sass_Value* v);
     attach_function :sass_string_get_value, [:sass_value_ptr], :string
 
+    # ADDAPI bool ADDCALL sass_string_is_quoted(const union Sass_Value* v);
+    attach_function :sass_string_is_quoted, [:sass_value_ptr], :bool
+
+    def self.string_get_type(native_value)
+      string_is_quoted(native_value) ? :string : :identifier
+    end
+
     # ADDAPI double ADDCALL sass_color_get_r (const union Sass_Value* v);
     # ADDAPI void ADDCALL sass_color_set_r (union Sass_Value* v, double r);
     # ADDAPI double ADDCALL sass_color_get_g (const union Sass_Value* v);

data/lib/sassc/script.rb

@@ -13,11 +13,14 @@ module SassC
 
       "#{function_name}(#{params})"
     end
+
+    module Value
+    end
   end
 end
 
 require_relative "script/functions"
-require_relative "script/string"
+require_relative "script/value_conversion"
 
 module Sass
   module Script
@@ -26,4 +29,11 @@ end
 
 require 'sass/util'
 require 'sass/script/value/base'
-require_relative "script/color"
+require 'sass/script/value/string'
+require 'sass/script/value/color'
+
+SassC::Script::String = Sass::Script::Value::String
+SassC::Script::Value::String = Sass::Script::Value::String
+
+SassC::Script::Color = Sass::Script::Value::Color
+SassC::Script::Value::Color = Sass::Script::Value::Color

data/lib/sassc/script/value_conversion.rb

@@ -0,0 +1,42 @@
+module SassC
+  module Script
+    module ValueConversion
+      def self.from_native(native_value, options)
+        case value_tag = Native.value_get_tag(native_value)
+        when :sass_null
+          # no-op
+        when :sass_string
+          value = Native.string_get_value(native_value)
+          type = Native.string_get_type(native_value)
+          argument = Script::String.new(value, type)
+
+          argument
+        when :sass_color
+          red, green, blue, alpha = Native.color_get_r(native_value), Native.color_get_g(native_value), Native.color_get_b(native_value), Native.color_get_a(native_value)
+
+          argument = Script::Color.new([red, green, blue, alpha])
+          argument.options = options
+
+          argument
+        else
+          raise UnsupportedValue.new("Sass argument of type #{value_tag} unsupported")
+        end
+      end
+
+      def self.to_native(value)
+        case value_name = value.class.name.split("::").last
+        when "String"
+          String.new(value).to_native
+        when "Color"
+          Color.new(value).to_native
+        else
+          raise UnsupportedValue.new("Sass return type #{value_name} unsupported")
+        end
+      end
+    end
+  end
+end
+
+require_relative "value_conversion/base"
+require_relative "value_conversion/string"
+require_relative "value_conversion/color"

data/lib/sassc/script/value_conversion/base.rb

@@ -0,0 +1,11 @@
+module SassC
+  module Script
+    module ValueConversion
+      class Base
+        def initialize(value)
+          @value = value
+        end
+      end
+    end
+  end
+end

data/lib/sassc/script/value_conversion/color.rb

@@ -0,0 +1,16 @@
+module SassC
+  module Script
+    module ValueConversion
+      class Color < Base
+        def to_native
+          Native::make_color(
+            @value.red,
+            @value.green,
+            @value.blue,
+            @value.alpha
+          )
+        end
+      end
+    end
+  end
+end

data/lib/sassc/script/value_conversion/string.rb

@@ -0,0 +1,15 @@
+module SassC
+  module Script
+    module ValueConversion
+      class String < Base
+        def to_native(opts = {})
+          if opts[:quote] == :none || @value.type == :identifier
+            Native::make_string(@value.to_s)
+          else
+            Native::make_qstring(@value.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sassc/version.rb

@@ -1,3 +1,3 @@
 module SassC
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

data/test/functions_test.rb

@@ -14,60 +14,75 @@ module SassC
     end
 
     def test_functions_may_return_sass_string_type
-      engine = Engine.new("div {url: url(sass_return_path('foo.svg'));}")
-
-      assert_equal <<-EOS, engine.render
-div {
-  url: url("foo.svg"); }
-      EOS
+      assert_sass <<-SCSS, <<-CSS
+        div { url: url(sass_return_path("foo.svg")); }
+      SCSS
+        div { url: url("foo.svg"); }
+      CSS
     end
 
     def test_functions_work_with_varying_quotes_and_string_types
-      filename = fixture_path('paths.scss')
-      data = File.read(filename)
-
-      engine = Engine.new(data, {
-        filename: filename,
-        syntax: :scss
-      })
-
-      assert_equal <<-EOS, engine.render
-div {
-  url: url(asset-path("foo.svg"));
-  url: url(image-path("foo.png"));
-  url: url(video-path("foo.mov"));
-  url: url(audio-path("foo.mp3"));
-  url: url(font-path("foo.woff"));
-  url: url("/js/foo.js");
-  url: url("/js/foo.js");
-  url: url(/css/foo.css); }
-      EOS
+      assert_sass <<-SCSS, <<-CSS
+        div {
+           url: url(asset-path("foo.svg"));
+           url: url(image-path("foo.png"));
+           url: url(video-path("foo.mov"));
+           url: url(audio-path("foo.mp3"));
+           url: url(font-path("foo.woff"));
+           url: url(javascript-path('foo.js'));
+           url: url(javascript-path("foo.js"));
+           url: url(stylesheet-path("foo.css"));
+        }
+      SCSS
+        div {
+          url: url(asset-path("foo.svg"));
+          url: url(image-path("foo.png"));
+          url: url(video-path("foo.mov"));
+          url: url(audio-path("foo.mp3"));
+          url: url(font-path("foo.woff"));
+          url: url("/js/foo.js");
+          url: url("/js/foo.js");
+          url: url(/css/foo.css);
+        }
+      CSS
     end
 
     def test_function_with_no_return_value
-      engine = Engine.new("div {url: url(no-return-path('foo.svg'));}")
+      assert_sass <<-SCSS, <<-CSS
+        div {url: url(no-return-path('foo.svg'));}
+      SCSS
+        div { url: url(); }
+      CSS
+    end
 
-      assert_equal <<-EOS, engine.render
-div {
-  url: url(); }
-      EOS
+    def test_function_that_returns_a_color
+      assert_sass <<-SCSS, <<-CSS
+        div { background: returns-a-color(); }
+      SCSS
+        div { background: black; }
+      CSS
     end
 
     def test_function_with_optional_arguments
-      engine = Engine.new("div {url: optional_arguments('first'); url: optional_arguments('second', 'qux')}")
-      assert_equal <<-EOS, engine.render
-div {
-  url: "first/bar";
-  url: "second/qux"; }
-      EOS
+      assert_sass <<-SCSS, <<-EXPECTED_CSS
+        div {
+          url: optional_arguments('first');
+          url: optional_arguments('second', 'qux');
+        }
+      SCSS
+        div {
+          url: "first/bar";
+          url: "second/qux";
+        }
+      EXPECTED_CSS
     end
 
     def test_functions_may_accept_sass_color_type
-      engine = Engine.new("div { color: nice_color_argument(red); }")
-      assert_equal <<-EOS, engine.render
-div {
-  color: "red"; }
-      EOS
+      assert_sass <<-SCSS, <<-EXPECTED_CSS
+        div { color: nice_color_argument(red); }
+      SCSS
+        div { color: "red"; }
+      EXPECTED_CSS
     end
 
     def test_function_with_unsupported_tag
@@ -77,36 +92,40 @@ div {
         engine.render
       end
 
-      assert_equal "Error: error in C function function_with_unsupported_tag: Sass argument of type sass_number unsupported\n\n       Backtrace:\n       \tstdin:1, in function `function_with_unsupported_tag`\n       \tstdin:1\n        on line 1 of stdin\n>> div {url: function_with_unsupported_tag(1);}\n   ----------^\n", exception.message
-
+      assert_match /Sass argument of type sass_number unsupported/, exception.message
       assert_equal "[SassC::FunctionsHandler] Sass argument of type sass_number unsupported", stderr_output
     end
 
     def test_function_with_error
       engine = Engine.new("div {url: function_that_raises_errors();}")
+
       exception = assert_raises(SassC::SyntaxError) do
         engine.render
       end
 
-      assert_equal "Error: error in C function function_that_raises_errors: Intentional wrong thing happened somewhere inside the custom function
-
-       Backtrace:
-       \tstdin:1, in function `function_that_raises_errors`
-       \tstdin:1
-        on line 1 of stdin
->> div {url: function_that_raises_errors();}
-   ----------^
-", exception.message
-
+      assert_match /Error: error in C function function_that_raises_errors/, exception.message
+      assert_match /Intentional wrong thing happened somewhere inside the custom function/, exception.message
       assert_equal "[SassC::FunctionsHandler] Intentional wrong thing happened somewhere inside the custom function", stderr_output
     end
 
+    def test_function_that_returns_a_sass_value
+      assert_sass <<-SCSS, <<-CSS
+        div { background: returns-sass-value(); }
+      SCSS
+        div { background: black; }
+      CSS
+    end
+
     private
 
-    SassString = Struct.new(:value, :type) do
-      def to_s
-        value
-      end
+    def assert_sass(sass, expected_css)
+      engine = Engine.new(sass)
+      assert_equal expected_css.strip.gsub!(/\s+/, " "), # poor man's String#squish
+                   engine.render.strip.gsub!(/\s+/, " ")
+    end
+
+    def stderr_output
+      $stderr.string.gsub("\u0000\n", '').chomp
     end
 
     module Script::Functions
@@ -119,14 +138,14 @@ div {
       end
 
       def sass_return_path(path)
-        return SassString.new("'#{path.value}'", :string)
+        Script::String.new("#{path.value}", :string)
       end
 
       def optional_arguments(path, optional = "bar")
-        return SassString.new("#{path}/#{optional}", :string)
+        Script::String.new("#{path.value}/#{optional}", :string)
       end
 
-      def function_that_raises_errors()
+      def function_that_raises_errors
         raise StandardError, "Intentional wrong thing happened somewhere inside the custom function"
       end
 
@@ -137,6 +156,14 @@ div {
         return Script::String.new(color.to_s, :string)
       end
 
+      def returns_a_color
+        return Script::Color.new(red: 0, green: 0, blue: 0)
+      end
+
+      def returns_sass_value
+        return Sass::Script::Value::Color.new(red: 0, green: 0, blue: 0)
+      end
+
       module Compass
         def stylesheet_path(path)
           Script::String.new("/css/#{path.value}", :identifier)
@@ -144,9 +171,5 @@ div {
       end
       include Compass
     end
-
-    def stderr_output
-      $stderr.string.gsub("\u0000\n", '')
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sassc
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Ryan Boland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-12 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -301,9 +301,11 @@ files:
 - lib/sassc/native/string_list.rb
 - lib/sassc/sass_2_scss.rb
 - lib/sassc/script.rb
-- lib/sassc/script/color.rb
 - lib/sassc/script/functions.rb
-- lib/sassc/script/string.rb
+- lib/sassc/script/value_conversion.rb
+- lib/sassc/script/value_conversion/base.rb
+- lib/sassc/script/value_conversion/color.rb
+- lib/sassc/script/value_conversion/string.rb
 - lib/sassc/version.rb
 - lib/tasks/libsass.rb
 - sassc.gemspec

data/lib/sassc/script/color.rb

@@ -1,11 +0,0 @@
-require 'sass/script/value/color'
-
-module SassC
-  module Script
-    class Color < ::Sass::Script::Value::Color
-      def to_native
-        Native::make_string(to_s)
-      end
-    end
-  end
-end

data/lib/sassc/script/string.rb

@@ -1,103 +0,0 @@
-module SassC
-  module Script
-    class String
-      # The Ruby value of the string.
-      #
-      # @return [String]
-      attr_reader :value
-
-      # Whether this is a CSS string or a CSS identifier.
-      # The difference is that strings are written with double-quotes,
-      # while identifiers aren't.
-      #
-      # @return [Symbol] `:string` or `:identifier`
-      attr_reader :type
-
-      def self.value(contents)
-        contents.gsub("\\\n", "").gsub(/\\(?:([0-9a-fA-F]{1,6})\s?|(.))/) do
-          next $2 if $2
-          # Handle unicode escapes as per CSS Syntax Level 3 section 4.3.8.
-          code_point = $1.to_i(16)
-          if code_point == 0 || code_point > 0x10FFFF ||
-              (code_point >= 0xD800 && code_point <= 0xDFFF)
-            '�'
-          else
-            [code_point].pack("U")
-          end
-        end
-      end
-
-      def self.quote(contents, quote = nil)
-        # Short-circuit if there are no characters that need quoting.
-        unless contents =~ /[\n\\"']/
-          quote ||= '"'
-          return "#{quote}#{contents}#{quote}"
-        end
-
-        if quote.nil?
-          if contents.include?('"')
-            if contents.include?("'")
-              quote = '"'
-            else
-              quote = "'"
-            end
-          else
-            quote = '"'
-          end
-        end
-
-        # Replace single backslashes with multiples.
-        contents = contents.gsub("\\", "\\\\\\\\")
-
-        if quote == '"'
-          contents = contents.gsub('"', "\\\"")
-        else
-          contents = contents.gsub("'", "\\'")
-        end
-
-        contents = contents.gsub(/\n(?![a-fA-F0-9\s])/, "\\a").gsub("\n", "\\a ")
-        "#{quote}#{contents}#{quote}"
-      end
-
-      def self.type(contents)
-        unquote(contents) == contents ? :identifier : :string
-      end
-
-      def self.unquote(contents)
-        s = contents.dup
-
-        case contents[0, 1]
-        when "'", '"', '`'
-          s[0] = ''
-        end
-
-        case contents[-1, 1]
-        when "'", '"', '`'
-          s[-1] = ''
-        end
-
-        return s
-      end
-
-      # Creates a new string.
-      #
-      # @param value [String] See \{#value}
-      # @param type [Symbol] See \{#type}
-      def initialize(value, type = :identifier)
-        value.freeze unless value.nil? || value == true || value == false
-        @value = value
-        @type = type
-      end
-
-      def to_native
-        Native::make_string(to_s)
-      end
-
-      # @see Value#to_s
-      def to_s(opts = {})
-        return @value.gsub(/\n\s*/, ' ') if opts[:quote] == :none || @type == :identifier
-        SassC::Script::String.quote(value, opts[:quote])
-      end
-    end
-  end
-end