jekyll-compass 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffa827930be0e2098c716ef4fa62a74c2b5ef41b
-  data.tar.gz: 9839292d3ef5da2f8dfecdb1dc3f63f56ee6fbd3
+  metadata.gz: bc734c3951787df164f485ec108768f42e63455e
+  data.tar.gz: a1d70d24c2c9cd71cf8a490a7c94010a8ea75ca7
 SHA512:
-  metadata.gz: af45a1cd54f3c1e9d77fc68e19384a71c5503b7100ccfde0683c14ef7579df9e5d2ddb5cc450b2bf4b79c9f8327dba5ba64622aa5ccaf6b052a32ca58250a70c
-  data.tar.gz: ef1ddc47d7396cb221172e67c6dc620641691b57fc782664c718e6053bc6e5e6d458b471debd9b57796456afc0b4a43ca515c171f808c02d19b4060b7c1b813d
+  metadata.gz: 17f2e9358d732a149e6d4bd3031007fc01edd67470244816b78a0f7fde16f181e1920b7761cd19e4fb1a3476ede481c7acffa312051d3c1896a0f6192726ed35
+  data.tar.gz: 9863583fe8ffb6d13e628563e6151da9614a4029edaf2bccd249ba077506e75fb856727430288d9c497939d834e1593cf6bab8b9b76a987a950b6ef5b453b030

data/lib/jekyll/compass/compass_file.rb

@@ -1,7 +1,13 @@
 
 module Jekyll
   module Compass
+    # This seemed to be necessary at the time, however I'm not sure now if it
+    # is or not. (very) minor performance boost.
     class CompassFile < StaticFile
+      # Write the static file. Since this class is used to represent files that
+      # are purely conceptual we short-circuit to the inevitable failure.
+      #
+      # @return [boolean] false
       def write(destination)
         # Short-circuit to the inevitable
         false

data/lib/jekyll/compass/generator.rb

@@ -6,10 +6,20 @@ require 'fileutils'
 
 module Jekyll
   module Compass
+    # This is the main generator plugin for Jekyll. Jekyll finds these plugins
+    # itself, we just need to be setup by the user as a gem plugin for their
+    # website. The plugin will only do something if there is a `_sass` folder
+    # in the source folder of the Jekyll website.
     class Generator < ::Jekyll::Generator
       safe true
       priority :high
 
+      # This is the entry point to our plugin from Jekyll. We setup a compass
+      # environment and force a full compilation directly into the Jekyll output
+      # folder.
+      #
+      # @param site [Jekyll::Site] The site to generate for
+      # @return [void]
       def generate(site)
         @site = site
         input_directory = File.join(@site.source, '_sass')
@@ -17,15 +27,27 @@ module Jekyll
         return unless File.exist? input_directory
         puts
 
-        config = configuration(@site.source, input_directory, File.join(@site.config['destination'], 'css'))
+        config = configuration(
+            @site.source,
+            input_directory,
+            File.join(@site.config['destination'], 'css')
+        )
         configure_compass(config)
 
-        ::Compass::Commands::UpdateProject.new(site.config['source'], config).execute
+        ::Compass::Commands::UpdateProject.new(site.config['source'], config).
+            execute
         nil
       end
 
       private
 
+      # Compile a configuration Hash from sane defaults mixed with user input
+      # from `_config.yml` as well as `_data/compass.yml`.
+      #
+      # @param source [String] The project source folder
+      # @param input_directory [String] The folder containing the Sass files
+      # @param output_directory [String] The folder to output CSS files to
+      # @return [Hash]
       def configuration(source, input_directory, output_directory)
         config = {
             :project_path => source,
@@ -40,30 +62,68 @@ module Jekyll
         }
 
         user_config = @site.config['compass']
-        config.deep_merge!(user_config.symbolize_keys) if user_config
+        config = deep_merge!(config, symbolize_keys(user_config)) if user_config
         user_data = @site.data['compass']
-        config.deep_merge!(user_data.symbolize_keys) if user_data
+        config = deep_merge!(config, symbolize_keys(user_data)) if user_data
 
         config
       end
 
+      # Sets up event handlers with Compass and various other
+      # configuration setup needs
+      #
+      # @param config [Hash] Configuration to pass to Compass and Sass
+      # @return [void]
       def configure_compass(config)
         ::Compass.add_configuration(config, 'Jekyll::Compass')
 
-        ::Compass.configuration.on_stylesheet_saved &method(:on_stylesheet_saved)
-        ::Compass.configuration.on_sprite_saved &method(:on_sprite_saved)
-        ::Compass.configuration.on_sprite_removed &method(:on_sprite_removed)
+        ::Compass.configuration.on_stylesheet_saved(
+            &method(:on_stylesheet_saved)
+        )
+        ::Compass.configuration.on_sprite_saved(
+            &method(:on_sprite_saved)
+        )
+        ::Compass.configuration.on_sprite_removed(
+            &method(:on_sprite_removed)
+        )
+        nil
       end
 
+      # Event handler triggered when Compass creates a new stylesheet
+      #
+      # @param filename [String] The name of the created stylesheet.
+      # @return [void]
       def on_stylesheet_saved(filename)
         source = @site.config['destination']
-        @site.static_files << CompassFile.new(@site, source, File.dirname(filename)[source.length..-1], File.basename(filename))
+        @site.static_files <<
+            CompassFile.new(
+                @site,
+                source,
+                File.dirname(filename)[source.length..-1],
+                File.basename(filename)
+            )
+        nil
       end
 
+      # Event handler triggered when Compass creates a new sprite image
+      #
+      # @param filename [String] The name of the created image.
+      # @return [void]
       def on_sprite_saved(filename)
-        @site.static_files << StaticFile.new(@site, @site.source, File.dirname(filename)[@site.source.length..-1], File.basename(filename))
+        @site.static_files <<
+            StaticFile.new(
+                @site,
+                @site.source,
+                File.dirname(filename)[@site.source.length..-1],
+                File.basename(filename)
+            )
+        nil
       end
 
+      # Event handler triggered when Compass deletes a stylesheet
+      #
+      # @param filename [String] The name of the deleted stylesheet.
+      # @return [void]
       def on_sprite_removed(filename)
         @site.static_files = @site.static_files.select do |p|
           if p.path == filename
@@ -74,6 +134,38 @@ module Jekyll
             true
           end
         end
+        nil
+      end
+
+      # Merges a target hash with another hash, recursively.
+      #
+      # @param target [Hash] The target hash
+      # @param merge [Hash] The hash to merge into the target
+      # @return [Hash] Returns the merged target
+      def deep_merge!(target, merge)
+        merge.keys.each do |key|
+          if merge[key].is_a? Hash and target[key].is_a? Hash
+            target[key] = deep_merge!(target[key], merge[key])
+          else
+            target[key] = merge[key]
+          end
+        end
+
+        target
+      end
+
+      # Turn all String keys of a hash into symbols, and return in another Hash.
+      #
+      # @param hash [Hash] The hash to convert
+      # @return [Hash] Returns the symbolized copy of hash.
+      def symbolize_keys(hash)
+        target = hash.dup
+
+        target.keys.each do |key|
+          target[(key.to_sym rescue key) || key] = target.delete(key)
+        end
+
+        target
       end
     end
   end

data/lib/jekyll/compass.rb

@@ -1,4 +1,20 @@
 
+# This file serves as the main entry point for the plugin. We simply include
+# all the various parts of the plugin so that everything just works.
+
+# Jekyll is the static site builder that we are making a plugin for.
+#
+# @see http://jekyllrb.com/
+module Jekyll
+  # Sass is a set of extensions to CSS that allows for things like mixins
+  # and variables. Compass is a library of Sass functions and code for use
+  # with your own websites.
+  #
+  # @see http://sass-lang.com/
+  # @see http://compass-style.org/
+  module Compass
+  end
+end
+
 require 'jekyll/compass/compass_file'
-require 'jekyll/compass/core_ext'
 require 'jekyll/compass/generator'

data/lib/jekyll-compass.rb

@@ -1,5 +1,6 @@
 
-# This is simply a router file. We don't do anything here except require the *actual* file for our gem
-# This is the file that jekyll requires by default. Ideally it shouldn't exist.
+# This is simply a router file. We don't do anything here except require the
+# *actual* file for our gem. This is the file that jekyll requires by default.
+# Ideally it shouldn't exist at all.
 # @see http://guides.rubygems.org/name-your-gem/
 require 'jekyll/compass'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-compass
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Matthew Scharley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-13 00:00:00.000000000 Z
+date: 2013-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compass
@@ -47,7 +47,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll/compass/compass_file.rb
-- lib/jekyll/compass/core_ext.rb
 - lib/jekyll/compass/generator.rb
 - lib/jekyll/compass.rb
 - lib/jekyll-compass.rb
@@ -78,3 +77,4 @@ signing_key:
 specification_version: 4
 summary: Jekyll generator plugin to build Compass projects during site build
 test_files: []
+has_rdoc: 

data/lib/jekyll/compass/core_ext.rb

@@ -1,30 +0,0 @@
-class Hash
-  # Merges self with another hash, recursively.
-  #
-  # Returns the merged self.
-  def deep_merge!(hash)
-    hash.keys.each do |key|
-      if hash[key].is_a? Hash and self[key].is_a? Hash
-        self[key] = self[key].deep_merge!(hash[key])
-        next
-      end
-
-      self[key] = hash[key]
-    end
-
-    self
-  end
-
-  # Turn all String keys of into symbols, and return in other Hash.
-  #
-  # Returns the symbolized copy of self.
-  def symbolize_keys
-    target = self.dup
-
-    keys.each do |key|
-      self[(key.to_sym rescue key) || key] = delete(key)
-    end
-
-    target
-  end
-end