dss_parser 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmQwMDI0MzgwYzdiMmEzZGEzOTcxODZiMWNkMzMwMjU0YzJkZjYyZA==
+  data.tar.gz: !binary |-
+    NzY3OGMxYTZkNWEzMjhmM2MxOGNhY2Y3ZmNhMjc3ODJiNTU4YWYzMg==
+SHA512:
+  metadata.gz: !binary |-
+    YmJjZDExNGY5ZTdhZWE1Yjg3MzNjODE3MDRhYzI3OTFlZDhkMjY5N2M4ZDVm
+    NzY2ZWRkMzJhMzYxNzhjYWJmMzk5ODBkODNhODVjYjFjMDZhMmQwMjkzMDA3
+    NzI2MTBiMThmYTY2NjVjMGNiMTRmMjlhZWNkNDkxMjhkZTE2Yjc=
+  data.tar.gz: !binary |-
+    MjdjZmFkZTI4NWM2NGU2ODM4ZWQyZTEzNzEyOTJmZmE1ODI0MzQ1ZTM3NGZj
+    MWFhN2M1MDNlOWM4NDYxNWJkZTYzM2I5NjFmYzFhOTY5MGMzYTY2MGYzYjY1
+    M2QxMzljNzI5N2Y3NDVmNjJmYTk5YmM0MDZhMWMxNWI5M2Q5NjA=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dss-parser.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Spicerack Media Ltd
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# DSS Parser for Ruby
+
+A parser for DSS comments in CSS.
+
+DSS allows documentation of CSS using comments in CSS files, designed to be machine readable for living style guides.  For more information on DSS [https://github.com/DSSWG/DSS](https://github.com/DSSWG/DSS).
+
+This has a couple of additional parsers beyond the DSS spec
+ - Variables for mixins in scss
+ - Section to organise the classes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dss-parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dss-parser
+
+## Usage
+
+To use DSS create an instance of dss-parser parsing in a folder containing your css.  It will recusivly pass any css/scss files in that directory. And then find any DSS comments.
+
+```ruby
+parser = DssParser.new('/path/to/stylesheets')
+dss = parser.get_dss
+```
+
+This will create an array of DSS comments that can be used e.g.
+
+```ruby
+dss.each do |d|
+  d.name
+  d.description
+  d.markup
+  d.section
+  d.states.each do |state|
+    state.name
+    state.description
+  end
+  d.variables.each do |variable|
+    variable.name
+    variable.description
+  end
+end
+```
+
+## Additional Parsers
+
+The gem contains parsers for the main DSS attributes but can be extended with your own parsers.
+
+```ruby
+parser = DssParser.new('/path/to/stylesheet')
+parser.register_parser(MyParser::AdditionalAttribute)
+dss = parser.get_dss
+```
+
+To create your own parser take a look at the parsers in lib/dss_parser/parsers.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dss-parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/dss-parser.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dss_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dss_parser"
+  spec.version       = DssParser::VERSION
+  spec.authors       = ["Graham Hadgraft"]
+  spec.email         = ["graham@spicerack.co.uk"]
+  spec.summary       = %q{A parser for DSS comments}
+  spec.description   = %q{Parses DSS comments from css files}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/dss_parser.rb

@@ -0,0 +1,130 @@
+PARSER_PATH = "#{File.expand_path('../..', __FILE__)}/lib/dss_parser/parsers/*.rb"
+
+require 'ostruct'
+require "dss_parser/version"
+Dir[PARSER_PATH].each {|file| require file }
+
+class DssParser
+  def initialize(stylesheet_path)
+    @stylesheet_path = stylesheet_path
+    @parsers = [DssParser::Parser::Name,
+                DssParser::Parser::Description,
+                DssParser::Parser::States,
+                DssParser::Parser::Markup,
+                DssParser::Parser::Variables,
+                DssParser::Parser::Section]
+  end
+
+  def get_dss
+    comments = []
+
+    find_css_files.each do |file_path|
+      css_file = IO.read(file_path)
+      comments |= parse_for_comments(css_file)
+    end
+
+    comments.map! { |c| build_dss(c) }
+  end
+
+  def register_parser(parser)
+    @parsers.push parser
+  end
+
+  private
+
+  def parse_for_comments(css)
+    lines = css.split "\n"
+
+    css_comments = find_css_comments(lines)
+    sass_comments = find_sass_comments(lines)
+
+    strip_whitespace(css_comments | sass_comments)
+  end
+
+  def build_dss(comment)
+    dss = []
+    @parsers.each do |parser|
+      parsed_content = parser.parse(comment)
+      dss.push parsed_content unless parsed_content.nil?
+    end
+    OpenStruct.new(dss.reduce({}, :merge))
+  end
+
+  def find_css_files
+    Dir.glob("#{@stylesheet_path}**/*.css*")
+  end
+
+  def find_sass_comments(lines)
+    in_comment = false
+    current_comment = []
+    comment_blocks = []
+
+    lines.each do |line_of_css|
+      line_of_css.strip!
+
+      if scss_comment?(line_of_css) || in_comment == true
+        in_comment = true
+
+        current_comment.push line_of_css
+        unless line_of_css.start_with?('//')
+          in_comment = false
+        end
+      else
+        in_comment = false
+        comment_blocks.push current_comment if is_dss_comment?(current_comment)
+        current_comment = []
+      end
+    end
+
+    comment_blocks
+  end
+
+  def find_css_comments(lines)
+    in_comment = false
+    current_comment = []
+    comment_blocks = []
+
+    lines.each do |line_of_css|
+      line_of_css.strip!
+
+      if css_comment?(line_of_css) || in_comment == true
+        in_comment = true
+        current_comment.push line_of_css
+        if line_of_css.end_with?('*/')
+          in_comment = false
+        end
+      else
+        in_comment = false
+        comment_blocks.push current_comment if is_dss_comment?(current_comment)
+        current_comment = []
+      end
+    end
+
+    comment_blocks
+  end
+
+  def is_dss_comment?(comment)
+    comment.any? { |line| line.downcase.include?("@name") || line.downcase.include?("@mixin") }
+  end
+
+  def css_comment?(line)
+    line.start_with?('/*','*/') && !line.end_with?('*/')
+  end
+
+  def scss_comment?(line)
+    line.start_with? '//'
+  end
+
+  def strip_whitespace(comment_blocks)
+    comment_blocks.each do |comment|
+      comment.map!{ |c| c.gsub(/^\/\//, '') }
+      comment.map!{ |c| c.gsub(/^\/\*/, '') }
+      comment.map!{ |c| c.gsub(/^\*\//, '') }
+      comment.map!{ |c| c.gsub(/^\*/, '') }
+      comment.map!{ |c| c.strip }
+      comment.reject!{ |c| c.size < 1 }
+    end
+
+    comment_blocks.reject{ |c| c.size < 1 }
+  end
+end

data/lib/dss_parser/parsers/description.rb

@@ -0,0 +1,30 @@
+class DssParser
+  class Parser
+    class Description
+      def self.parse(lines)
+        description = []
+        in_description = false
+
+        lines.each do |line|
+          if line.start_with?("@") && line !~ /^@description/  && in_description
+            in_description = false
+          end
+
+          if line.start_with?("@")
+            type, content = line.split(" ", 2)
+            if type == "@description"
+              in_description = true
+              description.push content
+            end
+          else
+            if in_description == true
+              description.push line
+            end
+          end
+        end
+
+        return {description: description.join("\n")}
+      end
+    end
+  end
+end

data/lib/dss_parser/parsers/markup.rb

@@ -0,0 +1,30 @@
+class DssParser
+  class Parser
+    class Markup
+      def self.parse(lines)
+        markup = []
+        in_markup = false
+
+        lines.each do |line|
+          if line.start_with?("@") && line !~ /^@markup/  && in_markup
+            in_description = false
+          end
+
+          if line.start_with?("@")
+            type, content = line.split(" ", 2)
+            if type == "@markup"
+              in_markup = true
+              markup.push content
+            end
+          else
+            if in_markup == true
+              markup.push line
+            end
+          end
+        end
+
+        return {markup: markup.join("\n").gsub(/^\n/, '')}
+      end
+    end
+  end
+end

data/lib/dss_parser/parsers/name.rb

@@ -0,0 +1,15 @@
+class DssParser
+  class Parser
+    class Name
+
+      def self.parse(lines)
+        lines.each do |line|
+          type, content = line.split(" ", 2)
+
+          return {name: content} if type == "@name"
+        end
+      end
+
+    end
+  end
+end

data/lib/dss_parser/parsers/section.rb

@@ -0,0 +1,19 @@
+class DssParser
+  class Parser
+    class Section
+      def self.parse(lines)
+        section = {}
+
+        lines.each do |line|
+          type, content = line.split(" ", 2)
+
+          if type == "@section"
+            section =  {section: content}
+          end
+        end
+
+        return section
+      end
+    end
+  end
+end

data/lib/dss_parser/parsers/states.rb

@@ -0,0 +1,22 @@
+class DssParser
+  class Parser
+    class States
+      def self.parse(lines)
+        states = []
+        Struct.new("State", :name, :description) unless defined?(Struct::State)
+
+        lines.each do |line|
+          type, content = line.split(" ", 2)
+
+          if type == "@state"
+            name, description = content.split("-", 2)
+
+            states.push(Struct::State.new(name.strip, description.strip))
+          end
+        end
+
+        return {states: states}
+      end
+    end
+  end
+end

data/lib/dss_parser/parsers/variables.rb

@@ -0,0 +1,22 @@
+class DssParser
+  class Parser
+    class Variables
+      def self.parse(lines)
+        variables = []
+        Struct.new("Variable", :name, :description) unless defined?(Struct::Variable)
+
+        lines.each do |line|
+          type, content = line.split(" ", 2)
+
+          if type == "@variable"
+            name, description = content.split("-", 2)
+
+            variables.push(Struct::Variable.new(name.strip, description.strip))
+          end
+        end
+
+        return {variables: variables}
+      end
+    end
+  end
+end

data/lib/dss_parser/version.rb

@@ -0,0 +1,3 @@
+class DssParser
+  VERSION = "1.0.0"
+end

data/spec/fixtures/buttons.css

@@ -0,0 +1,39 @@
+/**
+ * @name Gradient($Start, $End)
+ * @description Add a gradient to element
+ *
+ * @variable $Start - A hex color at the top of the gradient
+ * @variable $End - A hex color at the bottom of the gradient
+ *
+ */
+
+@mixin gradient($start, $end){
+
+}
+
+/* A non dss comment */
+
+/*
+ @name Button
+ @description Style for a button
+ this is a multiline description
+ @section Forms.Buttons
+
+ @state :disabled - Dims the button when disabled.
+ @state .primary - Indicates button is the primary action.
+ @state .smaller - A smaller button
+
+ @markup
+   <button>markup</button>
+*/
+
+button {
+  max-width: 150px;
+
+  .full-width {
+    width:100%;
+  }
+}
+
+
+

data/spec/fixtures/forms.css.scss

@@ -0,0 +1,53 @@
+//
+// @name Text Input
+// @description Style for a input with type text
+// @section Forms.Inputs
+//
+// @state :disabled - Dims the button when disabled.
+// @state .primary - Indicates button is the primary action.
+// @state .smaller - A smaller button
+//
+// @markup
+//   <button>markup<button>
+//
+
+input[type="text"] {
+  max-width: 150px;
+
+  .full-width {
+    width:100%;
+  }
+}
+
+// This
+// is
+// not
+// a
+// dss
+// comment
+
+.non-documented-class {
+
+}
+
+//
+// @name Submit Input
+// @description Style for an input with type button
+// @section Forms.Inputs
+//
+// @state :disabled - Dims the button when disabled.
+// @state .primary - Indicates button is the primary action.
+// @state .smaller - A smaller button
+//
+// @markup
+//   <button>markup<button>
+//
+
+input[type="submit"] {
+  max-width: 150px;
+
+  .full-width {
+    width:100%;
+  }
+}
+

data/spec/lib/dss_parser_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe DssParser do
+  describe '#get_comments' do
+    it 'finds comments in css files' do
+      parser = DssParser.new("#{File.expand_path('../..', __FILE__)}/fixtures/")
+      comments = parser.get_dss
+
+      expect(comments.size).to eq 4
+    end
+
+    it 'finds dss attributes in dss comments' do
+      parser = DssParser.new("#{File.expand_path('../..', __FILE__)}/fixtures/")
+      comments = parser.get_dss
+
+      mixin = comments[0]
+      dss_button = comments[1]
+
+      expect(dss_button.name).to eq "Button"
+      expect(dss_button.description).to eq "Style for a button\nthis is a multiline description"
+      expect(dss_button.states.size).to eq 3
+      expect(dss_button.states.first.name).to eq ":disabled"
+      expect(dss_button.states.first.description).to eq "Dims the button when disabled."
+      expect(dss_button.markup).to eq "<button>markup</button>"
+      expect(dss_button.section).to eq "Forms.Buttons"
+
+      expect(mixin.variables.size).to eq 2
+      expect(mixin.variables.first.name).to eq "$Start"
+      expect(mixin.variables.first.description).to eq "A hex color at the top of the gradient"
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'dss_parser' # and any other gems you need
+
+RSpec.configure do |config|
+    # some (optional) config here
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: dss_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Graham Hadgraft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parses DSS comments from css files
+email:
+- graham@spicerack.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dss-parser.gemspec
+- lib/dss_parser.rb
+- lib/dss_parser/parsers/description.rb
+- lib/dss_parser/parsers/markup.rb
+- lib/dss_parser/parsers/name.rb
+- lib/dss_parser/parsers/section.rb
+- lib/dss_parser/parsers/states.rb
+- lib/dss_parser/parsers/variables.rb
+- lib/dss_parser/version.rb
+- spec/fixtures/buttons.css
+- spec/fixtures/forms.css.scss
+- spec/lib/dss_parser_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A parser for DSS comments
+test_files:
+- spec/fixtures/buttons.css
+- spec/fixtures/forms.css.scss
+- spec/lib/dss_parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: