rubocop_method_order 0.1.0.beta → 0.1.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7211b5b76bc5400d2ced58be282733407e318266a1a7901337a9438c4491400a
-  data.tar.gz: 02a3d41c3a68f824a3571dffe4ae2e8c941f160775781759f26a3b1e7822e04c
+  metadata.gz: 65922ea8abc76bcda56fb4e87a976c6365411f1830737b5cf20f5fe087342888
+  data.tar.gz: 514a70a5c948377d6aa37983ba2b0b66c369d3d2c54c2fbbb8c246a4e3a34353
 SHA512:
-  metadata.gz: a173cdb0e717ddea7e00f3207fea70bd3c4162cd9e40c6621911714a12aa41584ac399331a403e6efa4d3be241cae90f77b3c61e397320004b5b51e936efa43b
-  data.tar.gz: e47bfee82e1a47cc63a973aa7e29261d057998ec015f9e72046a03d19c8324867cf4c257f4ea30bba9ffbabf603d96153cb4e29328ee6e7016d86af50dbb6669
+  metadata.gz: 21f2f14717003a01794a81b8df81a1e67e4c06ce1806dddf9ddfe275ef0b912cb2e43c48ad0d166b5e8891509e38b2d8167b409da6366bda9e2f9bcab238c936
+  data.tar.gz: 8afb97c663d3cd4ed382511eee0c698785b6ef6842c87d1d566f0185117981c26e7f1901440f2215e21c60901bf0cecaf6a508a7d388f55c6b55ed1c3ad4d5f1

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+U8�5R�^~�
~�Ѿ�i'__F>F�F��IBw��k3���	��S�n�x��Y��ް`�J����g���ں)��8Xy�qo���y�pvZ���5��)SK�J�|�ȬP��-�����{�qu��N���H,n%��� �tj�]ؑ�W!�x.l���mfn����R'�����X�z��,�d!:����]�H���������)E�	����A���>�?:�Ҿ3���&�����4�ȶ
��yk';�H�s������[�X�>��i���Ê�Ӡ�@(���g˷d@)r]
,��09xb�B��|�ZA��z�
+>g39�H��'�r��dy�z�V��z

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+* Initial version of the extension.
+
+[unreleased]: https://github.com/CoffeeAndCode/rubocop_method_order

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_method_order (0.1.0.beta)
+    rubocop_method_order (0.1.0.beta.2)
       rubocop (~> 0.53)
 
 GEM

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2018 Jonathan Knapp
+
+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

@@ -1,12 +1,29 @@
 # Rubocop MethodOrder
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop_method_order`. To experiment with that code, run `bin/console` for an interactive prompt.
+Bring back order to your Ruby files by leveraging this [Rubocop][0] extension to
+require methods be listed in alphabetical order in your code, grouped by scope
+and context. Method order is evaluated by looking at a methods context
+(ex: top-level method or inside a class/module) as well as the method's scope
+(ex: public, private, protected, class method).
 
-TODO: Delete this and the text above, and describe your gem
+Special treatment is given to the `initialize` method and it is expected to
+be listed as the first public method for `Module` and `Class` methods.
+
+The extension also works with `rubocop --auto-correct`, though you may want to
+only attempt corrections on code already committed to git just in case there
+are any issues.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+RuboCopMethodOrder is [cryptographically signed][1]. To be sure the gem you install
+hasn't been tampered with:
+
+```
+# Add my public key (if you haven’t already) as a trusted certificate
+gem cert --add <(curl -Ls https://raw.github.com/CoffeeAndCode/rubocop_method_order/master/certs/coffeeandcode.pem)
+```
+
+Then, add this line to your application's Gemfile:
 
 ```ruby
 gem 'rubocop_method_order'
@@ -14,22 +31,128 @@ gem 'rubocop_method_order'
 
 And then execute:
 
-    $ bundle
+    $ bundle --trust-policy MediumSecurity
 
 Or install it yourself as:
 
-    $ gem install rubocop_method_order
+    $ gem install rubocop_method_order -P MediumSecurity
+
+The MediumSecurity trust profile will verify signed gems, but allow the
+installation of unsigned dependencies. This is necessary because not all of
+RuboCopMethodOrder's dependencies are signed, so we cannot use HighSecurity.
+
+Lastly, you'll need to explicitly require the extension in your Rubocop config
+like so:
+
+```yaml
+require:
+  - rubocop_method_order
+
+# the rest of your config...
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Here are a few desirable, already ordered examples and you can find more
+examples in the [test/fixtures/](test/fixtures/) directory of this project.
+
+```ruby
+# In this example, `foo` should be listed after `bar` with both after the
+# `initialize` method. If in the incorrect order, both methods will
+# actually show a linter error with a message indicating if they should
+# show 'before' or 'after' a comparision method. The private methods will
+# also each show errors in relation to each other if in the opposite order.
+class ExampleClass
+  def initialize
+  end
+
+  def bar
+  end
+
+  def foo
+  end
+
+  private
+
+  def another_method
+  end
+
+  def private_method
+  end
+end
+```
+
+```ruby
+# This extension works on module methods as well.
+module ExampleModule
+  def self.example
+  end
+
+  # If included in a class, this method would be given special treatment so
+  # we expect it listed first if present in the module.
+  def initialize
+  end
+
+  def bar
+  end
+
+  def foo
+  end
+end
+```
+
+```ruby
+# This extension will also work with plain-ol Ruby files with top level method
+# definitions.
+def bar
+end
+
+def foo
+end
+```
+
+By default, this extension will examine all method definitions and class method
+definitions found in the Ruby source. You can exclude specific methods by using
+a Rubocop `disable comment` like:
+
+```ruby
+def my_method # rubocop:disable Style/MethodOrder
+end
+
+# rubocop:disable Style/MethodOrder
+def another_excluded_method
+end
+# rubocop:enable Style/MethodOrder
+```
+
+You can also exclude entire files using the `Exclude` configuration:
+
+```yaml
+Style/MethodOrder:
+  Exclude:
+    - test/**/*_test.rb
+```
 
 ## 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.
+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 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).
+Make sure that the project has no errors when running `bundle exec rake` which
+will run `rubocop` on the project source and `bundle exec rake test`.
+
+To release a new version, update the version number in `lib/rubocop_method_order/version.rb` and 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][2].
+Afterwards, a new checksum will be generated for the gem which should
+be added to the `master` branch.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/CoffeeAndCode/rubocop_method_order.
+
+[0]: https://github.com/bbatsov/rubocop
+[1]: http://guides.rubygems.org/security/
+[2]: https://rubygems.org

data/Rakefile

@@ -11,4 +11,14 @@ Rake::TestTask.new(:test) do |t|
 end
 RuboCop::RakeTask.new
 
+Rake::Task['release'].enhance do
+  require 'digest/sha2'
+  require_relative '../lib/rubocop_method_order/version'
+
+  built_gem_path = "pkg/rubocop_method_order-#{RuboCopMethodOrder.gem_version}.gem"
+  checksum = Digest::SHA512.new.hexdigest(File.read(built_gem_path))
+  checksum_path = "checksums/rubocop_method_order-#{RuboCopMethodOrder.gem_version}.gem.sha512"
+  File.open(checksum_path, 'w') { |file| file.write(checksum) }
+end
+
 task default: %i[test rubocop]

data/certs/coffeeandcode.pem

@@ -0,0 +1,25 @@
+-----BEGIN CERTIFICATE-----
+MIIERDCCAqygAwIBAgIBATANBgkqhkiG9w0BAQsFADAmMSQwIgYDVQQDDBtqb24v
+REM9Y29mZmVlYW5kY29kZS9EQz1jb20wHhcNMTgwMzIwMTAzNTQyWhcNMTkwMzIw
+MTAzNTQyWjAmMSQwIgYDVQQDDBtqb24vREM9Y29mZmVlYW5kY29kZS9EQz1jb20w
+ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCwhpj30UpL3zNnh+oC/QeA
+oADSvODuNGaZO2THz4UVoXvtlVmOvrMOHqxdAvf4rfv8Rw4U8TUn+5c/E76NWttU
+EYwPs9wB8HrQWxzutsbhGBBcCCyIClbrf5kLTjCIE0UIa4M1gTdUnneWJzyHCNoU
+O/ihDlfNtuB3GGrZ7gglzlBYxGrw+idgJbJp1CAxa2UDkDQhvZ4YIJmKeQIkXrD9
+CVlJXZP1epqixoA6Fq3ToKxFWu5NVHztr+wMKIQbotaruV+CO9a7KjdgP4by4hGL
+0gxhx9lIDtduGhgCL6ZsEGV0Yxy7RI8ylILfM/MbdckJ4KVT9UT0yL3lVoQjjr3t
+ZyIZnIRYj/eafol0sNrJo5MeJoCZaHWS25fE8pYrxJhv7beO9GMNpjGtUzgF11IW
+3i5Ok/a1+R4SRFIs65+ap5br6fPiYKXxThWJBTweOUMoBpEK5q+kN9M74lvrjSw3
+sZZevUtUprwu9WUeUtTxbkONP58PFdIm5az+qxuMYCMCAwEAAaN9MHswCQYDVR0T
+BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAF+y9VjIuh5VVlw69vYwQNnkjoB
+MCAGA1UdEQQZMBeBFWpvbkBjb2ZmZWVhbmRjb2RlLmNvbTAgBgNVHRIEGTAXgRVq
+b25AY29mZmVlYW5kY29kZS5jb20wDQYJKoZIhvcNAQELBQADggGBAA58Mcdzf0TV
+GzOFA2wmeQdIWZkGZ8zJysgaB11Web4iKIxrWZtxs8v3hF7en2+/LkzfDay3A4g6
+5Um1OkylzfvAEXCaTrIVT4lQz4dyiAqB1zj9/vUHillbXc/sGBVbCjSU4JFued4T
+vL9OCX+6XmJ1VG/tLmtj7xJaV2heRh/LvAtvcRvRWw4cPffk1ljWWMRNM7LAlReg
+X1oEnF2j/U6e069ChoLQH0PmRQMfVQv33l+5rs+0yrChU7mpwcWVG7Qrbzr0mMUY
+BsLPoAKTL0tR2XOrduH0QCjHnHMCry0923zLj5eNPQwDhlXyDQC/fyIHto39IvIZ
+ZdB1asnPvD2q9n/KCWkCOnmcQ+V7sdmtEiHMuBFHTDhpBUr1DuYY9wvZwoHo8qGr
+XxvXYAfIUSbb6/CHtemZT4zsEprRuk8eADIYUTMyAt9d2roTcsRKgq20m+PZO+b+
+DVnSbPSTRxaM+9Hds4CAzdoo5hIiLyvSXSqSRGgQEMT0yiFdK+6kRw==
+-----END CERTIFICATE-----

data/lib/rubocop_method_order/version.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+# Version information for the gem.
 module RuboCopMethodOrder
-  VERSION = '0.1.0.beta'
+  # Returns the version of the currently loaded gem as a <tt>Gem::Version</tt>
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  # Contains individual version parts for this gem.
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    PRE   = 'beta.2'
+
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
 end

data/rubocop_method_order.gemspec

@@ -7,24 +7,28 @@ require 'rubocop_method_order'
 
 Gem::Specification.new do |spec|
   spec.name = 'rubocop_method_order'
-  spec.version = RuboCopMethodOrder::VERSION
-  spec.licenses = ['MIT']
-  spec.authors = ['Jonathan Knapp']
-  spec.email = ['jon@coffeeandcode.com']
-
-  spec.summary = 'Provide order to your Ruby files by expecting methods' \
-                 ' to be listed alphabetically by permission group (public,' \
-                 ' private, protected).'
+  spec.version = RuboCopMethodOrder.gem_version
+  spec.license = 'MIT'
+  spec.author = 'Jonathan Knapp'
+  spec.email = 'jon@coffeeandcode.com'
+
+  spec.summary = 'A Rubocop extension that provides order to your Ruby files ' \
+                 'by expecting methods to be listed alphabetically.'
   spec.homepage = 'https://github.com/CoffeeAndCode/rubocop_method_order'
   spec.metadata = { 'source_code_uri' => 'https://github.com/CoffeeAndCode/rubocop_method_order' }
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(checksums|test)/})
   end
   spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables = spec.files.grep(%r{^exe/}) { |file| File.basename(file) }
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.3.0'
+  spec.cert_chain = ['certs/coffeeandcode.pem']
+
+  if $PROGRAM_NAME.end_with?('gem')
+    spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
+  end
 
   spec.add_dependency 'rubocop', '~> 0.53'
 

metadata

@@ -1,13 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_method_order
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 0.1.0.beta.2
 platform: ruby
 authors:
 - Jonathan Knapp
 autorequire: 
 bindir: exe
-cert_chain: []
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIERDCCAqygAwIBAgIBATANBgkqhkiG9w0BAQsFADAmMSQwIgYDVQQDDBtqb24v
+  REM9Y29mZmVlYW5kY29kZS9EQz1jb20wHhcNMTgwMzIwMTAzNTQyWhcNMTkwMzIw
+  MTAzNTQyWjAmMSQwIgYDVQQDDBtqb24vREM9Y29mZmVlYW5kY29kZS9EQz1jb20w
+  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCwhpj30UpL3zNnh+oC/QeA
+  oADSvODuNGaZO2THz4UVoXvtlVmOvrMOHqxdAvf4rfv8Rw4U8TUn+5c/E76NWttU
+  EYwPs9wB8HrQWxzutsbhGBBcCCyIClbrf5kLTjCIE0UIa4M1gTdUnneWJzyHCNoU
+  O/ihDlfNtuB3GGrZ7gglzlBYxGrw+idgJbJp1CAxa2UDkDQhvZ4YIJmKeQIkXrD9
+  CVlJXZP1epqixoA6Fq3ToKxFWu5NVHztr+wMKIQbotaruV+CO9a7KjdgP4by4hGL
+  0gxhx9lIDtduGhgCL6ZsEGV0Yxy7RI8ylILfM/MbdckJ4KVT9UT0yL3lVoQjjr3t
+  ZyIZnIRYj/eafol0sNrJo5MeJoCZaHWS25fE8pYrxJhv7beO9GMNpjGtUzgF11IW
+  3i5Ok/a1+R4SRFIs65+ap5br6fPiYKXxThWJBTweOUMoBpEK5q+kN9M74lvrjSw3
+  sZZevUtUprwu9WUeUtTxbkONP58PFdIm5az+qxuMYCMCAwEAAaN9MHswCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAF+y9VjIuh5VVlw69vYwQNnkjoB
+  MCAGA1UdEQQZMBeBFWpvbkBjb2ZmZWVhbmRjb2RlLmNvbTAgBgNVHRIEGTAXgRVq
+  b25AY29mZmVlYW5kY29kZS5jb20wDQYJKoZIhvcNAQELBQADggGBAA58Mcdzf0TV
+  GzOFA2wmeQdIWZkGZ8zJysgaB11Web4iKIxrWZtxs8v3hF7en2+/LkzfDay3A4g6
+  5Um1OkylzfvAEXCaTrIVT4lQz4dyiAqB1zj9/vUHillbXc/sGBVbCjSU4JFued4T
+  vL9OCX+6XmJ1VG/tLmtj7xJaV2heRh/LvAtvcRvRWw4cPffk1ljWWMRNM7LAlReg
+  X1oEnF2j/U6e069ChoLQH0PmRQMfVQv33l+5rs+0yrChU7mpwcWVG7Qrbzr0mMUY
+  BsLPoAKTL0tR2XOrduH0QCjHnHMCry0923zLj5eNPQwDhlXyDQC/fyIHto39IvIZ
+  ZdB1asnPvD2q9n/KCWkCOnmcQ+V7sdmtEiHMuBFHTDhpBUr1DuYY9wvZwoHo8qGr
+  XxvXYAfIUSbb6/CHtemZT4zsEprRuk8eADIYUTMyAt9d2roTcsRKgq20m+PZO+b+
+  DVnSbPSTRxaM+9Hds4CAzdoo5hIiLyvSXSqSRGgQEMT0yiFdK+6kRw==
+  -----END CERTIFICATE-----
 date: 2018-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -67,8 +93,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.3'
 description: 
-email:
-- jon@coffeeandcode.com
+email: jon@coffeeandcode.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -76,12 +101,15 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- certs/coffeeandcode.pem
 - lib/rubocop/cop/style/method_order.rb
 - lib/rubocop_method_order.rb
 - lib/rubocop_method_order/method_collector.rb
@@ -113,6 +141,6 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Provide order to your Ruby files by expecting methods to be listed alphabetically
-  by permission group (public, private, protected).
+summary: A Rubocop extension that provides order to your Ruby files by expecting methods
+  to be listed alphabetically.
 test_files: []