barcoop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8ce64d411c35913faa32cf6523d4b76b41c9c66
+  data.tar.gz: c6def3f016fa0a2160b4e52e80e886a1f2617547
+SHA512:
+  metadata.gz: 3692b7c5a638a9df174e9ec3f2a71365980c8d73132b95eb4a5d547631d97ff09a252de00eee0e72ff74ae3b9153a64b420cde078c83d72b6008899c8e597b87
+  data.tar.gz: 5d965481afdfe7491680bf161126535158f76057747322df4a7a1114ab30bdd1085e00f80b606cc64efa221d048adfe26d08c39a583c0b15519e12f97a68df8d

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - conf/rubocop.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# Barcoop
+
+Barcoo's shared RuboCop configuration and cops.
+
+### Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+group :development, :test do
+  gem 'barcoop', require: false
+end  
+```
+
+Or to your gem's `gemspec` file:
+
+```ruby
+spec.add_development_dependency 'barcoop'
+```
+
+To use it just add the following line to your `.rubocop.yml` file:
+```yaml
+inherit_gem:
+  barcoop: conf/rubocop.yml
+```
+
+### Cops
+
+This gems provides the following cops:
+
+[AvoidFixtures](lib/barcoop/cops/avoid_fixtures.rb): Avoid using fixtures, use `FactoryGirl` instead
+
+[AvoidRailsEnv](lib/barcoop/cops/avoid_rails_env.rb): Avoid using `Rails.env.environment?` and prefer adding a feature flag in a configuration file.
+
+[AvoidTimeout](lib/barcoop/cops/avoid_timeout.rb): `Timeout.timeout` is not thread safe, see http://www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/barcoop.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'barcoop/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'barcoop'
+  spec.version = Barcoop::VERSION
+  spec.authors = ['Sergio Medina']
+  spec.email = ['sergio.medina@offerista.com']
+
+  spec.summary = "barcoo's rubocop config and cops"
+  spec.description = "barcoo's rubocop config and cops"
+  spec.homepage = 'https://github.com/barcoo/barcoop'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rubocop'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/conf/rubocop.yml

@@ -0,0 +1,105 @@
+# see https://github.com/bbatsov/rubocop#configuration
+# for info on how to configure rubocop
+# see https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# for default configuration
+
+require:
+  - barcoop/cops/avoid_rails_env.rb
+  - barcoop/cops/avoid_fixtures.rb
+  - barcoop/cops/avoid_timeout.rb
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+    - '**/Gemfile'
+  Exclude:
+    - 'db/**/*'
+    - 'script/**/*'
+    - 'vendor/**/*'
+    - 'test/dummy/db/**/*'
+    - 'test/dummy/vendor/**/*'
+
+Rails:
+  Enabled: true
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 200
+  # Enabled: false
+
+Metrics/MethodLength:
+  Max: 40
+  # Enabled: false
+
+Metrics/ModuleLength:
+  Max: 500
+  # Enabled: false
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or a Float.
+  # http://c2.com/cgi/wiki?AbcMetric
+  Max: 50
+  Exclude:
+    - 'test/**/*_test.rb' # ignore test methods which typically have high B count due to many asserts
+
+Metrics/CyclomaticComplexity:
+  # http://www.rubydoc.info/github/bbatsov/rubocop/Rubocop/Cop/Style/CyclomaticComplexity
+  Max: 12
+  Exclude:
+    - 'test/**/*_test.rb'
+
+Metrics/PerceivedComplexity:
+  # http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Metrics/PerceivedComplexity
+  Max: 13
+  Exclude:
+    - 'test/**/*_test.rb'
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Metrics/ClassLength:
+  Max: 200
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/DefWithParentheses:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/lib/barcoop/cops/avoid_fixtures.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Barcoop
+  module Cops
+    class AvoidFixtures < RuboCop::Cop::Cop
+      def on_send(node)
+        _receiver, method_name = *node
+        if method_name == :fixtures
+          msg = 'Avoid using fixtures, use FactoryGirl instead'
+          add_offense(node, :expression, msg)
+        end
+      end
+    end
+  end
+end

data/lib/barcoop/cops/avoid_rails_env.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Barcoop
+  module Cops
+    class AvoidRailsEnv < RuboCop::Cop::Cop
+      # def uncomment_to_test_this_cop()
+      #   _foo = Rails.env.production?
+      # end
+
+      def rails_env?(node)
+        is_rails_env = false
+        if node.send_type?
+          receiver, method_name = *node
+          is_rails_env = method_name == :env && receiver.const_type? && receiver.const_name == 'Rails'
+        end
+        return is_rails_env
+      end
+
+      def on_send(node)
+        receiver, method_name = *node
+        if %i(production? development? test?).include?(method_name)
+          msg = 'Avoid using Rails.env.environment? and prefer adding a feature flag in the configuration file.'
+          add_offense(node, :expression, msg) if rails_env?(receiver)
+        end
+      end
+    end
+  end
+end

data/lib/barcoop/cops/avoid_timeout.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Barcoop
+  module Cops
+    class AvoidTimeout < RuboCop::Cop::Cop
+      # def uncomment_to_test_this_cop()
+      #   Timeout.timeout(5) do
+      #     _foo = 'Timeout.timeout sucks http://www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/'
+      #   end
+      #   timeout(5) do
+      #     _bar = 'This is a deprecated call'
+      #   end
+      # end
+
+      def on_send(node)
+        receiver, method_name = *node
+        if method_name == :timeout
+          if receiver.nil? || (receiver.const_type? && receiver.const_name == 'Timeout')
+            # TODO: add a real link, like AtomLinter/linter-shellcheck
+            msg = 'Timeout.timeout is not thread safe, see http://www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/'
+            add_offense(node, :expression, msg)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/barcoop/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Barcoop
+  VERSION = '0.1.0'
+end

data/lib/barcoop.rb

@@ -0,0 +1,3 @@
+require 'barcoop/version'
+
+module Barcoop; end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: barcoop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergio Medina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: barcoo's rubocop config and cops
+email:
+- sergio.medina@offerista.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- barcoop.gemspec
+- conf/rubocop.yml
+- lib/barcoop.rb
+- lib/barcoop/cops/avoid_fixtures.rb
+- lib/barcoop/cops/avoid_rails_env.rb
+- lib/barcoop/cops/avoid_timeout.rb
+- lib/barcoop/version.rb
+homepage: https://github.com/barcoo/barcoop
+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.6.11
+signing_key: 
+specification_version: 4
+summary: barcoo's rubocop config and cops
+test_files: []