jekyll-compass 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b48486097b59cef67758554dd741e1520d1872a
-  data.tar.gz: a9dcd89043b048a3bf01ee0180ba7ede6cc50c2c
+  metadata.gz: 782d2feab522ed7e13d5b7e5829eb2e12ed2fa2a
+  data.tar.gz: f7c2439fb383b74a63124d74d12a45987405c4dc
 SHA512:
-  metadata.gz: ab489d313433d8c11c68db1094f214b73b4ef55025749d3e673f35760a116114fde70f6059770c71662721c679b196734994714e6cf3e65b7b21377603068f79
-  data.tar.gz: 62bb9c6363569e5f76fe3400fef75af7298132cce56d09ae2857debf8db738034fac8dadda0cface9931ea2fc642a0f18293b54ebfbb1c2a47fb1e38ab80be44
+  metadata.gz: 20400ffcd9c4878b2cd83c23870d8ab5eca0020f93d6ff5d96c8d0917d1d0190b9486e700633dcd90655c2c47c4568b906e2ddb5f0774a352be91b1a1609a695
+  data.tar.gz: e4f7118ae47a720ebb028b32cc9560864a79fe402f91332dcfc3c9b3535c5b2c8259736c68b42460e57a26735ecfd4a53f2a166bcfdcea684e57476be0c882de

data/README.md

@@ -11,9 +11,8 @@ jekyll-compass: Compass generator for Jekyll websites
 Synopsis
 --------
 
-jekyll-compass is a jekyll plugin that provides an interface between Jekyll's building commands and the Compass
-libraries to automatically build your Compass Sass files during a regular website build. This means your CSS files
-end up directly in your `_site` output folder and never need to be checked into your version control.
+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.
 
 Installation
 ------------
@@ -32,14 +31,32 @@ This plugin has a very simple two step install:
 Usage
 -----
 
-Simply setup your SASS files in the `_sass` folder in your websites root folder. Then run `jekyll build` and watch the
-magic.
+You may use compass to generate a layout and configuration for you. The site root is the folder where your `_config.yml`
+lives.
+
+    compass create -r jekyll-compass --app=jekyll 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.
+
+    # 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
+
+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.
+
+    # Compiles your entire website, including Sass/Compass
+    jekyll build
+    jekyll serve
 
 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. Any of the
+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.
 
 Compass also provides a way to pass through options directly to Sass via the `sass_options` option. You can find

data/lib/jekyll/compass.rb

@@ -16,5 +16,13 @@ module Jekyll
   end
 end
 
-require 'jekyll/compass/compass_file'
-require 'jekyll/compass/generator'
+# Require dependencies
+require 'jekyll'
+require 'sass/plugin'
+require 'compass'
+require 'compass/commands'
+
+# Internal requires
+%w{compass_configuration compass_file generator compass_app_integration}.each do |f|
+  require "jekyll/compass/#{f}"
+end

data/lib/jekyll/compass/compass_app_integration.rb

@@ -0,0 +1,29 @@
+require 'compass/app_integration'
+require 'jekyll/compass/compass_installer'
+
+module Jekyll
+  module Compass
+    # Integration class to manage a new project type in Compass
+    class CompassAppIntegration
+      def self.installer(*args)
+        CompassInstaller.new(*args)
+      end
+
+      def self.configuration
+        project_path = ::Compass.configuration.project_path
+        config_file = File.join(project_path, '_data/compass.yml')
+        if File.exist? config_file
+          config = CompassConfiguration.from_yaml_file config_file
+          config[:css_dir] = "_site/#{config[:css_dir]}"
+        else
+          config = CompassConfiguration.default_configuration
+        end
+        config[:config_file] = config_file
+        config.to_compass
+      end
+    end
+  end
+end
+
+# Register our project type with compass
+::Compass::AppIntegration.register(:jekyll, 'Jekyll::Compass::CompassAppIntegration')

data/lib/jekyll/compass/compass_configuration.rb

@@ -0,0 +1,81 @@
+require 'yaml'
+
+module Jekyll
+  module Compass
+    # Abstracts Compass's configuration away from any particular process in our plugin
+    class CompassConfiguration
+      CONFIGURATION_NAME = 'Jekyll::Compass'
+
+      def extend(hash)
+        hash.each do |key, value|
+          self[key] = value
+        end
+      end
+
+      def delete(key)
+        @data.delete(key)
+      end
+
+      def has_key?(key)
+        @data.has_key?(key)
+      end
+
+      def []=(key, value)
+        key = key.to_sym unless key.is_a? Symbol
+        value = value.to_sym if SYMBOL_VALUES.include? key
+
+        if value.is_a? Hash
+          value.each do |subkey, subvalue|
+            subkey = subkey.to_sym unless subkey.is_a? Symbol
+            @data[key][subkey] = subvalue
+          end
+        end
+
+        @data[key] = value
+      end
+
+      def [](key)
+        @data[key]
+      end
+
+      def to_compass
+        ::Compass::Configuration::Data.new(CONFIGURATION_NAME, @data)
+      end
+
+      private
+
+      SYMBOL_VALUES = [
+          :project_type,
+          :environment,
+          :output_style,
+          :preferred_syntax,
+          :sprite_engine,
+      ]
+
+      def initialize(initial_hash = {})
+        @data = initial_hash
+      end
+
+      class << self
+        def default_configuration
+          new({
+              :default_project_type => :jekyll,
+              :http_path => '/',
+              :sass_dir => '_sass',
+              :css_dir => 'css',
+              :images_dir => 'images',
+              :javascripts_dir => 'javascripts',
+          })
+        end
+
+        def from_yaml_file(filename)
+           config = default_configuration
+          YAML.load_file(filename).each do |k, v|
+            config[k.to_sym] = v
+          end
+          config
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/compass/compass_file.rb

@@ -14,4 +14,4 @@ module Jekyll
       end
     end
   end
-end
+end

data/lib/jekyll/compass/compass_installer.rb

@@ -0,0 +1,91 @@
+require 'compass/installers'
+require 'yaml'
+
+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
+        write_file config_file, config_contents
+      end
+
+      def config_files_exist?
+        File.exists? targetize('_data/compass.yml')
+      end
+
+      def config_contents
+        config = ::Compass.configuration
+        contents = {}
+
+        required = (config.required_libraries.to_a || [])
+        load = (config.loaded_frameworks.to_a || [])
+        discover = (config.framework_path.to_a || [])
+
+        contents['require'] = required if required.any?
+        contents['load'] = load if load.any?
+        contents['discover'] = discover if discover.any?
+
+        (::Compass::Configuration::ATTRIBUTES + ::Compass::Configuration::ARRAY_ATTRIBUTES).each do |prop|
+          process_property(config, prop, contents)
+        end
+
+        contents.to_yaml
+      end
+
+      def finalize(options = {})
+        if options[:create] && !manifest.welcome_message_options[:replace]
+          puts <<-NEXTSTEPS
+
+*********************************************************************
+Congratulations! Your jekyll-compass project has been created.
+
+Don't forget to add jekyll-compass to the list of gem plugins in _config.yml.
+
+You may now add and edit Sass stylesheets in the #{::Compass.configuration.sass_dir} subdirectory of your project.
+
+Sass files beginning with an underscore are called partials and won't be
+compiled to CSS, but they can be imported into other sass stylesheets.
+
+You can configure your project by editing the _data/compass.yml configuration file.
+
+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)
+     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)
+
+More Resources:
+  * Website: http://compass-style.org/
+  * Sass: http://sass-lang.com
+  * Community: http://groups.google.com/group/compass-users/
+  * Jekyll: http://jekyllrb.com/
+  * jekyll-compass: https://github.com/mscharley/jekyll-compass
+          NEXTSTEPS
+        end
+        puts manifest.welcome_message if manifest.welcome_message
+      end
+
+      def process_property(config, prop, contents)
+        value = config.send("#{prop}_without_default")
+        if value.is_a?(Proc)
+          $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 value.nil?
+
+        if value.is_a? Symbol
+          contents[prop.to_s] = value.to_s
+        else
+          contents[prop.to_s] = value
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/compass/generator.rb

@@ -1,7 +1,3 @@
-
-require 'sass/plugin'
-require 'compass'
-require 'compass/commands'
 require 'fileutils'
 
 module Jekyll
@@ -24,16 +20,15 @@ module Jekyll
         @site = site
 
         config = configuration(@site.source)
-        puts "\rGenerating Compass: #{config[:sass_path]}" +
-                 " => #{config[:css_path]}"
-        unless File.exist? config[:sass_path]
+        configure_compass(config)
+        puts "\rGenerating Compass: #{::Compass.configuration.sass_path}" +
+                 " => #{::Compass.configuration.css_path}"
+        unless File.exist? ::Compass.configuration.sass_dir
           print "      Generating... "
           return
         end
-        configure_compass(config)
 
-        ::Compass::Commands::UpdateProject.new(site.config['source'], config).
-            execute
+        ::Compass::Commands::UpdateProject.new(@site.config['source'], {:project_type => :jekyll}).execute
 
         puts
         print "      Generating... "
@@ -46,61 +41,24 @@ module Jekyll
       # from `_config.yml` as well as `_data/compass.yml`.
       #
       # @param source [String] The project source folder
-      # @return [Hash]
+      # @return [::Compass::Configuration::Data]
       def configuration(source)
-        config = {
-            :project_path => source,
-            :http_path => '/',
-            :sass_dir => '_sass',
-            :css_dir => 'css',
-            :images_path => File.join(source, 'images'),
-            :javascripts_path => File.join(source, 'js'),
-            :environment => :production,
-            :force => true,
-        }
-
-        user_config = @site.config['compass']
-        config = deep_merge!(config, symbolize_keys(user_config)) if user_config
-        user_data = @site.data['compass']
-        config = deep_merge!(config, symbolize_keys(user_data)) if user_data
-
-        unless config.key? :sass_path
-          config[:sass_path] =
-              File.join(source, config[:sass_dir])
-        end
-        unless config.key? :css_path
-          config[:css_path] =
-              File.join(@site.config['destination'], config[:css_dir])
-        end
-
-        symbolize_configuration!(config)
-      end
-
-      # Symbolize values for configuration values which require it.
-      #
-      # @param config [Hash]
-      # @return [Hash]
-      def symbolize_configuration!(config)
-        [
-            :project_type,
-            :environment,
-            :output_style,
-            :preferred_syntax,
-            :sprite_engine,
-        ].each do |k|
-          config[k] = config[k].to_sym if config.key? k
-        end
-
-        config
+        config = CompassConfiguration.default_configuration
+        config[:project_path] = source
+        config[:force] = true
+        config.extend(@site.config['compass'] || {})
+        config.extend(@site.data['compass'] || {})
+        config[:css_path] = File.join(@site.config['destination'], config[:css_dir]) unless config.has_key? :css_path
+        config.to_compass
       end
 
       # Sets up event handlers with Compass and various other
       # configuration setup needs
       #
-      # @param config [Hash] Configuration to pass to Compass and Sass
+      # @param config [::Compass::Configuration::Data] Configuration to pass to Compass and Sass
       # @return [void]
       def configure_compass(config)
-        ::Compass.add_configuration(config, 'Jekyll::Compass')
+        ::Compass.add_configuration(config)
 
         ::Compass.configuration.on_stylesheet_saved(
             &method(:on_stylesheet_saved)
@@ -161,41 +119,6 @@ module Jekyll
         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|
-          value = target.delete(key)
-          if value.is_a? Hash
-            value = symbolize_keys(value)
-          end
-          target[(key.to_sym rescue key) || key] = value
-        end
-
-        target
-      end
     end
   end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-compass
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Scharley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compass
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 description: |2
@@ -46,7 +46,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/jekyll/compass/compass_app_integration.rb
+- lib/jekyll/compass/compass_configuration.rb
 - lib/jekyll/compass/compass_file.rb
+- lib/jekyll/compass/compass_installer.rb
 - lib/jekyll/compass/generator.rb
 - lib/jekyll/compass.rb
 - lib/jekyll-compass.rb
@@ -62,17 +65,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Jekyll generator plugin to build Compass projects during site build