matkoniecz-ruby-style 0.1.0 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a7213fd984305324ba7fd5eb6c61ceefbb8ecd06
-  data.tar.gz: 3f37fe3708552dcadda7719f56844958eec03734
+SHA256:
+  metadata.gz: 995eb438938e22dc49ec02f4db5628d087508a8eb3096b3d8f36f1d09624bdd1
+  data.tar.gz: c0e954c94476340b40e1bd66c0f9f98085059c9b05ba30f4b4d57cbce6673e18
 SHA512:
-  metadata.gz: d8171f0190b6edf2cd7024fce10c60afb16c4817b6f22116064cec49e3efccd693b4c50a55ee3e06100abf712ba343106c40ac92b6674b2fd02f7b058a6f40b0
-  data.tar.gz: 25582befabe374ecec220cb76bec15d1260aa1d6a8243579956bb6240e324812484c3829468d318e8da7669bb34ce16c57fba9275bbaa778ebfe0dba6d5494a4
+  metadata.gz: e2dd0b30f1423ae87a3be16ba36d08efc5b84c277802f2e3761fb627a25d9eccbd83142880e58cb69eb67efca05cf685d1c4576f3e1e900996f47d53b6939552
+  data.tar.gz: ab0507b5b2e102050a0b110204ddf3201e6a0697c2a4de4e0b18af0a384f2d66f2ab7ce0f954bcbbb0466f0195b1a65252e164e13262d9ef020a7576c7b59abe

data/.rubocop.yml

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

data/Gemfile

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

data/README.md

@@ -1,8 +1,6 @@
-# Matkoniecz::Ruby::Style
+# matkoniecz-ruby-style
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/matkoniecz/ruby/style`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Shared ruby style config for rubocop.
 
 Inspired by [percy-style](https://github.com/percy/percy-style).
 
@@ -16,6 +14,12 @@ or add this line to your application's Gemfile:
 gem 'matkoniecz-ruby-style'
 ```
 
+or, for a Ruby library, add this to your gemspec:
+
+```ruby
+spec.add_development_dependency 'matkoniecz-ruby-style'
+```
+
 ## Usage
 
 Create a `.rubocop.yml` with the following directives:
@@ -26,14 +30,11 @@ inherit_gem:
     - standard_rubocop_config.yml
 ```
 
+You do not need to include rubocop directly in your application's dependencies. This gem includes a specific version of `rubocop` and `rubocop-rspec` that is shared across all projects.
+
 ## How to release new gem version
 
-```
-rm *.gem
-gem build *.gemspec
-gem install --user-install *.gem
-gem push *.gem
-```
+See `reinstall.sh` and `reinstall_and_push_new_version.sh` files.
 
 ## Contributing
 

data/matkoniecz-ruby-style.gemspec

@@ -1,11 +1,6 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "matkoniecz/ruby/style/version"
-
 Gem::Specification.new do |spec|
   spec.name          = "matkoniecz-ruby-style"
-  spec.version       = Matkoniecz::Ruby::Style::VERSION
+  spec.version       = 1.5
   spec.authors       = ["Mateusz Konieczny"]
   spec.email         = ["matkoniecz@gmail.com"]
 
@@ -15,10 +10,12 @@ Gem::Specification.new do |spec|
 
   # 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('..', __FILE__)) do
+  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 = ["lib"]
+  spec.add_dependency "rubocop", "~> 0.89.1"
+  spec.add_dependency "rubocop-rspec", "~> 1.29.1"
 end

data/reinstall.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+IFS=$'\n\t'
+err_report() {
+    echo "Error on line $1"
+}
+trap 'err_report $LINENO' ERR
+
+rm ./*.gem | true
+gem build ./*.gemspec
+gem install --user-install ./*.gem

data/reinstall_and_push_new_version.sh

@@ -0,0 +1,4 @@
+rm ./*.gem
+gem build ./*.gemspec
+gem install --user-install ./*.gem
+gem push *.gem 

data/standard_rubocop_config.yml

@@ -1,5 +1,19 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+# this hurts readability and makes code more confusing
+# Rubocop is has opinion, Python has opinion, I also have opinion
+# I would gladly enable MethodCallRequireArgsParentheses
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
 # not preferred as this rule makes harder to move/add/remove items
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
   Enabled: false
 
 # change without benefit ( foobar == nil into foobar.nil?)
@@ -37,8 +51,74 @@ Lint/UnusedBlockArgument:
 Style/SpecialGlobalVars:
   Enabled: false
 
-#AllCops:
-#  TargetRubyVersion: 2.3
+# there is no benefit from ugly code of collapsed form
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# unconvinced that it is useful
+Style/RaiseArgs:
+  Enabled: false
+
+# adds useless line without benefit outweighting readability loss
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Ruby-specific syntax has no benefits whatsover over slashes
+# if there is one let me know
+Style/RegexpLiteral:
+  EnforcedStyle: slashes
+
+# Standard array is much better and less overcomplicated
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Neither is much better, consistency is much more important
+# for example see:
+# group = ["#{fish[0]}", "#{fish[0]} filet", "filet z #{fish[1]}"]
+# vs
+# group = [(fish[0]).to_s, "#{fish[0]} filet", "filet z #{fish[1]}"]
+Style/RedundantInterpolation:
+  Enabled: false
+
+# local style optimization is better than global consistency
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# this rubyism is not more readable
+Style/NumericPredicate:
+  Enabled: false
+
+# this blank lines are neither helpful nor useful
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+# not convinced that removing get_ is useful use of my time
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - bb # standard shortening of "bounding box"
+    - r # standard shortening of "radius"
+    - mb # standard for megabytes
+    - x # typically perfectly fine for position to a plane
+    - "y" # typically perfectly fine for position to a plane
+
+# avoding jumboXXLplus lines is a good idea, but
+# there is no reason to stick to 80 characters
+# a bit longer lines seems fine to me
+Layout/LineLength:
+  Max: 88
+
+# disabled due to bug reported as https://github.com/rubocop-hq/rubocop/issues/6630
+# note that bug is likely to be closed but wontfixed
+Style/CommentAnnotation:
+  Enabled: false
+
+# benefits from adding ? to the method names are outweighted
+# by increased costs of context switch between languages
+Naming/PredicateName:
+  Enabled: false
 
 # Uncomment following rules to allow using tabs:
 #Layout/Tab:

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: matkoniecz-ruby-style
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: '1.5'
 platform: ruby
 authors:
 - Mateusz Konieczny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
-dependencies: []
+date: 2020-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.29.1
 description: 
 email:
 - matkoniecz@gmail.com
@@ -18,11 +46,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - matkoniecz-ruby-style.gemspec
+- reinstall.sh
+- reinstall_and_push_new_version.sh
 - standard_rubocop_config.yml
 homepage: https://github.com/matkoniecz/matkoniecz-ruby-style
 licenses:
@@ -43,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: shared style config for Ruby