va-ruby-style 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0edcc62d1c82874a8a8acb2daeacd18bcffec45
+  data.tar.gz: e080bb924137cbf2a793f4a4bda3218c3a9d3c6a
+SHA512:
+  metadata.gz: 3c386f3935df97e12d9fc98e6f6adacfb2effd913a10898c6c70a71191d6d6bd0a2b379caf1fc865f202eef6f976ebe4e55bbe7539b81a998f0a8b43f1543fd9
+  data.tar.gz: 999d16cd5bd6ee7a6f62ba8ffd8e1a031640295683202c56a7d4fb48a39f07e20c966ec9bd4d9a87b83e2eed67ecde3447dedf36ea3bc007c6203b8531976381

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+.byebug_history
+*.gem
+*.bak

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_from: default.yml
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/va-ruby-style.rb'

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    va-ruby-style (0.0.0)
+      rubocop (= 0.55.0)
+      thor (= 0.19.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (9.1.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    thor (0.19.4)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  byebug (~> 9.1)
+  va-ruby-style!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Pedro Matos Monteiro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# va-ruby-style
+
+This is a ruby gem that holds Visible Alpha's default set of coding style rules. It's basically a `rubocop` wrapper designed with the purpose of sharing a common set of rules across multiple ruby projects.
+
+## Installation
+
+Install the gem directly:
+```
+gem install va-ruby-style
+```
+
+Or add it to your `Gemfile`:
+```
+gem 'va-ruby-style'
+```
+
+## Setup
+
+The gem can be easily set up both in new or existing projects (even if already using `rubocop` directly), although the configuration process will be slightly different.
+
+### New projects
+
+This is the easiest form: simply add the gem to the project's `Gemfile` and run `va-ruby-style init`. This command will create the project's `.rubocop.yml` file.
+
+From this moment, we're able to use `rubocop` normally and check if all files follow the specified base style rules.
+
+### Existing projects
+
+For existing projects, the process will be slightly different since a `.rubocop.yml` file might already exist.
+
+The `init` command will not overwrite existing rubocop configuration files so, the existing `.rubocop.yml` should be removed before running the `va-ruby-style init` command. In addition to that, `rubocop` should be removed from the `Gemfile`, since it's no longer a direct project dependency.
+
+After that, the following `rubocop` commands should be run:
+
+1. `rubocop -a` to fix any offenses that can be automatically fixed in the existing files (according to the new set of rules);
+2. `rubocop --auto-gen-config` to add offenses that can't be automatically fixed to the `rubocop_todo.yml` file.
+
+**Note:** Rules should not be disabled/enabled directly in project files, where an offense occurs. The `rubocop_todo.yml` file should be used to centralize all existing and pending offenses instead.
+
+## Extending the default set of rules
+
+The generated `.rubocop.yml` file includes a default set of rules set in the gem's `default.yml` file. These rules can be changed and/or new rules can be added to a specific project though.
+
+In order to add a new rule (not included in the default set of rules), simply add it after the `inherit_gem` setup:
+
+```
+inherit_gem:
+  va-ruby-style:
+    - default.yml
+
+ProjectSpecificRule:
+  Enabled: true
+```
+
+To extend and/or modify an existing rule, reference it and add the necessary modifiers (Ex.: exclude particular files):
+
+```
+inherit_gem:
+  va-ruby-style:
+    - default.yml
+
+Style/MethodCallWithArgsParentheses:
+  Exclude:
+    - 'Gemfile'
+    - 'db/migrate/*'
+```

data/bin/va_ruby_style

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'va_ruby_style/cli'
+
+VARubyStyle::CLI.start

data/default.yml

@@ -0,0 +1,89 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Rails:
+  Enabled: true
+
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+
+Rails/InverseOf:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodName:
+  EnforcedStyle: snake_case
+
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: space
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/TrailingBlankLines:
+  EnforcedStyle: final_newline
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/ExtraSpacing:
+  AllowForAlignment: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  IgnoredMethods: [
+    'require',
+    'require_relative',
+    'run',
+    'raise',
+    'throw',
+    'yield',
+    'receive',
+    'to',
+    'not_to',
+    'to_not',
+  ]

data/lib/va-ruby-style.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'va_ruby_style'

data/lib/va_ruby_style.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module VARubyStyle
+end

data/lib/va_ruby_style/cli.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'va_ruby_style/generators/setup'
+
+module VARubyStyle
+  class CLI < Thor
+
+    desc 'init', 'Setup the project to start using visible alpha\'s ruby style'
+    def init
+      VARubyStyle::Generators::Setup.create_default_setup_file
+    end
+  end
+end

data/lib/va_ruby_style/generators/files/default_setup.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  va-ruby-style:
+    - default.yml

data/lib/va_ruby_style/generators/setup.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module VARubyStyle
+  module Generators
+    class Setup
+      def self.create_default_setup_file
+        working_dir = File.expand_path(Dir.pwd)
+        dest_file = "#{working_dir}/.rubocop.yml"
+
+        if File.file?(dest_file)
+          puts('.rubocop.yml already exists.')
+        else
+          src_file = File.dirname(__FILE__) + '/files/default_setup.yml'
+          FileUtils.copy_file(src_file, dest_file)
+        end
+      end
+    end
+  end
+end

data/release

@@ -0,0 +1,9 @@
+#!/bin/bash
+cp va-ruby-style.gemspec va-ruby-style.gemspec.backup
+sed -i.bak s/0.0.0/$1/g va-ruby-style.gemspec
+sed -i.bak s/2001-01-01/`date +%Y-%m-%d`/g va-ruby-style.gemspec
+gem build va-ruby-style.gemspec
+mv va-ruby-style.gemspec.backup va-ruby-style.gemspec
+gem push va-ruby-style-$1.gem
+git tag -a v$1 -m "Release v$1"
+git push origin --tags

data/va-ruby-style.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name          = 'va-ruby-style'
+  s.version       = '0.0.1'
+  s.date          = '2018-11-10'
+  s.summary       = 'Visible Alpha\'s ruby style'
+  s.description   = 'Visible Alpha\'s ruby style keeps a centralized set of linter rules for the ruby programming language.'
+  s.homepage      = 'https://github.com/AlphaExchange/va-ruby-style'
+  s.authors       = ['Pedro Monteiro']
+  s.email         = ['pedro.monteiro@visiblealpha.com']
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.executables   = `git ls-files`.split("\n").map{ |f| f =~ /^bin\/(.*)/ ? $1 : nil }.compact
+  s.require_paths = ['lib']
+  s.license       = 'MIT'
+
+  s.required_ruby_version = '>= 2.2.2'
+
+  s.add_dependency 'rubocop', '0.55.0'
+  s.add_dependency 'thor', '0.19.4'
+
+  s.add_development_dependency 'bundler', '~> 1.12'
+  s.add_development_dependency 'byebug', '~> 9.1'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: va-ruby-style
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pedro Monteiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+description: Visible Alpha's ruby style keeps a centralized set of linter rules for
+  the ruby programming language.
+email:
+- pedro.monteiro@visiblealpha.com
+executables:
+- va_ruby_style
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/va_ruby_style
+- default.yml
+- lib/va-ruby-style.rb
+- lib/va_ruby_style.rb
+- lib/va_ruby_style/cli.rb
+- lib/va_ruby_style/generators/files/default_setup.yml
+- lib/va_ruby_style/generators/setup.rb
+- release
+- va-ruby-style.gemspec
+homepage: https://github.com/AlphaExchange/va-ruby-style
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Visible Alpha's ruby style
+test_files: []