rubocop_method_order 0.1.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7211b5b76bc5400d2ced58be282733407e318266a1a7901337a9438c4491400a
+  data.tar.gz: 02a3d41c3a68f824a3571dffe4ae2e8c941f160775781759f26a3b1e7822e04c
+SHA512:
+  metadata.gz: a173cdb0e717ddea7e00f3207fea70bd3c4162cd9e40c6621911714a12aa41584ac399331a403e6efa4d3be241cae90f77b3c61e397320004b5b51e936efa43b
+  data.tar.gz: e47bfee82e1a47cc63a973aa7e29261d057998ec015f9e72046a03d19c8324867cf4c257f4ea30bba9ffbabf603d96153cb4e29328ee6e7016d86af50dbb6669

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+require:
+  - ./lib/rubocop/cop/style/method_order
+
+AllCops:
+  Exclude:
+    - test/fixtures/files/**/*
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 100
+Metrics/MethodLength:
+  Exclude:
+    - test/**/*_test.rb
+Style/MethodOrder:
+  Exclude:
+    - test/**/*_test.rb

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/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rubocop_method_order.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    rubocop_method_order (0.1.0.beta)
+      rubocop (~> 0.53)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.0.4)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (12.3.0)
+    rubocop (0.53.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 12.3)
+  rubocop_method_order!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,35 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop_method_order'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop_method_order
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/CoffeeAndCode/rubocop_method_order.

data/Rakefile

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

data/bin/console

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

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

data/lib/rubocop/cop/style/method_order.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative '../../../rubocop_method_order/method_collector'
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop enforces methods to be sorted alphabetically within the context
+      # of their scope and permission level such as `private` or `protected`.
+      # The method `initialize` is given special treatment by being required to
+      # be listed first in the context of a class if it's a public method.
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   # `foo` should be listed after `bar`. Both methods will actually
+      #   # show a linter error with a message indicating if they should show
+      #   # before or after the comparision method. The private methods will
+      #   # also each show errors in relation to each other.
+      #   class ExampleClass
+      #     def foo
+      #     end
+      #
+      #     def bar
+      #     end
+      #
+      #     private
+      #
+      #     def private_method
+      #     end
+      #
+      #     def another_method
+      #     end
+      #   end
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   # Works on modules too.
+      #   module ExampleModule
+      #     def foo
+      #     end
+      #
+      #     def bar
+      #     end
+      #   end
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   # As well as top level ruby methods in a file.
+      #   def foo
+      #   end
+      #
+      #   def bar
+      #   end
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   class ExampleClass
+      #     def bar
+      #     end
+      #
+      #     def foo
+      #     end
+      #
+      #     private
+      #
+      #     def another_method
+      #     end
+      #
+      #     def private_method
+      #     end
+      #   end
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   module ExampleModule
+      #     def bar
+      #     end
+      #
+      #     def foo
+      #     end
+      #   end
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   def bar
+      #   end
+      #
+      #   def foo
+      #   end
+      class MethodOrder < Cop
+        include RangeHelp
+
+        MSG = 'Method `%<method>s` should come %<direction>s the method `%<other_method>s`.'
+
+        def autocorrect(node)
+          lambda do |corrector|
+            source_range = range_with_method_comments(node)
+            replace_range = range_with_method_comments(@autocorrect_replacements[node])
+            corrector.replace(replace_range, source_range.source)
+          end
+        end
+
+        def investigate(_processed_source)
+          @autocorrect_replacements = {}
+          @method_collector = RuboCopMethodOrder::MethodCollector.new(
+            should_skip_method: ->(node) { !cop_enabled_for_node?(node) }
+          )
+          @offenses_checked = false
+        end
+
+        # NOTE: Change this if cops get a callback method for running validations
+        #       after the on_* methods have been executed.
+        def offenses(*args)
+          unless @offenses_checked
+            @offenses_checked = true
+            check_nodes
+          end
+
+          super(*args)
+        end
+
+        def on_class(node)
+          @method_collector.collect_nodes_from_class(node)
+        end
+
+        def on_def(node)
+          @method_collector.collect(node)
+        end
+        alias on_defs on_def
+
+        def on_module(node)
+          @method_collector.collect_nodes_from_module(node)
+        end
+
+        private
+
+        def begin_pos_with_comments(node)
+          range = node.source_range
+          begin_of_first_line = range.begin_pos - range.column
+          line_number = range.first_line
+
+          loop do
+            line_number -= 1
+            source_line = @processed_source.buffer.source_line(line_number)
+            break unless source_line.match?(/\s*#/)
+
+            begin_of_first_line -= source_line.length + 1 # account for \n char
+          end
+          begin_of_first_line
+        end
+
+        def check_nodes
+          @method_collector.nodes_by_scope.values.each do |method_collection|
+            @autocorrect_replacements.merge!(method_collection.replacements)
+            method_collection.offenses.each do |offense|
+              add_offense(offense[:node], location: :expression, message: message(
+                offense[:node].method_name,
+                offense[:other_node].method_name,
+                offense[:direction]
+              ))
+            end
+          end
+        end
+
+        def cop_enabled_for_node?(node)
+          processed_source.comment_config.cop_enabled_at_line?(self, node.first_line)
+        end
+
+        def end_pos_with_comments(node)
+          range = node.source_range
+          last_line = @processed_source.buffer.source_line(range.last_line)
+          range.end_pos + last_line.length - range.last_column + 1 # account for \n char
+        end
+
+        def message(method_name, following_method_name, direction)
+          format(MSG,
+                 direction: direction,
+                 method: method_name,
+                 other_method: following_method_name)
+        end
+
+        def range_with_method_comments(node)
+          Parser::Source::Range.new(@processed_source.buffer,
+                                    begin_pos_with_comments(node),
+                                    end_pos_with_comments(node))
+        end
+      end
+    end
+  end
+end

data/lib/rubocop_method_order/method_collector.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative './method_node_collection'
+require_relative './public_method_node_collection'
+
+module RuboCopMethodOrder
+  # This object collects every method definition found during a cop run and will
+  # attempt to split them by scope and context. If a method is disabled by a
+  # Rubocop comment it is not added to the collector. A method is also only
+  # collected once.
+  class MethodCollector
+    attr_reader :all_method_nodes,
+                :nodes_by_scope
+
+    def initialize(should_skip_method:)
+      @all_method_nodes = []
+      @should_skip_method = should_skip_method
+      @nodes_by_scope = {}
+    end
+
+    def collect(def_node, scope_name = 'global')
+      return if @should_skip_method.call(def_node)
+      return if @all_method_nodes.include?(def_node)
+
+      @all_method_nodes << def_node
+
+      unless @nodes_by_scope.key?(scope_name)
+        @nodes_by_scope[scope_name] = new_node_collection(scope_name)
+      end
+      @nodes_by_scope[scope_name].push(def_node)
+    end
+
+    def collect_nodes_from_class(class_node)
+      base_scope_name = "CLASS:#{scope_for_node(class_node)}"
+
+      mode = :public
+      child_nodes_from_container(class_node).each do |node|
+        if node.type == :def
+          collect(node, "#{base_scope_name}:#{mode}_methods")
+        elsif node.type == :defs
+          collect(node, "#{base_scope_name}:class_methods")
+        end
+
+        mode = node.method_name if scope_change_node?(node)
+      end
+    end
+
+    def collect_nodes_from_module(module_node)
+      base_scope_name = "MODULE:#{scope_for_node(module_node)}"
+
+      child_nodes_from_container(module_node).each do |node|
+        if node.type == :def
+          collect(node, "#{base_scope_name}:public_methods")
+        elsif node.type == :defs
+          collect(node, "#{base_scope_name}:class_methods")
+        end
+      end
+    end
+
+    private
+
+    def child_nodes_from_container(node)
+      begin_node = node.child_nodes.select { |x| x&.type == :begin }.first
+      begin_node.nil? ? node.child_nodes : begin_node.child_nodes
+    end
+
+    def new_node_collection(scope_name)
+      if scope_name.match?(/:public_methods$/)
+        PublicMethodNodeCollection.new
+      else
+        MethodNodeCollection.new
+      end
+    end
+
+    def scope_change_node?(node)
+      node.type == :send && %i[private protected].include?(node.method_name)
+    end
+
+    def scope_for_node(node)
+      "#{node.source_range.begin_pos}-#{node.source_range.end_pos}"
+    end
+  end
+end

data/lib/rubocop_method_order/method_node_collection.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RuboCopMethodOrder
+  # Hold collection of public instance methods that has custom sorted order.
+  class MethodNodeCollection
+    attr_reader :nodes
+
+    def initialize
+      @nodes = []
+    end
+
+    def offenses
+      nodes.reject { |node| method_order_correct?(node) }.map do |node|
+        is_after = expected_method_index(node) > nodes.index(node)
+
+        {
+          direction: is_after ? 'after' : 'before',
+          node: node,
+          other_node: is_after ? previous_method_node(node) : next_method_node(node)
+        }
+      end
+    end
+
+    def push(method_node)
+      @nodes << method_node
+      self
+    end
+
+    def replacements
+      nodes.reject { |node| method_order_correct?(node) }.each_with_object({}) do |node, obj|
+        obj[node] = nodes[expected_method_index(node)]
+      end
+    end
+
+    private
+
+    def expected_method_index(method_node)
+      ordered_nodes.index(method_node)
+    end
+
+    def method_order_correct?(method_node)
+      nodes.index(method_node) == ordered_nodes.index(method_node)
+    end
+
+    def next_method_node(method_node)
+      expected_index = expected_method_index(method_node)
+      return if expected_index.nil?
+      return if expected_index + 1 >= nodes.size
+      ordered_nodes[expected_index + 1]
+    end
+
+    def ordered_nodes
+      nodes.sort_by(&:method_name)
+    end
+
+    def previous_method_node(method_node)
+      expected_index = expected_method_index(method_node)
+      return if expected_index.nil?
+      return if (expected_index - 1).negative?
+      ordered_nodes[expected_index - 1]
+    end
+  end
+end

data/lib/rubocop_method_order/public_method_node_collection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCopMethodOrder
+  # Hold collection of public instance methods that has custom sorted order.
+  class PublicMethodNodeCollection < MethodNodeCollection
+    def initialize
+      @initialize_node = nil
+      super
+    end
+
+    def ordered_nodes
+      if @initialize_node
+        [@initialize_node] + (super - [@initialize_node])
+      else
+        super
+      end
+    end
+
+    def push(method_node)
+      @initialize_node = method_node if method_node.method_name == :initialize
+      super(method_node)
+    end
+  end
+end

data/lib/rubocop_method_order/version.rb

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

data/lib/rubocop_method_order.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rubocop/cop/style/method_order'
+require 'rubocop_method_order/method_collector'
+require 'rubocop_method_order/method_node_collection'
+require 'rubocop_method_order/public_method_node_collection'
+require 'rubocop_method_order/version'

data/rubocop_method_order.gemspec

@@ -0,0 +1,34 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_dependency 'rubocop', '~> 0.53'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rubocop_method_order
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta
+platform: ruby
+authors:
+- Jonathan Knapp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: 
+email:
+- jon@coffeeandcode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubocop/cop/style/method_order.rb
+- lib/rubocop_method_order.rb
+- lib/rubocop_method_order/method_collector.rb
+- lib/rubocop_method_order/method_node_collection.rb
+- lib/rubocop_method_order/public_method_node_collection.rb
+- lib/rubocop_method_order/version.rb
+- rubocop_method_order.gemspec
+homepage: https://github.com/CoffeeAndCode/rubocop_method_order
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/CoffeeAndCode/rubocop_method_order
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+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).
+test_files: []