rubocop-ordered_methods 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ade6d192050ac40f268177e3ede23b40f57d569041c6191baa855bfcef87a2c2
+  data.tar.gz: b39ded0724baf7c35b2d48506bebbe0924a04be6fe0c300a75090bf7e9deb7af
+SHA512:
+  metadata.gz: 79368459e3709585a1741e6d5374b5e9d5176562f494a344ceed58208c512bf8c9f324ef8200bd9de9645b95a2d6a05d4bc584af97329997328bad44db2426ff
+  data.tar.gz: 1c3dcbf99709710ad10fec4e0085f1fd8caf9094082d27cb8a8b77fc6e081d0942bbfd41953b2bd715d184d3430a92ee463665913c51fcfcdac483c141a69f89

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,9 @@
+require: rubocop-ordered_methods
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-ordered_methods.rb

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+before_install: gem install bundler -v 1.17.2

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 shane@shanecav.net. 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,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rubocop-ordered_methods.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    rubocop-ordered_methods (0.1)
+      rubocop (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    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.64.0)
+      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)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop-ordered_methods!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Shane Cavanaugh
+
+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,94 @@
+# RuboCop OrderedMethods
+
+Check that methods are defined alphabetically.
+
+```ruby
+# bad
+def self.b; end
+def self.a; end
+
+def b; end
+def a; end
+
+private
+
+def d; end
+def c; end
+
+# good
+def self.a; end
+def self.b; end
+
+def a; end
+def b; end
+
+private
+
+def c; end
+def d; end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-ordered_methods'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-ordered_methods
+
+## Usage
+
+You need to tell RuboCop to load the OrderedMethods extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```
+require: rubocop-ordered_methods
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop OrderedMethods
+cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-ordered_methods
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+IgnoredMethods | `initialize` | Array
+
+## Development
+
+### Setup
+
+```bash
+bundle install
+bundle exec rake
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shanecav84/rubocop-ordered_methods. 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 RuboCop OrderedMethods project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shanecav84/rubocop-ordered_methods/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rubocop/ordered_methods'
+
+# 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/lib/rubocop/cop/layout/ordered_methods.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Check that methods are defined alphabetically.
+      #
+      # @example
+      #   # bad
+      #   def self.b; end
+      #   def self.a; end
+      #
+      #   def b; end
+      #   def a; end
+      #
+      #   private
+      #
+      #   def d; end
+      #   def c; end
+      #
+      #   # good
+      #   def self.a; end
+      #   def self.b; end
+      #
+      #   def a; end
+      #   def b; end
+      #
+      #   private
+      #
+      #   def c; end
+      #   def d; end
+      class OrderedMethods < Cop
+        include IgnoredMethods
+        include RangeHelp
+
+        MSG = 'Methods should be sorted alphabetically.'.freeze
+        VISIBILITY_MODIFIERS = %i[
+          module_function
+          private
+          protected
+          public
+        ].freeze
+
+        def_node_matcher :class_def?, 'defs'
+        def_node_matcher :instance_def?, 'def'
+        def_node_matcher :visibility_modifier?, <<-PATTERN
+          (send nil? { #{VISIBILITY_MODIFIERS.map(&:inspect).join(' ')} })
+        PATTERN
+
+        def on_begin(node)
+          consecutive_methods(node.children) do |previous, current|
+            add_offense(current) unless ordered?(previous, current)
+          end
+        end
+
+        private
+
+        def consecutive_methods(ast)
+          filtered_and_grouped(ast).each do |method_group|
+            method_group.each_cons(2) do |left_method, right_method|
+              yield left_method, right_method
+            end
+          end
+        end
+
+        def filter_relevant_nodes(nodes)
+          nodes.select do |node|
+            (
+              class_def?(node) ||
+                instance_def?(node) ||
+                visibility_modifier?(node)
+            ) && !ignored_method?(node.method_name)
+          end
+        end
+
+        def filtered_and_grouped(ast)
+          group_methods_by_visiblity_block(filter_relevant_nodes(ast))
+        end
+
+        # Group methods by the visiblity block they are declared in. Multiple
+        # blocks of the same visiblity will have their methods grouped
+        # separately; for example, the following would be separated into two
+        # groups:
+        #   private
+        #   def a; end
+        #   private
+        #   def b; end
+        # rubocop:disable Metrics/MethodLength
+        def group_methods_by_visiblity_block(nodes)
+          is_class_method_block = false
+          nodes.each_with_object([[]]) do |node, grouped_methods|
+            if new_visiblity_block?(node, is_class_method_block)
+              grouped_methods << []
+            end
+
+            is_class_method_block = true if class_def?(node)
+            is_class_method_block = false if instance_def?(node)
+
+            if visibility_modifier?(node)
+              is_class_method_block = false
+              next
+            end
+
+            grouped_methods.last << node
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def new_visiblity_block?(node, is_class_method_block)
+          (class_def?(node) && !is_class_method_block) ||
+            (instance_def?(node) && is_class_method_block) ||
+            visibility_modifier?(node)
+        end
+
+        def ordered?(left_method, right_method)
+          (left_method.method_name <=> right_method.method_name) != 1
+        end
+      end
+    end
+  end
+end

data/lib/rubocop-ordered_methods.rb

@@ -0,0 +1,2 @@
+require 'rubocop'
+require_relative 'rubocop/cop/layout/ordered_methods'

data/rubocop-ordered_methods.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-ordered_methods'
+  spec.version       = '0.1'
+  spec.authors       = ['Shane Cavanaugh']
+  spec.email         = ['shane@shanecav.net']
+
+  spec.summary       = 'Checks that methods are ordered alphabetically.'
+  spec.homepage      = 'https://github.com/shanecav84/rubocop-ordered_methods'
+  spec.license       = 'MIT'
+
+  # 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 do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rubocop', '~> 0.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-ordered_methods
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Shane Cavanaugh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- shane@shanecav.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- lib/rubocop-ordered_methods.rb
+- lib/rubocop/cop/layout/ordered_methods.rb
+- rubocop-ordered_methods.gemspec
+homepage: https://github.com/shanecav84/rubocop-ordered_methods
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Checks that methods are ordered alphabetically.
+test_files: []