kss 0.3.0 → 0.4.0

data/README.md

@@ -65,7 +65,7 @@ The library is also fully TomDoc'd, completing the circle of life.
 The documenting syntax and ruby library are intended to generate styleguides automatically. To do this, you'll need to leverage a small javascript library that generates class styles for pseudo-class styles (`:hover`, `:disabled`, etc).
 
 * [kss.coffee](https://github.com/kneath/kss/blob/master/lib/kss.coffee)
-* [kss.js](https://github.com/kneath/kss/blob/master/lib/kss.js) (compiled js)
+* [kss.js](https://github.com/kneath/kss/blob/master/example/public/javascripts/kss.js) (compiled js)
 
 For an example of how to generate a styleguide, check out the [`example`](https://github.com/kneath/kss/tree/master/example) sinatra application.
 
@@ -75,4 +75,4 @@ To hack on KSS, you'll need to install dependencies with `bundle install`. Run t
 
 To make your life easier, I suggest `bundle install --binstubs` and adding `bin/` to your `$PATH`. If you don't understand this, just blindly add `bundle exec` in front of everything you'd normally do, like `bundle exec rake`.
 
-I apologize on behalf of the Ruby community for this, it's embarrassing and disappointing that dependency management is still so clumsy.
+I apologize on behalf of the Ruby community for this, it's embarrassing and disappointing that dependency management is still so clumsy.

data/lib/kss.coffee

@@ -1,7 +1,7 @@
 # This class scans your stylesheets for pseudo classes, then inserts a new CSS
 # rule with the same properties, but named 'psuedo-class-{{name}}'.
 #
-# Supported pseudo classes: hover, disabled, active, visited.
+# Supported pseudo classes: hover, disabled, active, visited, focus.
 #
 # Example:
 #
@@ -9,15 +9,15 @@
 #   => a.pseudo-class-hover{ color:blue; }
 class KssStateGenerator
   constructor: ->
-    pseudos = /(\:hover|\:disabled|\:active|\:visited)/g
+    pseudos = /(\:hover|\:disabled|\:active|\:visited|\:focus)/g
 
     try
       for stylesheet in document.styleSheets
         idxs = []
         for rule, idx in stylesheet.cssRules
-          if (rule.type == CSSRule.STYLE_RULE) && pseudos.test(rule.selectorText)
+          while (rule.type == CSSRule.STYLE_RULE) && pseudos.test(rule.selectorText)
             replaceRule = (matched, stuff) ->
-              return ".pseudo-class-" + matched.replace(':', '')
+              return matched.replace(/\:/g, '.pseudo-class-')
             @insertRule(rule.cssText.replace(pseudos, replaceRule))
 
   # Takes a given style and attaches it to the current page.
@@ -36,4 +36,4 @@ class KssStateGenerator
 
     headEl.appendChild(styleEl)
 
-new KssStateGenerator
+new KssStateGenerator

data/lib/kss/parser.rb

@@ -10,14 +10,16 @@ module Kss
     # within the directory recursively for any comment blocks that look like
     # KSS.
     #
-    # base_path - The path String where style files are located.
-    def initialize(base_path)
+    # paths - Each path String where style files are located.
+    def initialize(*paths)
       @sections = {}
 
-      Dir["#{base_path}/**/*.*"].each do |filename|
-        parser = CommentParser.new(filename)
-        parser.blocks.each do |comment_block|
-          add_section comment_block, filename if self.class.kss_block?(comment_block)
+      paths.each do |path|
+        Dir["#{path}/**/*.*"].each do |filename|
+          parser = CommentParser.new(filename)
+          parser.blocks.each do |comment_block|
+            add_section comment_block, filename if self.class.kss_block?(comment_block)
+          end
         end
       end
     end

data/lib/kss/section.rb

@@ -34,12 +34,8 @@ module Kss
     def section
       return @section unless @section.nil?
 
-      comment_sections.each do |text|
-        if text =~ /Styleguide \d/i
-          cleaned = text.strip.sub(/\.$/, '') # Kill trailing period
-          @section = cleaned.match(/Styleguide (.+)/)[1]
-        end
-      end
+      cleaned  = section_comment.strip.sub(/\.$/, '') # Kill trailing period
+      @section = cleaned.match(/Styleguide (.+)/)[1]
 
       @section
     end
@@ -48,7 +44,10 @@ module Kss
     #
     # Returns the description String.
     def description
-      comment_sections.first
+      comment_sections.reject do |section|
+        section == section_comment ||
+        section == modifiers_comment
+      end.join("\n\n")
     end
 
     # Public: The modifiers section of a styleguide comment block.
@@ -57,9 +56,10 @@ module Kss
     def modifiers
       last_indent = nil
       modifiers = []
-      return modifiers unless comment_sections[1]
 
-      comment_sections[1].split("\n").each do |line|
+      return modifiers unless modifiers_comment
+
+      modifiers_comment.split("\n").each do |line|
         next if line.strip.empty?
         indent = line.scan(/^\s*/)[0].to_s.size
 
@@ -76,5 +76,18 @@ module Kss
       modifiers
     end
 
+  private
+  
+    def section_comment
+      comment_sections.find do |text|
+        text =~ /Styleguide \d/i
+      end.to_s
+    end
+  
+    def modifiers_comment
+      comment_sections[1..-1].reject do |section|
+        section == section_comment
+      end.last
+    end
   end
 end

data/lib/kss/version.rb

@@ -1,3 +1,3 @@
 module Kss
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/test/parser_test.rb

@@ -7,6 +7,7 @@ class ParserTest < Kss::Test
     @sass_parsed = Kss::Parser.new('test/fixtures/sass')
     @css_parsed = Kss::Parser.new('test/fixtures/css')
     @less_parsed = Kss::Parser.new('test/fixtures/less')
+    @multiple_parsed = Kss::Parser.new('test/fixtures/scss', 'test/fixtures/less')
 
     @css_comment = <<comment
 /*
@@ -104,4 +105,8 @@ comment
     assert_equal 2, @css_parsed.sections.count
   end
 
+  test "parse multiple paths" do
+    assert_equal 6, @multiple_parsed.sections.count
+  end
+
 end

data/test/section_test.rb

@@ -4,6 +4,8 @@ class SectionTest < Kss::Test
 
   def setup
     @comment_text = <<comment
+# Form Button
+
 Your standard form button.
 
 :hover    - Highlights when hovering.
@@ -18,7 +20,7 @@ comment
   end
 
   test "parses the description" do
-    assert_equal "Your standard form button.", @section.description
+    assert_equal "# Form Button\n\nYour standard form button.", @section.description
   end
 
   test "parses the modifiers" do
@@ -37,4 +39,4 @@ comment
     assert_equal '2.1.1', @section.section
   end
 
-end
+end

metadata

@@ -1,33 +1,25 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: kss
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Kyle Neath
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-06 00:00:00 -08:00
-default_executable: 
+date: 2012-08-02 00:00:00.000000000 Z
 dependencies: []
-
-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"
+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: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.md
 - Rakefile
 - LICENSE
@@ -52,39 +44,28 @@ files:
 - test/helper.rb
 - test/parser_test.rb
 - test/section_test.rb
-has_rdoc: true
 homepage: http://github.com/kneath/kss
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A library for parsing KSS documented stylesheets and generating styleguides
 test_files: []
-