marmara 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caffd5bb8874fcb945d1afd57aa80bf8f214783a
-  data.tar.gz: cd9f49013b3b591c9620d1193cb801832375c7d3
+  metadata.gz: a30c4afdfc40d807cee2c3e6dd4f2e02bd895530
+  data.tar.gz: 675fc30f309c95239b6853e7435fadec407773c4
 SHA512:
-  metadata.gz: a6d5ce21997d98f2fc262af141e2bcdc233a03da0c4a23f670f06d0c4d13cb53beb4a831a26e27e2059474ddf4791498721cba33929949e4af094fb1f09344c0
-  data.tar.gz: f34584cfe0a76c92472e4c14d34e537323165b2bf3107f5e5f0b824e06d665c9ce59dbb246e3a501f59e00af1856c24ff504cb2db3ccec0b9074d1a834a00e98
+  metadata.gz: 7c635c1f1e7ad3984ef846f31ac06c5ea469040d99d6f7ef9ffe708cbe8966b9f9da8ab9ccd765bc4e9a12cc3e9a03ebdfcefacc5527f6b845eddd2c127d895f
+  data.tar.gz: 7bff9f22acbd90c6c3df8acb5a7712b943449da663b73ff17c1b0f0ab6d9599e0355ab41643156e35c432ac21d1f017ec57e65c7f6db9efba9ecee70d2962e49

data/README.md

@@ -1,7 +1,7 @@
 # Marmara
 Marmara is a Ruby Gem that analyses your css during UI testing and generates a code coverage report.
 
-![Alt text](https://i.imgur.com/zX9SSuF.png)
+![Example screenshot of Marmara output](https://i.imgur.com/N7J6wjD.png)
 
 ## Why is CSS code coverage important?
 CSS code coverage is a little different than traditional code coverage.
@@ -67,20 +67,6 @@ AfterStep do
 end
 ```
 
-Since I also want to capture used selectors for mobile, my after step looks more like this:
-
-```ruby
-AfterStep do
-  if Marmara.recording?
-    Marmara.record(page)
-    old_size = page.driver.browser.client.window_size
-    page.driver.resize_window(600, 400)
-    Marmara.record(page)
-    page.driver.resize_window(*old_size)
-  end
-end
-```
-
 ### 3. Stop recording and generate your output
 
 ```ruby
@@ -89,5 +75,65 @@ at_exit do
 end
 ```
 
-## Development plan
-This project is currently in a "works in my project" stage, there's still work to be done to make it more vendable so I welcome pull requests. In addition, there are probably a lot of tweaks required to the parser and a lot of features that would be nice to have.
+You can also integrate with your existing tests to run all of the time if you like. To do that you can simply include `Marmara.start_recording` near the top of your `env.rb` file.
+
+## Execution
+
+If you're using a rake task like I have described above, simply execute:
+
+```bash
+rake css:cover
+```
+
+You should see your tests exceute normally but after your tests complete you should see:
+
+```bash
+Compiling CSS coverage report...
+
+    application.css:
+              Rules: 50/100 (50.00%)
+              Selectors:  75/200 (37.50%)
+              Declarations:  333/500 (66.67%)
+
+    fonts.css:
+              Rules: 2/2 (100.00%)
+              Selectors:  0/0 (NaN%)
+              Declarations:  2/2 (100.00%)
+
+    Overall:
+              Rules: 52/102 (50.98%)
+              Selectors:  75/200 (37.50%)
+              Declarations:  2/2 (66.73%)
+```
+
+A **rule** is matched whenever at least one selector is covered, each **selector** within a rule is covered independently, **declarations** are each property and value pair within a rule.
+
+You should now be able to find coverage report in your `log/css` directory. In the example above you should expect to find the files:
+
+```PowerShell
+[my_app]
+  ├ [app]
+  │   └ # ...
+  ├ [log]
+  │   ├ [css]
+  │   │   ├ application.css.html
+  │   │   └ fonts.css.html
+  │   ├ # application.log
+  │   └ # ...
+  └ [spec]
+      └ # ...
+```
+
+Open `application.css.html` or `fonts.css.html` in your browser to display your line coverage report.
+
+## Configuration
+
+### Output location
+You can change the output location of your coverage reports by setting:
+
+```Ruby
+Marmara.output_directory = '../build/logs'
+Marmara.start_recording
+```
+
+Set the `output_directory` before you start recording and you should find your HTML reports located in the directory you provided. *Note that this directory will removed and re-created each time the tests are run.*

data/lib/marmara/parser.rb

@@ -0,0 +1,19 @@
+require 'css_parser'
+
+module CssParser
+  class MarmaraParser < Parser
+    attr_reader :last_file_contents
+
+    def read_remote_file(uri)
+      if Gem.win_platform? && uri.scheme == 'file' && uri.path =~ /^\/[a-zA-Z]:\/[a-zA-Z]:\//
+        # file scheme seems to be broken for windows, do some fixing
+        uri.path = uri.path.gsub(/^\/[a-zA-Z]:\/([a-zA-Z]:\/.*)$/, '\1')
+      end
+
+      # save the output
+      result = super(uri)
+      @last_file_contents = result.first
+      return result
+    end
+  end
+end

data/lib/marmara.rb

@@ -1,7 +1,6 @@
 require 'open-uri'
 require 'cgi'
-require 'cgi'
-require 'css_parser'
+require 'marmara/parser'
 
 module Marmara
 
@@ -61,9 +60,11 @@ module Marmara
 
           parser = nil
           begin
-            parser = CssParser::Parser.new
+            parser = CssParser::MarmaraParser.new
             parser.load_uri!(sheet, capture_offsets: true)
-          rescue
+          rescue Exception => e
+            puts e.to_s
+            puts "\t" + e.backtrace.join("\n\t")
             log "Error reading #{sheet}"
           end
 
@@ -74,7 +75,7 @@ module Marmara
               rule.each_selector do |sel, dec, spec|
                 if sel.length > 0
                   # we need to look for @keyframes and @font-face coverage differently
-                  if sel.first == '@'
+                  if sel[0] == '@'
                     rule_type = sel[1..-1]
                     at_rule = {
                         rule: rule,
@@ -89,12 +90,17 @@ module Marmara
                       at_rule[:property] = ["#{$1}animation-name", "#{$1}animation"]
                       at_rule[:value] = $2
                       at_rule[:valueRegex] = [/(?:^|,)\s*(?:#{Regexp.escape(at_rule[:value])})\s*(?:,|;?$)/, /(?:^|\s)(?:#{Regexp.escape(at_rule[:value])})(?:\s|;?$)/]
+                    when /^(\-moz\-document|supports)/
+                      # ignore these types
+                      at_rule[:used] = true
                     end
 
-                    at_rule[:valueRegex] ||= /(?:^|,)\s*(?:#{Regexp.escape(at_rule[:value])}|\"#{Regexp.escape(at_rule[:value])}\")\s*(?:,|;?$)/
+                    if at_rule[:value]
+                      at_rule[:valueRegex] ||= /(?:^|,)\s*(?:#{Regexp.escape(at_rule[:value])}|\"#{Regexp.escape(at_rule[:value])}\")\s*(?:,|;?$)/
 
-                    # store all the info that we collected about the rule
-                    @style_sheet_rules[sheet] << at_rule
+                      # store all the info that we collected about the rule
+                      @style_sheet_rules[sheet] << at_rule
+                    end
                   else
                     # just a regular selector, collect it
                     selectors << {
@@ -123,7 +129,7 @@ module Marmara
 
             # store info about the stylesheet
             @style_sheets[sheet] = {
-              css: download_style_sheet(sheet),
+              css: parser.last_file_contents,
               all_selectors: all_selectors,
               all_at_rules: all_at_rules,
               included_with: Set.new
@@ -285,7 +291,7 @@ module Marmara
     end
 
     def get_report_filename(uri)
-      File.basename(uri)
+      File.basename(uri).gsub(/^(.*?)\?.*$/, '\1')
     end
 
     def is_property_covered(sheets, property, valueRegex)
@@ -361,21 +367,25 @@ module Marmara
               covered_selectors += rule[:used_selectors].count
             else
               original_selectors, = @style_sheets[uri][:css].byteslice(rule[:rule].offset).split(/\s*\{/, 2)
-              selector_i = 0
 
-              original_selectors.scan(/(?<=^|,)\s*(.*?)\s*(?=,|$)/m) do |match|
+              selectors_length = 0
+              original_selectors.split(/,/m).each_with_index do |sel, selector_i|
+                sel_length = sel.length
+                sel_length += 1 unless selector_i == (rule[:used_selectors].length - 1)
+
                 is_covered = rule[:used_selectors][selector_i] ? :covered : :not_covered
                 covered_selectors += 1 if is_covered
                 sheet_covered_rules << {
                   offset: [
-                      coverage[:offset][0] + Regexp.last_match.offset(0).first,
-                      coverage[:offset][0] + Regexp.last_match.offset(0).last
+                      coverage[:offset][0] + selectors_length,
+                      coverage[:offset][0] + selectors_length + sel_length
                     ],
                   state: is_covered
                 }
-                selector_i += 1
+                selectors_length += sel_length
               end
-              coverage[:offset][0] += original_selectors.length + 1
+
+              coverage[:offset][0] += original_selectors.length
             end
           else
             rule[:rule].each_declaration do
@@ -457,13 +467,20 @@ module Marmara
       # collect the sheet html
       coverage.each do |rule|
         sheet_html += wrap_code(original_sheet.byteslice(last_index...rule[:offset][0]), :ignored)
-        sheet_html += wrap_code(original_sheet.byteslice(rule[:offset][0]..rule[:offset][1]), rule[:state])
-        last_index = rule[:offset][1] + 1
+        sheet_html += wrap_code(original_sheet.byteslice(rule[:offset][0]...rule[:offset][1]), rule[:state])
+        last_index = rule[:offset][1]
+      end
+
+      # finish off the rest of the file
+      if last_index < original_sheet.length
+        sheet_html += wrap_code(original_sheet[last_index...original_sheet.length], :ignored)
       end
 
-      sheet_html += wrap_code(original_sheet[last_index..original_sheet.length], :ignored)
-      sheet_html.gsub!(/\n/, '<br>')
-      lines = (1..original_sheet.lines.count).to_a.map do |line|
+      # replace line returns with HTML line breaks
+      sheet_html.gsub!(/\r?\n/, '<br>')
+
+      # build the lines section
+      lines = (1..original_sheet.lines.count + 1).to_a.map do |line|
         "<a href=\"#L#{line}\" id=\"L#{line}\">#{line}</a>"
       end
       get_style_sheet_html.gsub('%{lines}', lines.join('')).gsub('%{style_sheet}', sheet_html)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marmara
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Godwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: css_parser
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  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: Generates a CSS coverage report
 email:
 - goodgodwin@hotmail.com
@@ -91,6 +119,7 @@ files:
 - README.md
 - Rakefile
 - lib/marmara.rb
+- lib/marmara/parser.rb
 - lib/marmara/style-sheet.html
 homepage: http://bikecollectives.org
 licenses: