boxt_ruby_style_guide 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3cf99c87343e8450a4aa86d90493ca202b1d3cfcbdea1fcb805e0023efd63c32
+  data.tar.gz: 9ae4a2d50c330e0286f5b168a03cd1ef89facdd0a4cddc34ba35f4309e659c02
+SHA512:
+  metadata.gz: 87834c401242cbda4dead8687defcf286e2dbe000da0727ebff7f01c47d2f0798d3785265f18d42c612013ca830270a26692fc4bd0bd925d16742acef7c6e56d
+  data.tar.gz: fc056da1890c4381a1dc9519288cec772401955ec9794f695389549624713be59202bcd235f68cd74642a0b95fb7308a7121307f574acfdc359cf04262a34586

data/.circleci/config.yml

@@ -0,0 +1,29 @@
+version: 2
+jobs:
+  build:
+    parallelism: 3
+    docker:
+      - image: circleci/ruby:2.5.3
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - restore_cache:
+          keys: boxt-ruby-style-guide-{{ checksum "Gemfile.lock" }}
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+      - save_cache:
+          key: boxt-ruby-style-guide-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: Run tests
+          command: bundle exec rake test | circleci tests split --split-by=timings)
+      - store_test_results:
+          path: test_results

data/.gitignore

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

data/.rubocop.yml

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

data/.ruby-gemset

@@ -0,0 +1 @@
+boxt-ruby-style-guide

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+sudo: false
+matrix:
+  fast_finish: true
+branches:
+  only:
+  - develop
+  - master
+  - /\Arelease.*\z/
+  - /\Ahotfix.*\z/
+before_script:
+- gem install bundler
+- git config --local user.email "developers@boxt.co.uk"
+- git config --local user.name  "Boxt Developers Group"
+script:
+- bundle exec rake test
+cache: bundler
+notifications:
+  email:
+  - developers@boxt.co.uk
+  slack: boxt:hwim3Ix4PeXQtkTXRZ5kd8Kr

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+ruby "~> 2.5.3"
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in boxt-ruby-style-guide.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    boxt_ruby_style_guide (2.0.0)
+      reek (~> 5.3, >= 5.3.0)
+      rubocop (~> 0.63.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.3)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.3.1)
+    equalizer (0.0.11)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
+    kwalify (0.7.2)
+    minitest (5.11.3)
+    minitest-fail-fast (0.1.0)
+      minitest (~> 5)
+    minitest-macos-notification (0.0.5)
+      minitest (~> 5.0)
+      minitest-reporters (~> 1.3)
+      os (~> 1.0)
+      terminal-notifier (~> 2.0)
+    minitest-reporters (1.3.6)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    os (1.0.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    reek (5.3.1)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    rubocop (0.63.1)
+      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)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    terminal-notifier (2.0.0)
+    thread_safe (0.3.6)
+    unicode-display_width (1.4.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  boxt_ruby_style_guide!
+  bundler (~> 1.17, >= 1.17.3)
+  minitest (~> 5.11, >= 5.11.3)
+  minitest-fail-fast (~> 0.1.0)
+  minitest-macos-notification (~> 0.0.5)
+  minitest-reporters (~> 1.3, >= 1.3.6)
+  rake (~> 12.3, >= 12.3.2)
+  simplecov (~> 0.16.1)
+
+RUBY VERSION
+   ruby 2.5.3p105
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Stuart Chinery
+
+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,106 @@
+# BOXT Ruby Style Guide
+
+Ruby style guide info for the BOXT projects, as well as config settings for Rubocop.
+
+For the most part we are using [this Ruby style guide](https://github.com/bbatsov/ruby-style-guide) as our base guide, with any deviations can be found in the `default.yml` for this project.
+
+## Installation
+
+We are now using Gemfury to host all our private packages. Please ensure you have added your private repo URL from Gemfury to the application's Gemfile, example:
+
+```ruby
+source 'https://qVz5xDENYkkuVWQ37cb5@gem.fury.io/boxt/'
+```
+
+Then add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  # ...
+  gem "boxt_ruby_style_guide"
+end
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+To make the lint rake tasks available to non Rails apps and gems, add the following to the project's `Rakefile`:
+
+```ruby
+require "boxt_ruby_style_guide"
+BoxtRubyStyleGuide.install_tasks
+```
+
+Rails apps should have access to the lint tasks by default.
+
+## Usage
+
+### Reek Config
+
+The Reek config is loaded automatically by this gem so there shouldn't be anything that you need to do. However am not sure if this will effect using in-editor linters.
+
+### Rubocop Config
+
+Add a `.rubocop.yml` file to the root of your project with the following settings:
+
+```yml
+inherit_gem:
+  boxt-ruby-style-guide:
+    - default.yml
+```
+
+### Lint Rake Tasks
+
+There are a couple of rake tasks added to the project that allow you to run `reek` and `rubocop` against files listed as changed by Git.
+
+To run `reek` against any changed files use:
+
+```sh
+rake lint:reek
+```
+
+To run `rubocop` against any changed files use:
+
+```sh
+rake lint:rubocop
+```
+
+If there are no changed files the commands will run against all files.
+
+There are also some useful editor plugins to help with in-editor linting.
+
+Atom:
+
+* [linter-reek](https://atom.io/packages/linter-reek)
+* [linter-rubocop](https://atom.io/packages/linter-rubocop)
+* [rubocop-auto-correct](https://atom.io/packages/rubocop-auto-correct)
+
+RubyMine:
+
+* reek - Doesn't appear to be editor integration
+* [rubocop](https://www.jetbrains.com/help/ruby/rubocop.html)
+
+## Versioning
+
+The version of the engine should be set in the `VERSION` file found in the root of the project. This is then read by the `lib/boxt/ruby/style/guide/core/version.rb` file to set in the engine.
+
+If you are using [Git Flow AVH](https://github.com/petervanderdoes/gitflow-avh) and the default [Git Flow Hooks](https://github.com/jaspernbrouwer/git-flow-hooks) then the `VERSION` file will be updated automatically when creating a 'release' or 'hotfix' tag.
+
+## Publishing to Gemfury
+
+After setting the new version as explained above you will now need to push the new version to Gemfury. To do this carry out the following steps:
+
+Add the Gemfury remote (you only need to do this once):
+
+```sh
+git remote add fury https://YOUR_USRNAME_HERE@git.fury.io/boxt/boxt_ruby_style_guide.git
+```
+
+And then push the new code to Gemfury:
+
+```sh
+git push fury master
+```

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+import "./tasks/lint.rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "boxt/ruby/style/guide"
+
+# 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

data/boxt_ruby_style_guide.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/ExpandPathArguments
+# NOTE: This is because of Gemfury failing with __dir__
+lib = File.expand_path("../lib", __FILE__)
+# rubocop:enable Style/ExpandPathArguments
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "boxt_ruby_style_guide/version"
+Gem::Specification.new do |spec|
+  spec.authors       = ["Stuart Chinery"]
+  spec.description   = "Ruby styleguide info for the BOXT projects, as well as"\
+                       "config settings for Rubocop"
+  spec.email         = ["stuart.chinery@gmail.com"]
+  spec.homepage      = "https://github.com/boxt/ruby-style-guide"
+  spec.license       = "MIT"
+  spec.name          = "boxt_ruby_style_guide"
+  spec.summary       = "Ruby styleguide info for the BOXT Ruby projects"
+  spec.version       = BoxtRubyStyleGuide::VERSION
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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 = ["lib"]
+
+  spec.add_dependency "reek", "~> 5.3", ">= 5.3.0"
+  spec.add_dependency "rubocop", "~> 0.63.1"
+
+  spec.add_development_dependency "bundler", "~> 1.17", ">= 1.17.3"
+  spec.add_development_dependency "minitest", "~> 5.11", ">= 5.11.3"
+  spec.add_development_dependency "minitest-fail-fast", "~> 0.1.0"
+  spec.add_development_dependency "minitest-macos-notification", "~> 0.0.5"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3", ">= 1.3.6"
+  spec.add_development_dependency "rake", "~> 12.3", ">= 12.3.2"
+  spec.add_development_dependency "simplecov", "~> 0.16.1"
+end
+# rubocop:enable Metrics/BlockLength

data/config.reek

@@ -0,0 +1,6 @@
+---
+
+IrresponsibleModule:
+  enabled: false
+exclude_paths:
+  - db

data/default.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 2.5.3
+  Exclude:
+    - "db/*"
+    - "db/**/*"
+    - "db/fixtures/**/*"
+    - "node_modules/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+
+# To make Lorenzo happy
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+# Increase line length to 120
+Metrics/LineLength:
+  Max: 120
+
+# Exclude class and method length for test
+Metrics/BlockLength:
+  Exclude:
+    - "test/**/*"
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*"
+Metrics/MethodLength:
+  Exclude:
+    - "test/**/*"
+
+# Disable Style/Documentation because...
+Style/Documentation:
+  Enabled: false
+
+# Use double quotes ALL THE TIME!!!
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/lib/boxt_ruby_style_guide.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "boxt_ruby_style_guide/railtie" if defined?(Rails)
+require "boxt_ruby_style_guide/version"
+
+module BoxtRubyStyleGuide
+  class << self
+    def install_tasks
+      Dir[File.join(gem_spec.gem_dir, "tasks/*.rake")].each do |file|
+        load(file)
+      end
+    end
+
+    def reek_config
+      File.join(gem_spec.gem_dir, "config.reek")
+    end
+
+    private
+
+    def gem_spec
+      Gem::Specification.find_by_name("boxt_ruby_style_guide")
+    end
+  end
+end

data/lib/boxt_ruby_style_guide/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module BoxtRubyStyleGuide
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      files = File.join(File.dirname(__FILE__), "../../tasks/*.rake")
+      Dir[files].each { |file| load(file) }
+    end
+  end
+end

data/lib/boxt_ruby_style_guide/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BoxtRubyStyleGuide
+  VERSION = File.read("VERSION").split("\n").first
+end

data/tasks/lint.rake

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "boxt_ruby_style_guide"
+require "reek"
+require "rubocop"
+
+namespace :lint do
+  desc "Runs reek against all .rb files git lists as changed. Will run
+  against all files if none changed"
+  task :reek do
+    run_cmd("reek -c #{BoxtRubyStyleGuide.reek_config}")
+  end
+
+  desc "Runs rubocop against all .rb files git lists as changed. Will run
+  against all files if none changed"
+  task :rubocop do
+    run_cmd("rubocop")
+  end
+end
+
+def run_cmd(cmd)
+  xargs = "xargs #{cmd}"
+  exec("git ls-files -m | xargs ls -1 2>/dev/null | grep '\.rb$' | #{xargs}")
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: boxt_ruby_style_guide
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Stuart Chinery
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: minitest-fail-fast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest-macos-notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: Ruby styleguide info for the BOXT projects, as well asconfig settings
+  for Rubocop
+email:
+- stuart.chinery@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- boxt_ruby_style_guide.gemspec
+- config.reek
+- default.yml
+- lib/boxt_ruby_style_guide.rb
+- lib/boxt_ruby_style_guide/railtie.rb
+- lib/boxt_ruby_style_guide/version.rb
+- tasks/lint.rake
+homepage: https://github.com/boxt/ruby-style-guide
+licenses:
+- MIT
+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.6
+signing_key: 
+specification_version: 4
+summary: Ruby styleguide info for the BOXT Ruby projects
+test_files: []