ruboclean 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fd9b5156a1868e0cac70e314d59f7d17a878a564b597ccc19e4fdbc40d56ce5
+  data.tar.gz: 96da31ede8824d61f59376df26f19a6184eb018f5d5dae214a296c9a750117b7
+SHA512:
+  metadata.gz: f7681c72564a7e23c72a7b753b1a6326fef3d67485b09b2cbbc9b321ba7344eaa4f56abaf88a2f950ee01505456e3a4f3d7a928c15473e6a77103a7a2b830477
+  data.tar.gz: 4b8acb5a91d422876058adca6efcfb422ba698c1d08b6c3dcec79a92e34fa75f82bd9f0458bff251ff76681b7491872d8a578eb33e025b2bd2959634647eec58

data/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+env:
+  RUBY_VERSION: 2.7
+  CC_TEST_REPORTER_BINARY_URL: https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+  CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+
+name: Continuous Integration
+on: [pull_request]
+
+jobs:
+  test:
+    name: Run bin/test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.RUBY_VERSION }}
+
+      # install gems
+      - name: Cache Ruby gems
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      # prepare CC test reporter
+      - name: Download CC test reporter binary
+        run: |
+          curl -L ${CC_TEST_REPORTER_BINARY_URL} > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+
+      # run tests
+      - name: Run tests
+        run: bin/test
+
+      # report to CC
+      - run: ./cc-test-reporter after-build --exit-code 1
+        if: ${{ failure() }}
+
+      - run: ./cc-test-reporter after-build --exit-code 0
+        if: ${{ success() }}

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,70 @@
+---
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lxxxvi@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'minitest'
+  gem 'rake'
+  gem 'rubocop'
+  gem 'simplecov', '< 0.18'
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    ruboclean (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    docile (1.3.2)
+    json (2.3.1)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rake
+  ruboclean!
+  rubocop
+  simplecov (< 0.18)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 lxxxvi
+
+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,122 @@
+![Continuous Integration](https://github.com/lxxxvi/ruboclean/workflows/Continuous%20Integration/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a940762e1c0b27caa905/maintainability)](https://codeclimate.com/github/lxxxvi/ruboclean/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a940762e1c0b27caa905/test_coverage)](https://codeclimate.com/github/lxxxvi/ruboclean/test_coverage)
+
+# ruboclean
+
+**ruboclean** puts `.rubocop.yml` into order. It groups the configuration into three groups:
+
+1. `require`
+2. `Namespaces`
+3. `Namespace/Cops`
+
+Finally it orders the configurations **alphabetically** within these groups.
+
+## Example
+
+### Input `.rubocop.yml`:
+
+```yml
+Rails/ShortI18n:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120
+
+Rails:
+  Enabled: true
+
+AllCops:
+  Exclude:
+  - bin/**/*
+
+require:
+- rubocop-rails
+```
+
+### Output `.rubocop.yml`:
+
+```yml
+---
+
+require:
+- rubocop-rails
+
+AllCops:
+  Exclude:
+  - bin/**/*
+
+Rails:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120
+
+Rails/ShortI18n:
+  Enabled: true
+
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruboclean', require: false
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install ruboclean
+```
+
+## Usage
+
+```shell
+ruboclean [path]
+```
+
+* `path` is optional, it defaults to the current working directory
+* `path` can be a directory that contains a `.rubocop.yml`
+* `path` can be a path to a `.rubocop.yml` directly
+
+### Examples
+
+```shell
+ruboclean                 # uses `.rubocop.yml` of current working directory
+```
+
+```shell
+ruboclean /path/to/dir    # uses `.rubocop.yml` of /path/to/dir
+```
+
+```shell
+ruboclean /path/to/dir/.rubocop.yml
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/lxxxvi/ruboclean. 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/lxxxvi/ruboclean/blob/master/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 Ruboclean project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lxxxvi/ruboclean/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ruboclean'
+
+# 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/ruboclean

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'ruboclean'
+
+path = ARGV[0] || Dir.pwd
+
+print "Using path '#{path}' ... "
+Ruboclean.run(path)
+puts 'done.'

data/bin/setup

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+# frozen_string_literal: true
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'fileutils'
+
+# Runs all tests and linters
+class BinTest
+  include FileUtils
+
+  APP_ROOT = File.expand_path('..', __dir__)
+
+  def system!(*args)
+    system(*args) || abort("\n== Command #{args} failed ==")
+  end
+
+  def run
+    chdir APP_ROOT do
+      puts "\n== Run tests =="
+      system! 'bundle exec rake test'
+
+      puts "\n== Run rubocop =="
+      system! 'bundle exec rubocop -p'
+    end
+  end
+end
+
+BinTest.new.run

data/lib/ruboclean.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ruboclean/version'
+require 'ruboclean/rubocop_configuration'
+require 'ruboclean/rubocop_configuration_path'
+require 'ruboclean/orderer'
+
+# Ruboclean entry point
+module Ruboclean
+  class Error < StandardError; end
+
+  def self.run(path)
+    rubocop_configuration_path = RubocopConfigurationPath.new(path)
+    rubocop_configuration = rubocop_configuration_path.load
+    rubocop_configuration_path.write(rubocop_configuration.order)
+  end
+end

data/lib/ruboclean/grouper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Ruboclean
+  # Groups the rubocop configuration items into three categories:
+  #   - require: the require block
+  #   - namespaces: every item which does **not** include an "/"
+  #   - cops: every item which **includes** an "/"
+  class Grouper
+    def initialize(config_hash)
+      @config_hash = config_hash
+    end
+
+    def group_config
+      @config_hash.each_with_object(empty_groups) do |item, result|
+        key, value = item
+        target_group = find_target_group(key)
+        result[target_group].merge! Hash[key, value]
+      end
+    end
+
+    private
+
+    def empty_groups
+      { require: {}, namespaces: {}, cops: {} }
+    end
+
+    def find_target_group(key)
+      return :require if key == 'require'
+      return :cops if key.include?('/')
+
+      :namespaces
+    end
+  end
+end

data/lib/ruboclean/orderer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'ruboclean/grouper'
+
+module Ruboclean
+  # Orders the items within the groups alphabetically
+  class Orderer
+    def initialize(config_hash)
+      @config_hash = config_hash
+    end
+
+    def order
+      grouped_config.reduce({}) do |result, group|
+        _group_name, group_items = group
+        result.merge!(order_by_key(group_items))
+      end
+    end
+
+    private
+
+    def order_by_key(config_hash)
+      config_hash.sort_by(&:first).to_h
+    end
+
+    def grouped_config
+      Ruboclean::Grouper.new(@config_hash).group_config
+    end
+  end
+end

data/lib/ruboclean/rubocop_configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Ruboclean
+  # Contains the config_hash representation of the `.rubocop.yml` file
+  class RubocopConfiguration
+    def initialize(config_hash)
+      @config_hash = config_hash
+    end
+
+    def order
+      Ruboclean::Orderer.new(@config_hash).order
+    end
+  end
+end

data/lib/ruboclean/rubocop_configuration_path.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'yaml'
+
+module Ruboclean
+  # Interface for reading and writing the `.rubocop.yml` file
+  class RubocopConfigurationPath
+    # Thrown if given path is invalid
+    class InvalidPathError < StandardError
+      def initialize(path)
+        super "path does not exist: '#{path}'"
+      end
+    end
+
+    def initialize(path)
+      input_path = Pathname.new(path)
+
+      @rubocop_configuration_path = if input_path.directory?
+                                      input_path.join('.rubocop.yml')
+                                    else
+                                      input_path
+                                    end
+
+      raise InvalidPathError, @rubocop_configuration_path unless @rubocop_configuration_path.exist?
+    end
+
+    def load
+      Ruboclean::RubocopConfiguration.new(load_yaml)
+    end
+
+    def write(rubocop_configuration)
+      output = sanitize_yaml(rubocop_configuration.to_yaml)
+      @rubocop_configuration_path.write(output)
+    end
+
+    private
+
+    def sanitize_yaml(data)
+      data.gsub(/^([a-zA-Z]+)/, "\n\\1")
+    end
+
+    def load_yaml
+      YAML.safe_load(@rubocop_configuration_path.read)
+    end
+  end
+end

data/lib/ruboclean/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ruboclean
+  VERSION = '0.1.0'
+end

data/ruboclean.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ruboclean/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruboclean'
+  spec.version       = Ruboclean::VERSION
+  spec.authors       = ['lxxxvi']
+  spec.email         = ['lxxxvi@users.noreply.github.com']
+
+  spec.summary       = 'Cleans and orders settings in .rubocop.yml'
+  spec.description   = 'Cleans and orders settings in .rubocop.yml'
+  spec.homepage      = 'https://github.com/lxxxvi/ruboclean'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/lxxxvi/ruboclean'
+  spec.metadata['changelog_uri'] = 'https://github.com/lxxxvi/ruboclean/blob/master/CHANGELOG.md'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.executables << 'ruboclean'
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ruboclean
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- lxxxvi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-04 00:00:00.000000000 Z
+dependencies: []
+description: Cleans and orders settings in .rubocop.yml
+email:
+- lxxxvi@users.noreply.github.com
+executables:
+- ruboclean
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/ruboclean
+- bin/setup
+- bin/test
+- lib/ruboclean.rb
+- lib/ruboclean/grouper.rb
+- lib/ruboclean/orderer.rb
+- lib/ruboclean/rubocop_configuration.rb
+- lib/ruboclean/rubocop_configuration_path.rb
+- lib/ruboclean/version.rb
+- ruboclean.gemspec
+homepage: https://github.com/lxxxvi/ruboclean
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lxxxvi/ruboclean
+  source_code_uri: https://github.com/lxxxvi/ruboclean
+  changelog_uri: https://github.com/lxxxvi/ruboclean/blob/master/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.1.2
+signing_key: 
+specification_version: 4
+summary: Cleans and orders settings in .rubocop.yml
+test_files: []