main_branch_shared_rubocop_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71dc0235b6f0f831d1903800bf05606af666aa86091891138922bfcbeef207bc
+  data.tar.gz: 515d3723380cdac8bd68949adb707111e49afd954304072e2967212d11f5b853
+SHA512:
+  metadata.gz: 3d6c1c9a764da4be29a07c5f3ccee1de38337113c68ef8fdd8dd425a3f834ce45c864adb99513a25293bc25994138beb1e88500681749bea72bcd1a68c609b50
+  data.tar.gz: 04ed4d52b4a89b23b32e3b346772172a1515c92f91ec5610c3450695966c82c604afe43f60c5addbb9ca3d46fcc3c16d0db16488c8dcb1f09885413fbd89d2e6

data/.markdownlint.yml

@@ -0,0 +1,25 @@
+default: true
+
+# Unordered list indentation
+MD007: { indent: 2 }
+
+# Line length
+MD013: { line_length: 90, tables: false, code_blocks: false }
+
+# Heading duplication is allowed for non-sibling headings
+MD024: { siblings_only: true }
+
+# Do not allow the specified trailing punctuation in a header
+MD026: { punctuation: '.,;:' }
+
+# Order list items must have a prefix that increases in numerical order
+MD029: { style: 'ordered' }
+
+# Lists do not need to be surrounded by blank lines
+MD032: false
+
+# Allow raw HTML in Markdown
+MD033: false
+
+# Allow emphasis to be used instead of a heading
+MD036: false

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## v0.1.0 (2024-09-17)
+
+[Full Changelog](https://github.com/main-branch/main_branch_shared_rubocop_config/compare/f01fd76..v0.1.0)
+
+Changes:
+
+* 450a0f6 Create a standard structure for keeping the gem version
+* dc7d7ea Add create_github_release as a development dependency
+* 3a2a26b Allow the config/ directory to be include in the gem.
+* 352792c Update installation and usage directions
+* f01fd76 Initial revision

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 James Couball
+
+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,72 @@
+# main-branch shared Rubocop configuration
+
+This gem contains a shared Rubocop configuration to use for all projects in the
+main-branch organization.
+
+## Installation
+
+1. Add the main_branch_shared_rubocop_config gem as a development dependency to your
+   project by doing either:
+
+     Add the following line to your gem's gemspec:
+
+     ```ruby
+     spec.add_development_dependency 'main_branch_shared_rubocop_config'
+     ```
+
+     OR add the following line to your Gemfile:
+
+     ```ruby
+     gem "main_branch_shared_rubocop_config", :group => :development
+     ```
+
+2. Install the gem as a dependency by running:
+
+     ```shell
+     bundle install
+     ```
+
+## Usage
+
+To use the Rubocop configuration contained in this gem, add the following to your
+project's Rubocop configuration file (usually .rubocop.yml):
+
+```yaml
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
+```
+
+Configurations inherited in with `inerit_gem` will have the lowest precedence of
+inheritance. Other directives in the above configuration file will supersede any of
+the inherited configurations.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake
+spec` to run the tests. 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 the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/main-branch/main_branch_shared_rubocop_config. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [code of
+conduct](https://github.com/main-branch/main_branch_shared_rubocop_config/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MainBranchSharedRubocopConfig project's codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/main-branch/main_branch_shared_rubocop_config/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/config/rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  DefaultFormatter: fuubar
+
+  # Output extra information for each offense to make it easier to diagnose:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+
+  # RuboCop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  TargetRubyVersion: 3.1
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Layout/LineLength:
+  Max: 120
+
+# The DSL for RSpec and the gemspec file make it very hard to limit block length:
+Metrics/BlockLength:
+  Exclude:
+    - "spec/spec_helper.rb"
+    - "spec/**/*_spec.rb"
+    - "*.gemspec"
+
+Metrics/ModuleLength:
+  CountAsOne: ['hash']
+
+# When writing minitest tests, it is very hard to limit test class length:
+Metrics/ClassLength:
+  CountAsOne: ['hash']
+  Exclude:
+    - "test/**/*_test.rb"
+
+Style/AsciiComments:
+  Enabled: false

data/lib/main_branch_shared_rubocop_config/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Toplevel namespace for this gem
+module MainBranchSharedRubocopConfig
+  # Version of this gem
+  VERSION = "0.1.0"
+end

data/lib/main_branch_shared_rubocop_config.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: main_branch_shared_rubocop_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Couball
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: create_github_release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Shared Rubocop configuration for the main-branch organization
+email:
+- jcouball@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".markdownlint.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/rubocop.yml
+- lib/main_branch_shared_rubocop_config.rb
+- lib/main_branch_shared_rubocop_config/version.rb
+homepage: https://github.com/main-branch/main_branch_shared_rubocop_config
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/main-branch/main_branch_shared_rubocop_config
+  source_code_uri: https://github.com/main-branch/main_branch_shared_rubocop_config
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Shared Rubocop configuration for the main-branch organization
+test_files: []