maximus 0.1.0

data/lib/maximus/lints/rubocop.rb

@@ -0,0 +1,18 @@
+module Maximus
+  class Rubocop < Maximus::Lint
+
+    # RuboCop
+    def result
+      @task = 'rubocop'
+      @path ||= @@is_rails ? "#{@opts[:root_dir]}/app" : "#{@opts[:root_dir]}/*.rb"
+
+      return unless path_exists(@path)
+
+      rubo = `rubocop #{@path} --require #{reporter_path('rubocop')} --config #{check_default('rubocop.yml')} --format RuboCop::Formatter::MaximusRuboFormatter #{'-R' if @@is_rails}`
+
+      @output[:files_inspected] ||= files_inspected('rb', ' ')
+      refine rubo
+    end
+
+  end
+end

data/lib/maximus/lints/scsslint.rb

@@ -0,0 +1,17 @@
+module Maximus
+  class Scsslint < Maximus::Lint
+
+    # SCSS-Lint
+    def result
+      @task = 'scsslint'
+      @path ||= @@is_rails ? "#{@opts[:root_dir]}/app/assets/stylesheets" : "#{@opts[:root_dir]}/source/assets/stylesheets"
+
+      return unless path_exists(@path)
+
+      scss = `scss-lint #{@path} -c #{check_default('scsslint.yml')}  --format=JSON`
+      @output[:files_inspected] ||= files_inspected('scss')
+      refine scss
+    end
+
+  end
+end

data/lib/maximus/rake_tasks.rb

@@ -0,0 +1,13 @@
+require 'rake'
+
+if defined?(Rails)
+  module Maximus
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+      end
+    end
+  end
+else
+  Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+end

data/lib/maximus/reporter/git-lines.sh

@@ -0,0 +1,57 @@
+#!/bin/bash
+
+# http://stackoverflow.com/questions/8259851/using-git-diff-how-can-i-get-added-and-modified-lines-numbers
+# TODO - this function is tricky because I don't fully understand regex in BASH. Also, getting line hunks from git is tricky. This will likely need to be refactored
+function lines-added(){
+  local path=
+  local line=
+  local start=
+  local finish=
+  while read; do
+    esc=$'\033'
+    if [[ $REPLY =~ ---\ (a/)?.* ]]; then
+      continue
+    elif [[ $REPLY =~ \+\+\+\ (b/)?([^[:blank:]$esc]+).* ]]; then
+      path=${BASH_REMATCH[2]}
+    elif [[ $REPLY =~ @@\ -[0-9]+,([0-9]+)?\ \+([0-9]+)?,([0-9]+)?\ @@.* ]]; then
+      if [[ ${BASH_REMATCH[2]} = ${BASH_REMATCH[3]} ]]; then
+        line="0..0"
+      elif [[ ${BASH_REMATCH[2]} = $((${BASH_REMATCH[2]} + ${BASH_REMATCH[3]})) ]]; then
+        line="$((${BASH_REMATCH[2]} + ${BASH_REMATCH[3]} - ${BASH_REMATCH[1]}))..$((${BASH_REMATCH[2]} + ${BASH_REMATCH[3]} - ${BASH_REMATCH[1]}))"
+      else
+        line="${BASH_REMATCH[2]}..$((${BASH_REMATCH[2]} + ${BASH_REMATCH[3]}))"
+      fi
+    elif [[ $REPLY =~ @@\ -([0-9])?,([0-9]+)?\ \+([0-9]+)?\ @@.* ]]; then
+      line="${BASH_REMATCH[3]}..${BASH_REMATCH[3]}"
+    elif [[ $REPLY =~ @@\ -([0-9]+)?,\ \+([0-9]+)?\ @@.* ]]; then
+      line="0..${BASH_REMATCH[2]}"
+    elif [[ $REPLY =~ ^($esc\[[0-9;]+m)*([\ +-]) ]]; then
+      echo "$path:$line"
+    fi
+  done
+}
+function diff-lines(){
+  local path=
+  local line=
+  while read; do
+    esc=$'\033'
+    if [[ $REPLY =~ ---\ (a/)?.* ]]; then
+      continue
+    elif [[ $REPLY =~ \+\+\+\ (b/)?([^[:blank:]$esc]+).* ]]; then
+      path=${BASH_REMATCH[2]}
+    elif [[ $REPLY =~ @@\ -[0-9]+(,[0-9]+)?\ \+([0-9]+)(,[0-9]+)?\ @@.* ]]; then
+      line=${BASH_REMATCH[2]}
+    elif [[ $REPLY =~ ^($esc\[[0-9;]+m)*([\ +-]) ]]; then
+      echo "$path:$line:$REPLY"
+      if [[ ${BASH_REMATCH[2]} != - ]]; then
+        ((line++))
+      fi
+    fi
+  done
+}
+
+if [ -z "$2" ]; then
+  git diff $1^ $1 --unified=0 | lines-added
+else
+  git diff --unified=0 | lines-added
+fi

data/lib/maximus/reporter/jshint.js

@@ -0,0 +1,28 @@
+/* jshint node: true */
+
+"use strict";
+
+module.exports = {
+  reporter: function (res) {
+    var str = {};
+    var files = {};
+    res.forEach(function (r) {
+      var err = r.error;
+      var reform = {};
+      if (!files[r.file]) {
+        files[r.file] = [];
+      }
+      reform.linter = err.code;
+      reform.severity = err.code.indexOf('W') > - 1 ? 'warning' : 'error';
+      reform.reason = err.reason;
+      reform.line = err.line;
+      reform.column = err.character;
+      files[r.file].push(reform);
+    });
+
+    if (res.length) {
+      str = files;
+      process.stdout.write(JSON.stringify(str));
+    }
+  }
+};

data/lib/maximus/reporter/rubocop.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'json'
+require 'pathname'
+require 'rubocop'
+
+RuboCop = Rubocop if defined?(Rubocop) && ! defined?(RuboCop)
+
+module RuboCop
+  module Formatter
+    # This formatter formats the report data in JSON
+    # Makes it consistent with output of other Maximus linters
+    class MaximusRuboFormatter < BaseFormatter
+      include PathUtil
+
+      attr_reader :output_hash
+
+      def initialize(output)
+        super
+        @output_hash = {}
+      end
+
+      def started(target_files)
+      end
+
+      def file_finished(file, offenses)
+        unless offenses.empty?
+          @output_hash[relative_path(file).to_sym] = {}
+          @output_hash[relative_path(file).to_sym] = offenses.map { |o| hash_for_offense(o) }
+        end
+      end
+
+      def finished(inspected_files)
+        output.write @output_hash.to_json
+      end
+
+      def hash_for_offense(offense)
+        {
+          severity: offense.severity.name,
+          reason:  offense.message,
+          linter: offense.cop_name,
+          line: offense.line,
+          column: offense.real_column
+        }
+      end
+
+    end
+  end
+end

data/lib/maximus/statistic.rb

@@ -0,0 +1,65 @@
+
+module Maximus
+  class Statistic
+    attr_accessor :output
+
+    include Helper
+
+    # opts - Lint options (default: {})
+    #    :is_dev - wether or not this is being called by a rake task
+    #    :root_dir - absolute path to working directory (optional)
+    #    :port - 4-digit port number (optional)
+    #    :base_url - standard domain with http:// (default: http://localhost:3000) (optional)
+    #    :path - default set in methods (optional)
+    # All statistics should have the following:
+    # def result method to handle the actual parsing
+    # TODO - should this be def output to be more consistent?
+    # Didn't want to trip over the instance variable @output
+    def initialize(opts = {})
+      opts[:is_dev] ||= false
+      opts[:root_dir] ||= root_dir
+      opts[:port] ||= ''
+      opts[:base_url] ||= 'http://localhost:3000'
+
+      @@log ||= mlog
+      @@is_rails ||= is_rails?
+      @@is_dev = opts[:is_dev]
+      @path = opts[:path]
+      @opts = opts
+
+      @output = {}
+      # This is different from lints
+      # A new stat is run per file or URL, so they should be stored in a child
+      # A lint just has one execution, so it's data can be stored directly in @output
+      @output[:statistics] = {}
+    end
+
+
+    protected
+
+    # Organize stat output on the @output variable
+    # Adds @output[:statistics][:filepath] with all statistic data
+    def refine_stats(stats_cli, file_path)
+
+      # Stop right there unless you mean business
+      return puts stats_cli if @@is_dev
+
+      # JSON.parse will throw an abortive error if it's given an empty string
+      return false if stats_cli.blank?
+
+      stats = JSON.parse(stats_cli)
+      @output[:statistics][file_path.to_sym] ||= {}
+
+      # TODO - is there a better way to do this?
+      fp = @output[:statistics][file_path.to_s.to_sym]
+
+      # TODO - Can I do like a self << thing here?
+      stats.each do |stat, value|
+        fp[stat.to_sym] = value
+      end
+
+      @output
+    end
+
+  end
+end

data/lib/maximus/statistics/phantomas.rb

@@ -0,0 +1,32 @@
+module Maximus
+  class Phantomas < Maximus::Statistic
+
+    # path can be array or string of URLS. Include http://
+    # By default, checks homepage
+    def result
+
+      node_module_exists('phantomjs', 'brew install')
+      node_module_exists('phantomas')
+
+      @path ||= YAML.load_file(check_default('phantomas_urls.yaml'))
+      # Phantomas doesn't actually skip the skip-modules defined in the config BUT here's to hoping for future support
+      phantomas_cli = "phantomas --config=#{check_default('phantomas.json')} "
+      phantomas_cli += @@is_dev ? '--colors' : '--reporter=json:no-skip'
+      phantomas_cli += " --proxy=#{@opts[:base_url]}:#{@opts[:port]}" unless @opts[:port].blank?
+      @path.is_a?(Hash) ? @path.each { |label, url| phantomas_by_url(url, phantomas_cli) } : phantomas_by_url(@path, phantomas_cli)
+      @output
+    end
+
+
+    private
+
+    # Organize stat output on the @output variable
+    # Adds @output[:statistics][:filepath] with all statistic data
+    def phantomas_by_url(url, phantomas_cli)
+      puts "Phantomas on #{@opts[:base_url] + url}".color(:green)
+      phantomas = `#{phantomas_cli} #{@opts[:base_url] + url}`
+      refine_stats(phantomas, url)
+    end
+
+  end
+end

data/lib/maximus/statistics/stylestats.rb

@@ -0,0 +1,111 @@
+module Maximus
+  class Stylestats < Maximus::Statistic
+
+    # @path array preferrably absolute paths, but relative should work
+    # If stylestatting one file, pass that as an array, i.e. ['/absolute/to/public/assets/application.css']
+    def result
+
+      node_module_exists('stylestats')
+      @path ||= @@is_rails ? "#{@opts[:root_dir]}/public/assets/**/*.css" : "#{@opts[:root_dir]}/**/*.css"
+
+      css_files = @path.is_a?(Array) ? @path : find_css_files
+
+      css_files.each do |file|
+
+        # For Rails, we only want the name of the compiled asset, because we know it'll live in public/assets.
+        # If this isn't Rails, sure, give me the full path because the directory structure is likely unique
+        pretty_name = @@is_rails ? file.split('/').pop.gsub(/(-{1}[a-z0-9]{32}*\.{1}){1}/, '.') : file
+
+        puts "#{'stylestats'.color(:green)}: #{pretty_name}\n\n"
+
+        # include JSON formatter unless we're in dev
+        stylestats = `stylestats #{file} --config=#{check_default('stylestats.json')} #{'--type=json' unless @@is_dev}`
+
+        refine_stats(stylestats, pretty_name)
+
+        File.delete(file)
+      end
+
+      if @@is_rails
+        # TODO - I'd rather Rake::Task but it's not working in different directories
+        Dir.chdir(@opts[:root_dir]) do
+          if @@is_dev
+            # TODO - review that this may not be best practice, but it's really noisy in the console
+            quietly { `rake assets:clobber` }
+          else
+            `rake assets:clobber`
+          end
+        end
+      end
+
+      @output
+
+    end
+
+
+    private
+
+    # Find all CSS files
+    # Will compile using sprockets if Rails
+    # Will compile using built-in Sass engine otherwise
+    # Compass friendly
+    # Returns Array of CSS files
+    def find_css_files
+      searched_files = []
+
+      if @@is_rails
+        # Only load tasks if we're not running a rake task
+        Rails.application.load_tasks unless @@is_dev
+
+        puts "\n"
+        puts 'Compiling assets for stylestats...'.color(:blue)
+
+        # TODO - I'd rather Rake::Task but it's not working in different directories
+        Dir.chdir(@opts[:root_dir]) do
+          if @@is_dev
+             # TODO - review that this may not be best practice, but it's really noisy in the console
+            quietly { `rake assets:precompile` }
+          else
+            `rake assets:precompile`
+          end
+        end
+
+        Dir.glob(@path).select { |f| File.file? f }.each do |file|
+          searched_files << file
+        end
+
+      else
+
+        # Load Compass paths if it exists
+        if Gem::Specification::find_all_by_name('compass').any?
+          require 'compass'
+          Compass.sass_engine_options[:load_paths].each do |path|
+            Sass.load_paths << path
+          end
+        end
+
+        # Shouldn't need to load paths anymore, but in case this doesn't work
+        # as it should
+        # Dir.glob(@path).select { |d| File.directory? d}.each do |directory|
+        #   Sass.load_paths << directory
+        # end
+
+        @path += ".scss"
+
+        Dir[@path].select { |f| File.file? f }.each do |file|
+          # TODO - don't compile file if it starts with an underscore
+          scss_file = File.open(file, 'rb') { |f| f.read }
+
+          output_file = File.open( file.split('.').reverse.drop(1).reverse.join('.'), "w" )
+          output_file << Sass::Engine.new(scss_file, { syntax: :scss, quiet: true, style: :compressed }).render
+          output_file.close
+
+          searched_files << output_file.path
+
+        end
+      end
+      searched_files
+    end
+
+  end
+end

data/lib/maximus/statistics/wraith.rb

@@ -0,0 +1,88 @@
+module Maximus
+  class Wraith < Maximus::Statistic
+
+    # By default checks homepage
+    # Requires config to be in config/wraith/history.yaml
+    # Adds a new config/wraith/history.yaml if not present
+    # Path should be an Array defined as [{ label: url }]
+    # Returns Hash as defined in the wraith_parse method
+    def result
+
+      node_module_exists('phantomjs', 'brew install')
+      @root_config = "#{@opts[:root_dir]}/config/wraith"
+      wraith_exists = File.directory?(@root_config)
+      @wraith_config_file = "#{@opts[:root_dir]}/config/wraith.yaml"
+
+      puts 'Starting visual regression tests with wraith...'.color(:blue)
+
+      # Copy wraith config and run the initial baseline
+      # Or, if the config is already there, just run wraith latest
+      unless wraith_exists
+
+        FileUtils.copy_entry(File.join(File.dirname(__FILE__), "../config/wraith"), @root_config)
+        FileUtils.cp(File.join(File.dirname(__FILE__), "../config/wraith.yaml"), @wraith_config_file)
+        wraith_yaml_reset
+        puts `wraith history #{@wraith_config_file}`
+
+      else
+
+        wraith_yaml_reset
+
+        # If the paths have been updated, call a timeout and run history again
+        # TODO - this doesn't work very well. It puts the new shots in the history folder,
+        # even with absolute paths. Could be a bug in wraith
+        YAML.load_file(@wraith_config_file)['paths'].each do |label, url|
+          edit_yaml(@wraith_config_file) do |file|
+            unless File.directory?("#{@opts[:root_dir]}/maximus_wraith_history/#{label}")
+              puts `wraith history #{@wraith_config_file}`
+              break
+            end
+          end
+        end
+
+        # Look for changes if it's not the first time
+        puts `wraith latest #{@wraith_config_file}`
+
+      end
+      wraith_parse
+    end
+
+
+    private
+
+    # Get a diff percentage of all changes by label and screensize
+    # { path: { percent_changed: [{ size: percent_diff }] } }
+    # Example {:statistics=>{:/=>{:percent_changed=>[{1024=>0.0}, {767=>0.0}, {1024=>0.0}, {767=>0.0}, {1024=>0.0}, {767=>0.0}, {1024=>0.0}, {767=>0.0}] } }}
+    # Returns Hash
+    def wraith_parse(wraith_config_file = @wraith_config_file)
+      paths = YAML.load_file(wraith_config_file)['paths']
+      Dir.glob("#{@opts[:root_dir]}/maximus_wraith/**/*.txt").select { |f| File.file? f }.each do |file|
+        file_object = File.open(file, 'rb')
+        orig_label = File.dirname(file).split('/').last
+        label = paths[orig_label]
+        @output[:statistics][label.to_sym] ||= {}
+        @output[:statistics][label.to_sym][:name] = orig_label
+        @output[:statistics][label.to_sym][:percent_changed] ||= []
+        @output[:statistics][label.to_sym][:percent_changed] << { File.basename(file).split('_')[0].to_i => file_object.read.to_f }
+        file_object.close
+      end
+      @output
+    end
+
+    # Update the root domain (docker ports and addresses may change) and set paths as defined in @path
+    def wraith_yaml_reset(wraith_config_file = @wraith_config_file)
+      edit_yaml(wraith_config_file) do |file|
+        unless @@is_dev
+          file['snap_file'] = "#{@root_config}/snap.js"
+          file['directory'] = "#{@opts[:root_dir]}/maximus_wraith"
+          file['history_dir'] = "#{@opts[:root_dir]}/maximus_wraith_history"
+        end
+        # .to_s is for consistency in the yaml, but could likely be removed without causing an error
+        fresh_domain = @opts[:port].blank? ? @opts[:base_url].to_s : "#{@opts[:base_url]}:#{@opts[:port]}"
+        file['domains']['main'] = fresh_domain
+        @path.each { |label, url| file['paths'][label] = url } if @path.is_a?(Hash)
+      end
+    end
+
+  end
+end