rubocop-rails-order_model_macros 0.1.2 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed903f2fbfeb0a0d31b12fd9065546096cbb7457
-  data.tar.gz: 34add53f42543f33693587d283d72b820ac26d4e
+  metadata.gz: 9ba11eeb674a43a28a2fb1944e9cd5975e696f28
+  data.tar.gz: 4a0a2bd080367c4946085678da14a1b50835f161
 SHA512:
-  metadata.gz: e1aa12a8c00effdfe02be99b18b1e44e9cd358e87f03d4532c9283becbb3fbdec5ba5d4d7a1cacac2b69266470cc695440b5c6d7386d08a41e580eadfcc3176a
-  data.tar.gz: f10619faf332a82c35b004dd9a3d1e4f91937fa5ae4fbc782ee1597eb64d0b7ded8993b7d3d2285cfe6c893727a3f1a6f895fb87540f34276b618a774d8bace7
+  metadata.gz: fd091e969007c4a84a73681068938fb9c193f5ecddc3e821f75d0deee87aeca8f4189bad0af362e1b64a3c31e0e00445905fa07608c41fd773e0b9664b72aa6d
+  data.tar.gz: e6b52288501a7f7448cdc3c03558c7ca66e583d7bc71f476c9af68c4835ebb0fb72a0dab87e7d32b5ca4136d0a59cdd2ff9bc66d72b470e1c0f7eb063d49fb29

data/README.md

@@ -12,15 +12,88 @@ gem 'rubocop-rails-order_model_macros'
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install rubocop-rails-order_model_macros
+```shell
+$ gem install rubocop-rails-order_model_macros
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+You need to tell RuboCop to load the `Rails/OrderModelMacros` extension. There are three ways to do this:
+
+### 1. RuboCop configuration file
+
+Put this into your `.rubocop.yml`:
+
+```ruby
+require: rubocop-rails-order_model_macros
+```
+
+Now you can run `rubocop` and it will automatically load the `RuboCop` `Rails/OrderModelMacros` cop together with the standard cops.
+
+### 2. Command line
+
+```
+rubocop --require rubocop-rails-order_model_macros
+```
+
+### 3. Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rails-order_model_macros'
+end
+```
+
+## Configuring the cops
+
+The [default configuration](config/default.yml) defines an outer group ordering, Rails macros to check, and inner group orderings for associations and validations.
+
+```yaml
+Rails/OrderModelMacros:
+  Description: 'Sort macros methos in Rails models.'
+  Enabled: true
+  PreferredGroupOrdering:
+    - default_scope
+    - class_method
+    - enum
+    - association
+    - validation
+    - callback
+    - delegate
+    - rails
+    - gem
+    - custom
+    - scope
+  PreferredInnerGroupOrdering:
+    association:
+      - belongs_to
+      - has_one
+      - has_and_belongs_to_many
+      - has_many
+    validation:
+      - validates
+      - validate
+      - with_options
+  Rails:
+    - accepts_nested_attributes_for
+    - serialize
+    - store_accessor
+  Custom: null
+  Gem: null
+```
+
+
+
+All of these may be customized. To only include a subset of groups, or to modify the order, define your own `PreferredGroupOrdering`. To add additional Rails macros, define a `Rails` array. Definitions overwrite defaults, so if you customize, be sure to copy over any desired types from the default set when applicable.
+
+- Add custom macros to `Custom`.
+- Add any Gem defined macros to `Gem`.
 
 ## Development
 
@@ -32,7 +105,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-rails-order_model_macros. 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](http://opensource.org/licenses/MIT).

data/lib/rubocop/cop/rails/order_model_macros.rb

@@ -23,8 +23,7 @@ module RuboCop
         def on_class(node)
           _name, superclass, body = *node
 
-          return unless body
-          return unless body.begin_type?
+          return unless body && body.begin_type?
           return unless superclass && superclass.descendants.any?
           return unless %w(ActiveRecord ApplicationRecord).include?(superclass.descendants.first.const_name)
 
@@ -49,10 +48,14 @@ module RuboCop
             ordered_for_type = preferred_group_ordering[type]
             squeezed = squeeze(targets_for_type.map(&:method_name))
 
+            mixed = squeezed != squeezed.uniq
+
             a = (ordered_for_type & squeezed)
             b = (squeezed & ordered_for_type)
 
-            a == b || (set_within_group_error_message(type, a, b) and false)
+            a = squeezed.drop_while { |el| squeezed.count(el) > 1 } if mixed
+
+            a == b or set_within_group_error_message(type, a, b) && false
           end
         end
 
@@ -70,7 +73,7 @@ module RuboCop
           a = type_order & squeezed
           b = squeezed & type_order
 
-          a == b || (set_outer_group_error_message(a, b) and false)
+          a == b or set_outer_group_error_message(a, b) && false
         end
 
         def single_groups?(targets)
@@ -84,9 +87,12 @@ module RuboCop
         end
 
         def target_methods(body)
-          body.children.compact.select do |child|
-            child.send_type? && matches_targets?(child.method_name)
-          end
+          body.children.compact.select(&method(:match)).map(&method(:match))
+        end
+
+        def match(child)
+          return child if child.send_type? && matches_targets?(child.method_name)
+          child.children && match(child.children.compact.first)
         end
 
         def matches_targets?(declared)

data/lib/rubocop/rails/order_model_macros/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Rails
     module OrderModelMacros
       module Version
-        STRING = "0.1.2".freeze
+        STRING = "0.1.21".freeze
 
         def self.gem_version
           Gem::Version.new(STRING)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails-order_model_macros
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.21
 platform: ruby
 authors:
 - Caroline Artz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop