jekyll-sass 1.1.0 → 1.2.0

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Roger López, Jason Kozak, Joe Buszkiewic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/jekyll-sass.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('jekyll', [">= 0.10.0"])
   s.add_runtime_dependency('sass', [">= 3.0.0"])
+  s.add_runtime_dependency('colorator', "~> 0.1")
 end

data/lib/jekyll-sass.rb

@@ -1,32 +1,50 @@
 require "jekyll-sass/version"
+require "colorator"
 
 module Jekyll
   module Sass
     require 'sass'
 
     class SassConfig
-      def self.generate()
-        config = Hash["style", :compressed, "syntax", :scss]
-        if Jekyll.configuration({}).has_key?('sass')
-          config.merge!(Jekyll.configuration({})['sass']) {|key,v1,v2| v2.to_sym}
+      def self.style(site)
+        if site.config['watch']
+          style = site.config['sass']['style'] || 'expanded'
+        else
+          style = site.config['sass']['deploy_style'] ||
+            site.config['sass']['style'] ||
+            'compressed'
         end
-        config
+        style.to_sym
       end
 
-      def self.get()
-        @config ||= generate()
+      def self.line_comments(site)
+        should_comment = false
+        if site.config['watch'] && self.style(site).to_s == 'expanded'
+          should_comment = true
+        end
+        should_comment
+      end
+
+      def self.compile_in_place?(site)
+        site.config['sass']['compile_in_place']
       end
     end
 
     class SassCssFile < StaticFile
+      class << self
+        attr_accessor :should_write_sass
+      end
 
       # Obtain destination path.
       #   +dest+ is the String path to the destination dir
       #
       # Returns destination file path.
       def destination(dest)
-        syntax = SassConfig.get()['syntax'].to_s
-        File.join(dest, @dir, @name.sub(/#{syntax}$/, 'css'))
+        File.join(dest, @dir, File.basename(@name, ".*") + ".css")
+      end
+
+      def in_place_destination(dest)
+        File.join(File.dirname(path), File.basename(@name, ".*") + ".css")
       end
 
       # Convert the sass/scss file into a css file.
@@ -34,28 +52,37 @@ module Jekyll
       #
       # Returns false if the file was not modified since last time (no-op).
       def write(dest)
-        config = SassConfig.get()
-        dest_path = destination(dest)
+        return false if !SassCssFile.should_write_sass
 
-        return false if File.exist? dest_path and !modified?
         @@mtimes[path] = mtime
-
+        dest_path = destination(dest)
         FileUtils.mkdir_p(File.dirname(dest_path))
         begin
-          content = File.read(path)
-          engine = ::Sass::Engine.new( content, :syntax => config['syntax'], :load_paths => ["#{@site.source}#{@dir}"], :style => config['style'] )
+          engine = ::Sass::Engine.for_file(path,
+                                           :style => SassConfig.style(@site),
+                                           :line_comments => SassConfig.line_comments(@site))
           content = engine.render
           File.open(dest_path, 'w') do |f|
             f.write(content)
           end
-        rescue => e
-          STDERR.puts "Sass failed generating '#{dest_path}': #{e.message}"
+          if SassConfig.compile_in_place?(@site)
+            in_place_dest_path = in_place_destination(dest)
+            File.open(in_place_dest_path, 'w') do |f|
+              f.write(content)
+            end
+          end
+        rescue ::Sass::SyntaxError => e
+          STDERR.puts "Sass failed generating '#{e.sass_filename}' line:#{e.sass_line} '#{e.message}'".red
           false
         end
-
         true
       end
+    end
 
+    class SuppressedSassFile < StaticFile
+      def update_mtime
+        @@mtimes[path] = mtime
+      end
     end
 
     class SassCssGenerator < Generator
@@ -65,18 +92,93 @@ module Jekyll
       # objects to the static_files array.  Here we replace those with a
       # SassCssFile object.
       def generate(site)
-        syntax = SassConfig.get()['syntax'].to_s
         site.static_files.clone.each do |sf|
-          if sf.kind_of?(Jekyll::StaticFile) && sf.path =~ /\.#{syntax}$/
+          if sf.path =~ /\.(scss|sass)$/
             site.static_files.delete(sf)
             name = File.basename(sf.path)
             destination = File.dirname(sf.path).sub(site.source, '')
-            site.static_files << SassCssFile.new(site, site.source, destination, name)
+            sass_file =  SassCssFile.new(site, site.source, destination, name)
+            if sass_file.modified?
+              SassCssFile.should_write_sass = true
+            end
+            site.static_files << sass_file
           end
         end
+        supp_files = suppressed_sass_files(site)
+        if suppressed_files_modified?(supp_files)
+          SassCssFile.should_write_sass = true
+          update_files_mtime(supp_files)
+        end
       end
 
-    end
+      def suppressed_files_modified?(files)
+        files.each do |file|
+          return true if file.modified?
+        end
+        return false
+      end
 
+      def update_files_mtime(files)
+        files.each do |file|
+          file.update_mtime
+        end
+      end
+
+      def suppressed_sass_files(site)
+        sass_matcher = /^_.*\.(sass|scss)/
+        suppressed_sass_paths = recursively_search_directories(site, sass_matcher)
+        files = [ ]
+        suppressed_sass_paths.each do |path|
+          name = File.basename(path)
+          destination = File.dirname(path).sub(site.source, '')
+          files << SuppressedSassFile.new(site, site.source, destination, name)
+        end
+        return files
+      end
+
+      # Recursively find files in site that match a regexp
+      # Does not ignore underscored files
+      # This could probably be shortened but
+      # we need to search like jekyll searches
+      #
+      # site - The Jekyll site
+      # matcher - a regexp for the filename's to find
+      # dir - the relative directory to recurse in
+      #
+      # Returns an Array of absolute paths that match
+      def recursively_search_directories(site, matcher, dir = '')
+        base = File.join(site.source, dir)
+        entries = Dir.chdir(base) { filter_files(Dir.entries('.'), site) }
+        found = [ ]
+        entries.each do |f|
+          f_abs = File.join(base, f)
+          found << f_abs if matcher.match(f)
+          if File.directory?(f_abs)
+            f_rel = File.join(dir, f)
+            if site.dest.sub(/\/$/, '') != f_abs
+              more_found = recursively_search_directories(site, matcher, f_rel)
+              found.concat(more_found)
+            end
+          end
+        end
+        return found
+      end
+
+      # Filter out any files/directories that are specifically
+      # excluded in the site config
+      #
+      # entries - The Array of String file/directory entries to filter.
+      #
+      # Returns the Array of filtered entries.
+      def filter_files(entries, site)
+        entries.reject do |e|
+          unless site.include.glob_include?(e)
+            ['.', '#'].include?(e[0..0]) ||
+            site.exclude.glob_include?(e) ||
+            (File.symlink?(e) && site.safe)
+          end
+        end
+      end
+    end
   end
 end

data/lib/jekyll-sass/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Sass
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/readme.md

@@ -2,7 +2,7 @@ Sass for Jekyll
 ===============
 
 This gem provides a [Jekyll](http://github.com/mojombo/jekyll) converter for
-[Sass](http://http://sass-lang.com//) files.
+[Sass](http://sass-lang.com/) files.
 
 Basic Setup
 -----------
@@ -17,7 +17,7 @@ In a plugin file within your Jekyll project's `_plugins` directory:
 
 Place .scss files anywhere in your Jekyll project's directory.  These will be
 converted to .css files with the same directory path and filename. For example,
-if you create a Less file at `css/my-stuff/styles.scss`, then the corresponding
+if you create an `scss` file at `css/my-stuff/styles.scss`, then the corresponding
 css file would end up at `css/my-stuff/styles.css`.
 
 Bundler Setup
@@ -38,11 +38,18 @@ Configuration
 -------------
 In your `_config.yml`
 
-	# defaults
+    # defaults
 	sass:
-	    syntax: scss        # scss|sass
-	    style:  compressed  # nested|expanded|compact|compressed
+        style:  expanded  # nested|expanded|compact|compressed
+        deploy_style: compressed  # nested|expanded|compact|compressed
+        # "deploy_style:" is used only for building the site
+        # (ie: not using the --watch flag)
+ 
+        compile_in_place: false   # true|false
+        # If true, compiles sass directly into your jekyll source directory
+        # As well as your destination directory
 
 Credit
 ------
-This gem is based on [Roger López's](https://github.com/zroger) [jekyll-less](https://github.com/zroger/jekyll-less), with contributions from [Joe Buszkiewic](https://github.com/zznq).
+This gem is based on [@zroger's](https://github.com/zroger) [jekyll-less](https://github.com/zroger/jekyll-less),
+with contributions from [@zznq](https://github.com/zznq), [@Tambling](https://github.com/Tambling), and [@rebelzach](https://github.com/rebelzach).

metadata

@@ -2,7 +2,7 @@
 name: jekyll-sass
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Jason Kozak
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-20 00:00:00 Z
+date: 2013-11-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: jekyll
@@ -34,6 +34,17 @@ dependencies:
         version: 3.0.0
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: colorator
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.1"
+  type: :runtime
+  version_requirements: *id003
 description: Convert Sass SCSS files to standard CSS files as part of your Jekyll build.
 email: 
 - jay@noctal.com
@@ -46,6 +57,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
 - Rakefile
 - jekyll-sass.gemspec
 - lib/jekyll-sass.rb