codeguard 0.1.0

data/config/.scss-lint.yml

@@ -0,0 +1,234 @@
+# Default application configuration that all configurations inherit from.
+
+scss_files: "**/*.scss"
+plugin_directories: ['.scss-linters']
+
+# List of gem names to load custom linters from (make sure they are already
+# installed)
+plugin_gems: []
+
+linters:
+  BangFormat:
+    enabled: true
+    space_before_bang: true
+    space_after_bang: false
+
+  BemDepth:
+    enabled: false
+    max_elements: 1
+
+  BorderZero:
+    enabled: true
+    convention: zero # or `none`
+
+  ColorKeyword:
+    enabled: true
+
+  ColorVariable:
+    enabled: true
+
+  Comment:
+    enabled: true
+
+  DebugStatement:
+    enabled: true
+
+  DeclarationOrder:
+    enabled: true
+
+  DisableLinterReason:
+    enabled: false
+
+  DuplicateProperty:
+    enabled: true
+
+  ElsePlacement:
+    enabled: true
+    style: same_line # or 'new_line'
+
+  EmptyLineBetweenBlocks:
+    enabled: true
+    ignore_single_line_blocks: true
+
+  EmptyRule:
+    enabled: true
+
+  ExtendDirective:
+    enabled: false
+
+  FinalNewline:
+    enabled: true
+    present: true
+
+  HexLength:
+    enabled: true
+    style: short # or 'long'
+
+  HexNotation:
+    enabled: true
+    style: lowercase # or 'uppercase'
+
+  HexValidation:
+    enabled: true
+
+  IdSelector:
+    enabled: true
+
+  ImportantRule:
+    enabled: true
+
+  ImportPath:
+    enabled: true
+    leading_underscore: false
+    filename_extension: false
+
+  Indentation:
+    enabled: true
+    allow_non_nested_indentation: false
+    character: space # or 'tab'
+    width: 2
+
+  LeadingZero:
+    enabled: true
+    style: exclude_zero # or 'include_zero'
+
+  MergeableSelector:
+    enabled: true
+    force_nesting: true
+
+  NameFormat:
+    enabled: true
+    allow_leading_underscore: true
+    convention: hyphenated_lowercase # or 'camel_case', or 'snake_case', or a regex pattern
+
+  NestingDepth:
+    enabled: true
+    max_depth: 3
+    ignore_parent_selectors: false
+
+  PlaceholderInExtend:
+    enabled: true
+
+  PropertyCount:
+    enabled: false
+    include_nested: false
+    max_properties: 10
+
+  PropertySortOrder:
+    enabled: true
+    ignore_unspecified: false
+    min_properties: 2
+    separate_groups: false
+
+  PropertySpelling:
+    enabled: true
+    extra_properties: []
+
+  PropertyUnits:
+    enabled: true
+    global: [
+      'ch', 'em', 'ex', 'rem',                 # Font-relative lengths
+      'cm', 'in', 'mm', 'pc', 'pt', 'px', 'q', # Absolute lengths
+      'vh', 'vw', 'vmin', 'vmax',              # Viewport-percentage lengths
+      'deg', 'grad', 'rad', 'turn',            # Angle
+      'ms', 's',                               # Duration
+      'Hz', 'kHz',                             # Frequency
+      'dpi', 'dpcm', 'dppx',                   # Resolution
+      '%']                                     # Other
+    properties: {}
+
+  QualifyingElement:
+    enabled: true
+    allow_element_with_attribute: false
+    allow_element_with_class: false
+    allow_element_with_id: false
+
+  SelectorDepth:
+    enabled: true
+    max_depth: 3
+
+  SelectorFormat:
+    enabled: true
+    convention: hyphenated_lowercase # or 'strict_BEM', or 'hyphenated_BEM', or 'snake_case', or 'camel_case', or a regex pattern
+
+  Shorthand:
+    enabled: true
+    allowed_shorthands: [1, 2, 3]
+
+  SingleLinePerProperty:
+    enabled: true
+    allow_single_line_rule_sets: true
+
+  SingleLinePerSelector:
+    enabled: true
+
+  SpaceAfterComma:
+    enabled: true
+    style: one_space # or 'no_space', or 'at_least_one_space'
+
+  SpaceAfterPropertyColon:
+    enabled: true
+    style: one_space # or 'no_space', or 'at_least_one_space', or 'aligned'
+
+  SpaceAfterPropertyName:
+    enabled: true
+
+  SpaceAfterVariableName:
+    enabled: true
+
+  SpaceAroundOperator:
+    enabled: true
+    style: one_space # or 'no_space'
+
+  SpaceBeforeBrace:
+    enabled: true
+    style: space # or 'new_line'
+    allow_single_line_padding: false
+
+  SpaceBetweenParens:
+    enabled: true
+    spaces: 0
+
+  StringQuotes:
+    enabled: true
+    style: single_quotes # or double_quotes
+
+  TrailingSemicolon:
+    enabled: true
+
+  TrailingWhitespace:
+    enabled: true
+
+  TrailingZero:
+    enabled: false
+
+  TransitionAll:
+    enabled: false
+
+  UnnecessaryMantissa:
+    enabled: true
+
+  UnnecessaryParentReference:
+    enabled: true
+
+  UrlFormat:
+    enabled: true
+
+  UrlQuotes:
+    enabled: true
+
+  VariableForProperty:
+    enabled: false
+    properties: []
+
+  VendorPrefix:
+    enabled: true
+    identifier_list: base
+    additional_identifiers: []
+    excluded_identifiers: []
+
+  ZeroUnit:
+    enabled: true
+
+  Compass::*:
+    enabled: false

data/config/coffeelint.json

@@ -0,0 +1,135 @@
+{
+  "arrow_spacing": {
+    "level": "ignore"
+  },
+  "braces_spacing": {
+    "level": "ignore",
+    "spaces": 0,
+    "empty_object_spaces": 0
+  },
+  "camel_case_classes": {
+    "level": "error"
+  },
+  "coffeescript_error": {
+    "level": "error"
+  },
+  "colon_assignment_spacing": {
+    "level": "ignore",
+    "spacing": {
+      "left": 0,
+      "right": 0
+    }
+  },
+  "cyclomatic_complexity": {
+    "value": 10,
+    "level": "ignore"
+  },
+  "duplicate_key": {
+    "level": "error"
+  },
+  "empty_constructor_needs_parens": {
+    "level": "ignore"
+  },
+  "ensure_comprehensions": {
+    "level": "warn"
+  },
+  "eol_last": {
+    "level": "ignore"
+  },
+  "indentation": {
+    "value": 2,
+    "level": "error"
+  },
+  "line_endings": {
+    "level": "ignore",
+    "value": "unix"
+  },
+  "max_line_length": {
+    "value": 80,
+    "level": "error",
+    "limitComments": true
+  },
+  "missing_fat_arrows": {
+    "level": "ignore",
+    "is_strict": false
+  },
+  "newlines_after_classes": {
+    "value": 3,
+    "level": "ignore"
+  },
+  "no_backticks": {
+    "level": "error"
+  },
+  "no_debugger": {
+    "level": "warn",
+    "console": false
+  },
+  "no_empty_functions": {
+    "level": "ignore"
+  },
+  "no_empty_param_list": {
+    "level": "ignore"
+  },
+  "no_implicit_braces": {
+    "level": "ignore",
+    "strict": true
+  },
+  "no_implicit_parens": {
+    "strict": true,
+    "level": "ignore"
+  },
+  "no_interpolation_in_single_quotes": {
+    "level": "ignore"
+  },
+  "no_nested_string_interpolation": {
+    "level": "warn"
+  },
+  "no_plusplus": {
+    "level": "ignore"
+  },
+  "no_private_function_fat_arrows": {
+    "level": "warn"
+  },
+  "no_stand_alone_at": {
+    "level": "ignore"
+  },
+  "no_tabs": {
+    "level": "error"
+  },
+  "no_this": {
+    "level": "ignore"
+  },
+  "no_throwing_strings": {
+    "level": "error"
+  },
+  "no_trailing_semicolons": {
+    "level": "error"
+  },
+  "no_trailing_whitespace": {
+    "level": "error",
+    "allowed_in_comments": false,
+    "allowed_in_empty_lines": true
+  },
+  "no_unnecessary_double_quotes": {
+    "level": "ignore"
+  },
+  "no_unnecessary_fat_arrows": {
+    "level": "warn"
+  },
+  "non_empty_constructor_needs_parens": {
+    "level": "ignore"
+  },
+  "prefer_english_operator": {
+    "level": "ignore",
+    "doubleNotLevel": "ignore"
+  },
+  "space_operators": {
+    "level": "ignore"
+  },
+  "spacing_after_comma": {
+    "level": "ignore"
+  },
+  "transform_messes_up_line_numbers": {
+    "level": "warn"
+  }
+}

data/config/jshint.yml

@@ -0,0 +1,21 @@
+files: ["**/*.js"] # No need to put app/assets/ or vendor/assets here
+exclude_paths: []
+options:
+  boss:       true
+  browser:    true
+  curly:      true
+  eqeqeq:     true
+  eqnull:     true
+  expr:       true
+  immed:      true
+  indent:     2
+  latedef:    true
+  newcap:     true
+  noarg:      true
+  sub:        true
+  trailing:   true
+  undef:      true
+  unused:     true
+  globals:
+    jQuery:   true
+    "$":      true

data/lib/codeguard/cli.rb

@@ -0,0 +1,17 @@
+module Codeguard
+  module CLI
+    AVAILABLE_OPTIONS = %w(install help diff)
+
+    module_function
+
+    def run(*args)
+      command = args.shift
+      unless AVAILABLE_OPTIONS.include?(command)
+        puts "Invalid option: #{command}"
+        command = :help
+      end
+
+      Codeguard.send(command || :help, *args)
+    end
+  end # module CLI
+end # module Codeguard

data/lib/codeguard/coffeelint.rb

@@ -0,0 +1,13 @@
+module Codeguard
+  module Coffeelint
+    module_function
+
+    def config_project_path
+      Pathname.new 'coffeelint.json'
+    end
+
+    def config_gem_path
+      Codeguard.config_path.join('coffeelint.json')
+    end
+  end # module Coffeelint
+end # module Codeguard

data/lib/codeguard/diff.rb

@@ -0,0 +1,44 @@
+require 'rainbow'
+module Codeguard
+  class Diff
+    extend Forwardable
+    attr_accessor :lint, :message, :raw_diff
+
+    def self.perform(lint)
+      new(lint).tap(&:perform)
+    end
+
+    def initialize(lint)
+      @lint = lint
+    end
+
+    def perform
+      self.raw_diff = Diffy::Diff.new(config_gem_path.to_s,
+                                      config_project_path.to_s,
+                                      source: 'files')
+    end
+
+    def diff
+      raw_diff.to_s(:color) unless diff_empty?
+    end
+
+    def message
+      if !File.exist?(config_project_path)
+        Rainbow("#{config_project_path} does not exists. " \
+          'Run `codeguard install`.').yellow
+      elsif !diff_empty?
+        Rainbow("#{config_project_path} was changed.").red
+      else
+        Rainbow("#{config_project_path} is OK!").green
+      end
+    end
+
+    private
+
+    def diff_empty?
+      raw_diff.to_s.empty?
+    end
+
+    def_delegators :lint, :config_project_path, :config_gem_path
+  end # class Diff
+end # module Codeguard

data/lib/codeguard/git_message.rb

@@ -0,0 +1,17 @@
+module Codeguard
+  module GitMessage
+    module_function
+
+    def config_project_path
+      Pathname.new '.gitmessage'
+    end
+
+    def config_gem_path
+      Codeguard.config_path.join('.gitmessage')
+    end
+
+    def after_install
+      `git config commit.template .gitmessage`
+    end
+  end # module GitMessage
+end # module Codeguard

data/lib/codeguard/install.rb

@@ -0,0 +1,46 @@
+require 'rainbow'
+module Codeguard
+  class Install
+    extend Forwardable
+    attr_accessor :lint
+
+    def self.perform(lint)
+      new(lint).tap(&:perform)
+    end
+
+    def initialize(lint)
+      @lint = lint
+    end
+
+    def perform
+      output = config_gem_path.read
+      prepare_dir
+      output = if write_to_file(config_project_path, output)
+                 "File: #{config_project_path} was updated!"
+               else
+                 "File: #{config_project_path} was created!"
+               end
+      puts Rainbow(output).green
+
+      lint.after_install if lint.respond_to?(:after_install)
+    end
+
+    private
+
+    def prepare_dir
+      dir = config_project_path.to_s[%r{(.*)\/[\w\.-]*}, 1]
+      FileUtils.mkdir_p(dir) unless dir.nil?
+    end
+
+    def write_to_file(path, content)
+      if (updating = File.exist?(path))
+        FileUtils.chmod 'a+w', path
+      end
+      File.open(path, 'w+') { |f| f.write(content) }
+      FileUtils.chmod 'a-w', path
+      updating
+    end
+
+    def_delegators :lint, :config_project_path, :config_gem_path
+  end # class Install
+end # module Codeguard

data/lib/codeguard/js_hint.rb

@@ -0,0 +1,13 @@
+module Codeguard
+  module JSHint
+    module_function
+
+    def config_project_path
+      Pathname.new 'config/jshint.yml'
+    end
+
+    def config_gem_path
+      Codeguard.config_path.join('jshint.yml')
+    end
+  end # module JSHint
+end # module Codeguard

data/lib/codeguard/rubocop.rb

@@ -0,0 +1,13 @@
+module Codeguard
+  module Rubocop
+    module_function
+
+    def config_project_path
+      Pathname.new '.rubocop.yml'
+    end
+
+    def config_gem_path
+      Codeguard.config_path.join('.rubocop.yml')
+    end
+  end # module Rubocop
+end # module Codeguard

data/lib/codeguard/scss_lint.rb

@@ -0,0 +1,13 @@
+module Codeguard
+  module SCSSLint
+    module_function
+
+    def config_project_path
+      Pathname.new '.scss-lint.yml'
+    end
+
+    def config_gem_path
+      Codeguard.config_path.join('.scss-lint.yml')
+    end
+  end # module SCSSLint
+end # module Codeguard

data/lib/codeguard/version.rb

@@ -0,0 +1,3 @@
+module Codeguard
+  VERSION = '0.1.0'
+end # module Codeguard

data/lib/codeguard.rb

@@ -0,0 +1,54 @@
+require 'diffy'
+require 'codeguard/install'
+require 'codeguard/coffeelint'
+require 'codeguard/js_hint'
+require 'codeguard/rubocop'
+require 'codeguard/scss_lint'
+require 'codeguard/git_message'
+require 'codeguard/diff'
+
+module Codeguard
+  LINTERS = [Coffeelint, GitMessage, JSHint, Rubocop, SCSSLint]
+
+  module_function
+
+  def install
+    LINTERS.each do |lint|
+      Install.perform(lint)
+    end
+  end
+
+  def diff
+    lints = LINTERS.map do |lint|
+      diff = Diff.perform(lint)
+      [diff.diff, diff.message]
+    end
+    transposed = lints.transpose
+    puts transposed.first.compact
+    puts transposed.last.compact
+  end
+
+  def help
+    puts %(
+      codeguard help    - show this message
+      codeguard install - install config for current project
+      codeguard diff    - check if the files were not modified
+
+      The project will use configuration for:
+      - coffeelint (http://www.coffeelint.org/)
+      - js_hint (https://github.com/damian/jshint)
+      - rubocop (https://github.com/bbatsov/rubocop)
+      - scss_lint (https://github.com/brigade/scss-lint)
+
+      .gitmessage file will be added as a template in .git/config
+    )
+  end
+
+  def config_path
+    gem_root.join('config')
+  end
+
+  def gem_root
+    Pathname.new($LOAD_PATH.first).join('../')
+  end
+end # module Codeguard