kss 0.1.3 → 0.2.0

data/lib/kss.rb

@@ -1,4 +1,6 @@
 require 'sass'
+require 'v8'
+require 'less'
 
 require 'kss/modifier'
 require 'kss/parser'

data/lib/kss/parser.rb

@@ -12,30 +12,75 @@ module Kss
       @sections = {}
 
       Dir["#{base_path}/**/*.*"].each do |filename|
-        root_node = Sass::SCSS::Parser.new(File.read(filename), filename).parse
-        parse_node(root_node, filename)
+        if File.extname(filename) == ".less"
+          tree = Less::Parser.new(:paths => [base_path], :filename => filename).
+            # HACK: get the internal JS tree object
+            parse(File.read(filename)).instance_variable_get "@tree"
 
+          # inject less.js into a new V8 context
+          less = Less.instance_variable_get "@less"
+          cxt = V8::Context.new
+          cxt['less'] = less
+
+          # parse node tree for comments
+          parse_v8_node(cxt, tree, filename)
+        else
+          if filename.match(/\.css$/)
+            root_node = Sass::SCSS::Parser.new(File.read(filename), filename).parse
+          else
+            root_node = Sass::Engine.for_file(filename, {}).to_tree
+          end
+          parse_sass_node(root_node, filename)
+        end
       end
     end
 
-    def parse_node parent_node, filename
+    # Given a Sass::Tree::Node, find all CommentNodes and populate @sections
+    # with parsed Section objects.
+    #
+    # parent_node - A Sass::Tree::Node to start at.
+    # filename    - The filename String this node is found at.
+    #
+    # Returns the Sass::Tree::Node given.
+    def parse_sass_node parent_node, filename
       parent_node.children.each do |node|
         unless node.is_a? Sass::Tree::CommentNode
-          parse_node(node, filename) if node.has_children
+          parse_sass_node(node, filename) if node.has_children
           next
         end
-        comment_text = self.class.clean_comments node.value[0]
+        comment_text = self.class.clean_comments node.to_scss
+        add_section node.to_scss, filename
+      end
+      parent_node
+    end
+
+    def parse_v8_node cxt, parent_node, filename
+      parent_node.rules.each do |node|
+        # inject the current to into JS context
+        cxt['node'] = node
 
-        if self.class.kss_block? comment_text
-          base_name = File.basename(filename)
-          section = Section.new(comment_text, base_name)
-          @sections[section.section] = section
+        unless cxt.eval "node instanceof less.tree.Comment"
+          parse_v8_node(cxt, node, filename) if cxt.eval 'node.rules != null'
+
+          next
         end
+
+        add_section node.value, filename
       end
 
       parent_node
     end
 
+    def add_section comment, filename
+      comment_text = self.class.clean_comments comment
+
+      if self.class.kss_block? comment_text
+        base_name = File.basename(filename)
+        section = Section.new(comment_text, base_name)
+        @sections[section.section] = section
+      end
+    end
+
     # Public: Takes a cleaned (no comment syntax like // or /* */) comment
     # block and determines whether it is a KSS documentation block.
     #
@@ -55,10 +100,14 @@ module Kss
     def self.clean_comments(text)
       text.strip!
 
-      # SASS generated comment syntax
+      # SASS generated multi-line comment syntax
       text.gsub!(/(\/\* )?( \*\/)?/, '') # [/* + space] or [space + */]
       text.gsub!(/\n\s\* ?/, "\n") # * in front of every line
 
+      # SASS generated single-line comment syntax
+      text.gsub!(/\/\/ /, '') # [// + space]
+      text.gsub!(/\/\/\n/, "\n") # [// + carriage return]
+
       # Manual generated comment syntax
       text.gsub!(/^\/\*/, '') # starting block
       text.gsub!(/\*\/$/, '') # ending block

data/lib/kss/version.rb

@@ -1,3 +1,3 @@
 module Kss
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/test/fixtures/less/_label.less

@@ -0,0 +1,10 @@
+/*
+A default form label
+
+Styleguide 5.0.0
+*/
+label {
+  display: block;
+  float: left;  
+  width: 150px;
+}

data/test/fixtures/less/buttons.less

@@ -0,0 +1,51 @@
+/*
+Your standard form button.
+
+:hover    - Highlights when hovering.
+:disabled - Dims the button when disabled.
+.primary  - Indicates button is the primary action.
+.smaller  - A little bit smaller now.
+ 
+Styleguide 2.1.1.
+*/
+button, .button {
+  padding:5px 15px;
+
+  &.primary, &.primary:hover{
+    color:#fff;
+  }
+
+  &.smaller{
+    font-size:9px;
+  }
+
+  &:hover{
+    color:#337797;
+  }
+
+  &:disabled{
+    opacity:0.5;
+  }
+}
+
+/*
+A button suitable for giving stars to someone.
+ 
+.star-given - A highlight indicating you've already given a star.
+.disabled   - Dims the button to indicate it cannot be used.
+
+Styleguide 2.2.1.
+*/
+a.button.star{
+  display:inline-block;
+
+  .star{ font-size:10px; }
+
+  &.star-given{
+    color:#ae7e00;
+  }
+
+  &.disabled{
+    opacity:0.5;
+  }
+}

data/test/fixtures/less/mixins.less

@@ -0,0 +1,8 @@
+/*
+Your standard grid helper.
+
+Styleguide 4.0.0.
+*/
+.grid(@columns, @max: 10) {
+  width: (@columns / @max) * 960px;
+}

data/test/fixtures/less/nested.less

@@ -0,0 +1,17 @@
+@import "_label";
+/*
+Your standard form element.
+
+Styleguide 3.0.0
+*/
+form {
+
+  /*
+  Your standard text input box.
+
+  Styleguide 3.0.1
+  */
+  input[type="text"] {
+    border: 1px solid #ccc;
+  }
+}

data/test/fixtures/sass/buttons.sass

@@ -0,0 +1,40 @@
+/* Your standard form button.
+ *
+ * :hover    - Highlights when hovering.
+ * :disabled - Dims the button when disabled.
+ * .primary  - Indicates button is the primary action.
+ * .smaller  - A little bit smaller now.
+ *
+ * Styleguide 2.1.1. */
+button
+  padding: 5px 15px
+
+  &.primary, &.primary:hover
+    color: #fff
+
+  &.smaller
+    font-size: 11px
+
+  &:hover
+    color: #337797
+
+  &:disabled
+    opacity: 0.5
+
+// A button suitable for giving stars to someone.
+//
+// .star-given - A highlight indicating you've already given a star.
+// .disabled   - Dims the button to indicate it cannot be used.
+//
+// Styleguide 2.2.1.
+a.button.star
+  display: inline-block
+
+  .star
+    font-size: 10px
+
+  &.star-given
+    color: #ae7e00
+
+  &.disabled
+    opacity: 0.5

data/test/fixtures/sass/nested.sass

@@ -0,0 +1,10 @@
+/* Your standard form element.
+ *
+ * Styleguide 3.0.0 */
+form
+
+  /* Your standard text input box.
+   *
+   * Styleguide 3.0.1 */
+  input[type="text"]
+    border: 1px solid #ccc

data/test/parser_test.rb

@@ -4,7 +4,9 @@ class ParserTest < Kss::Test
 
   def setup
     @scss_parsed = Kss::Parser.new('test/fixtures/scss')
+    @sass_parsed = Kss::Parser.new('test/fixtures/sass')
     @css_parsed = Kss::Parser.new('test/fixtures/css')
+    @less_parsed = Kss::Parser.new('test/fixtures/less')
 
     @css_comment = <<comment
 /*
@@ -26,13 +28,22 @@ comment
  * Styleguide 2.2.1. */
 comment
 
+  @slashed_css_comment = <<comment
+// A button suitable for giving stars to someone.
+//
+// .star-given - A highlight indicating you've already given a star.
+// .disabled   - Dims the button to indicate it cannot be used.
+//
+// Styleguide 2.2.1.
+comment
+
   @indented_css_comment = <<comment
   /*
   A button suitable for giving stars to someone.
-  
+
   .star-given - A highlight indicating you've already given a star.
   .disabled   - Dims the button to indicate it cannot be used.
-  
+
   Styleguide 2.2.1.
   */
 comment
@@ -54,6 +65,21 @@ comment
       @scss_parsed.section('2.1.1').description
   end
 
+  test "parsers KSS comments in LESS" do
+    assert_equal 'Your standard form button.',
+      @less_parsed.section('2.1.1').description
+  end
+
+  test "parses KSS multi-line comments in SASS (/* ... */)" do
+    assert_equal 'Your standard form button.',
+      @sass_parsed.section('2.1.1').description
+  end
+
+  test "parses KSS single-line comments in SASS (// ... )" do
+    assert_equal 'A button suitable for giving stars to someone.',
+      @sass_parsed.section('2.2.1').description
+  end
+
   test "parses KSS comments in CSS" do
     assert_equal 'Your standard form button.',
       @css_parsed.section('2.1.1').description
@@ -64,6 +90,8 @@ comment
       Kss::Parser.clean_comments(@css_comment)
     assert_equal @cleaned_css_comment,
       Kss::Parser.clean_comments(@starred_css_comment)
+    assert_equal @cleaned_css_comment,
+      Kss::Parser.clean_comments(@slashed_css_comment)
     assert_equal @cleaned_css_comment,
       Kss::Parser.clean_comments(@indented_css_comment)
   end
@@ -73,4 +101,14 @@ comment
     assert_equal "Your standard text input box.", @scss_parsed.section('3.0.1').description
   end
 
+  test "parses nested LESS documents" do
+    assert_equal "Your standard form element.", @less_parsed.section('3.0.0').description
+    assert_equal "Your standard text input box.", @less_parsed.section('3.0.1').description
+  end
+
+  test "parses nested SASS documents" do
+    assert_equal "Your standard form element.", @sass_parsed.section('3.0.0').description
+    assert_equal "Your standard text input box.", @sass_parsed.section('3.0.1').description
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kss
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kyle Neath
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-10 00:00:00 -08:00
+date: 2012-01-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,6 +33,21 @@ dependencies:
         version: "3.1"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: less
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id002
 description: "  Inspired by TomDoc, KSS attempts to provide a methodology for writing\n  maintainable, documented CSS within a team. Specifically, KSS is a CSS\n  structure, documentation specification, and styleguide format.\n\n  This is a ruby library for parsing KSS documented CSS and generating\n  styleguides.\n"
 email: kneath@gmail.com
 executables: []
@@ -52,6 +67,12 @@ files:
 - lib/kss.coffee
 - lib/kss.rb
 - test/fixtures/css/buttons.css
+- test/fixtures/less/_label.less
+- test/fixtures/less/buttons.less
+- test/fixtures/less/mixins.less
+- test/fixtures/less/nested.less
+- test/fixtures/sass/buttons.sass
+- test/fixtures/sass/nested.sass
 - test/fixtures/scss/buttons.scss
 - test/fixtures/scss/nested.scss
 - test/helper.rb