zfletch-style 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66c51cab6d138390f4f3769f91274476c4b0feeb17133b03e25e4e9b819fe165
+  data.tar.gz: a125f58d98256ac2a79bb3391c9f0c5da85cdb2665289e0413421ccd1114b7e9
+SHA512:
+  metadata.gz: 1c4c5ef8012dbc21c852139b47955e54f60808557fc04f41e601a0af37370a05b3e44668e1e1464e5b3c130920bbe993eaada6c8ce7e014f52ce5a37321584b6
+  data.tar.gz: 87c4b0879865d2690fc4332bfa260ca200c444e802ffc146edf2c34b6a62286ab39e797285a5106c6380abe05e7b842fd9c7dd2639d9646bd86b431ccfcc4537

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rubocop-rake', require: false

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    zfletch-style (0.1.0)
+      rubocop (~> 1.50)
+      rubocop-performance (~> 1.17)
+      rubocop-rails (~> 2.19)
+      rubocop-rake (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rack (3.0.7)
+    rainbow (3.1.1)
+    rake (13.0.1)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.50.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.19.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rubocop-rake
+  zfletch-style!
+
+BUNDLED WITH
+   2.4.12

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 The Gnar Company
+
+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 @@
+# zfletch-style
+
+Shared style configurations.
+Forked from the (now deprecated) [gnar-style](https://github.com/TheGnarCo/gnar-style).
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+group :development, :test do
+  gem 'zfletch-style'
+end
+```
+
+And then execute:
+
+`bundle`
+
+Or install it yourself as:
+
+`gem install zfletch-style`
+
+(See project at [rubygems.org](https://rubygems.org/gems/zfletch-style))
+
+## Usage
+
+This Gem includes Rubocop, and it's not necessary to separately include Rubocop directly in your
+application's dependencies.
+
+### Inheriting from the Gem
+
+Create a `.rubocop.yml` with the following configuration:
+
+```yaml
+inherit_gem:
+  zfletch-style:
+    # Choose from one of these three
+    - rubocop/rubocop.yml # if the pure Ruby style is all that's needed
+    - rubocop/rubocop_gem.yml # if the application is a Gem
+    - rubocop/rubocop_rails.yml # if the application is a Rails project
+```
+
+To check your application against these style configurations:
+
+```bash
+$ bundle exec rubocop
+```
+
+## Overriding Styles
+
+Example:
+
+```yaml
+# In your app's .rubocop.yml
+inherit_gem:
+  zfletch-style:
+    - "rubocop/rubocop.yml"
+
+Metrics/BlockLength:
+  Exclude:
+    - specific_file.rb
+```
+
+Note that if you add in a local style exception in your own application after inheriting from
+zfletch-style, that will completely override zfletch-style's defaults.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: [:rubocop]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'zfletch_style'
+
+require 'irb'
+IRB.start(__FILE__)

data/lib/zfletch_style/version.rb

@@ -0,0 +1,3 @@
+module ZfletchStyle
+  VERSION = '1.0.0'.freeze
+end

data/lib/zfletch_style.rb

@@ -0,0 +1,4 @@
+require_relative 'zfletch_style/version'
+
+module ZfletchStyle
+end

data/rubocop/rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+require: rubocop-performance
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/LineLength:
+  Max: 100
+  Severity: refactor
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Style/ConditionalAssignment:
+  EnforcedStyle: assign_inside_condition
+  IncludeTernaryExpressions: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/rubocop/rubocop_gem.yml

@@ -0,0 +1,16 @@
+inherit_from: rubocop.yml
+
+require: rubocop-rake
+
+Layout/ExtraSpacing:
+  Exclude:
+    - '*.gemspec'
+
+Layout/SpaceAroundOperators:
+  Exclude:
+    - '*.gemspec'
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'

data/rubocop/rubocop_rails.yml

@@ -0,0 +1,17 @@
+inherit_from: rubocop.yml
+
+require: rubocop-rails
+
+AllCops:
+  Exclude:
+    - db/schema.rb
+    - 'bin/**/*'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'db/migrate/**/*'
+
+Rails/NotNullColumn:
+  Enabled: false

data/zfletch-style.gemspec

@@ -0,0 +1,40 @@
+require_relative 'lib/zfletch_style/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'zfletch-style'
+  spec.version = ZfletchStyle::VERSION
+  spec.licenses = ['MIT']
+  spec.authors = ['zfletch']
+  spec.email = ['zf.rubygems@gmail.com']
+
+  spec.summary = 'Custom style guide configurations'
+  spec.description = 'Style guide configurations for Ruby projects, Rails applications, and Gems'
+  spec.homepage = 'https://github.com/zfletch/zfletch-style'
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/releases"
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = [
+    'Gemfile',
+    'Gemfile.lock',
+    'LICENSE',
+    'README.md',
+    'Rakefile',
+    'bin/console',
+    'rubocop/rubocop.yml',
+    'rubocop/rubocop_gem.yml',
+    'rubocop/rubocop_rails.yml',
+    'lib/zfletch_style.rb',
+    'lib/zfletch_style/version.rb',
+    'zfletch-style.gemspec',
+  ]
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubocop', '~> 1.50'
+  spec.add_dependency 'rubocop-performance', '~> 1.17'
+  spec.add_dependency 'rubocop-rails', '~> 2.19'
+  spec.add_dependency 'rubocop-rake', '~> 0.6'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: zfletch-style
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- zfletch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Style guide configurations for Ruby projects, Rails applications, and
+  Gems
+email:
+- zf.rubygems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- lib/zfletch_style.rb
+- lib/zfletch_style/version.rb
+- rubocop/rubocop.yml
+- rubocop/rubocop_gem.yml
+- rubocop/rubocop_rails.yml
+- zfletch-style.gemspec
+homepage: https://github.com/zfletch/zfletch-style
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zfletch/zfletch-style
+  source_code_uri: https://github.com/zfletch/zfletch-style
+  changelog_uri: https://github.com/zfletch/zfletch-style/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Custom style guide configurations
+test_files: []