jekyll-sass-converter 1.0.0.alpha.1 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82e58fdd63ea4f8cfb532b9eb0c9bb38d4f7fdb9
-  data.tar.gz: 611747a8002674cb0d09a015bae27bcf03f86432
+  metadata.gz: 4a5a330647c5fc08383c7fa2e975581efb5f5e2d
+  data.tar.gz: 70b8fbc1a5c00bfbfae9860505de0ef96471a6b3
 SHA512:
-  metadata.gz: 20434be7cdd16f2afb7ddc29fd615ff851e5711a595d8d54e114faafb5348dd98a93bb9cc313c20718d6b504741362a5a6d3cc6e8991a7845f1b31eb8128a077
-  data.tar.gz: a3aa0f296be45cde68c54db43f9d392da0d8c43c3cb0fbd4e781fbc3b7c6bf3fc3cc92898ffe3ad821ca7397079744acdc22a64d6f54e6f7b87670cd1f986518
+  metadata.gz: e295fa24ed3f62353c8f525a7f803f6139305a238f8b0fa554a163a3dedbc19c1a9f6ca6be0ef6bd13a57b11ad665aafe73c11106143a2b04fc974d46c5220e8
+  data.tar.gz: 03786d64805e0578ae2a52346c53a4f64e60ba52f1308b88ee6630304e029d10c2b17c193691f096172151587f460cc8889e8e96e2cae4bc34f2828c69fe96ea

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.sass-cache
 .yardoc
 Gemfile.lock
 InstalledFiles

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script : script/cibuild
+rvm:
+- 2.1.0
+- 2.0.0
+- 1.9.3
+notifications:
+  email: false

data/README.md

@@ -1,9 +1,14 @@
-# Jekyll::Sass::Converter
+# Jekyll Sass Converter
 
-TODO: Write a gem description
+Let Jekyll build your Sass and SCSS!
+
+[![Build Status](https://travis-ci.org/jekyll/jekyll-sass-converter.png?branch=master)](https://travis-ci.org/jekyll/jekyll-sass-converter)
 
 ## Installation
 
+**Jekyll Sass Converter requires Jekyll 2.0.0 or greater and is bundled
+with Jekyll so you don't need to install it if you're already using Jekyll.**
+
 Add this line to your application's Gemfile:
 
     gem 'jekyll-sass-converter'
@@ -18,11 +23,13 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Jekyll Sass Converter comes bundled with Jekyll 2.0.0 and greater. For more
+information about usage, visit the [Jekyll Assets Documentation
+page](http://jekyllrb.com/docs/assets/).
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/jekyll-sass-converter/fork )
+1. Fork it ( http://github.com/jekyll/jekyll-sass-converter/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/jekyll-sass-converter.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "jekyll"
+  spec.add_development_dependency "rspec"
 end

data/lib/jekyll/converters/sass.rb

@@ -1,55 +1,64 @@
+require 'sass'
+
 module Jekyll
-  class Sass < Converter
-    safe true
-    priority :low
+  module Converters
+    class Sass < Converter
+      safe true
+      priority :low
 
-    def matches(ext)
-      ext =~ /^\.s(a|c)ss$/i
-    end
+      def matches(ext)
+        ext =~ /^\.s(a|c)ss$/i
+      end
 
-    def output_ext(ext)
-      ".css"
-    end
+      def output_ext(ext)
+        ".css"
+      end
 
-    def jekyll_sass_configuration
-      @config["sass"] || {}
-    end
+      def jekyll_sass_configuration
+        @config["sass"] || {}
+      end
 
-    def sass_build_configuration_options(overrides)
-      jekyll_sass_configuration.deep_merge(overrides).symbolize_keys
-    end
+      def sass_build_configuration_options(overrides)
+        jekyll_sass_configuration.deep_merge(overrides).symbolize_keys
+      end
 
-    def syntax_type_of_content(content)
-      if content.include?(";") || content.include?("{")
-        :scss
-      else
-        :sass
+      def syntax_type_of_content(content)
+        if content.include?(";") || content.include?("{")
+          :scss
+        else
+          :sass
+        end
       end
-    end
 
-    def sass_dir
-      return "_sass" if jekyll_sass_configuration["sass_dir"].to_s.empty?
-      jekyll_sass_configuration["sass_dir"]
-    end
+      def sass_dir
+        return "_sass" if jekyll_sass_configuration["sass_dir"].to_s.empty?
+        jekyll_sass_configuration["sass_dir"]
+      end
 
-    def sass_dir_relative_to_site_source
-      Jekyll.sanitized_path(@config["source"], sass_dir)
-    end
+      def sass_dir_relative_to_site_source
+        # FIXME: Not Windows-safe. Can only change once Jekyll 2.0.0 is out
+        # Jekyll.sanitized_path(@config["source"], sass_dir)
+        File.join(
+          @config["source"],
+          File.expand_path(sass_dir, "/")
+        )
+      end
 
-    def allow_caching?
-      !@config["safe"]
-    end
+      def allow_caching?
+        !@config["safe"]
+      end
 
-    def sass_configs(content = "")
-      sass_build_configuration_options({
-        "syntax" => syntax_type_of_content(content),
-        "cache"  => allow_caching?,
-        "load_paths" => [sass_dir_relative_to_site_source]
-      })
-    end
+      def sass_configs(content = "")
+        sass_build_configuration_options({
+          "syntax" => syntax_type_of_content(content),
+          "cache"  => allow_caching?,
+          "load_paths" => [sass_dir_relative_to_site_source]
+        })
+      end
 
-    def convert(content)
-      ::Sass.compile(content, sass_configs(content))
+      def convert(content)
+        ::Sass.compile(content, sass_configs(content))
+      end
     end
   end
 end

data/lib/jekyll-sass-converter/version.rb

@@ -1,3 +1,3 @@
 module JekyllSassConverter
-  VERSION = "1.0.0.alpha.1"
+  VERSION = "1.0.0.rc1"
 end

data/lib/jekyll-sass-converter.rb

@@ -1,6 +1,4 @@
 require "jekyll-sass-converter/version"
-
-require "jekyll"
 require "jekyll/converters/sass"
 
 module JekyllSassConverter

data/spec/dest/css/main.css

@@ -0,0 +1,2 @@
+.half {
+  width: 50%; }

data/spec/sass_coverter_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe(Jekyll::Converters::Sass) do
+  let(:site) do
+    Jekyll::Site.new(site_configuration)
+  end
+  let(:sass_content) do
+    <<-SASS
+$font-stack: Helvetica, sans-serif
+body
+  font-family: $font-stack
+  font-color: fuschia
+SASS
+  end
+  let(:scss_content) do
+    <<-SCSS
+$font-stack: Helvetica, sans-serif;
+body {
+  font-family: $font-stack;
+  font-color: fuschia;
+}
+SCSS
+  end
+  let(:css_output) do
+    <<-CSS
+body {\n  font-family: Helvetica, sans-serif;\n  font-color: fuschia; }
+CSS
+  end
+
+  def converter(overrides = {})
+    Jekyll::Converters::Sass.new(site_configuration({"sass" => overrides}))
+  end
+
+  context "matching file extensions" do
+    it "matches .scss files" do
+      expect(converter.matches(".scss")).to be_true
+    end
+
+    it "matches .sass files" do
+      expect(converter.matches(".sass")).to be_true
+    end
+  end
+
+  context "determining the output file extension" do
+    it "always outputs the .css file extension" do
+      expect(converter.output_ext(".always-css")).to eql(".css")
+    end
+  end
+
+  context "when building configurations" do
+    it "not allow caching in safe mode" do
+      verter = converter
+      verter.instance_variable_get(:@config)["safe"] = true
+      expect(verter.sass_configs[:cache]).to be_false
+    end
+
+    it "allow caching in unsafe mode" do
+      expect(converter.sass_configs[:cache]).to be_true
+    end
+
+    it "set the load paths to the _sass dir relative to site source" do
+      expect(converter.sass_configs[:load_paths]).to eql([source_dir("_sass")])
+    end
+
+    it "allow the user to specify a different sass dir" do
+      expect(converter({"sass_dir" => "_scss"}).sass_configs[:load_paths]).to eql([source_dir("_scss")])
+    end
+
+    it "set syntax :scss when SCSS content" do
+      expect(converter.sass_configs(scss_content)[:syntax]).to eql(:scss)
+    end
+
+    it "set syntax :sass when Sass content" do
+      expect(converter.sass_configs(sass_content)[:syntax]).to eql(:sass)
+    end
+
+    it "default to :sass syntax when content is empty" do
+      expect(converter.sass_configs[:syntax]).to eql(:sass)
+    end
+
+    it "not allow sass_dirs outside of site source" do
+      expect(
+        converter({"sass_dir" => "/etc/passwd"}).sass_dir_relative_to_site_source
+      ).to eql(source_dir("etc/passwd"))
+    end
+
+    it "override user-set syntax based on content" do
+      expect(
+        converter({"syntax" => :scss}).sass_configs(sass_content)[:syntax]
+      ).to eql(:sass)
+    end
+  end
+
+  context "converting sass" do
+    it "produces CSS" do
+      expect(converter.convert(sass_content)).to eql(css_output)
+    end
+  end
+
+  context "converting SCSS" do
+    it "produces CSS" do
+      expect(converter.convert(scss_content)).to eql(css_output)
+    end
+  end
+
+  context "importing partials" do
+    let(:test_css_file) { dest_dir("css/main.css") }
+    before(:each) { site.process }
+
+    it "outputs the CSS file" do
+      expect(File.exist?(test_css_file)).to be_true
+    end
+
+    it "imports SCSS partial" do
+      expect(File.read(test_css_file)).to eql(".half {\n  width: 50%; }\n")
+    end
+  end
+end

data/spec/source/_sass/_grid.scss

@@ -0,0 +1 @@
+.half { width: 50%; }

data/spec/source/css/main.scss

@@ -0,0 +1,4 @@
+---
+---
+
+@import "grid";

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+require 'fileutils'
+require 'jekyll'
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-sass-converter'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  SOURCE_DIR = File.expand_path("../source", __FILE__)
+  DEST_DIR   = File.expand_path("../dest",   __FILE__)
+  FileUtils.rm_rf(DEST_DIR)
+  FileUtils.mkdir_p(DEST_DIR)
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  end
+
+  def site_configuration(overrides = {})
+    Jekyll::Configuration::DEFAULTS.deep_merge(overrides).deep_merge({
+      "source" => source_dir,
+      "destination" => dest_dir
+    })
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sass-converter
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.1
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Parker Moore
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - parkrmoore@gmail.com
@@ -74,6 +88,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -85,6 +101,11 @@ files:
 - script/bootstrap
 - script/cibuild
 - script/release
+- spec/dest/css/main.css
+- spec/sass_coverter_spec.rb
+- spec/source/_sass/_grid.scss
+- spec/source/css/main.scss
+- spec/spec_helper.rb
 homepage: https://github.com/jekyll/jekyll-sass-converter
 licenses:
 - MIT
@@ -109,4 +130,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A basic Sass converter for Jekyll.
-test_files: []
+test_files:
+- spec/dest/css/main.css
+- spec/sass_coverter_spec.rb
+- spec/source/_sass/_grid.scss
+- spec/source/css/main.scss
+- spec/spec_helper.rb