compass-edge 0.9.2 → 0.9.3

data/CHANGELOG.markdown

@@ -1,6 +1,129 @@
 COMPASS CHANGELOG
 =================
 
+0.10.0 (UNRELEASED)
+------------
+
+Command-Line:
+
+* The compass command-line tool has been re-written to allow be easier to
+  use and be more flexible. The old command line is still supported at
+  this time. "compass help" will get you started on using the new
+  command line syntax.
+* Allow specification of a height for the grid image
+* For the truly hardcore compass users, you may now create a
+  compass project using "compass create my_project --bare"
+  and you'll have a completely bare project created for you with no
+  sass files provided for you.
+* Get stats on your compass project with "compass stats". You'll
+  need to install the "css_parser" ruby gem to get stats on your
+  css files.
+
+Configuration:
+
+* The entire configuration infrastructure has been re-written to make it
+  easier to support the various sources of configuration data (project type,
+  config file, command line, and hard coded defaults)
+* Whether to generate relative links to assets is now controlled by a
+  separate boolean configuration flag called `relative_assets` in the
+  configuration file and `--relative-assets` on the command line.
+  Setting `http_images_path` to `:relative` is deprecated.
+* You may now configure the http locations for your project by simply setting
+  `http_path` for the top level path of the project. You
+  may also set `http_images_dir`, `http_stylesheets_dir`, and
+  `http_javascripts_dir` relative to the `http_path` instead of
+  setting the absolute `http_XXX_path` counterparts.
+
+Compass Core:
+
+* A new helper function `stylesheet_url(path)` can now be used to refer
+  to assets that are relative to the css directory.
+* Compass sprite mixins are now more flexible and feature rich.
+* Fixed the append_selector function to allow comma-delimited selectors
+  for both arguments instead of just the first
+* There is no longer any outline on unstyled links in the :active and :focused states.
+* IE6 bug fixes for sticky-footer
+* New CSS3 Compatibility Mixins. You can import them all with `@import compass/css3`
+    * `+opacity(amount)` where amount should be between 0 and 1, where 0 is transparent and 1 is opaque.
+    * `+opaque` and `+transparent` mixins for convenience. Built on top of the opacity mixin.
+    * `+border-radius(amount)` as well as the following convenience mixins:
+        * `+border-top-left-radius(amount)`
+        * `+border-top-right-radius(amount)`
+        * `+border-top-right-radius(amount)`,
+        * `+border-bottom-left-radius(amount)`
+        * `+border-bottom-right-radius(amount)`
+        * `+border-top-radius(amount)`
+        * `+border-right-radius(amount)`
+        * `+border-left-radius(amount)`
+        * `+border-bottom-radius(amount)`
+    * `+box-shadow(!horiz_offset, !vert_offset, !blur, !color)`
+    * `+box-sizing(!sizing_mode)`
+    * Column support via the following mixins:
+        * `+column-count`
+        * `+column-gap`
+        * `+column-width`
+        * `+column-rule-width`
+        * `+column-rule-style`
+        * `+column-rule-color`
+        * `+column-rule`
+    * The import for `+inline-block` has moved from compass/utilities/general/inline_block
+      to compass/css3/inline_block
+    * The import for `+opacity` has moved from compass/utilities/general/opacity
+      to compass/css3/opacity
+    * Note: If you are using the `+opacity` or `+inline-block` mixins,
+      you may need to update your imports.
+
+Blueprint:
+
+* Make the primary blueprint mixins easier to use by allowing them to be nested when passing true as the first argument.
+  The old approach of passing a selector as the first argument is now deprecated in favor of a simple flag to indicate nesting or not.
+
+YUI:
+
+* YUI was upgraded to 2.7.0
+* Yahoo has deprecated the YUI CSS framework, as such YUI has been extracted to a plugin.
+  If you use it, please install it with: `sudo gem install compass-yui`
+
+Extensions:
+
+* Extensions can now be installed locally by unpacking them into a project's
+  "extensions" directory.
+* Extensions can deliver html to projects if they like. The html can be in
+  haml and will be transformed to html.
+* All files can be processed using ERB before being copied into the user's
+  project.
+* Compass extensions can now add support for other application frameworks.
+  These extensions can help compass understand the project structure of that
+  framework as well as provide runtime integration for ruby-based apps.
+  Contact me if you plan to do this -- the first couple times may be a little
+  rough.
+* Compass extensions can now add new command line commands. Contact me if you
+  plan to do this -- the first couple times may be a little rough.
+* Extensions can now provide help documentation just after a project is
+  created and on demand when the user uses the command line help system.
+  This can be done via the manifest file or by adding a USAGE.markdown file
+  at the top level of the framework template.
+
+Miscellaneous:
+
+* The compass configuration object is no longer a singleton, this makes it
+  possible for other ruby software to manage multiple compass projects at a
+  time.
+* Compass no longer requires rubygems in order to work, this is a ruby
+  best-practice.
+* All sass provided by compass now uses css-style property syntax.
+* The command line tool is now tested using the cucumber testing framework.
+
+Many thanks to the following Contributors:
+
+  * Brandon Mathis - CSS3 (+opacity, +border-radius) and sprites
+  * Eric Meyer - CSS3 (+box-shadow, +columns, +box-sizing)
+  * Jacques Crocker - Merb Compatibility fixes
+  * Gabriel Mansour - Fixes to +unstyled-link
+  * John Debs - IE6 Fixes for +sticky-footer
+  * Brian Johnson - Upgraded to YUI 2.7.0
+  * Beau Smith - fixing my dyslexia.
+
 0.8.12 (August 22, 2009)
 ------------------------
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
+:major: 0
 :minor: 9
+:patch: 3
 :build: 
-:patch: 2
-:major: 0

data/lib/compass/app_integration/stand_alone/installer.rb

@@ -44,7 +44,7 @@ module Compass
         end
 
         def finalize(options = {})
-          if options[:create]
+          if options[:create] && !manifest.welcome_message_options[:replace]
             puts <<-NEXTSTEPS
 
 *********************************************************************
@@ -71,7 +71,8 @@ More Resources:
 
 NEXTSTEPS
           end
-          if manifest.has_stylesheet?
+          puts manifest.welcome_message if manifest.welcome_message
+          if manifest.has_stylesheet? && !manifest.welcome_message_options[:replace]
             puts "\nTo import your new stylesheets add the following lines of HTML (or equivalent) to your webpage:"
             puts stylesheet_links
           end

data/lib/compass/commands/help.rb

@@ -21,6 +21,19 @@ Available commands:
           end
           banner << "\n"
         end
+ 
+        banner << "\nAvailable Frameworks & Patterns:\n\n"
+        Compass::Frameworks::ALL.each do |framework|
+          banner << "  * #{framework.name}\n"
+          framework.template_directories.each do |pattern|
+            banner << "    - #{framework.name}/#{pattern}"
+            if description = framework.manifest(pattern).description
+              banner << "\t- #{description}"
+            end
+            banner << "\n"
+          end
+        end
+
         opts.banner = banner
 
         super
@@ -53,6 +66,8 @@ Available commands:
           $command = options[:help_command]
           puts Compass::Commands[options[:help_command]].usage
           $command = "help"
+        elsif Compass::Frameworks.template_exists? options[:help_command]
+          puts Compass::Frameworks.template_usage(options[:help_command])
         else
           raise OptionParser::ParseError, "No such command: #{options[:help_command]}"
         end

data/lib/compass/commands/validate_project.rb

@@ -31,7 +31,9 @@ module Compass
       def perform
         require 'compass/validator'
         UpdateProject.new(working_path, options).perform
-        Validator.new(project_css_subdirectory).validate()
+        Dir.chdir Compass.configuration.project_path do
+          Validator.new(project_css_subdirectory).validate()
+        end
       end
 
       class << self

data/lib/compass/commands/write_configuration.rb

@@ -17,6 +17,9 @@ module Compass
 
           Options:
         }.strip.split("\n").map{|l| l.gsub(/^ {0,10}/,'')}.join("\n")
+        opts.on("--debug [PROPERTY]", "Debug your configuration by printing out details.") do |prop|
+          self.options[:debug] = prop.nil? ? true : prop.to_sym
+        end
 
         super
       end
@@ -37,8 +40,20 @@ module Compass
       end
 
       def perform
-        directory projectize(File.dirname(options[:configuration_file]))
-        installer.write_configuration_files(options[:configuration_file])
+        if options[:debug]
+          Compass.configuration.debug.each do |prop, values|
+            if options[:debug].is_a?(Symbol)
+              next unless prop == options[:debug]
+            end
+            puts "***** #{prop} = #{values.first[:resolved].inspect} *****"
+            [:default, :value, :raw, :resolved].each do |kind|
+              puts "#{kind}: " + values.inject([]){|m, v| m << v[kind]}.map{|v| v.nil? ? '-' : v.inspect}.join(", ")
+            end
+          end
+        else
+          directory projectize(File.dirname(options[:configuration_file]))
+          installer.write_configuration_files(options[:configuration_file])
+        end
       end
 
       def installer_args

data/lib/compass/configuration/inheritance.rb

@@ -156,7 +156,7 @@ module Compass
                 :raw => (instance.send("raw_#{prop}") rescue nil),
                 :value => (instance.send("#{prop}_without_default") rescue nil),
                 :default => (instance.send("default_#{prop}") rescue nil),
-                :resoved => instance.send(prop)
+                :resolved => instance.send(prop)
               }
             end
             normalized_attrs[prop] = values

data/lib/compass/frameworks.rb

@@ -15,6 +15,16 @@ module Compass
         @templates_directory = options[:templates_directory] || File.join(path, 'templates')
         @stylesheets_directory = options[:stylesheets_directory] || File.join(path, 'stylesheets')
       end
+      def template_directories
+        Dir.glob(File.join(templates_directory, "*")).map{|f| File.basename(f)}
+      end
+      def manifest_file(pattern)
+        File.join(templates_directory, pattern.to_s, "manifest.rb")
+      end
+      def manifest(pattern, options = {})
+        options[:pattern_name] ||= pattern
+        Compass::Installers::Manifest.new(manifest_file(pattern), options)
+      end
     end
 
     def register(name, *arguments)
@@ -47,6 +57,31 @@ module Compass
       end
     end
 
+    def template_exists?(template)
+      framework_name, template = template.split(%r{/}, 2)
+      template ||= "project"
+      if framework = self[framework_name]
+        return File.directory?(File.join(framework.templates_directory, template))
+      end
+      false
+    end
+
+    def template_usage(template)
+      framework_name, template = template.split(%r{/}, 2)
+      framework = self[framework_name]
+      template ||= "project"
+      usage_file = File.join(framework.templates_directory, template, "USAGE.markdown")
+      if File.exists?(usage_file)
+        File.read(usage_file)
+      elsif help = framework.manifest(template).help
+        help
+      else
+        <<-END.gsub(/^ {8}/, '')
+          No Usage!
+        END
+      end
+    end
+
   end
 end
 

data/lib/compass/frameworks/blueprint/stylesheets/blueprint/modules/_buttons.sass

@@ -1,4 +1,4 @@
-@import compass/utilities/css3/inline_block.sass
+@import compass/css3/inline_block.sass
 @import compass/utilities/general/float.sass
 
 // Button Font

data/lib/compass/frameworks/blueprint/templates/buttons/manifest.rb

@@ -1,5 +1,17 @@
+description "Button Plugin"
 stylesheet 'buttons.sass', :media => 'screen, projection'
 
 image 'buttons/cross.png'
 image 'buttons/key.png'
 image 'buttons/tick.png'
+
+help %Q{
+To install the button plugin:
+  compass init --using blueprint/buttons
+
+The buttons.sass file is just a recommendation to show you how to use the button mixins.  
+}
+
+welcome_message %Q{
+The buttons.sass file is just a recommendation to show you how to use the button mixins.  
+}

data/lib/compass/frameworks/blueprint/templates/link_icons/manifest.rb

@@ -1,3 +1,5 @@
+description "Icons for common types of links"
+
 stylesheet "link_icons.sass", :media => 'screen, projection'
 
 image 'link_icons/doc.png'
@@ -8,3 +10,14 @@ image 'link_icons/im.png'
 image 'link_icons/pdf.png'
 image 'link_icons/visited.png'
 image 'link_icons/xls.png'
+
+help %Q{
+To install the link_icons plugin:
+  compass init --using blueprint/link_icons
+
+The link_icons.sass file is just a recommendation to show you how to use the link mixins.  
+}
+
+welcome_message %Q{
+The link_icons.sass file is just a recommendation to show you how to use the link mixins.  
+}

data/lib/compass/frameworks/blueprint/templates/project/manifest.rb

@@ -1,3 +1,5 @@
+description "The blueprint framework."
+
 stylesheet 'screen.sass', :media => 'screen, projection'
 stylesheet 'partials/_base.sass'
 stylesheet 'print.sass',  :media => 'print'
@@ -6,3 +8,25 @@ stylesheet 'ie.sass',     :media => 'screen, projection', :condition => "lt IE 8
 image 'grid.png'
 
 html 'welcome.html.haml', :erb => true
+
+help %Q{
+Please see the blueprint website for documentation on how blueprint works:
+
+    http://blueprintcss.org/
+
+Docs on the compass port of blueprint can be found on the wiki:
+
+    http://wiki.github.com/chriseppstein/compass/blueprint-documentation
+}
+
+welcome_message %Q{
+Please see the blueprint website for documentation on how blueprint works:
+
+    http://blueprintcss.org/
+
+Docs on the compass port of blueprint can be found on the wiki:
+
+    http://wiki.github.com/chriseppstein/compass/blueprint-documentation
+
+To get started, edit the screen.sass file and read the comments and code there.
+}

data/lib/compass/frameworks/compass/stylesheets/_compass.sass

@@ -1 +1,2 @@
-@import compass/utilities.sass
+@import compass/utilities.sass
+@import compass/css3.sass

data/lib/compass/frameworks/compass/stylesheets/compass/_utilities.sass

@@ -1,4 +1,3 @@
-@import utilities/css3.sass
 @import utilities/general.sass
 @import utilities/links.sass
 @import utilities/lists.sass

data/lib/compass/frameworks/compass/templates/ellipsis/manifest.rb

@@ -1,2 +1,27 @@
+description "Plugin for cross-browser ellipsis truncated text."
+
 file 'xml/ellipsis.xml', :like => :css
-stylesheet 'ellipsis.sass'
+stylesheet 'ellipsis.sass'
+
+help %Q{
+First, install the plugin to get the xml file that makes this work in firfox:
+
+  compass init --using blueprint/link_icons
+
+Then mix +ellipsis into your selectors to enable ellipsis
+there when text gets too long.
+
+The ellipsis.sass file is just an example for how to use this plugin,
+feel free to delete it.
+
+For more information see:
+  http://mattsnider.com/css/css-string-truncation-with-ellipsis/
+}
+
+welcome_message %Q{
+The ellipsis.sass file is just an example for how to use this plugin,
+feel free to delete it.
+
+For more information see:
+  http://mattsnider.com/css/css-string-truncation-with-ellipsis/  
+}

data/lib/compass/frameworks/compass/templates/extension/manifest.rb

@@ -1,6 +1,20 @@
-file 'stylesheets/main.sass', :to => "stylesheets/_#{File.basename(options[:pattern_name])}.sass"
+description "Generate a compass extension."
+
+file 'stylesheets/main.sass', :to => "stylesheets/_#{File.basename(options[:pattern_name]||options[:project_name]||'main')}.sass"
 file 'templates/project/manifest.rb'
 file 'templates/project/screen.sass'
 
+help %Q{
+  To generate a compass extension:
+  compass create my_extension --using compass/extension
+}
+
+welcome_message %Q{
+For a full tutorial on how to build your own extension see:
+
+http://github.com/chriseppstein/compass/blob/edge/docs/EXTENSIONS.markdown
+
+}, :replace => true
+
 no_configuration_file!
-skip_compilation!
+skip_compilation!

data/lib/compass/frameworks/compass/templates/project/USAGE.markdown

@@ -0,0 +1,32 @@
+When no framework is specified, a new compass project is set up with three stylesheets:
+
+* screen.sass
+* print.sass
+* ie.sass
+
+It is expected that you will link your html to these like so:
+
+    <head>
+      <link href="/stylesheets/screen.css" media="screen, projection"
+            rel="stylesheet" type="text/css" />
+      <link href="/stylesheets/print.css" media="print"
+            rel="stylesheet" type="text/css" />
+      <!--[if IE]>
+          <link href="/stylesheets/ie.css" media="screen, projection"
+                rel="stylesheet" type="text/css" />
+      <![endif]-->
+    </head>
+
+You don't have to use these three stylesheets, they are just a recommendation.
+You can rename them, make new stylesheets, and delete them. Compass will
+happily compile whatever sass files you place into your project.
+
+Any folders you create in your source directory with sass files in them will be folders
+that get created with css files in them when compiled.
+
+Sass files beginning with an underscore are called partials, they are not directly
+compiled to their own css file. You can use these partials by importing them
+into other stylesheets. This is useful for keeping your stylesheets small and manageable
+and single-focused. It is common to create a file called _base.sass at the top level
+of your stylesheets and to import this to set up project-wide constants and mixins.
+

data/lib/compass/frameworks/compass/templates/project/manifest.rb

@@ -1,3 +1,4 @@
+description "The default project layout."
 stylesheet 'screen.sass', :media => 'screen, projection'
 stylesheet 'print.sass',  :media => 'print'
 stylesheet 'ie.sass',     :media => 'screen, projection', :condition => "IE"

data/lib/compass/installers/manifest.rb

@@ -40,6 +40,37 @@ module Compass
       type :file
       type :html
 
+      def help(value = nil)
+        if value
+          @help = value
+        else
+          @help
+        end
+      end
+
+      attr_reader :welcome_message_options
+
+      def welcome_message(value = nil, options = {})
+        if value
+          @welcome_message = value
+          @welcome_message_options = options
+        else
+          @welcome_message
+        end
+      end
+
+      def welcome_message_options
+        @welcome_message_options || {}
+      end
+
+      def description(value = nil)
+        if value
+          @description = value
+        else
+          @description
+        end
+      end
+
       # Enumerates over the manifest files
       def each
         @entries.each {|e| yield e}
@@ -76,4 +107,4 @@ module Compass
     end
 
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: compass-edge
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors: 
 - Chris Eppstein
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-30 00:00:00 -07:00
+date: 2009-11-01 00:00:00 -07:00
 default_executable: compass
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -239,12 +239,18 @@ files:
 - lib/compass/frameworks/blueprint/templates/project/screen.sass
 - lib/compass/frameworks/blueprint/templates/project/welcome.html.haml
 - lib/compass/frameworks/compass/stylesheets/_compass.sass
+- lib/compass/frameworks/compass/stylesheets/compass/_css3.sass
 - lib/compass/frameworks/compass/stylesheets/compass/_layout.sass
 - lib/compass/frameworks/compass/stylesheets/compass/_misc.sass
 - lib/compass/frameworks/compass/stylesheets/compass/_reset.sass
 - lib/compass/frameworks/compass/stylesheets/compass/_utilities.sass
+- lib/compass/frameworks/compass/stylesheets/compass/css3/_border_radius.sass
+- lib/compass/frameworks/compass/stylesheets/compass/css3/_box_shadow.sass
+- lib/compass/frameworks/compass/stylesheets/compass/css3/_box_sizing.sass
+- lib/compass/frameworks/compass/stylesheets/compass/css3/_columns.sass
+- lib/compass/frameworks/compass/stylesheets/compass/css3/_inline_block.sass
+- lib/compass/frameworks/compass/stylesheets/compass/css3/_opacity.sass
 - lib/compass/frameworks/compass/stylesheets/compass/layout/_sticky_footer.sass
-- lib/compass/frameworks/compass/stylesheets/compass/utilities/_css3.sass
 - lib/compass/frameworks/compass/stylesheets/compass/utilities/_general.sass
 - lib/compass/frameworks/compass/stylesheets/compass/utilities/_links.sass
 - lib/compass/frameworks/compass/stylesheets/compass/utilities/_lists.sass
@@ -252,12 +258,6 @@ files:
 - lib/compass/frameworks/compass/stylesheets/compass/utilities/_sprites.sass
 - lib/compass/frameworks/compass/stylesheets/compass/utilities/_tables.sass
 - lib/compass/frameworks/compass/stylesheets/compass/utilities/_text.sass
-- lib/compass/frameworks/compass/stylesheets/compass/utilities/css3/_border_radius.sass
-- lib/compass/frameworks/compass/stylesheets/compass/utilities/css3/_box_shadow.sass
-- lib/compass/frameworks/compass/stylesheets/compass/utilities/css3/_box_sizing.sass
-- lib/compass/frameworks/compass/stylesheets/compass/utilities/css3/_columns.sass
-- lib/compass/frameworks/compass/stylesheets/compass/utilities/css3/_inline_block.sass
-- lib/compass/frameworks/compass/stylesheets/compass/utilities/css3/_opacity.sass
 - lib/compass/frameworks/compass/stylesheets/compass/utilities/general/_clearfix.sass
 - lib/compass/frameworks/compass/stylesheets/compass/utilities/general/_float.sass
 - lib/compass/frameworks/compass/stylesheets/compass/utilities/general/_hacks.sass
@@ -284,6 +284,7 @@ files:
 - lib/compass/frameworks/compass/templates/extension/stylesheets/main.sass
 - lib/compass/frameworks/compass/templates/extension/templates/project/manifest.rb
 - lib/compass/frameworks/compass/templates/extension/templates/project/screen.sass
+- lib/compass/frameworks/compass/templates/project/USAGE.markdown
 - lib/compass/frameworks/compass/templates/project/ie.sass
 - lib/compass/frameworks/compass/templates/project/manifest.rb
 - lib/compass/frameworks/compass/templates/project/print.sass