rubocop_method_order 0.1.0.beta.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65922ea8abc76bcda56fb4e87a976c6365411f1830737b5cf20f5fe087342888
-  data.tar.gz: 514a70a5c948377d6aa37983ba2b0b66c369d3d2c54c2fbbb8c246a4e3a34353
+  metadata.gz: ab19c825958da68b876b86e287411591d1656885ad6add3df83d6893e586cc0f
+  data.tar.gz: 276d8f2e12003d75b283312aad1f1cc7a8e84166f8cf5332d9c537b95f77cdeb
 SHA512:
-  metadata.gz: 21f2f14717003a01794a81b8df81a1e67e4c06ce1806dddf9ddfe275ef0b912cb2e43c48ad0d166b5e8891509e38b2d8167b409da6366bda9e2f9bcab238c936
-  data.tar.gz: 8afb97c663d3cd4ed382511eee0c698785b6ef6842c87d1d566f0185117981c26e7f1901440f2215e21c60901bf0cecaf6a508a7d388f55c6b55ed1c3ad4d5f1
+  metadata.gz: 55fd84404e00fc9bb72cad2fe6bc6a93d1316df805f0cea41947fb02c05ee56c6db941cf07c6694379a929b03ce26515d64ae66275b78defff1359821071e5c5
+  data.tar.gz: 9e2964b8653047536814e91c514dfb398fcd2c7329725a2eedf143b9f7cd6dc411bf27898e923398a2f6ef802582620a4a091e8c88f1c4f3c6081706e8224f9f

data/CHANGELOG.md

@@ -5,8 +5,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.1.0] - 2018-03-21
+
 ### Added
 
 * Initial version of the extension.
 
 [unreleased]: https://github.com/CoffeeAndCode/rubocop_method_order
+[0.1.0]: https://github.com/CoffeeAndCode/rubocop_method_order/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_method_order (0.1.0.beta.2)
+    rubocop_method_order (0.1.0)
       rubocop (~> 0.53)
 
 GEM
@@ -15,7 +15,7 @@ GEM
     powerpack (0.1.1)
     rainbow (3.0.0)
     rake (12.3.0)
-    rubocop (0.53.0)
+    rubocop (0.54.0)
       parallel (~> 1.10)
       parser (>= 2.5)
       powerpack (~> 0.1)

data/README.md

@@ -54,14 +54,14 @@ require:
 ## Usage
 
 Here are a few desirable, already ordered examples and you can find more
-examples in the [test/fixtures/](test/fixtures/) directory of this project.
+examples in the [test/fixtures/files/](test/fixtures/files/) 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.
+# `initialize` method. If in the incorrect order, each method that should show
+# up before another will show a linter error indicating which method they should
+# be defined before. The private methods will work the same way in the context
+# of just the private methods.
 class ExampleClass
   def initialize
   end

data/Rakefile

@@ -13,9 +13,14 @@ RuboCop::RakeTask.new
 
 Rake::Task['release'].enhance do
   require 'digest/sha2'
-  require_relative '../lib/rubocop_method_order/version'
+  require_relative './lib/rubocop_method_order/version'
 
   built_gem_path = "pkg/rubocop_method_order-#{RuboCopMethodOrder.gem_version}.gem"
+
+  checksum = Digest::SHA256.new.hexdigest(File.read(built_gem_path))
+  checksum_path = "checksums/rubocop_method_order-#{RuboCopMethodOrder.gem_version}.gem.sha256"
+  File.open(checksum_path, 'w') { |file| file.write(checksum) }
+
   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) }

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

@@ -15,10 +15,10 @@ module RuboCop
       #
       #   # 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.
+      #   # `bar` should be listed before `foo`. The method `bar` will show
+      #   # a linter error with a message indicating which method is should show
+      #   # before. The private method `another_method` will also an error
+      #   # saying it should be before `private_method`.
       #   class ExampleClass
       #     def foo
       #     end
@@ -103,18 +103,27 @@ module RuboCop
       class MethodOrder < Cop
         include RangeHelp
 
-        MSG = 'Method `%<method>s` should come %<direction>s the method `%<other_method>s`.'
+        MSG = 'Methods should be sorted in alphabetical order within their section' \
+              ' of the code. Method `%<method>s` should come before `%<previous_method>s`.'
 
         def autocorrect(node)
+          return if @autocorrect_replacements[node].nil?
+
           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)
+            @autocorrect_replacements[node].each do |node_to_move, node_to_replace|
+              next if @autocorrected_nodes.include?(node_to_move)
+
+              @autocorrected_nodes << node_to_move
+              node_source = range_with_method_comments(node_to_move).source
+              replacement_range = range_with_method_comments(node_to_replace)
+              corrector.replace(replacement_range, node_source)
+            end
           end
         end
 
         def investigate(_processed_source)
           @autocorrect_replacements = {}
+          @autocorrected_nodes = []
           @method_collector = RuboCopMethodOrder::MethodCollector.new(
             should_skip_method: ->(node) { !cop_enabled_for_node?(node) }
           )
@@ -168,8 +177,7 @@ module RuboCop
             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]
+                offense[:other_node].method_name
               ))
             end
           end
@@ -185,11 +193,10 @@ module RuboCop
           range.end_pos + last_line.length - range.last_column + 1 # account for \n char
         end
 
-        def message(method_name, following_method_name, direction)
+        def message(method_name, following_method_name)
           format(MSG,
-                 direction: direction,
                  method: method_name,
-                 other_method: following_method_name)
+                 previous_method: following_method_name)
         end
 
         def range_with_method_comments(node)

data/lib/rubocop_method_order/method_node_collection.rb

@@ -10,13 +10,10 @@ module RuboCopMethodOrder
     end
 
     def offenses
-      nodes.reject { |node| method_order_correct?(node) }.map do |node|
-        is_after = expected_method_index(node) > nodes.index(node)
-
+      nodes.reject { |node| definition_order_correct?(node) }.map do |node|
         {
-          direction: is_after ? 'after' : 'before',
           node: node,
-          other_node: is_after ? previous_method_node(node) : next_method_node(node)
+          other_node: previous_node_from_definition_order(node)
         }
       end
     end
@@ -26,14 +23,25 @@ module RuboCopMethodOrder
       self
     end
 
+    # Build a hash for every node that is not at the correct, final position
+    # which includes any nodes that need to be moved. Used for autocorrecting.
     def replacements
       nodes.reject { |node| method_order_correct?(node) }.each_with_object({}) do |node, obj|
-        obj[node] = nodes[expected_method_index(node)]
+        node_to_replace = nodes[expected_method_index(node)]
+
+        obj[node] = {
+          node => node_to_replace,
+          node_to_replace => nodes[expected_method_index(node_to_replace)]
+        }
       end
     end
 
     private
 
+    def definition_order_correct?(method_node)
+      previous_node_from_definition_order(method_node).nil?
+    end
+
     def expected_method_index(method_node)
       ordered_nodes.index(method_node)
     end
@@ -42,22 +50,17 @@ module RuboCopMethodOrder
       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]
+    def ordered_nodes
+      nodes.sort(&method(:sort))
     end
 
-    def ordered_nodes
-      nodes.sort_by(&:method_name)
+    def previous_node_from_definition_order(method_node)
+      index = nodes.index(method_node)
+      nodes[0..index].find { |comp_node| sort(comp_node, method_node).positive? }
     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]
+    def sort(one, two)
+      one.method_name <=> two.method_name
     end
   end
 end

data/lib/rubocop_method_order/public_method_node_collection.rb

@@ -8,17 +8,18 @@ module RuboCopMethodOrder
       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
+
+    def sort(one, two)
+      if @initialize_node
+        return 0 if one == @initialize_node && two == @initialize_node
+        return -1 if one == @initialize_node
+        return 1 if two == @initialize_node
+      end
+      super
+    end
   end
 end

data/lib/rubocop_method_order/version.rb

@@ -12,7 +12,7 @@ module RuboCopMethodOrder
     MAJOR = 0
     MINOR = 1
     PATCH = 0
-    PRE   = 'beta.2'
+    PRE   = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_method_order
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Jonathan Knapp
@@ -34,7 +34,7 @@ cert_chain:
   XxvXYAfIUSbb6/CHtemZT4zsEprRuk8eADIYUTMyAt9d2roTcsRKgq20m+PZO+b+
   DVnSbPSTRxaM+9Hds4CAzdoo5hIiLyvSXSqSRGgQEMT0yiFdK+6kRw==
   -----END CERTIFICATE-----
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -133,9 +133,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3