accessiblerb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c75a133e2c5a7b35fbe21471678ecf34e6216e6bae5561e4b9e22c06819f6085
+  data.tar.gz: 4247620387bb76a06c2da46611260393c1b1102201c97ff10793e101ca742754
+SHA512:
+  metadata.gz: 29189bf0c989a4aa4badfe83750c65c261660663ea478edc2837d7b3d15f3433bd23d608cb23971fb28a11bbb49f58d87d3ce805675c6ba0ccf8ea828b113214
+  data.tar.gz: e4f90aa788ba7ca325afd2badfd8f61a8bbcf8f364362fa1dad4957f60fe1301f200441ccfc1c6dc17ce1e6c64800be8945c73227b8bc56481b34501969f0a93

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### Releases
+
+#### [0.1.0] - 2023-11-26
+
+The initial release containing a base set of rules to be expanded upon later.
+The rules contained within are related to:
+
+- Quoting strings
+- Documenting methods
+- Indentation modes
+- Alignment of lines

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Stephan Tarulli
+
+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,37 @@
+### 🎁 accessiblerb
+
+A set of Rubocop rules focused on accessiblity and legibility without concern
+for existing community standards.
+
+#### Why?
+
+All of the existing tools, like standardrb or the Ruby style guide, do not
+consider the consequences of their defaults on the wide variety of people
+using Ruby day to day.
+
+#### What can I expect?
+
+This set of rules focuses on reduced nesting of code and accessibility for
+the reader. It breaks with the community entirely in several areas like indent
+styles.
+
+Rules will evoke immediate disagreement from some, but they are all considered
+using real code and the following guidelines:
+
+- it improves the experience of Rubyists with any form of visual impairment
+- it eases programming for Rubyists with hand impairments
+- it improves working memory burden by eliminating nested scopes
+- it improves legibility by reducing rightward drift in statements and expressions
+- it improves ease of understanding Ruby code
+
+#### Quickstart
+
+To use this gem, install it:
+
+	gem install accessiblerb
+
+Then configure Rubocop:
+
+	# inside of your .rubocop.yml
+	inherit_gem:
+	  accessiblerb: rules.yml

data/accessibility.yml

@@ -0,0 +1,62 @@
+#=============================================================================#
+# Accessibility Rules
+#
+# The rules in this file aim to make Ruby code accessible to individuals with
+# visual impairments and generally improve ease of reading for everyone.
+#=============================================================================#
+
+# This is the big one; the one most people will absolutely disagree with, but
+# it is critical.
+#
+# The 2 space indentation rule the Ruby community uses creates a large amount
+# of friction for anyone with visual impairments. It's not ok to force people
+# to jump through indentation conversion hoops to participate in a community.
+#
+# Tabs provide the accessibility seam necessary for everyone to read code.
+Layout/IndentationStyle:
+  EnforcedStyle: tabs
+
+# A consequence of using tabs is that only 1 character is ever used for any
+# indentation level.
+#
+# The entire concept of an indentation width disappears from static analysis
+# tools and only has meaning within the person's display configuration.
+Layout/IndentationWidth:
+  Width: 1
+
+# Many languages with terminator characters use leading dot syntax as a way to
+# continue a method chain across lines. Ruby does not require any terminator
+# character.
+#
+# When reading top-down it is useful to have the dot as a trailing character
+# indicating the line continues. This is the opposite of languages like English
+# where the absence of a full stop indicates continuation.
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+# Indenting to receiver and alignment cause a large amount of righward drift
+# in codebases while requiring extra typing work to maintain these alignments
+# as code changes over time.
+#
+# Simple indentation for method calls eliminates most of the rightward drift
+# while providing lower strain maintenance. It reduces the distance your eyes
+# scan to read the method call and the next lines.
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# This is one of the only pieces of configuration that purposely adds rightward
+# drift to the codebase, but does so for good reason: visual distinction of
+# access control sections within classes.
+#
+# This small amount of rightward drift makes these areas distinct and provides
+# incentive to eliminate them by making smaller classes.
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+# Separating chained method calls allows you to visualize complexity as a
+# function of the number of lines and ease understanding of the individual
+# parts of the transformation while eliminating rightward drift.
+#
+# The extra lines are additional incentive to encapsulate these details.
+Layout/SingleLineBlockChain:
+  Enabled: true

data/base.yml

@@ -0,0 +1,22 @@
+#=============================================================================#
+# Base Rules
+#
+# The rules in this file establish a common base for Ruby files to avoid areas
+# of inconsistency across platforms. There aren't many of these, but keeping
+# them separate allows for the other files to focus exclusively on legibility
+# and accessibility.
+#=============================================================================#
+
+# Use universal line feed characters as the line break character to avoid
+# inconsistencies across platforms.
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+# Double quoted string literals match the majority of other languages and don't
+# break the flow of work when interpolation is necessary. Other literals can be
+# used for the few cases it improves legibility.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/legibility.yml

@@ -0,0 +1,16 @@
+#=============================================================================#
+# Legibility Rules
+#
+# The rules in this file aim to make Ruby easy to understand for all future
+# readers of any file.
+#=============================================================================#
+
+# Documentation is important for giving future readers a quick understanding of
+# what your classes and methods do. It is your opportunity to clearly define
+# how to use the public API of a class.
+#
+# There is a large amount of wasted development time across companies because
+# of poor public API documentation.
+Style/DocumentationMethod:
+  Enabled: true
+  RequireForNonPublicMethods: false

data/rules.yml

@@ -0,0 +1,11 @@
+#=============================================================================#
+# Accessible Ruby Rules
+#
+# This file combines all the others. Look in each to see the rules and reasons
+# for their configuration.
+#=============================================================================#
+
+inherit_from:
+  - base.yml
+  - accessibility.yml
+  - legibility.yml

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: accessiblerb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephan Tarulli
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-27 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- srt@tinychameleon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- accessibility.yml
+- base.yml
+- legibility.yml
+- rules.yml
+homepage: https://github.com/tinychameleon/accessiblerb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tinychameleon/accessiblerb
+  source_code_uri: https://github.com/tinychameleon/accessiblerb
+  changelog_uri: https://github.com/tinychameleon/accessiblerb/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Write accessible Ruby with this set of Rubocop rules.
+test_files: []