gazelle_styleguide 0.0.1 → 0.0.2

data/config/rubocop.yml

@@ -1,21 +1,13 @@
-# This is the default configuration file. Enabling and disabling is configured
-# in separate files. This file adds all other parameters apart from Enabled.
-
-inherit_from:
-#  - enabled.yml
-#  - disabled.yml
-
 # Common configuration.
 AllCops:
   # Include gemspec and Rakefile
-  Includes:
+  Include:
     - '**/*.gemspec'
     - '**/Rakefile'
     - '**/*.rake'
     - '**/Gemfile'
-  Excludes: []
-  # By default, the rails cops are not run. Override in project or home
-  # directory .rubocop.yml files, or by giving the -R/--rails option.
+  Exclude:
+    - 'vendor/**'
   RunRailsCops: true
 
 # Indent private/protected/public as deep as method definitions
@@ -25,6 +17,81 @@ AccessModifierIndentation:
     - outdent
     - indent
 
+# Indentation of `when`.
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+
+ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 200
+
+# Align ends correctly.
+EndAlignment:
+  # The value `keyword` means that `end` should be aligned with the matching
+  # keyword (if, while, etc.).
+  # The value `variable` means that in assignments, `end` should be aligned
+  # with the start of the variable on the left hand side of `=`. In all other
+  # situations, `end` should still be aligned with the keyword.
+  AlignWith: variable
+  SupportedStyles:
+    - keyword
+    - variable
+
+# Built-in global variables are allowed by default.
+GlobalVars:
+  AllowedVariables: ['$1', '$2', '$3', '$4', '$5', '$6']
+
+LineLength:
+  Max: 120
+
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+NumericLiterals:
+  MinDigits: 10
+
+SignalException:
+  EnforcedStyle: only_raise
+  SupportedStyles:
+    - only_raise
+    - only_fail
+    - semantic
+
+SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+SpaceInsideBlockBraces:
+  EnforcedStyle: no_space
+  SupportedStyles:
+    - space
+    - no_space
+  # Valid values are: space, no_space
+  EnforcedStyleForEmptyBraces: no_space
+  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
+  SpaceBeforeBlockParameters: false
+
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+WordArray:
+  MinSize: 0
+
+##########################################################################
+####################### DEFAULTS FROM RUBOCOP ############################
+##########################################################################
+
 # Align the elements of a hash literal if they span more than one line.
 AlignHash:
   # Alignment of entries using hash rocket as separator. Valid values are:
@@ -51,6 +118,62 @@ AlignHash:
   #   a:  0
   #   bb: 1
   EnforcedColonStyle: key
+  # Select whether hashes that are the last argument in a method call should be
+  # inspected? Valid values are:
+  #
+  # always_inspect - Inspect both implicit and explicit hashes.
+  #   Registers and offence for:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offence for:
+  #     function({a: 1,
+  #       b: 2})
+  # always_ignore - Ignore both implicit and explicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_implicit - Ingore only implicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offence for:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_explicit - Ingore only explicit hashes.
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  #   Registers an offence for:
+  #     function(a: 1,
+  #       b: 2)
+  EnforcedLastArgumentHashStyle: always_inspect
+  SupportedLastArgumentHashStyles:
+    - always_inspect
+    - always_ignore
+    - ignore_implicit
+    - ignore_explicit
+
+AlignParameters:
+  # Alignment of parameters in multi-line method calls.
+  #
+  # The `with_first_parameter` style aligns the following lines along the same column
+  # as the first parameter.
+  #
+  #     method_call(a,
+  #                 b)
+  #
+  # The `with_fixed_indentation` style alignes the following lines with one
+  # level of indenation relative to the start of the line with the method call.
+  #
+  #     method_call(a,
+  #       b)
+  EnforcedStyle: with_first_parameter
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation
 
 # Allow safe assignment in conditions.
 AssignmentInCondition:
@@ -65,20 +188,35 @@ BracesAroundHashParameters:
     - braces
     - no_braces
 
-# Indentation of `when`.
-CaseIndentation:
-  IndentWhenRelativeTo: case
+ClassAndModuleChildren:
+  # Checks the style of children definitions at classes and modules.
+  #
+  # Basically there are two different styles:
+  #
+  # `nested` - have each child on a separat line
+  #   class Foo
+  #     class Bar
+  #     end
+  #   end
+  #
+  # `compact` - combine definitions as much as possible
+  #   class Foo::Bar
+  #   end
+  #
+  # The compact style is only forced, for classes / modules with one child.
+  EnforcedStyle: nested
   SupportedStyles:
-    - case
-    - end
-  IndentOneStep: false
-
-ClassLength:
-  CountComments: false  # count full line comments?
-  Max: 200
+    - nested
+    - compact
 
 # Align with the style guide.
 CollectionMethods:
+  # Mapping from undesired method to desired_method
+  # e.g. to use `detect` over `find`:
+  #
+  # CollectionMethods:
+  #   PreferredMethods:
+  #     find: detect
   PreferredMethods:
     collect: 'map'
     collect!: 'map!'
@@ -99,12 +237,9 @@ CommentAnnotation:
 CyclomaticComplexity:
   Max: 6
 
-Documentation:
-  Enabled: true
-
 # Multi-line method chaining should be done with leading dots.
 DotPosition:
-  Style: leading
+  EnforcedStyle: leading
   SupportedStyles:
     - leading
     - trailing
@@ -115,20 +250,11 @@ EmptyLineBetweenDefs:
   # need an empty line between them.
   AllowAdjacentOneLineDefs: false
 
-Encoding:
-  Enabled: true
-
-# Align ends correctly.
-EndAlignment:
-  # The value `keyword` means that `end` should be aligned with the matching
-  # keyword (if, while, etc.).
-  # The value `variable` means that in assignments, `end` should be aligned
-  # with the start of the variable on the left hand side of `=`. In all other
-  # situations, `end` should still be aligned with the keyword.
-  AlignWith: variable
-  SupportedStyles:
-    - keyword
-    - variable
+FileName:
+  Exclude:
+    - Rakefile
+    - Gemfile
+    - Capfile
 
 # Checks use of for or each in multiline loops.
 For:
@@ -137,9 +263,13 @@ For:
     - for
     - each
 
-# Built-in global variables are allowed by default.
-GlobalVars:
-  AllowedVariables: ['$1', '$2', '$3', '$4', '$5', '$6']
+# Enforce the method used for string formatting.
+FormatString:
+  EnforcedStyle: format
+  SupportedStyles:
+    - format
+    - sprintf
+    - percent
 
 HashSyntax:
   EnforcedStyle: ruby19
@@ -147,15 +277,29 @@ HashSyntax:
     - ruby19
     - hash_rockets
 
+IfUnlessModifier:
+  MaxLineLength: 79
+
+# Checks the indentation of the first key in a hash literal.
+IndentHash:
+  # The value `special_inside_parentheses` means that hash literals with braces
+  # that have their opening brace on the same line as a surrounding opening
+  # round parenthesis, shall have their first key indented relative to the
+  # first position inside the parenthesis.
+  # The value `consistent` means that the indentation of the first key shall
+  # always be relative to the first position of the line where the opening
+  # brace is.
+  EnforcedStyle: special_inside_parentheses
+  SupportedStyles:
+    - special_inside_parentheses
+    - consistent
+
 LambdaCall:
   EnforcedStyle: call
   SupportedStyles:
     - call
     - braces
 
-LineLength:
-  Max: 120
-
 MethodDefParentheses:
   EnforcedStyle: require_parentheses
   SupportedStyles:
@@ -164,7 +308,7 @@ MethodDefParentheses:
 
 MethodLength:
   CountComments: false  # count full line comments?
-  Max: 20
+  Max: 10
 
 MethodName:
   EnforcedStyle: snake_case
@@ -172,16 +316,6 @@ MethodName:
     - snake_case
     - camelCase
 
-NumericLiterals:
-  MinDigits: 10
-
-Output:
-  Ignore:
-    - '^.*\.rake$'
-    - '^.*/script/.*$'
-    - '^.*/tasks/.*$'
-    - 'Rakefile$'
-
 ParameterLists:
   Max: 5
   CountKeywordArgs: true
@@ -190,6 +324,18 @@ ParameterLists:
 ParenthesesAroundCondition:
   AllowSafeAssignment: true
 
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
+
 PredicateName:
   NamePrefixBlacklist:
     - is_
@@ -208,20 +354,14 @@ RedundantReturn:
   AllowMultipleReturnValues: false
 
 RegexpLiteral:
+  # The maximum number of (escaped) slashes that a slash-delimited regexp is
+  # allowed to have. If there are more slashes, a %r regexp shall be used.
   MaxSlashes: 1
 
 Semicolon:
   # Allow ; to separate several expressions on the same line.
   AllowAsExpressionSeparator: false
 
-SignalException:
-  EnforcedStyle: only_raise
-  SupportedStyles:
-    - only_raise
-    - only_fail
-    - semantic
-
-
 SingleLineBlockParams:
   Methods:
     - reduce:
@@ -240,23 +380,18 @@ StringLiterals:
     - single_quotes
     - double_quotes
 
-SpaceAroundBlockBraces:
-  EnforcedStyle: no_space_inside_braces
-  SupportedStyles:
-    - space_inside_braces
-    - no_space_inside_braces
-  # Valid values are: space, no_space
-  EnforcedStyleForEmptyBraces: no_space
-  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
-  SpaceBeforeBlockParameters: false
-
-SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-  EnforcedStyleForEmptyBraces: no_space
+SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
   SupportedStyles:
     - space
     - no_space
 
+TrailingBlankLines:
+  EnforcedStyle: final_newline
+  SupportedStyles:
+    - final_newline
+    - final_blank_line
+
 TrailingComma:
   EnforcedStyleForMultiline: no_comma
   SupportedStyles:
@@ -268,6 +403,15 @@ TrailingComma:
 TrivialAccessors:
   ExactNameMatch: false
   AllowPredicates: false
+  # Allows trivial writers that don't end in an equal sign. e.g.
+  #
+  # def on_exception(action)
+  #   @on_exception=action
+  # end
+  # on_exception :restart
+  #
+  # Commonly used in DSLs
+  AllowDSLWriters: false
   Whitelist:
     - to_ary
     - to_a
@@ -293,23 +437,35 @@ VariableName:
     - snake_case
     - camelCase
 
-WordArray:
-  MinSize: 0
+WhileUntilModifier:
+  MaxLineLength: 79
 
 ##################### Rails ##################################
 
+ActionFilter:
+  EnforcedStyle: action
+  SupportedStyles:
+    - action
+    - filter
+  Include:
+    - app/controllers/*.rb
+
 DefaultScope:
-  IncludePaths:
-    - app/models
+  Include:
+    - app/models/*.rb
 
 HasAndBelongsToMany:
-  IncludePaths:
-    - app/models
+  Include:
+    - app/models/*.rb
+
+ReadWriteAttribute:
+  Include:
+    - app/models/*.rb
 
-ReadAttribute:
-  IncludePaths:
-    - app/models
+ScopeArgs:
+  Include:
+    - app/models/*.rb
 
 Validation:
-  IncludePaths:
-    - app/models
+  Include:
+    - app/models/*.rb

data/gazelle_styleguide.gemspec

@@ -19,9 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'pre-commit'
+  spec.add_runtime_dependency 'pre-commit-checkstyle'
   spec.add_runtime_dependency 'rubocop'
   spec.add_runtime_dependency 'execjs'
   spec.add_runtime_dependency 'grit'
+  spec.add_runtime_dependency 'thor'
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/lib/gazelle_styleguide/cli.rb

@@ -1,28 +1,31 @@
 # -*- encoding : utf-8 -*-
 require 'grit'
 require 'thor'
+require 'fileutils'
 
 module GazelleStyleguide
   # Command line tool for managing linter running and pre-commits
   class CLI < Thor
-    CHECKS = 'env, jshint, rspec_focus, merge_conflict, rubocop, coffee_lint, json, yaml, scss_lint, checkstyle'
+    CHECKS = 'rubocop, jshint, rspec_focus, merge_conflict, coffeelint, json, yaml, scss_lint, checkstyle'
 
     desc 'init', 'Sets up pre-commit hooks to check style.'
     def init
-      install_pre_commit
       setup_git_config
+      install_pre_commit
+      setup_houndci
     end
 
     desc 'lint [flags|FILES]', 'Runs linters'
     option :all, aliases: :a
     option :changed, aliases: :c
     def lint(*files)
+      require 'pre-commit'
       files = lint_files(files, options)
 
       PreCommit::Runner.new($stderr, files).run
     end
 
-  private
+    private
 
     def install_pre_commit
       require 'pre-commit/installer'
@@ -32,21 +35,40 @@ module GazelleStyleguide
 
     def setup_git_config
       repo.config['pre-commit.checks'] = CHECKS
+      repo.config['pre-commit.jshint.config'] = GazelleStyleguide.config_for('jshintrc.json')
       repo.config['pre-commit.rubocop.config'] = GazelleStyleguide.config_for('rubocop.yml')
+      repo.config['pre-commit.coffeelint.config'] = GazelleStyleguide.config_for('coffeelint.json')
+      repo.config['pre-commit.checkstyle.config'] = GazelleStyleguide.config_for('sun_checks.xml')
+    end
+
+    def setup_houndci
+      return unless ruby?
+
+      FileUtils.cp(GazelleStyleguide.config_for('rubocop.yml'), project_root.join('.hound.yml'))
+    end
+
+    def project_root
+      @project_root ||= Pathname.new('.').ascend do |path|
+        return path if path.join('.git').exist?
+      end
+    end
+
+    def ruby?
+      project_root.join('Gemfile').exist?
     end
 
     def lint_files(files, options)
       if files.any?
         files
       elsif options[:all]
-        Dir['./**/*'].select {|f| File.file?(f)}
+        Dir['./**/*'].select { |f| File.file?(f) }
       else
         changed_files
       end
     end
 
     def changed_files
-      repo.status.files.select {|file, status| status.type == 'M' || status.untracked}.keys
+      repo.status.files.select { |file, status| status.type == 'M' || status.untracked }.keys
     end
 
     def repo

data/lib/gazelle_styleguide/version.rb

@@ -2,5 +2,5 @@
 
 # Styleguide version
 module GazelleStyleguide
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/gazelle_styleguide.rb

@@ -1,15 +1,7 @@
 # -*- encoding : utf-8 -*-
-require 'pre-commit'
 require 'rubocop'
 require 'execjs'
 
-require 'plugins/pre_commit/checks/checkstyle'
-require 'plugins/pre_commit/checks/coffee_lint'
-require 'plugins/pre_commit/checks/env'
-require 'plugins/pre_commit/checks/json'
-require 'plugins/pre_commit/checks/scss_lint'
-require 'plugins/pre_commit/checks/yaml'
-
 require 'gazelle_styleguide/version'
 require 'gazelle_styleguide/cli'
 

data/spec/gazelle_styleguide_spec.rb

@@ -6,7 +6,4 @@ describe GazelleStyleguide do
     expect(GazelleStyleguide::VERSION).not_to be nil
   end
 
-  it 'should do something useful' do
-    expect(false).to be true
-  end
 end