netsoft-rubocop 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8cf6516546fb841a50c1ae074379461322412af26b550d185a29732bd89ff601
+  data.tar.gz: b7f3bf4846b605d70a81c9f6dafa991eb14d33a036e67895d09caf921d38e89e
+SHA512:
+  metadata.gz: d6279ee377b16ca8faed2b20d9ee54d881f2e40acc58a272ae779936cda7319a217c352e9edcc44a88219f0a0d82ccc4d5ea1372ab891b1dbac50b17317b63fd
+  data.tar.gz: 3c6376c673f1d22ac69c87b4051963af7d6a941541f4fb0b4f346ac8fad46151ab45f2ac480251015315101c2b5e3cab5857cc9bf1c9fb5e4e71189479c5bca7

data/.circleci/config.yml

@@ -0,0 +1,141 @@
+version: 2
+
+defaults: &defaults
+  docker: &ruby_image
+    - &ruby_image
+      image: circleci/ruby:2.4.4-stretch
+      environment:
+        CIRCLE_ARTIFACTS: /tmp/circelci-artifacts
+        RUBYOPT: '-KU -E utf-8:utf-8'
+        BUNDLE_PATH: vendor/bundle
+        BUNDLE_VERSION: 1.15.2
+        BUNDLE_JOBS: 4
+        BUNDLE_RETRY: 3
+
+filters:
+  test: &filter_test
+    filters:
+      tags:
+        ignore: /^v.*/
+  beta: &filter_beta
+    filters:
+      branches:
+        ignore: /.*/
+      tags:
+        only: /^v[0-9]+(\.[0-9]+)+(\.[a-z].+).*/
+  release: &filter_release
+    filters:
+      branches:
+        ignore: /.*/
+      tags:
+        only: /^v[0-9]+(\.[0-9]+)+/
+
+workflows:
+  version: 2
+  build_test:
+    jobs:
+      - "Checkout":
+          <<: *filter_test
+          context: org-global
+      - "Build":
+          <<: *filter_test
+          context: org-global
+          requires:
+            - "Checkout"
+  build_test_beta:
+    jobs:
+      - "Checkout":
+          <<: *filter_beta
+          context: org-global
+      - "Build":
+          <<: *filter_beta
+          context: org-global
+          requires:
+            - "Checkout"
+      - "Publish":
+          <<: *filter_beta
+          context: org-global
+          requires:
+            - "Build"
+  build_test_release:
+    jobs:
+      - "Checkout":
+          <<: *filter_release
+          context: org-global
+      - "Build":
+          <<: *filter_release
+          context: org-global
+          requires:
+            - "Checkout"
+      - "Publish":
+          <<: *filter_release
+          context: org-global
+          requires:
+            - "Build"
+
+jobs:
+  "Checkout":
+    <<: *defaults
+    steps:
+      - attach_workspace:
+          at: .
+      - checkout
+
+      - restore_cache:
+          keys:
+            - netsoft-rubocop-bundle-v2-{{ checksum "Gemfile" }}-{{ checksum "netsoft-rubocop.gemspec" }}
+      - run:
+          name: Install bundler
+          command: gem install bundler --version=$BUNDLE_VERSION
+      - run:
+          name: Bundle Install
+          command: |-
+            bundle _${BUNDLE_VERSION}_ check || bundle _${BUNDLE_VERSION}_ install --retry=$BUNDLE_RETRY
+      - save_cache:
+          key: netsoft-rubocop--bundle-v2-{{ checksum "Gemfile" }}-{{ checksum "netsoft-rubocop.gemspec" }}
+          paths:
+            - vendor/bundle
+            - Gemfile.lock
+
+      - persist_to_workspace:
+          root: .
+          paths: .
+  "Build":
+    <<: *defaults
+    steps:
+      - attach_workspace:
+          at: .
+      - run:
+          name: Install bundler
+          command: gem install bundler --version=$BUNDLE_VERSION
+      - run:
+          name: Build gem
+          command: |-
+            gem build *.gemspec
+      - run:
+          name: "Install netsoft-danger"
+          command: |-
+            gem install netsoft-danger
+      - run:
+          name: Run rubocop
+          command: |-
+            netsoft-circle rubocop
+      - run:
+          name: Run Danger
+          command: |-
+            danger
+      - store_artifacts:
+          path: /tmp/circelci-artifacts
+  "Publish":
+    <<: *defaults
+    steps:
+      - attach_workspace:
+          at: .
+      - run:
+          name: Deploy to gem server
+          command: |-
+            ./bin/tag_check.sh
+            ./bin/setup-rubygems.sh
+            rm -rf pkg
+            rake build
+            gem push pkg/*.gem

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+Gemfile.lock
+.ruby-*

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: default.yml

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2019-08-28
+### Added
+- Default rubocop config
+- Netsoft/AuthHttpPositionalArguments cop

data/Dangerfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+danger.import_dangerfile(gem: 'netsoft-danger')

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in netsoft-rubocop.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+# netsoft-rubocop
+
+Hubstaff style guides and shared style configs.
+
+## Installation
+
+Add this line to your project Gemfile:
+
+```ruby
+group :test, :development do
+  gem 'netsoft-rubocop', github: 'NetsoftHoldings/netsoft-rubocop', tag: 'v1.0.0'
+end
+```
+
+And then run:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+Create a `.rubocop.yml` with the following directives:
+
+```yaml
+inherit_gem:
+  netsoft-rubocop:
+    - default.yml
+```
+
+Now, run:
+
+```bash
+$ bundle exec rubocop
+```
+
+You do not need to include rubocop directly in your application's dependencies.
+netsoft-rubocop will include a specific version of `rubocop`, `rubocop-performance`,
+`rubocop-rails` and `rubocop-rspec` that is shared across all projects.
+
+## Releasing
+
+1. Update version.rb file accordingly.
+2. Tag the release: `git tag vVERSION`
+3. Push changes: `git push --tags`

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem
+echo -e "---\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 ~/.gem/credentials

data/bin/tag_check.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+tag=`git describe --tags --exact-match  HEAD 2> /dev/null`
+
+if [ $? -eq 0 ]; then
+  version=`grep VERSION lib/netsoft/rubocop/version.rb | sed -e "s/.*'\([^']*\)'.*/\1/"`
+  
+  if [ "v$version" = "$tag" ]; then
+    echo "Revision $tag Matches $version"
+  else
+    echo "Revision $tag does not match $version"
+    exit 2
+  fi
+else
+  echo "No tag found"
+  exit 1
+fi

data/default.yml

@@ -0,0 +1,117 @@
+require:
+  - ./lib/netsoft/rubocop/cops/auth_http_positional_arguments
+  - rubocop-rails
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+  TargetRailsVersion: 5.2
+  DisplayStyleGuide: true
+  StyleGuideBaseURL: https://rubystyle.guide
+  Exclude:
+    - 'db/**/*'
+    - 'coverage/**/*'
+    - 'log/**/*'
+    - 'public/**/*'
+    - 'tmp/**/*'
+    - 'spec/dummy/**/*'
+    - 'vendor/**/*'
+    - 'gemfiles/**/*'
+    - 'node_modules/**/*'
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: ex
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - me
+    - ex
+
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+
+Layout/IndentAssignment:
+  IndentationWidth: 4
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+  IndentationWidth: 4
+
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+  IndentationWidth: 4
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  SpaceBeforeBlockParameters: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Rails:
+  Enabled: true
+
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Whitelist:
+    - touch
+    - update_attribute
+    - update_counters
+    - increment_counter
+    - decrement_counter
+
+Netsoft/AuthHttpPositionalArguments:
+  Enabled: true
+  Include:
+    - 'spec/controllers/**/*'
+
+RSpec/ExpectChange:
+  EnforcedStyle: block
+
+RSpec/ImplicitSubject:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  AllowBracesOnProceduralOneLiners: true
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Metrics:
+  Enabled: false

data/lib/netsoft/rubocop.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'netsoft/rubocop/version'
+
+module Netsoft
+  # Hubstaff shared rubocop style configs
+  module Rubocop
+  end
+end

data/lib/netsoft/rubocop/cops/auth_http_positional_arguments.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'rubocop/cop/mixin/target_rails_version'
+
+module RuboCop
+  module Cop
+    module Netsoft
+      # This cop is used to identify usages of http methods like `get`, `post`,
+      # `put`, `patch` without the usage of keyword arguments in your tests and
+      # change them to use keyword args. This cop only applies to Rails >= 5.
+      # If you are running Rails < 5 you should disable the
+      # Netsoft/HttpPositionalArguments cop or set your TargetRailsVersion in your
+      # .rubocop.yml file to 4.0, etc.
+      #
+      # @example
+      #   # bad
+      #   get :new, { user_id: 1}
+      #
+      #   # good
+      #   get :new, params: { user_id: 1 }
+      class AuthHttpPositionalArguments < Cop
+        extend RuboCop::Cop::TargetRailsVersion
+
+        MSG = 'Use keyword arguments instead of positional arguments for http call: `%<verb>s`.'
+        KEYWORD_ARGS = %i[method params session body flash xhr as headers env].freeze
+        HTTP_METHODS = %i[get post put patch delete head].freeze
+        HTTP_AUTH_METHODS = %i[get_with post_with put_with patch_with delete_with].freeze
+
+        minimum_target_rails_version 5.0
+
+        def_node_matcher :http_request?, <<-PATTERN
+          (send nil? {#{HTTP_METHODS.map(&:inspect).join(' ')}} !nil? $_ ...)
+        PATTERN
+
+        def_node_matcher :http_auth_request?, <<-PATTERN
+          (send nil? {#{HTTP_AUTH_METHODS.map(&:inspect).join(' ')}} !nil? !nil? $_ ...)
+        PATTERN
+
+        def on_send(node)
+          message = format(MSG, verb: node.method_name)
+
+          http_request?(node) do |data|
+            return unless needs_conversion?(data)
+
+            add_offense(node, location: :selector, message: message)
+          end
+
+          http_auth_request?(node) do |data|
+            return unless auth_needs_conversion?(data)
+
+            add_offense(node, location: :selector, message: message)
+          end
+        end
+
+        # given a pre Rails 5 method: get :new, {user_id: @user.id}, {}
+        #
+        # @return lambda of auto correct procedure
+        # the result should look like:
+        #     get :new, params: { user_id: @user.id }, session: {}
+        # the http_method is the method used to call the controller
+        # the controller node can be a symbol, method, object or string
+        # that represents the path/action on the Rails controller
+        # the data is the http parameters and environment sent in
+        # the Rails 5 http call
+        def autocorrect(node)
+          has_auth = HTTP_AUTH_METHODS.include?(node.method_name.to_sym)
+          if has_auth
+            user, http_path, *data = *node.arguments
+          else
+            http_path, *data = *node.arguments
+          end
+
+          controller_action = http_path.source
+          params = convert_hash_data(data.first, 'params')
+          session = convert_hash_data(data.last, 'session') if data.size > 1
+          # the range of the text to replace, which is the whole line
+          code_to_replace = node.loc.expression
+          # what to replace with
+          format = parentheses_format(node)
+          new_code = format(format, name: node.method_name,
+                            action: has_auth ? [user.source, controller_action].join(',') : controller_action,
+                            params: params, session: session)
+          ->(corrector) { corrector.replace(code_to_replace, new_code) }
+        end
+
+        private
+
+        def needs_conversion?(data)
+          return true unless data.hash_type?
+
+          data.each_pair.none? do |pair|
+            special_keyword_arg?(pair.key) ||
+              format_arg?(pair.key) && data.pairs.one?
+          end
+        end
+
+        def auth_needs_conversion?(data)
+          return true unless data.hash_type?
+
+          data.each_pair.none? do |pair|
+            special_keyword_arg?(pair.key) ||
+              format_arg?(pair.key) && data.pairs.one?
+          end
+        end
+
+        def special_keyword_arg?(node)
+          node.sym_type? && KEYWORD_ARGS.include?(node.value)
+        end
+
+        def format_arg?(node)
+          node.sym_type? && node.value == :format
+        end
+
+        def convert_hash_data(data, type)
+          return '' if data.hash_type? && data.empty?
+
+          hash_data = if data.hash_type?
+                        format('{ %<data>s }',
+                               data: data.pairs.map(&:source).join(', '))
+                      else
+                        # user supplies an object,
+                        # no need to surround with braces
+                        data.source
+                      end
+
+          format(', %<type>s: %<hash_data>s', type: type, hash_data: hash_data)
+        end
+
+        def parentheses_format(node)
+          if parentheses?(node)
+            '%<name>s(%<action>s%<params>s%<session>s)'
+          else
+            '%<name>s %<action>s%<params>s%<session>s'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/netsoft/rubocop/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Netsoft
+  module Rubocop
+    VERSION = '1.0.0'
+  end
+end

data/netsoft-rubocop.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'netsoft/rubocop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'netsoft-rubocop'
+  spec.version       = Netsoft::Rubocop::VERSION
+  spec.authors       = ['Alex Yarotsky']
+  spec.email         = ['alex.yarotsky@hubstaff.com']
+
+  spec.summary       = 'Hubstaff style guides and shared style configs.'
+  spec.homepage      = 'https://github.com/netsoftHoldings/netsoft-rubocop'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.0'
+
+  spec.add_runtime_dependency 'rubocop', '~> 0.74.0'
+  spec.add_runtime_dependency 'rubocop-performance', '~> 1.4'
+  spec.add_runtime_dependency 'rubocop-rails', '~> 2.2'
+  spec.add_runtime_dependency 'rubocop-rspec', '~> 1.35'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: netsoft-rubocop
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Yarotsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.35'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.35'
+description: 
+email:
+- alex.yarotsky@hubstaff.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Dangerfile
+- Gemfile
+- README.md
+- Rakefile
+- bin/setup-rubygems.sh
+- bin/tag_check.sh
+- default.yml
+- lib/netsoft/rubocop.rb
+- lib/netsoft/rubocop/cops/auth_http_positional_arguments.rb
+- lib/netsoft/rubocop/version.rb
+- netsoft-rubocop.gemspec
+homepage: https://github.com/netsoftHoldings/netsoft-rubocop
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Hubstaff style guides and shared style configs.
+test_files: []