sassc 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9be84b195a429b61aff99dbfc6f9519d5cb0fde8
-  data.tar.gz: 4cb83e248f3ad95eed85bf61691bf3adf11af5a7
+  metadata.gz: 7a212192b55be4390eb3420aefcbb2b9c0240852
+  data.tar.gz: 24aa593a9b043f454dd0da299cc18572eb480bee
 SHA512:
-  metadata.gz: 4f4cd497fd81d8467d81f7b641238c2c948829b0640b1d26df25d2c33c78e0b3cec60ff3b79734f3fc1dbad6c483b0e70840e761b00c2cf58b102fb11fd2a478
-  data.tar.gz: 48e9398643a1472b4b807d5fcfb52d5b1a060d384dda86d3b7c83e1f88444b47197bf50efc92316ff9ff4af146b14f4252f8469f08634ebdda13b99026e3ec3e
+  metadata.gz: e04ff420d46edf08fc4cf3a330d35f0212ddf294e6228e20768d86c9cc9ef628863477e34e3f143c2fd546a9979781701a3c991d44cb8c908f6062eceef6c1ca
+  data.tar.gz: 2a356fd1f4f954d4cd8a60c9e79eba076398d60afa48822fe12f51edf58738ea79bf83f4eb60dcb07395d9ebcdba7a937277f4e6d6a59bb37e0561633c4816fd

data/.travis.yml

@@ -3,7 +3,8 @@ language: ruby
 bundler_args: "--binstubs --standalone --without documentation --path ../bundle"
 script: "bundle exec rake test"
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.5
   - 2.2.0
+notifications:
+  email: false

data/README.md

@@ -1,10 +1,12 @@
-# SassC [![Build Status](https://travis-ci.org/bolandrm/sassc.svg?branch=master)](https://travis-ci.org/bolandrm/sassc) [![Gem Version](https://badge.fury.io/rb/sassc.svg)](http://badge.fury.io/rb/sassc)
+# SassC [![Build Status](https://travis-ci.org/bolandrm/sassc-ruby.svg?branch=master)](https://travis-ci.org/bolandrm/sassc-ruby) [![Gem Version](https://badge.fury.io/rb/sassc.svg)](http://badge.fury.io/rb/sassc)
 
-TODO: Write a gem description
+Use `libsass` with Ruby!
 
-## Usage
+This gem combines the speed of `libsass`, the [Sass C implementation](https://github.com/sass/libsass), with the easy of use of the original [Ruby Sass](https://github.com/sass/sass) library.
 
-TODO: Write usage instructions here
+### libsass Version
+
+[3.1.0](https://github.com/sass/libsass/releases/tag/3.1.0)
 
 ## Contributing
 

data/lib/sassc.rb

@@ -4,3 +4,7 @@ end
 require_relative "sassc/version"
 require_relative "sassc/native"
 require_relative "sassc/engine"
+require_relative "sassc/script"
+require_relative "sassc/cache_stores"
+require_relative "sassc/dependency"
+require_relative "sassc/error"

data/lib/sassc/cache_stores.rb

@@ -0,0 +1,6 @@
+module SassC
+  module CacheStores
+  end
+end
+
+require_relative "cache_stores/base"

data/lib/sassc/cache_stores/base.rb

@@ -0,0 +1,6 @@
+module SassC
+  module CacheStores
+    class Base
+    end
+  end
+end

data/lib/sassc/dependency.rb

@@ -0,0 +1,13 @@
+module SassC
+  class Dependency
+    attr_reader :options
+
+    def initialize(filename)
+      @options = { filename: filename }
+    end
+
+    def self.from_filenames(filenames)
+      filenames.map { |f| new(f) }
+    end
+  end
+end

data/lib/sassc/engine.rb

@@ -1,13 +1,61 @@
 module SassC
   class Engine
+    class NotRenderedError < StandardError; end
+
     def initialize(template, options = {})
-      #@options = self.class.normalize_options(options)
       @template = template
+      @options = options
     end
 
     def render
-      return _to_tree.render unless @options[:quiet]
-      Sass::Util.silence_sass_warnings {_to_tree.render}
+      data_context = Native.make_data_context(@template)
+      context = Native.data_context_get_context(data_context)
+      options = Native.context_get_options(context)
+
+      Native.option_set_is_indented_syntax_src(options, true) if sass?
+      Native.option_set_input_path(options, filename) if filename
+      Native.option_set_include_path(options, load_paths)
+
+      status = Script.setup_custom_functions(options, @options) do
+        Native.compile_data_context(data_context)
+      end
+
+      css = Native.context_get_output_string(context)
+
+      if status != 0
+        message = SassC::Native.context_get_error_message(context)
+        raise SyntaxError.new(message)
+      end
+
+      @dependencies = Native.context_get_included_files(context)
+
+      Native.delete_data_context(data_context)
+
+      return css unless quiet?
+    end
+
+    def dependencies
+      raise NotRenderedError unless @dependencies
+      Dependency.from_filenames(@dependencies)
+    end
+
+    private
+
+    def quiet?
+      @options[:quiet]
+    end
+
+    def filename
+      @options[:filename]
+    end
+
+    def sass?
+      @options[:syntax] && @options[:syntax].to_sym == :sass
+    end
+
+    def load_paths
+      paths = @options[:load_paths]
+      paths.join(":") if paths
     end
   end
 end

data/lib/sassc/error.rb

@@ -0,0 +1,4 @@
+module SassC
+  class SyntaxError < StandardError
+  end
+end

data/lib/sassc/native.rb

@@ -38,7 +38,7 @@ module SassC
 
     # https://github.com/ffi/ffi/wiki/Examples#array-of-strings
     def self.return_string_array(ptr)
-      ptr.read_pointer.null? ? [] : ptr.get_array_of_string(0).compact
+      ptr.null? ? [] : ptr.get_array_of_string(0).compact
     end
 
     require_relative "native/native_context_api"

data/lib/sassc/native/native_functions_api.rb

@@ -23,6 +23,10 @@ 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 size_t ADDCALL sass_list_get_length(const union Sass_Value* v)
+    # ADDAPI union Sass_Value* ADDCALL sass_list_get_value (const union Sass_Value* v, size_t i);
+    attach_function :sass_list_get_length, [:sass_value_ptr], :size_t
+    attach_function :sass_list_get_value, [:sass_value_ptr, :size_t], :sass_value_ptr
 
     # Getters for custom function descriptors
     # ADDAPI const char* ADDCALL sass_function_get_signature (Sass_C_Function_Callback fn);

data/lib/sassc/script.rb

@@ -0,0 +1,71 @@
+module SassC
+  module Script
+    def self.custom_functions
+      Functions.instance_methods.select do |function|
+        Functions.public_method_defined?(function)
+      end
+    end
+
+    def self.setup_custom_functions(options, sass_options)
+      callbacks = {}
+
+      list = Native.make_function_list(custom_functions.count)
+
+      functs = Class.new.extend(Functions)
+      def functs.options=(opts)
+        @sass_options = opts
+      end
+      def functs.options
+        @sass_options
+      end
+      functs.options = sass_options
+
+      custom_functions.each_with_index do |custom_function, i|
+        callbacks[custom_function] = FFI::Function.new(:pointer, [:pointer, :pointer]) do |s_args, cookie|
+          length = Native.list_get_length(s_args)
+
+          v = Native.list_get_value(s_args, 0)
+          v = Native.string_get_value(v).dup
+
+          s = String.new(String.unquote(v), String.type(v))
+
+          value = functs.send(custom_function, s)
+
+          if value
+            value.to_native
+          else
+            String.new("").to_native
+          end
+        end
+
+        callback = Native.make_function(
+          formatted_function_name(custom_function),
+          callbacks[custom_function],
+          nil
+        )
+
+        Native::function_set_list_entry(list, i, callback)
+      end
+
+      Native::option_set_c_functions(options, list)
+
+      status = yield
+
+      callbacks
+
+      status
+    end
+
+    def self.formatted_function_name(function_name)
+      params = Functions.instance_method(function_name).parameters
+      params = params.select { |param| param[0] == :req }
+                     .map(&:first)
+                     .map { |p| "$#{p}" }
+                     .join(", ")
+      "#{function_name}(#{params})"
+    end
+  end
+end
+
+require_relative "script/functions"
+require_relative "script/string"

data/lib/sassc/script/functions.rb

@@ -0,0 +1,6 @@
+module SassC
+  module Script
+    module Functions
+    end
+  end
+end

data/lib/sassc/script/string.rb

@@ -0,0 +1,103 @@
+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

data/lib/sassc/version.rb

@@ -1,3 +1,3 @@
 module SassC
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/sassc.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = SassC::VERSION
   spec.authors       = ["Ryan Boland"]
   spec.email         = ["bolandryanm@gmail.com"]
-  spec.summary       = "Use Libsass with Ruby!"
-  spec.description   = "Use Libsass with Ruby!"
+  spec.summary       = "Use libsass with Ruby!"
+  spec.description   = "Use libsass with Ruby!"
   spec.homepage      = "https://github.com/bolandrm/sassc-ruby"
   spec.license       = "MIT"
 

data/test/engine_test.rb

@@ -0,0 +1,122 @@
+require_relative "test_helper"
+
+class EngineTest < SassCTest
+  def render(data)
+    SassC::Engine.new(data).render
+  end
+
+  def test_one_line_comments
+    assert_equal <<CSS, render(<<SCSS)
+.foo {
+  baz: bang; }
+CSS
+.foo {// bar: baz;}
+  baz: bang; //}
+}
+SCSS
+    assert_equal <<CSS, render(<<SCSS)
+.foo bar[val="//"] {
+  baz: bang; }
+CSS
+.foo bar[val="//"] {
+  baz: bang; //}
+}
+SCSS
+  end
+
+  def test_variables
+    assert_equal <<CSS, render(<<SCSS)
+blat {
+  a: foo; }
+CSS
+$var: foo;
+
+blat {a: $var}
+SCSS
+
+    assert_equal <<CSS, render(<<SCSS)
+foo {
+  a: 2;
+  b: 6; }
+CSS
+foo {
+  $var: 2;
+  $another-var: 4;
+  a: $var;
+  b: $var + $another-var;}
+SCSS
+  end
+
+  def test_dependency_filenames_are_reported
+    within_construct do |construct|
+      construct.file("not_included.scss", "$size: 30px;")
+      construct.file("import_parent.scss", "$size: 30px;")
+      construct.file("import.scss", "@import 'import_parent'; $size: 30px;")
+      construct.file("styles.scss", "@import 'import.scss'; .hi { width: $size; }")
+
+      engine = SassC::Engine.new(File.read("styles.scss"))
+      engine.render
+      deps = engine.dependencies
+      filenames = deps.map { |dep| dep.options[:filename] }.sort
+
+      assert_equal ["import.scss", "import_parent.scss"], filenames
+    end
+  end
+
+  def test_no_dependencies
+    engine = SassC::Engine.new("$size: 30px;")
+    engine.render
+    deps = engine.dependencies
+    assert_equal [], deps
+  end
+
+  def test_not_rendered_error
+    engine = SassC::Engine.new("$size: 30px;")
+    assert_raises(SassC::Engine::NotRenderedError) { engine.dependencies }
+  end
+
+  def test_load_paths
+    within_construct do |c|
+      c.directory("included_1")
+      c.directory("included_2")
+
+      c.file("included_1/import_parent.scss", "$s: 30px;")
+      c.file("included_2/import.scss", "@import 'import_parent'; $size: $s;")
+      c.file("styles.scss", "@import 'import.scss'; .hi { width: $size; }")
+
+      assert_equal ".hi {\n  width: 30px; }\n", SassC::Engine.new(
+        File.read("styles.scss"),
+        load_paths: [ "included_1", "included_2" ]
+      ).render
+    end
+  end
+
+  def test_load_paths_not_configured
+    within_construct do |c|
+      c.file("included_1/import_parent.scss", "$s: 30px;")
+      c.file("included_2/import.scss", "@import 'import_parent'; $size: $s;")
+      c.file("styles.scss", "@import 'import.scss'; .hi { width: $size; }")
+
+      assert_raises(SassC::SyntaxError) {
+        SassC::Engine.new(File.read("styles.scss")).render
+      }
+    end
+  end
+
+  def test_sass_variation
+    sass = <<SASS
+$size: 30px
+.foo
+  width: $size
+SASS
+
+    css = <<CSS
+.foo {
+  width: 30px; }
+CSS
+
+    assert_equal css, SassC::Engine.new(sass, syntax: :sass).render
+    assert_equal css, SassC::Engine.new(sass, syntax: "sass").render
+    assert_raises(SassC::SyntaxError) { SassC::Engine.new(sass).render }
+  end
+end

data/test/fixtures/paths.scss

@@ -0,0 +1,10 @@
+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"));
+}

data/test/functions_test.rb

@@ -0,0 +1,57 @@
+require_relative "test_helper"
+
+class FunctionsTest < SassCTest
+  module ::SassC::Script::Functions
+    def javascript_path(path)
+      ::SassC::Script::String.new("/js/#{path.value}", :string)
+    end
+
+    def no_return_path(path)
+      nil
+    end
+
+    module Compass
+      def stylesheet_path(path)
+        ::SassC::Script::String.new("/css/#{path.value}", :identifier)
+      end
+    end
+    include Compass
+  end
+
+  def test_functions_work
+    filename = fixture_path('paths.scss')
+    assert data = File.read(filename)
+
+    engine = ::SassC::Engine.new(data, {
+      filename: filename,
+      syntax: :scss
+    })
+
+    # test identifier / string types
+    # test varying quotes
+
+    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
+  end
+
+  def test_function_with_no_return_value
+    filename = fixture_path('paths.scss')
+    assert data = File.read(filename)
+
+    engine = ::SassC::Engine.new("div {url: url(no-return-path('foo.svg'));}")
+
+    assert_equal <<-EOS, engine.render
+div {
+  url: url(); }
+      EOS
+  end
+end

data/test/{smoke_test.rb → native_test.rb}

@@ -1,18 +1,17 @@
 require_relative "test_helper"
-require "sassc"
 
-module SmokeTest
+module NativeTest
   SAMPLE_SASS_STRING = "$size: 30px; .hi { width: $size; }"
   SAMPLE_CSS_OUTPUT = ".hi {\n  width: 30px; }\n"
   BAD_SASS_STRING = "$size = 30px;"
 
-  class General < MiniTest::Test
+  class General < SassCTest
     def test_it_reports_the_libsass_version
       assert_equal "3.1.0", SassC::Native.version
     end
   end
 
-  class DataContext < MiniTest::Test
+  class DataContext < SassCTest
     def teardown
       SassC::Native.delete_data_context(@data_context)
     end
@@ -90,9 +89,7 @@ module SmokeTest
     end
   end
 
-  class FileContext < MiniTest::Test
-    include TestConstruct::Helpers
-
+  class FileContext < SassCTest
     def around
       within_construct do |construct|
         @construct = construct

data/test/test_helper.rb

@@ -2,3 +2,28 @@ require "minitest/autorun"
 require "minitest/pride"
 require "minitest/around/unit"
 require "test_construct"
+
+require "sassc"
+
+class SassCTest < MiniTest::Test
+  include TestConstruct::Helpers
+
+  FIXTURE_ROOT = File.expand_path(File.join(File.dirname(__FILE__), "fixtures"))
+
+  def self.test(name, &block)
+    define_method("test_#{name.inspect}", &block)
+  end
+
+  def fixture(path)
+    IO.read(fixture_path(path))
+  end
+
+  def fixture_path(path)
+    if path.match(FIXTURE_ROOT)
+      path
+    else
+      File.join(FIXTURE_ROOT, path)
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sassc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Ryan Boland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-01 00:00:00.000000000 Z
+date: 2015-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.9.6
-description: Use Libsass with Ruby!
+description: Use libsass with Ruby!
 email:
 - bolandryanm@gmail.com
 executables: []
@@ -239,7 +239,11 @@ files:
 - ext/libsass/win/libsass.sln
 - ext/libsass/win/libsass.vcxproj
 - lib/sassc.rb
+- lib/sassc/cache_stores.rb
+- lib/sassc/cache_stores/base.rb
+- lib/sassc/dependency.rb
 - lib/sassc/engine.rb
+- lib/sassc/error.rb
 - lib/sassc/native.rb
 - lib/sassc/native/native_context_api.rb
 - lib/sassc/native/native_functions_api.rb
@@ -247,9 +251,15 @@ files:
 - lib/sassc/native/sass_output_style.rb
 - lib/sassc/native/sass_value.rb
 - lib/sassc/native/string_list.rb
+- lib/sassc/script.rb
+- lib/sassc/script/functions.rb
+- lib/sassc/script/string.rb
 - lib/sassc/version.rb
 - sassc.gemspec
-- test/smoke_test.rb
+- test/engine_test.rb
+- test/fixtures/paths.scss
+- test/functions_test.rb
+- test/native_test.rb
 - test/test_helper.rb
 homepage: https://github.com/bolandrm/sassc-ruby
 licenses:
@@ -275,7 +285,10 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Use Libsass with Ruby!
+summary: Use libsass with Ruby!
 test_files:
-- test/smoke_test.rb
+- test/engine_test.rb
+- test/fixtures/paths.scss
+- test/functions_test.rb
+- test/native_test.rb
 - test/test_helper.rb