csscss 1.2.0 → 1.3.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+_site

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.3.0 - 4/20/2013 ##
+
+* Adds --require switch for user configuration
+* Deprecates --compass-with-config config.rb in favor of --compass --require config.rb
+* Ignores @import statements. Users will need to run csscss on those directly
+* Adds --ignore-sass-mixins which won't match declarations coming from sass mixins
+
 ## 1.2.0 - 4/14/2013 ##
 
 * 0 and 0px are now reconciled as redundancies

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csscss (1.2.0)
+    csscss (1.3.0)
       colorize
       parslet (~> 1.5)
 

data/lib/csscss/cli.rb

@@ -9,6 +9,7 @@ module Csscss
       @ignored_properties = []
       @ignored_selectors  = []
       @match_shorthand    = true
+      @ignore_sass_mixins = false
     end
 
     def run
@@ -18,7 +19,7 @@ module Csscss
 
     private
     def execute
-      warn_old_debug_flag if ENV["CSSCSS_DEBUG"]
+      deprecate("Use --show-parser-errors instead of CSSCSS_DEBUG") if ENV["CSSCSS_DEBUG"]
 
       all_contents= @argv.map do |filename|
         if filename =~ URI.regexp
@@ -71,48 +72,61 @@ module Csscss
           @verbose = v
         end
 
-        opts.on("--[no-]color", "Colorize output (default is #{@color})") do |c|
+        opts.on("--[no-]color", "Colorize output", "(default is #{@color})") do |c|
           @color = c
         end
 
-        opts.on("-n", "--num N", Integer, "Print matches with at least this many rules. Defaults to 3") do |n|
+        opts.on("-n", "--num N", Integer, "Print matches with at least this many rules.", "(default is 3)") do |n|
           @minimum = n
         end
 
-        opts.on("--ignore-properties property1,property2,...", Array, "Ignore these properties when finding matches") do |ignored_properties|
-          @ignored_properties = ignored_properties
+        opts.on("--[no-]match-shorthand", "Expand shorthand rules and matches on explicit rules", "(default is true)") do |match_shorthand|
+          @match_shorthand = match_shorthand
         end
 
-        opts.on('--ignore-selectors "selector1","selector2",...', Array, "Ignore these selectors when finding matches") do |ignored_selectors|
-          @ignored_selectors = ignored_selectors
+        opts.on("-j", "--[no-]json", "Output results in JSON") do |j|
+          @json = j
         end
 
-        opts.on("-V", "--version", "Show version") do |v|
-          puts opts.ver
-          exit
+        opts.on("--ignore-sass-mixins", "EXPERIMENTAL: Ignore matches that come from including sass/scss mixins",
+                "This is an experimental feature and may not be included in future releases",
+                "(default is false)") do |ignore|
+          @ignore_sass_mixins = ignore
         end
 
         opts.on("--[no-]compass", "Enable compass extensions when parsing sass/scss (default is false)") do |compass|
           enable_compass if @compass = compass
         end
 
-        opts.on("--compass-with-config config", "Enable compass extensions when parsing sass/scss and pass config file") do |config|
+        opts.on("--compass-with-config config", "Enable compass extensions when parsing sass/scss and pass config file",
+                "DEPRECATED: use --compass --require path/to/config.rb instead."
+               ) do |config|
+          deprecate("Use --compass --require #{config} instead of --compass-with-config #{config}")
           @compass = true
           enable_compass(config)
         end
 
-        opts.on("--[no-]match-shorthand", "Expands shorthand rules and matches on explicit rules (default is true)") do |match_shorthand|
-          @match_shorthand = match_shorthand
+        opts.on("--require file.rb", "Load ruby file before running csscss.", "Great for bootstrapping requires/configurations") do |file|
+          load file
         end
 
-        opts.on("-j", "--[no-]json", "Output results in JSON") do |j|
-          @json = j
+        opts.on("--ignore-properties property1,property2,...", Array, "Ignore these properties when finding matches") do |ignored_properties|
+          @ignored_properties = ignored_properties
+        end
+
+        opts.on('--ignore-selectors "selector1","selector2",...', Array, "Ignore these selectors when finding matches") do |ignored_selectors|
+          @ignored_selectors = ignored_selectors
         end
 
         opts.on("--show-parser-errors", "Print verbose parser errors") do |show_parser_errors|
           @show_parser_errors = show_parser_errors
         end
 
+        opts.on("-V", "--version", "Show version") do |v|
+          puts opts.ver
+          exit
+        end
+
         opts.on_tail("-h", "--help", "Show this message") do
           print_help(opts)
         end
@@ -129,20 +143,18 @@ module Csscss
       exit
     end
 
-    def warn_old_debug_flag
-      $stderr.puts "CSSCSS_DEBUG is now deprecated. Use --show-parser-errors instead".red
+    def deprecate(message)
+      $stderr.puts("DEPRECATED: #{message}".yellow)
     end
 
     def enable_compass(config = nil)
-      require "compass"
+      abort 'Must install the "compass" gem before enabling its extensions' unless gem_installed?("compass")
 
       if config
         Compass.add_configuration(config)
       else
         Compass.add_configuration("config.rb") if File.exist?("config.rb")
       end
-    rescue LoadError
-      abort "Must install compass gem before enabling its extensions"
     end
 
     def windows_1_9
@@ -159,14 +171,17 @@ module Csscss
     end
 
     def load_sass_file(filename)
-      if !gem_installed?("sass") then
-        abort 'Must install the "sass" gem before parsing sass/scss files'
-      end
+      abort 'Must install the "sass" gem before parsing sass/scss files' unless gem_installed?("sass")
 
       sass_options = {cache:false}
       sass_options[:load_paths] = Compass.configuration.sass_load_paths if @compass
       begin
-        Sass::Engine.for_file(filename, sass_options).render
+        tree = Sass::Engine.for_file(filename, sass_options).to_tree
+        if @ignore_sass_mixins
+          require "csscss/sass_include_extensions"
+          Csscss::SassMixinVisitor.visit(tree)
+        end
+        tree.render
       rescue Sass::SyntaxError => e
         if e.message =~ /compass/ && !@compass
           puts "Enable --compass option to use compass's extensions"
@@ -178,10 +193,7 @@ module Csscss
     end
 
     def load_less_file(filename)
-      if !gem_installed?("less") then
-        abort 'Must install the "less" gem before parsing less files'
-      end
-
+      abort 'Must install the "less" gem before parsing less files' unless gem_installed?("less")
       contents = load_css_file(filename)
       Less::Parser.new.parse(contents).to_css
     end

data/lib/csscss/parser/css.rb

@@ -36,12 +36,30 @@ module Csscss
           space?
         }
 
+        rule(:mixin_attributes) {
+          (
+            str('/* CSSCSS START MIXIN') >>
+            (str('*/').absent? >> any).repeat >>
+            str('*/') >>
+            (str('/* CSSCSS END MIXIN').absent? >> any).repeat >>
+            str('/* CSSCSS END MIXIN') >>
+            (str('*/').absent? >> any).repeat >>
+            str('*/') >>
+            space?
+          ).as(:mixin)
+        }
+
         rule(:ruleset) {
           (
             match["^{}"].repeat(1).as(:selector) >>
             str("{") >>
             space? >>
-            (comment | attribute | blank_attribute).repeat(0).as(:properties) >>
+            (
+              mixin_attributes |
+              comment          |
+              attribute        |
+              blank_attribute
+            ).repeat(0).as(:properties) >>
             str("}") >>
             space?
           ).as(:ruleset)
@@ -58,8 +76,22 @@ module Csscss
           ).as(:nested_ruleset)
         }
 
+        rule(:import) {
+          (
+            stri("@import") >>
+            match["^;"].repeat(1) >>
+            str(";") >>
+            space?
+          ).as(:import)
+        }
+
         rule(:blocks) {
-          space? >> (comment | nested_ruleset | ruleset).repeat(1).as(:blocks) >> space?
+          space? >> (
+            comment        |
+            import         |
+            nested_ruleset |
+            ruleset
+          ).repeat(1).as(:blocks) >> space?
         }
 
         root(:blocks)
@@ -70,6 +102,9 @@ module Csscss
           rulesets
         }
 
+        rule(import: simple(:import)) { [] }
+        rule(mixin: simple(:mixin)) { nil }
+
         rule(comment: simple(:comment)) { nil }
 
         rule(ruleset: {

data/lib/csscss/sass_include_extensions.rb

@@ -0,0 +1,19 @@
+require "sass"
+
+module Csscss
+  class SassMixinVisitor < Sass::Tree::Visitors::Base
+    def self.visit(root)
+      new.send(:visit, root)
+    end
+
+    def visit_mixindef(node)
+      begin_comment = Sass::Tree::CommentNode.new(["/* CSSCSS START MIXIN: #{node.name} */"], :normal)
+      end_comment = Sass::Tree::CommentNode.new(["/* CSSCSS END MIXIN: #{node.name} */"], :normal)
+
+      begin_comment.options = end_comment.options = {}
+
+      node.children.unshift(begin_comment)
+      node.children.push(end_comment)
+    end
+  end
+end

data/lib/csscss/version.rb

@@ -1,3 +1,3 @@
 module Csscss
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/test/csscss/parser/css_test.rb

@@ -104,7 +104,7 @@ module Csscss::Parser
         ])
       end
 
-      it "recognizes media queries" do
+      it "recognizes @media queries" do
         css = %$
           @media only screen {
             /* some comment */
@@ -129,12 +129,55 @@ module Csscss::Parser
         ])
       end
 
+      it "ignores @import statements" do
+        css = %$
+          @import "foo.css";
+          @import "bar.css";
+
+          /*
+          .x {
+              padding: 3px;
+          }
+          */
+
+          h1 {
+            outline: 1px;
+          }
+        $
+
+        trans(css).must_equal([
+          rs(sel("h1"), [dec("outline", "1px")])
+        ])
+      end
+
       it "ignores double semicolons" do
         trans("h1 { display:none;;}").must_equal([
           rs(sel("h1"), [dec("display", "none")])
         ])
       end
 
+      it "ignores mixin selectors" do
+        css = %$
+        h1 {
+          /* CSSCSS START MIXIN: foo */
+          font-family: serif;
+          font-size: 10px;
+          display: block;
+          /* CSSCSS END MIXIN: foo */
+
+          /* CSSCSS START MIXIN: bar */
+          outline: 1px;
+          /* CSSCSS END MIXIN: bar */
+
+          float: left;
+        }
+        $
+
+        trans(css).must_equal([
+          rs(sel("h1"), [dec("float", "left")])
+        ])
+      end
+
       it "parses attributes with encoded data that include semicolons" do
         trans(%$
             .foo1 {

data/test/csscss/sass_include_extensions_test.rb

@@ -0,0 +1,45 @@
+require "test_helper"
+require "csscss/sass_include_extensions"
+
+module Csscss
+  describe "sass import extensions" do
+    it "should do something" do
+      scss =<<-SCSS
+      @mixin foo {
+        font: {
+          family: serif;
+          size: 10px;
+        }
+
+        display: block;
+      }
+
+      @mixin bar {
+        outline: 1px;
+      }
+
+      h1 {
+        @include foo;
+        @include bar;
+      }
+      SCSS
+
+
+      css =<<-CSS
+h1 {
+  /* CSSCSS START MIXIN: foo */
+  font-family: serif;
+  font-size: 10px;
+  display: block;
+  /* CSSCSS END MIXIN: foo */
+  /* CSSCSS START MIXIN: bar */
+  outline: 1px;
+  /* CSSCSS END MIXIN: bar */ }
+      CSS
+
+      tree = Sass::Engine.new(scss, syntax: :scss).to_tree
+      Csscss::SassMixinVisitor.visit(tree)
+      tree.render.must_equal(css)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csscss
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-14 00:00:00.000000000 Z
+date: 2013-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -85,6 +85,7 @@ files:
 - lib/csscss/parslet_optimizations.rb
 - lib/csscss/redundancy_analyzer.rb
 - lib/csscss/reporter.rb
+- lib/csscss/sass_include_extensions.rb
 - lib/csscss/types.rb
 - lib/csscss/version.rb
 - test/csscss/json_reporter_test.rb
@@ -104,6 +105,7 @@ files:
 - test/csscss/parser/padding_test.rb
 - test/csscss/redundancy_analyzer_test.rb
 - test/csscss/reporter_test.rb
+- test/csscss/sass_include_extensions_test.rb
 - test/csscss/types_test.rb
 - test/just_parse.rb
 - test/test_helper.rb
@@ -127,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4177886489285701178
+      hash: 2367732181301313903
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -152,6 +154,7 @@ test_files:
 - test/csscss/parser/padding_test.rb
 - test/csscss/redundancy_analyzer_test.rb
 - test/csscss/reporter_test.rb
+- test/csscss/sass_include_extensions_test.rb
 - test/csscss/types_test.rb
 - test/just_parse.rb
 - test/test_helper.rb