jekyll-compass 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 782d2feab522ed7e13d5b7e5829eb2e12ed2fa2a
-  data.tar.gz: f7c2439fb383b74a63124d74d12a45987405c4dc
+  metadata.gz: d43c3f9bd54d201651db82eb3fb2d6f772a3e79c
+  data.tar.gz: 771d73f6d579755f59a9377f8e0316fa01c2510c
 SHA512:
-  metadata.gz: 20400ffcd9c4878b2cd83c23870d8ab5eca0020f93d6ff5d96c8d0917d1d0190b9486e700633dcd90655c2c47c4568b906e2ddb5f0774a352be91b1a1609a695
-  data.tar.gz: e4f7118ae47a720ebb028b32cc9560864a79fe402f91332dcfc3c9b3535c5b2c8259736c68b42460e57a26735ecfd4a53f2a166bcfdcea684e57476be0c882de
+  metadata.gz: 89ac6f9aecb7bdeab7eeee0cc6a32ab4ce15ed271af3574d41975cd3a2402f476f97f5b224fc524593b90b931219cf1c1a5aa140071fcb707075d89b8e0fc9ae
+  data.tar.gz: d98782e7a56dde8e2303d4c1a8f33f70b263460cebc3fe12a5fa6925e48fc076ea1dab48bbf3bb7f88a9575fa79b159060cb48f73d5709600529cb3400e32e77

data/README.md

@@ -11,8 +11,9 @@ jekyll-compass: Compass generator for Jekyll websites
 Synopsis
 --------
 
-jekyll-compass is a plugin for both jekyll and compass that provides an bi-directional interface between the two
-applications, tightly integrating them and allowing each to work well when used directly.
+jekyll-compass is a plugin for both Jekyll and Compass that provides a bi-directional interface between the two
+applications, tightly integrating them and allowing each to work well together when either is used directly. In short,
+if you use Compass as well as Jekyll, jekyll-compass makes your life easier.
 
 Installation
 ------------
@@ -21,7 +22,7 @@ This plugin has a very simple two step install:
 
 1.  Install the gem:
 
-        gem install jekyll-compass
+        $ gem install jekyll-compass
 
 2.  Add the gem to your jekyll website's `_config.yml` file:
 
@@ -31,18 +32,24 @@ This plugin has a very simple two step install:
 Usage
 -----
 
-You may use compass to generate a layout and configuration for you. The site root is the folder where your `_config.yml`
-lives.
+You may use Compass to generate a layout and configuration for you. The site root is the folder where your `_config.yml`
+lives. This step is highly recommended as it will also install some plumbing to help Compass work correctly with your
+new jekyll-compass project. You can also install your favourite framework directly, just remember to add the extra
+parameters so that Compass understands the target project structure.
 
     compass create -r jekyll-compass --app=jekyll path/to/site/root
+    compass create -r jekyll-compass --app=jekyll -r zurb-foundation path/to/site/root
 
-Other `compass` commands will work as per usual, however you will need to add the `-r jekyll-compass --app=jekyll`
-parameters to make sure `compass` can find the files from this plugin that it needs. If you forget these parameters
-then Compass will fail with an error message as it won't understand the project layout.
+If you are coming from an older version of jekyll-compass and just want to install the plumbing for Compass then use
+this command:
 
-    # Compiles all your Sass/Compass into the _site folder, you may also specify --css-path on the command line
-    compass compile -r jekyll-compass --app=jekyll
-    compass watch -r jekyll-compass --app=jekyll
+    compass init jekyll -r jekyll-compass --prepare [path/to/site/root]
+
+Other `compass` commands will then work as per usual:
+
+    # Compiles all your Sass/Compass into the _site folder, or you may also specify --css-path on the command line
+    compass compile
+    compass watch
 
 You will also note that Compass will build your Sass files whenever jekyll builds the rest of your website, ensuring
 that what you publish is always up to date.
@@ -57,7 +64,7 @@ Configuration
 You may add a file to your `_data` folder called `compass.yml`. This will contain overrides for the compass
 configuration, similar to the `config.rb` in a regular compass project. If you generated a layout using compass above
 then this file will already exist with some default settings setup for you. Any of the
-[regular configuration properties][compass-props] should be supported via the YAML file.
+[regular configuration properties][compass-props] should be supported via this YAML file.
 
 Compass also provides a way to pass through options directly to Sass via the `sass_options` option. You can find
 details of what options are available from Sass in the [Sass Reference][sass-props].
@@ -68,7 +75,11 @@ An example configuration file might look like the following:
     sass_options:
       unix_newlines: true
 
+In order to use other plugins for compass, add them to the `require` key in your `compass.yml` file. There is also a
+`load` and `discover` key which map to the relevant commands in Compass' regular configuration file.
 
+    require:
+    - zurb-foundation
 
   [license]: https://raw.github.com/mscharley/jekyll-compass/master/LICENSE
   [gh-contrib]: https://github.com/mscharley/jekyll-compass/graphs/contributors

data/lib/jekyll/compass/compass_app_integration.rb

@@ -19,6 +19,7 @@ module Jekyll
           config = CompassConfiguration.default_configuration
         end
         config[:config_file] = config_file
+
         config.to_compass
       end
     end

data/lib/jekyll/compass/compass_configuration.rb

@@ -25,13 +25,16 @@ module Jekyll
         value = value.to_sym if SYMBOL_VALUES.include? key
 
         if value.is_a? Hash
+          @data[key] = {} unless @data[key].is_a? Hash
           value.each do |subkey, subvalue|
             subkey = subkey.to_sym unless subkey.is_a? Symbol
+            subvalue = subvalue.to_sym if SYMBOL_VALUES.include? subkey
             @data[key][subkey] = subvalue
           end
+        else
+          @data[key] = value
         end
 
-        @data[key] = value
       end
 
       def [](key)
@@ -39,7 +42,22 @@ module Jekyll
       end
 
       def to_compass
-        ::Compass::Configuration::Data.new(CONFIGURATION_NAME, @data)
+        required = @data.delete(:require) || []
+        load = @data.delete(:load) || []
+        discover = @data.delete(:discover) || []
+
+        config = ::Compass::Configuration::Data.new(CONFIGURATION_NAME, @data)
+        required.each do |name|
+          config.require(name)
+        end
+        load.each do |name|
+          config.load(name)
+        end
+        discover.each do |name|
+          config.discover(name)
+        end
+
+        config
       end
 
       private

data/lib/jekyll/compass/compass_installer.rb

@@ -5,11 +5,14 @@ module Jekyll
   module Compass
     #
     class CompassInstaller < ::Compass::AppIntegration::StandAlone::Installer
-      def write_configuration_files(config_file = nil)
-        config_file ||= targetize('_data/compass.yml')
-        unless File.exists? File.dirname(config_file)
-          directory File.dirname(config_file)
-        end
+
+      def prepare
+        config_file = targetize('_data/compass.yml')
+        directory targetize('.compass')
+        write_file targetize('.compass/config.rb'), compass_config_contents
+        return if config_files_exist?
+
+        directory File.dirname(config_file)
         write_file config_file, config_contents
       end
 
@@ -36,6 +39,15 @@ module Jekyll
         contents.to_yaml
       end
 
+      def compass_config_contents
+        config = ::Compass.configuration
+        contents = ''
+
+        contents << "require 'jekyll-compass'\n"
+        contents << config.serialize_property(:project_type, config.project_type)
+        contents
+      end
+
       def finalize(options = {})
         if options[:create] && !manifest.welcome_message_options[:replace]
           puts <<-NEXTSTEPS
@@ -55,10 +67,10 @@ You can configure your project by editing the _data/compass.yml configuration fi
 You must compile your Sass stylesheets into CSS when they change.
 This can be done in one of the following ways:
   1. To compile on demand:
-     compass compile --app=jekyll -r jekyll-compass (just compile your Sass)
+     compass compile (just compile your Sass)
      jekyll build (compile your entire website, including Sass)
   2. To monitor your project for changes and automatically recompile:
-     compass watch --app=jekyll -r jekyll-compass (just watches your Sass)
+     compass watch (just watches your Sass)
 
 More Resources:
   * Website: http://compass-style.org/
@@ -77,7 +89,7 @@ More Resources:
           $stderr.puts "WARNING: #{prop} is code and cannot be written to a file. You'll need to copy it yourself."
           return
         end
-        return if [:project_path, :project_type].include? prop
+        return if [:project_type].include? prop
         return if value.nil?
 
         if value.is_a? Symbol

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-compass
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Matthew Scharley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compass