maximus 0.1.2 → 0.1.3

data/lib/maximus/config.rb

@@ -0,0 +1,329 @@
+module Maximus
+  # @since 0.1.3
+  # @attr_reader settings [Hash] all the options
+  # @attr_reader temp_files [Hash] Filename without extension => path to temp file
+  class Config
+
+    include Helper
+
+    attr_reader :settings, :temp_files
+
+    # Global options for all of maximus
+    #
+    # @param opts [Hash] options passed directly to config
+    # @option opts [Boolean] :is_dev (false) whether or not the class was initialized from the command line
+    # @option opts [String, Boolean, nil] :log ('log/maximus_git.log') path to log file
+    #   If not set, logger outputs to STDOUT
+    # @option opts [String, Boolean] :git_log (false) path to log file or don't log
+    #   The git gem is very noisey
+    # @option opts [String] :root_dir base directory
+    # @option opts [String] :domain ('http://localhost:3000') the host - used for Statistics
+    # @option opts [String, Integer] :port ('') port number - used for Statistics
+    #   and appended to domain. If blank (false, empty string, etc.), will not
+    #   append to domain
+    # @option opts [String, Array] :file_paths ('') path to files. Accepts glob notation
+    # @option opts [Hash] :paths ({home: '/'}) labeled relative path to URLs. Statistics only
+    # @option opts [String] :commit accepts sha, "working", "last", or "master".
+    # @option opts [String] :config_file ('maximus.yml') path to config file
+    # @return [void] this method is used to set up instance variables
+    def initialize(opts = {})
+      opts[:is_dev] ||= false
+
+      # Only set log file if it's set to true.
+      #   Otherwise, allow it to be nil or a path
+      opts[:log] = 'log/maximus.log' if opts[:log].is_a?(TrueClass)
+
+      opts[:git_log] = false if opts[:git_log].nil?
+      opts[:git_log] = 'log/maximus_git.log' if opts[:git_log].is_a?(TrueClass)
+
+      # @see Helper#root_dir
+      opts[:root_dir] ||= root_dir
+      opts[:domain] ||= 'http://localhost'
+      opts[:port] ||= is_rails? ? 3000 : ''
+      opts[:paths] ||= { 'home' => '/' }
+
+      # Accounting for space-separated command line arrays
+      if opts[:paths].is_a?(Array)
+        new_paths = {}
+        opts[:paths].each do |p|
+          if p.split('/').length > 1
+            new_paths[p.split('/').last.to_s] = p
+          else
+            new_paths['home'] = '/'
+          end
+        end
+        opts[:paths] = new_paths
+      end
+
+      # What we're really interested in
+      @settings = opts
+
+      # Instance variables for Config class only
+      @temp_files = {}
+
+      conf_location = (opts[:config_file] && File.exist?(opts[:config_file])) ? opts[:config] : find_config
+
+      @yaml = YAML.load_file(conf_location)
+
+      # Match defaults
+      @yaml['domain'] ||= @settings[:domain]
+      @yaml['paths'] ||= @settings[:paths]
+      @yaml['port'] ||= @settings[:port]
+      set_families('lints', ['jshint', 'scsslint', 'rubocop', 'brakeman', 'railsbp'])
+      set_families('frontend', ['jshint', 'scsslint', 'phantomas', 'stylestats', 'wraith'])
+      set_families('backend', ['rubocop', 'brakeman', 'railsbp'])
+      set_families('ruby', ['rubocop', 'brakeman', 'railsbp'])
+      set_families('statistics', ['phantomas', 'stylestats', 'wraith'])
+      set_families('all', ['lints', 'statistics'])
+
+      # Override options with any defined in a discovered config file
+      evaluate_yaml
+    end
+
+    # Set global options or generate appropriate config files for lints or statistics
+    #
+    # @param yaml_data [Hash] (@yaml) loaded data from the discovered maximus config file
+    # @return [Hash] paths to temp config files and static options
+    #   These should be deleted with destroy_temp after read and loaded
+    def evaluate_yaml(yaml_data = @yaml)
+      yaml_data.each do |key, value|
+        unless value.is_a?(FalseClass)
+          value = {} if value.is_a?(TrueClass)
+
+          case key
+
+            when 'jshint', 'JSHint', 'JShint'
+
+              # @todo DRY this up, but can't call it at the start because of the
+              #   global config variables (last when statement in this switch)
+              value = load_config(value)
+
+              if yaml_data[key].is_a?(Hash) && yaml_data[key].has_key?['ignore']
+                jshintignore_file = []
+                yaml_data[key]['ignore'].each { |i| jshintignore_file << "#{i}\n" }
+                @settings[:jshintignore] = temp_it('jshintignore.json', jshintignore_file)
+              end
+              @settings[:jshint] = temp_it('jshint.json', value.to_json)
+
+            when 'scsslint', 'scss-lint', 'SCSSlint'
+              value = load_config(value)
+
+              @settings[:scsslint] = temp_it('scsslint.yml', value.to_yaml)
+
+            when 'rubocop', 'Rubocop', 'RuboCop'
+              value = load_config(value)
+
+              @settings[:rubocop] = temp_it('rubocop.yml', value.to_yaml)
+
+            when 'brakeman'
+              @settings[:brakeman] = yaml_data[key]
+
+            when 'rails_best_practice', 'railsbp'
+              @settings[:railsbp] = yaml_data[key]
+
+            when 'stylestats', 'Stylestats'
+              value = load_config(value)
+              @settings[:stylestats] = temp_it('stylestats.json', value.to_json)
+
+            when 'phantomas', 'Phantomas'
+              value = load_config(value)
+              @settings[:phantomas] = temp_it('phantomas.json', value.to_json)
+
+            when 'wraith', 'Wraith'
+              value = load_config(value)
+
+              @settings[:wraith] = {}
+              if value.include?('browser')
+                value['browser'].each do |browser, browser_value|
+                  unless browser_value.is_a?(FalseClass)
+                    new_data = {}
+                    new_data['browser'] = []
+                    new_data['browser'] << { browser.to_s => browser.to_s }
+
+                    # Regardless of what's in the config, override with maximus,
+                    #   predictable namespacing
+                    new_data['directory'] = "maximus_wraith_#{browser}"
+                    new_data['history_dir'] = "maximus_wraith_history_#{browser}"
+
+                    # @todo a snap file cannot be set in the config
+                    snap_file = case browser
+                      when 'casperjs' then 'casper'
+                      when 'nojs' then 'nojs'
+                      else 'snap'
+                    end
+                    new_data['snap_file'] = File.join(File.dirname(__FILE__), "config/wraith/#{snap_file}.js")
+
+                    @settings[:wraith][browser.to_sym] = wraith_setup(new_data, "wraith_#{browser}")
+                  end
+                end
+              else
+                value['browser'] = { 'phantomjs' => 'phantomjs' }
+                value['directory'] = 'maximus_wraith_phantomjs'
+                value['history_dir'] = 'maximus_wraith_history_phantomjs'
+                value['snap_file'] = File.join(File.dirname(__FILE__), "config/wraith/snap.js")
+                @settings[:wraith][:phantomjs] = wraith_setup(value)
+              end
+
+            # Configuration important to all of maximus
+            when 'is_dev', 'log', 'root_dir', 'domain', 'port', 'paths', 'commit'
+              @settings[key.to_sym] = yaml_data[key]
+          end
+        end
+      end
+
+      # Finally, we're done
+      @settings
+    end
+
+    # @return [Boolean]
+    def is_dev?
+      @settings[:is_dev]
+    end
+
+    # Defines base logger
+    #
+    # @param out [String, STDOUT] location for logging
+    #   Accepts file path
+    # @return [Logger] self.log
+    def log
+      out = @settings[:log] || STDOUT
+      @log ||= Logger.new(out)
+      @log.level ||= Logger::INFO
+      @log
+    end
+
+    # Remove all or one created temporary config file
+    #
+    # @see #temp_it
+    # @see #yaml_evaluate
+    #
+    # @param filename [String] (nil) file to destroy
+    #   If nil, destroy all temp files
+    # @return [void]
+    def destroy_temp(filename = nil)
+      return if @temp_files[filename.to_sym].blank?
+      if filename.nil?
+        @temp_files.each { |filename, file| file.unlink }
+        @temp_files = {}
+      else
+        @temp_files[filename.to_sym].unlink
+        @temp_files.delete(filename.to_sym)
+      end
+    end
+
+    # Combine domain with port if necessary
+    #
+    # @return [String] complete domain/host address
+    def domain
+      (!@settings[:port].blank? || @settings[:domain].include?(':')) ? "#{@settings[:domain]}:#{@settings[:port]}" : @settings[:domain]
+    end
+
+
+    private
+
+    # Allow shorthand to be declared for groups Maximus executions
+    #
+    # @example disable statistics
+    #   @yaml['statistics'] = false
+    #   set_families('statistics', ['phantomas', 'stylestats', 'wraith'])
+    #
+    # Sets as Boolean based on whether or not the queried label is `true`
+    # @param head_of_house [String] @yaml key and group label
+    # @param family [Array] group of other @yaml keys to be disabled
+    # @return [void] modified @yaml
+    def set_families(head_of_house, family)
+      if @yaml.has_key?(head_of_house)
+        family.each { |f| @yaml[f] = @yaml[head_of_house].is_a?(TrueClass) }
+      end
+    end
+
+    # Load config files if filename supplied
+    #
+    # @param value [Mixed] value from base config file
+    # @param [Hash] return blank hash if file not found so
+    #   the reset of the process doesn't break
+    def load_config(value)
+      return value unless value.is_a?(String)
+      if File.exist?(value)
+        return YAML.load_file(value)
+      else
+        puts "#{value} not found"
+        return {}
+      end
+    end
+
+    # Create a temp file with config data
+    #
+    # Stores all temp files in @temp_files or self.temp_files
+    #   In Hash with filename minus extension as the key.
+    #
+    # @param filename [String] the preferred name/identifier of the file
+    # @param data [Mixed] config data important to each lint or statistic
+    # @return [String] absolute path to new config file
+    def temp_it(filename, data)
+      ext = filename.split('.')
+      file = Tempfile.new([filename, ".#{ext[1]}"])
+      file.write(data)
+      file.close
+      @temp_files[ext[0].to_sym] = file
+      file.path
+    end
+
+    # Look for a maximus config file
+    #
+    # Checks ./maximus.yml, ./maximus.yaml, ./config/maximus.yaml in order.
+    #   If there hasn't been a file discovered yet, checks ./config/maximus.yml
+    #   and if there still isn't a file, load the default one included with the
+    #   maximus gem.
+    #
+    # @return [String] absolute path to config file
+    def find_config
+      config_exists('maximus.yml') || config_exists('maximus.yaml') || config_exists('config/maximus.yaml') || check_default_config_path('maximus.yml')
+    end
+
+    # See if a config file exists
+    #
+    # @see #find_config
+    #
+    # This is used exclusively for the find_config method
+    # @param file [String] file name
+    # @return [String, FalseClass] if file is found return the absolute path
+    #   otherwise return false so we can keep checking
+    def config_exists(file)
+      File.exist?(File.join(File.dirname(__FILE__), file)) ? File.join(File.dirname(__FILE__), file) : false
+    end
+
+    # Wraith is a complicated gem with significant configuration
+    #
+    # @see #yaml_evaluate
+    # @see #temp_it
+    #
+    # @param value [Hash] modified data from a wraith config or injected data
+    # @param name [String] ('wraith') config file name to write and eventually load
+    # @return [String] temp file path
+    def wraith_setup(value, name = 'phantomjs')
+
+      if @yaml.include?('urls')
+        value['domains'] = yaml_data['urls']
+      else
+        value['domains'] = {}
+        # @see #domain
+        value['domains']['main'] = domain
+      end
+
+      # Wraith requires this screen_width config to be present
+      value['screen_widths'] ||= [767, 1024, 1280]
+
+      value['paths'] = @yaml['paths']
+      value['threshold'] ||= 0
+
+      # Wraith requires config files have .yaml extensions
+      # https://github.com/BBC-News/wraith/blob/2aff771eba01b76e61600cccb2113869bfe16479/lib/wraith/wraith.rb
+      file = Tempfile.new([name, '.yaml'])
+      file.write(value.to_yaml)
+      file.close
+      file.path
+    end
+
+  end
+end

data/lib/maximus/git_control.rb

@@ -1,8 +1,4 @@
 require 'git'
-require 'active_support'
-require 'active_support/core_ext/object/blank'
-require 'rainbow'
-require 'rainbow/ext/string'
 
 module Maximus
   # @since 0.1.0
@@ -12,29 +8,21 @@ module Maximus
 
     # Git management
     #
-    # @param opts [Hash] the options to initialize and pass to other classes
-    # @option opts [Boolean] :is_dev whether or not the class was initialized from the command line
-    # @option opts [String] :log ('log/maximus_git.log') path to log file
-    # @option opts [String] :root_dir base directory
-    # @option opts [String] :base_url ('http://localhost:3000') the host - used for Statistics
-    # @option opts [String, Integer] :port port number - used for Statistics
-    # @option opts [String, Array] :path ('') path to files. Accepts glob notation
+    # Inherits settings from {Config#initialize}
+    # @param opts [Hash] options passed directly to config
+    # @option opts [Boolean] :is_dev (false) whether or not the class was initialized from the command line
+    #   This is set here again in case only GitControl needs to be directly called (outside of command line)
+    # @option opts [Config object] :config custom Maximus::Config object
     # @option opts [String] :commit accepts sha, "working", "last", or "master".
-    #   Used in the command line
     # @return [void] this method is used to set up instance variables
     def initialize(opts = {})
       opts[:is_dev] ||= false
-      opts[:log] = Logger.new('log/maximus_git.log') if opts[:log].nil?
-      opts[:base_url] ||= 'http://localhost:3000'
-      opts[:port] ||= ''
-      opts[:root_dir] ||= root_dir
-      log = opts[:log] ? log : nil
-      @@log = mlog
-      @@is_dev = opts[:is_dev]
-      @opts = opts
-
-      @psuedo_commit = (!@opts[:commit].blank? && @opts[:commit] == 'working')
-      @g = Git.open(@opts[:root_dir], :log => log)
+
+      opts[:config] ||= Maximus::Config.new({commit: opts[:commit], is_dev: opts[:is_dev] })
+      @config ||= opts[:config]
+      @settings ||= @config.settings
+      @psuedo_commit = (!@settings[:commit].blank? && (@settings[:commit] == 'working' || @settings[:commit] == 'last' || @settings[:commit] == 'master') )
+      @g = Git.open(@settings[:root_dir], :log => @settings[:git_log])
     end
 
     # 30,000 foot view of a commit
@@ -74,12 +62,12 @@ module Maximus
     def compare(sha1 = master_commit.sha, sha2 = sha)
       diff_return = {}
 
-      if @opts[:commit]
-        sha1 = case @opts[:commit]
+      if @settings[:commit]
+        sha1 = case @settings[:commit]
           when 'master' then master_commit.sha
           when 'last' then @g.object('HEAD^').sha
           when 'working' then 'working'
-          else @opts[:commit]
+          else @settings[:commit]
         end
       end
 
@@ -112,7 +100,7 @@ module Maximus
             unless files[child].blank?
               files[child].each do |c|
                 # hack to ignore deleted files
-                files[child] = new_lines[c].blank? ? [] : [ filename: "#{@opts[:root_dir]}/#{c}", changes: new_lines[c] ]
+                files[child] = new_lines[c].blank? ? [] : [ filename: "#{@settings[:root_dir]}/#{c}", changes: new_lines[c] ]
               end
               files[ext].concat(files[child])
               files.delete(child)
@@ -149,30 +137,23 @@ module Maximus
       git_shas.each do |sha, exts|
         # @todo better way to silence git, in case there's a real error?
         quietly { `git checkout #{sha} -b maximus_#{sha}` } unless @psuedo_commit
-        puts sha.to_s.color(:blue) if @@is_dev
+        puts sha.to_s.color(:blue) if @config.is_dev?
         git_output[sha.to_sym] = {
           lints: {},
           statistics: {}
         }
         lints = git_output[sha.to_sym][:lints]
         statistics = git_output[sha.to_sym][:statistics]
-        lint_opts = {
-          is_dev: @@is_dev,
-          root_dir: @opts[:root_dir],
-          commit: !@opts[:commit].blank?
-        }
-        stat_opts = {
-          is_dev: @@is_dev,
-          base_url: @opts[:base_url],
-          port: @opts[:port],
-          root_dir: @opts[:root_dir]
-        }
+        lint_opts = {}
 
         # This is where everything goes down
         exts.each do |ext, files|
           # For relevant_lines data
-          lint_opts[:git_files] = files
-          lint_opts[:path] = lint_file_paths(files, ext) if lint_by_path
+          lint_opts = {
+            git_files: files,
+            config: @config
+          }
+          lint_opts[:file_paths] = lint_file_paths(files, ext) if lint_by_path
           case ext
             when :scss
               lints[:scsslint] = Maximus::Scsslint.new(lint_opts).result
@@ -183,11 +164,11 @@ module Maximus
                 # @todo stylestat is singular here because model name in Rails is singular.
                 #   But adding a .classify when it's converted to a model chops off the end s on 'phantomas',
                 #   which breaks the model name.
-                statistics[:stylestat] = Maximus::Stylestats.new(stat_opts).result
+                statistics[:stylestat] = Maximus::Stylestats.new({config: @config}).result
 
                 # @todo double pipe here is best way to say, if it's already run, don't run again, right?
-                statistics[:phantomas] ||= Maximus::Phantomas.new(stat_opts).result
-                statistics[:wraith] = Maximus::Wraith.new(stat_opts).result
+                statistics[:phantomas] ||= Maximus::Phantomas.new({config: @config}).result
+                statistics[:wraith] ||= Maximus::Wraith.new({config: @config}).result
               end
             when :js
               lints[:jshint] = Maximus::Jshint.new(lint_opts).result
@@ -195,14 +176,14 @@ module Maximus
               # Do not run statistics if called from command line
               if lint_opts[:commit].blank?
 
-                statistics[:phantomas] = Maximus::Phantomas.new(stat_opts).result
+                statistics[:phantomas] ||= Maximus::Phantomas.new({config: @config}).result
 
                 # @todo double pipe here is best way to say, if it's already run, don't run again, right?
-                statistics[:wraith] ||= Maximus::Wraith.new(stat_opts).result
+                statistics[:wraith] ||= Maximus::Wraith.new({config: @config}).result
               end
             when :ruby
               lints[:rubocop] = Maximus::Rubocop.new(lint_opts).result
-              lints[:railsbp] = Maximus::Railsbp.new(lint_opts).result
+              lints[:railsbp] ||= Maximus::Railsbp.new(lint_opts).result
               lints[:brakeman] = Maximus::Brakeman.new(lint_opts).result
             when :rails
               lints[:railsbp] ||= Maximus::Railsbp.new(lint_opts).result
@@ -280,6 +261,7 @@ module Maximus
     end
 
     # Store last commit as Ruby Git::Object
+    #
     # @param commitsha [String]
     # @return [Git::Object]
     def vccommit(commitsha = sha)

data/lib/maximus/helper.rb

@@ -3,18 +3,15 @@ require 'rainbow/ext/string'
 require 'active_support'
 require 'active_support/core_ext/object/blank'
 require 'yaml'
+require 'tempfile'
 
 module Maximus
   # @since 0.1.0
   module Helper
 
     # See if project linted is a Rails app
-    # This will usually be stored as a class variable in the inherited class
-    # @example class variable
-    #   @@is_rails = is_rails?
-    #
-    # @see Lint#initialize
     #
+    # This will usually be stored as a class variable in the inherited class
     # @return [Boolean]
     def is_rails?
       defined?(Rails)
@@ -45,15 +42,13 @@ module Maximus
       end
     end
 
-    # Look for a custom config in the app's config/ directory;
-    # otherwise, use the built-in one.
-    # @todo best practice that this inherits the @opts from the model it's being included in?
+    # Look for a file in the config directory
     #
-    # @param filename [String]
-    # @return [String] absolute path to the reporter file
-    def check_default(filename)
-      user_file = "#{@opts[:root_dir]}/config/#{filename}"
-      File.exist?(user_file) ? user_file : File.join(File.dirname(__FILE__), "config/#{filename}")
+    # @since 0.1.0
+    # @param file [String] filename with extension to search for
+    # @return [String] path to default config file or file in user's directory
+    def check_default_config_path(file)
+      File.exist?(file) ? file : File.join(File.dirname(__FILE__), "config/#{file}")
     end
 
     # Grab the absolute path of the reporter file
@@ -61,7 +56,7 @@ module Maximus
     # @param filename [String]
     # @return [String] absolute path to the reporter file
     def reporter_path(filename)
-      File.join(File.dirname(__FILE__),"reporter/#{filename}")
+      File.join(File.dirname(__FILE__), "reporter/#{filename}")
     end
 
     # Find all files that were linted by extension
@@ -96,6 +91,7 @@ module Maximus
 
     # Edit and save a YAML file
     #
+    # @param yaml_location [String] YAML absolute file path
     # @return [void]
     def edit_yaml(yaml_location, &block)
       d = YAML.load_file(yaml_location)
@@ -112,15 +108,6 @@ module Maximus
       STDIN.gets
     end
 
-    # Defines base logger
-    #
-    # @return [Logger] @@log for logging use
-    def mlog
-      @@log ||= Logger.new(STDOUT)
-      @@log.level ||= Logger::INFO
-      @@log
-    end
-
     # Convert the array from lines_added into spelled-out ranges
     # This is a GitControl helper but it's used in Lint
     # @see GitControl#lines_added