codeowners-checker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9768a17e8e26a830efa9f9808aec4a6e2fad800b1da0e7223fa68b8ee1a4c31c
+  data.tar.gz: 0e744a329069f56f24a1ba922c1c614eef6667816de05d6b042f2c77a883b559
+SHA512:
+  metadata.gz: 02bcb19b84e96d42aedb93253baaedc4ead716c259dfc811f76d2bc75285c5a97ce69cffd4d88f82a9b5fa2891409337158fc0ba7fbef7090a55eaf9d722f41b
+  data.tar.gz: 2d63073791a7fa205e3aee026158fd37841217316c0a6bbbdad5c75f0ac73d9d9f3ab6858296c918cfc167654ca2d3778db4dc29822b1dbc98f16ebe21ea4c33

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+
+# rspec failure tracking
+.rspec_status

data/.projections.json

@@ -0,0 +1,4 @@
+{
+  "README.md": { "type": "readme" },
+  "lib/*.rb": { "type": "lib", "alternate": "spec/{}_spec.rb" }
+}

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Style/StructInheritance:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

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 jonatas.paganini@toptal.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# frozen_string_literal: true
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    codeowners-checker (1.0.0)
+      fuzzy_match (~> 2.1)
+      git (~> 1.5)
+      thor (~> 0.20.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    fuzzy_match (2.1.0)
+    git (1.5.0)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    method_source (0.9.2)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-readline (0.5.5)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.61.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.30.1)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.3)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  codeowners-checker!
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rb-readline (~> 0.5.5)
+  rspec (~> 3.0)
+  rubocop (~> 0.61.1)
+  rubocop-rspec (~> 1.30)
+  simplecov (~> 0.16.1)
+
+BUNDLED WITH
+   1.17.3

data/Guardfile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'livereload' do
+  watch(%r{lib/.+\.rb$})
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jônatas Davi Paganini
+
+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,171 @@
+# Codeowners Checker
+
+This gem checks if the GitHub codeowners are specified to all files changes
+between two git revisions.
+
+## Installation
+
+    $ gem install codeowners-checker
+
+## Usage
+
+
+### Configure
+
+    $  codeowners-checker config owner <@owner>
+
+It will configure `@owner` as the default owner in the config file.
+
+### Check file consistency
+
+To check if your CODEOWNERS file is consistent with your current project you can run
+this check.
+
+    $  codeowners-checker check
+
+Or via code:
+
+```ruby
+Codeowners::Checker.check! 'repo-dir', 'HEAD', 'branch-name'
+```
+
+
+#### Example
+
+Example CODEOWNERS file:
+
+```
+# Backend
+app/jobs/* @company/backend-devs
+app/models/* @company/backend-devs
+
+# Frontend
+app/assets/* @company/frontend-devs
+app/views/* @company/frontend-devs
+
+# Shared
+Gemfile @company
+```
+
+The content of the CODEOWNERS file is parsed into groups where each group is a collection of patterns
+separated by an empty line and comments describing the group. If no comment is present after
+an empty line, a new group is created only in the case when the owner differs from the owner
+of the previous group. It is also possible to define a group by comments `# BEGIN` and `# END`.
+`# Group` can contain subgroups distinguished by the number of hashes: `## Subgroup`.
+
+When a new file is added to the folder structure, the program detects the file and suggests possible
+groups to which particular file belongs based on the main owner of the patterns in each group.
+After selecting a group the pattern is added to the group in alphabetical order. If no group is
+selected or found the pattern can be added at the end of the CODEOWNERS file.
+
+After modifying the CODEOWNERS file the changes can be immediately committed.
+
+![Missing reference example](demos/missing_reference.svg)
+
+Desired changes were made to the CODEOWNERS file:
+```
+# Backend
+app/controllers/application_controller.rb @company/backend-devs
+app/jobs/* @company/backend-devs
+app/models/* @company/backend-devs
+
+# Frontend
+app/assets/* @company/frontend-devs
+app/views/* @company/frontend-devs
+
+# Shared
+Gemfile @company
+
+lib/invoices.rb @company/billing-team
+```
+
+Now some new patterns containing mistakes have been added by the user to the group `# Shared` and `# Billing`
+and invalid pattern to a new group which is defined by `# BEGIN Security` and `# END Security` comments.
+
+CODEOWNERS file after performing the changes described above:
+```
+# Backend
+app/controllers/application_controller.rb @company/backend-devs
+app/jobs/* @company/backend-devs
+app/models/* @company/backend-devs
+
+# Frontend
+app/assets/* @company/frontend-devs
+app/views/* @company/frontend-devs
+
+# Billing
+app/models/billng.rb @company/billing-team
+lib/invoices.rb @company/billing-team
+
+# BEGIN Security
+lib/security/* @company/security-team
+# END Security
+
+# Shared
+.rubo.yml @company
+Gemfile @company
+
+```
+
+When running it again it will detect the invalid patterns. It will ask to fix the patterns
+and suggest a possible alternative. The user can choose to accept the suggestion, ignore, edit
+or delete the pattern. If the user decides to delete the last pattern in a group,
+the comments defining the group are deleted as well as the pattern.
+
+![Useless pattern example](demos/useless_pattern.svg)
+
+Invalid patterns were fixed and the group `Security` was removed when deleting the only pattern
+in the group:
+```
+# Backend
+app/controllers/application_controller.rb @company/backend-devs
+app/jobs/* @company/backend-devs
+app/models/* @company/backend-devs
+
+# Frontend
+app/assets/* @company/frontend-devs
+app/views/* @company/frontend-devs
+
+# Billing
+app/models/billing.rb @company/billing-team
+lib/invoices.rb @company/billing-team
+
+# Shared
+.rubocop.yml @company
+Gemfile @company
+```
+
+### Filtering Changes in Pull Requests
+
+If you have a Pull Request to review and you just want to check the changes that
+are meaningful to you, you can also filter the changes.
+
+To list all the changes grouped by an owner:
+
+    $  codeowners-checker filter all
+
+It will use the default owner from the configuration if you omit parameters:
+
+    $  codeowners-checker filter
+
+Or you can filter any owner as a parameter:
+
+    $  codeowners-checker filter by <owner>
+
+## 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 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/toptal/codeowners-checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Codeowners::Checker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/toptal/codeowners-checker/blob/master/CODE_OF_CONDUCT.md).