makandra-rubocop 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc54683fa1e2c0eceae8b06d37d1f4b428f9bf15ca0d2966ead0230cf5a93aeb
+  data.tar.gz: e908e68baa27055a333b79dd3387303c8e0af6b1d0202f18fdb70ce0df7d3100
+SHA512:
+  metadata.gz: d14cc9368ab5ad2480625be0da6786f8a18a594145fdbc908454e71eaafb61cca6700be8c9729b840564c14f10aa5da9359521a6cfc21654710858c57d242e4b
+  data.tar.gz: da13915354010462599284ef98cd92f994ffd2b8aa0d11b0589719fa89679627b2382bf9a11f9a9b30ecdadc93ae7faa4d55e2c871b9059c4c87bf57c15a382d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

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

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+
+## Unreleased
+
+### Breaking changes
+
+-
+
+### Compatible changes
+
+-
+
+
+## 1.0.0 - 2019-01-15
+
+### Compatible changes
+
+- First release of our default rule set. See README on how to integrate with your project.
+- Rubocop 0.62.0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    makandra-rubocop (1.0.0)
+      rubocop (~> 0.62.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.2)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rubocop (0.62.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  makandra-rubocop!
+  rake (~> 12.3)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 makandra
+
+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,95 @@
+This gem holds makandra's default Rubocop configuration.
+It is currently very relaxed, and will evolve over time.
+
+Note that we lock each version on a specific Rubocop version, as Rubocop's syntax changes regularly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'makandra-rubocop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install makandra-rubocop
+
+## Usage
+
+Add `.rubocop.yml` to your project with the following contents:
+
+```yaml
+inherit_gem:
+  makandra-rubocop: config/default.yml
+```
+
+Any per-project rules can then be defined in `.rubocop.yml`.
+
+### Executing Rubocop on demand
+
+Run Rubocop via `bundle exec rubocop` from your project directory.
+
+For an initial run it might also useful to use the auto-correct option (`bundle exec  rubocop --auto-correct`) and carefully check in all changes.
+
+### Integrating Rubocop into your test suite
+
+We recommend you add an RSpec test that runs rubocop automatically and confirms that there are no offenses.
+This gem provides one. Simply add `spec/rubocop_spec.rb` to your project with the following code.
+
+```
+require 'makandra_rubocop/support/rubocop_spec'
+```
+
+### Configuring exceptions
+
+Some of our defaults might not fit your project. You can disable specific cops or add exclusions to `.rubocop.yml` in such cases. You basically have two options:
+
+- Disable cops for specific lines using [Ruby comments in your code](https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md#disabling-cops-within-source-code), like so:
+
+      for x in (0..19) # rubocop:disable Style/For
+
+- Disable entire files by [adding exclusions](https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md#cop-specific-include-and-exclude) to `.rubocop.yml`, like so:
+
+      Style/For:
+        Exclude:
+          - app/models/example.rb
+
+See [Rubocop's configuration manual](https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md) for more information.
+
+Note that disabling cops should be an exception for extremely rare cases where your code can not be aligned with Rubocop's requirements.
+If our defaults don't match your opinion, you should discuss with the team.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Upgrading Rubocop version being used
+
+1. Change `rubocop` dependency in gemspec to the release you want to upgrade to.
+2. `bundle`
+3. `git add remote rubocop https://github.com/rubocop-hq/rubocop.git`
+4. `git fetch rubocop --no-tags` (we can't import their tags or they would clash with ours)
+5. Find out the commit SHA of the release you put into the gemspec.
+6. `git checkout COMMIT_SHA config/default.yml`
+7. `git reset` to unstage the changes you just picked
+8. Review all changes and stage those that you want. Note that cop settings will be reverted to their default settings and that you do not want to add them all.
+9. Commit.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/makandra/makandra-rubocop.
+
+If you make any changes to this gem's Ruby code, make sure to run `rubocop`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'makandra_rubocop'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here