maximus 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70e71aa9bf1801ab2da6baad0c7a6de45759d5b2
-  data.tar.gz: 1f3fc9752270915bfe051d3e76ba034816c7c42b
+  metadata.gz: dfcfe18a00fe7415422140b106609c011870cea5
+  data.tar.gz: db6a33810bb07a2fe58f0e29e9dd9e59f4c48e3e
 SHA512:
-  metadata.gz: 2d24180804d7722eeaef5faedabc1ef5b0915af20ff9cee8cb30ce230cff669bd994f1de046894d6e96c35894f35aab4cce5b6248ab4a6d48b39961099bd287a
-  data.tar.gz: 04e6694a21cc3926fc9338b26827480f8423e104fb5562ead917959edb7a563f12a01c180ad154ded26ab4c4bb4ff6433bcc9f684d4ced8559ae98a71fc6334a
+  metadata.gz: cfef49478e9d9f9b994c80f77ab9c987963b6f396828023b9e99902254d03b2382b56755d8929ba96154cb41f0571e5b9474a66ea9378788c314f63f1e6c03c7
+  data.tar.gz: 2d38e52edb5a2cc6850d7f303d86d87d48a1e9f6c98237aed90f0a31b478c42a598549fa0f6d0164de2c0912abcdc253caf1b8fe084bb2d68b4f3056f8a70668

data/README.md

@@ -6,25 +6,81 @@ The all-in-one linting solution.
 
 Plays nice with Middleman and Rails.
 
-In the development block:
+## Install
 
-`gem 'maximus', git: 'git@bitbucket.org:wearefine/maximus.git'`
+* Gemfile: `gem 'maximus', group: :development`
+* Elsewhere/command line: `gem install maximus`
+* Globally with RVM (~/.rvm/gemsets/global.gems): `maximus` 
+
+Maximus has several node dependencies that can be installed with a `npm install -g jshint phantomas stylestats` or a `maximus install` once the gem is successfully installed.
+
+## Config
+
+Lints and statistics can be configured turned on or off with a  `maximus.yml` file in the root directory maximus is being called in. `config/maximus.yml` will be checked if a config file isn't found in the root, and if there's still no luck, [the default config](lib/maximus/config/maximus.yml) will be loaded.
+
+Parent options are identical to the [command line flags](#command-line-flags) with the exception of `include` and `exclude`.
+
+```yaml
+domain: 'http://localhost'
+port: 3000
+paths:
+  home: '/'
+```
+
+Configs for each lint or statistic are identical to their own syntax.
+
+```yaml
+scsslint:
+  linters:
+    Compass::*:
+      enabled: true
+```
+
+For systems that are JavaScript based, like JSHint, the YAML is converted to JSON.
+
+```yaml
+jshint:
+  browser: true
+  unused: true
+  jquery: true
+```
+
+Some configs can be massive and it's more readable to break these into their own files. They can be loaded by setting the value to the path of the desired config.
+
+```yaml
+rubocop: 'config/rubocop.yml'
+```
+
+Systems and groups of systems can be disabled with booleans. Groups of systems override individual preferences.
+
+```yaml
+brakeman: false
+statistics: false # no statistics will run
+lints: true # all lints including brakeman will run
+```
+
+### [Sample Config](lib/maximus/config/maximus-example.yml)
 
 ## Command Line Flags
 
 Flag                | Accepts                          | Description
 --------------------|----------------------------------|--------------------
-`-p`/`--path`       | String/Array                     | Absolute path to URLs or files
+`-fp`/`--filepaths` | String/Array                     | Space-separated path(s) to files
+`-u`/`--urls`       | String/Array                     | Statistics only - Space-separated path(s) to relative URL paths
+`-d`/`--domain`     | String                           | Statistics only - Web address (prepended to paths)
+`-po`/`--port`      | String/Numeric                   | Statistics only - Port to use if required (appended to domain)
 `-f`/`--frontend`   | Boolean/Blank                    | Run all front-end lints
 `-b`/`--backend`    | Boolean/Blank                    | Run all back-end lints
-`-s`/`--statistics` | Boolean/Blank                    | Run all back-end lints
-`-a`/`--all`        | Boolean/Blank                    | Run all everything
+`-s`/`--statistics` | Boolean/Blank                    | Run all statistics
+`-a`/`--all`        | Boolean/Blank                    | Run everything
 `-i`/`--include`    | String/Array                     | Include specific lints or statistics
 `-i`/`--exclude`    | String/Array                     | Exclude specific lints or statistics
-`-c`/`--commit`     | String/`working`/`last`/`master` |
+`-git`/`--sha`      | String                           | Run maximus based on a git commit, working copy (`working`, default), the last commit (`last` or `HEAD^`), or the master branch (`master`)
+`-c`/`--config`     | String                           | Path to config file
+
 
 * Lint tasks can accept glob notation, i.e. `**/*.scss`
-* Arrays are space-separated, i.e. `--path=http://localhost:3000/ http://localhost:3000/about`
+* Arrays are space-separated, i.e. `--urls=/ /about`
 
 ## Command Line Commands
 
@@ -35,23 +91,23 @@ Command               | Description
 `backend`             | Runs all back-end lints
 `statistics`          | Runs all statistics
 
-## Examples
+### Examples
 
 Default. Lints based on your working directory
 
-`maximus -c working` 
+`maximus -g working` 
 
 Lints based on the previous commit by `HEAD^`
 
-`maximus -c last` 
+`maximus -g last` 
 
 Lints based on the commit on the master branch
 
-`maximus -c master`
+`maximus -g master`
 
 Lints based on commit d96a8e23
 
-`maximus -c d96a8e23`
+`maximus -g d96a8e23`
 
 ## Lint syntax
 
@@ -66,3 +122,34 @@ When adding new lints, the JSON output should obey the following format:
   line: <position Integer>
 } ]
 ```
+
+## Changelog
+
+### 0.1.3
+
+Features:
+
+* Options are defined once in Config class
+* `maximus.yml` can be loaded to set the config
+* All lint and statistic options can be in the maximus config file
+* More command line flags
+
+### 0.1.2 (December 18, 2014)
+
+Features: 
+
+* Better inline documentation
+
+Bugfixes:
+
+* Resolve exiting error when no lint errors are preset (0efef67)
+
+### 0.1.1 (December 9, 2014)
+
+* Description and homepage update
+
+### 0.1.0 (December 9, 2014)
+
+* Initial
+
+

data/lib/maximus/cli.rb

@@ -2,15 +2,30 @@ require 'thor'
 
 # @since 0.1.0
 class Maximus::CLI < Thor
+
   include Thor::Actions
-  class_option :path, aliases: ["-p", "-u", "\--url"], default: nil, desc: "Space-separated path(s) to URLs or files"
-  class_option :frontend, default: false, lazy_default: false, type: :boolean, desc: "Do front-end lints", aliases: ["-f", "--front-end"]
-  class_option :backend, default: false, lazy_default: false, type: :boolean, desc: "Do back-end lints", aliases: ["-b", "--back-end"]
-  class_option :statistics, default: false, lazy_default: false, type: :boolean, desc: "Do statistics", aliases: ["-s"]
-  class_option :all, default: false, lazy_default: false, type: :boolean, desc: "Do everything", aliases: ["-a"]
-  class_option :include, default: [], type: :array, aliases: ["-i"], desc: "Include only specific lints or statistics"
-  class_option :exclude, default: [], type: :array, aliases: ["-e"], desc: "Exlude specific lints or statistics"
-  class_option :commit, default: 'working', type: :string, banner: "working, last, master, or sha", aliases: ["-c", "--sha"], desc: "Lint by commit or working copy"
+
+  class_option :frontend, aliases: ['-f', '--front-end'], type: :boolean, default: false, lazy_default: false, desc: "Do front-end lints"
+  class_option :backend, aliases: ['-b', '--back-end'], type: :boolean, default: false, lazy_default: false, desc: "Do back-end lints"
+  class_option :statistics, aliases: ['-s'], type: :boolean, default: false, lazy_default: false, desc: "Do statistics"
+  class_option :all, aliases: ['-a'], type: :boolean,  default: false, lazy_default: false, desc: "Do everything"
+
+  class_option :filepath, aliases: ['-fp'], type: :array, default: [], desc: "Space-separated path(s) to files"
+  class_option :urls, aliases: ['-u'], type: :array, default: ['/'], desc: "Statistics only - Space-separated path(s) to relative URL paths"
+  class_option :domain, aliases: ['-d'], type: :string, default: 'http://localhost', desc: "Statistics only - Web address (prepended to paths)"
+  class_option :port, aliases: ['-po'], type: :numeric, default: nil, desc: 'Statistics only - Port to use if required (appended to domain)'
+
+  class_option :include, aliases: ['-i'], type: :array, default: [], desc: "Include only specific lints or statistics"
+  class_option :exclude, aliases: ['-e'], type: :array, default: [], desc: "Exlude specific lints or statistics"
+
+  class_option :config, aliases: ['-c'], type: :string, default: 'maximus.yml', desc: 'Path to config file'
+
+  class_option :git, aliases: ['-g', '--sha'], type: :string, default: 'working', banner: "working, last, master, or sha", desc: "Lint by commit or working copy"
+
+  def initialize(*args)
+    super
+    @config ||= Maximus::Config.new(default_options)
+  end
 
   desc "frontend", "Execute all front-end tasks"
   def frontend
@@ -44,11 +59,11 @@ class Maximus::CLI < Thor
     # If include flag is enabled, run based on what's included
     return options[:include].each { |i| send(i) } unless options[:include].blank?
     # If all flag is not enabled, lint working copy as it's supposed to be
-    return Maximus::GitControl.new({ commit: options[:commit], is_dev: true }).lints_and_stats(true)
+    @config.settings[:commit] = options[:git]
+    return Maximus::GitControl.new({config: @config}).lints_and_stats(true)
   end
 
   # @todo something better than just installing in the global npm file
-  # and including phantomjs
   desc "install", "Install all dependencies"
   def install
     `npm install -g jshint phantomas stylestats`
@@ -65,41 +80,45 @@ class Maximus::CLI < Thor
     end
     def default_options
       {
-        path: options[:path],
-        is_dev: true
+        file_paths: options[:filepath],
+        paths: options[:urls],
+        domain: options[:domain],
+        port: options[:port],
+        is_dev: true,
+        config_file: options[:config]
       }
     end
 
     def scsslint
-      Maximus::Scsslint.new(default_options).result
+      Maximus::Scsslint.new({config: @config}).result
     end
 
     def jshint
-      Maximus::Jshint.new(default_options).result
+      Maximus::Jshint.new({config: @config}).result
     end
 
     def rubocop
-      Maximus::Rubocop.new(default_options).result
+      Maximus::Rubocop.new({config: @config}).result
     end
 
     def railsbp
-      Maximus::Railsbp.new(default_options).result
+      Maximus::Railsbp.new({config: @config}).result
     end
 
     def brakeman
-      Maximus::Brakeman.new(default_options).result
+      Maximus::Brakeman.new({config: @config}).result
     end
 
     def stylestats
-      Maximus::Stylestats.new(default_options).result
+      Maximus::Stylestats.new({config: @config}).result
     end
 
     def phantomas
-      Maximus::Phantomas.new(default_options).result
+      Maximus::Phantomas.new({config: @config}).result
     end
 
     def wraith
-      Maximus::Wraith.new(default_options).result
+      Maximus::Wraith.new({config: @config}).result
     end
   end
 

data/lib/maximus/config/maximus-example.yml

@@ -0,0 +1,129 @@
+# Config for all
+domain: 'http://localhost'
+port: 3000
+
+paths:
+  home: '/'
+
+# Lints
+
+# lints: true # enable all lints
+
+scsslint:
+  scss_files: 'app/assets/stylesheets/'
+
+  # output format will always be JSON, so don't bother setting
+  # Format: whatever
+
+  linters:
+    Compass::*:
+      enabled: true
+    Compass::PropertyWithMixin:
+      ignore:
+        - 'inline-block'
+        - 'border-radius'
+        - 'box-shadow'
+        - 'opacity'
+        - 'text-shadow'
+    Indentation:
+      enabled: false
+      character: tab
+      severity: warning
+      width: 1
+    NameFormat:
+      convention: BEM
+      enabled: false
+    SelectorFormat:
+      enabled: false
+    DeclarationOrder:
+      enabled: false
+    EmptyLineBetweenBlocks:
+      enabled: false
+    NestingDepth:
+      max_depth: 6
+      severity: error
+    SelectorDepth:
+      max_depth: 5
+      severity: error
+    LeadingZero:
+      enabled: false
+    PlaceholderInExtend:
+      enabled: false
+    PropertySortOrder:
+      enabled: false
+    QualifyingElement:
+      enabled: true
+      allow_element_with_attribute: true
+    SpaceAfterPropertyColon:
+      enabled: false
+    UnnecessaryParentReference:
+      severity: error
+    VendorPrefixes:
+      exclude:
+        - '-webkit-tap-highlight-color'
+        - '-webkit-font-smoothing'
+        - '-moz-osx-font-smoothing'
+        - '-webkit-appearance'
+        - '-moz-placeholder'
+        - '-ms-input-placeholder'
+        - '-moz-pre-wrap'
+
+jshint:
+  browser: true
+  esnext: true
+  globals: {}
+  globalstrict: true
+  undef: true
+  unused: true
+  jquery: true
+
+rubocop: 'rubocop.yml'
+
+brakeman: true
+
+rails_best_practice: false
+
+# Statistics
+phantomas:
+  block-domain: 'google-analytics.com'
+  skip-modules:
+    - 'Caching'
+    - 'localStorage'
+    - 'Cookies'
+    - 'assetsWithQueryString'
+    - 'nodesWithInlineCSS'
+
+stylestats:
+  published: false
+  paths: false
+  stylesheets: false
+  styleElements: true
+  size: true
+  dataUriSize: true
+  ratioOfDataUriSize: true
+  gzippedSize: false
+  simplicity: true
+  rules: true
+  selectors: true
+  mostIdentifier: true
+  mostIdentifierSelector: true
+  lowestCohesion: true
+  lowestCohesionSelector: true
+  totalUniqueFontSizes: true
+  uniqueFontSize: true
+  totalUniqueColors: true
+  uniqueColor: true
+  idSelectors: true
+  universalSelectors: true
+  unqualifiedAttributeSelectors: true
+  javascriptSpecificSelectors: "[#\\.]js\\-"
+  importantKeywords: true
+  floatProperties: true
+  mediaQueries: true
+  propertiesCount: 10
+  requestOptions: {}
+
+wraith:
+  browser:
+    phantomjs: phantomjs
+    casperjs: casperjs

data/lib/maximus/config/maximus.yml

@@ -0,0 +1,2 @@
+lints: true
+statistics: true