lib/kss/parser.rb

Summary

Maintainability
A
1 hr
Test Coverage
module Kss
  # Public: The main KSS parser. Takes a directory full of SASS / SCSS / CSS
  # files and parses the KSS within them.
  class Parser
    # Public: Returns a hash of Sections.
    attr_accessor :sections

    # Public: Initializes a new parser based on a directory of files or kss strings.
    # Scans within the directory recursively or the strings for any comment blocks
    # that look like KSS.
    #
    # paths_or_strings - Each path String where style files are located, or each String containing KSS.
    def initialize(*paths_or_strings)
      @sections = {}

      paths_or_strings.each do |path_or_string|
        if Dir.exists?(path_or_string)
          # argument is a path
          path = path_or_string
          Dir["#{path}/**/*.{css,less,sass,scss}"].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
        else
          # argument is a KSS string
          kss_string = path_or_string
          parser = CommentParser.new(kss_string)
          parser.blocks.each do |comment_block|
            add_section(comment_block) if self.class.kss_block?(comment_block)
          end
        end
      end
    end

    def add_section(comment_text, filename = '')
      base_name = File.basename(filename)
      section = Section.new(comment_text, base_name)
      @sections[section.section] = section
    end

    # Public: Takes a cleaned (no comment syntax like // or /* */) comment
    # block and determines whether it is a KSS documentation block.
    #
    # Returns a boolean indicating whether the block conforms to KSS.
    def self.kss_block?(cleaned_comment)
      return false unless cleaned_comment.is_a? String

      possible_reference = cleaned_comment.split("\n\n").last
      possible_reference =~ STYLEGUIDE_PATTERN
    end

    # Public: Finds the Section for a given styleguide reference.
    #
    # Returns a Section for a reference, or a blank Section if none found.
    def section(reference)
      @sections[reference] || Section.new
    end

  end
end