dark_finger 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2c5b4a2b9fd64fc712fe87e8217705c9fc10fb37
-  data.tar.gz: 01cf3213671f4e9a18ad2e355b549dc5ee38ab06
+SHA256:
+  metadata.gz: '0962a291b4b5701f5523c84ecbd4865afe91953e5a40ce3c3467a92d31dfba1a'
+  data.tar.gz: b6bbe7abfa4d16caca2ec60a3090435d4498db374ec2e0bd451608ccaa747ee8
 SHA512:
-  metadata.gz: 256aea1e41241022db13ec4c7f7dabdcd7eeeb878a96282833ab63b679c0411c4d8db2dd193116847c8d42d6f96ebf78c14c4ff152f46d93d01137f8bf917f10
-  data.tar.gz: 5a74ed3a93cbdb4951fa3b98acb9b7a4d37581452c04fc651009298ff0b3011abae28bf87915c80b6fdb3acc2bc6eaab981dbbdd93067f621fd3f4a3dff0b46a
+  metadata.gz: 5f60cc6dd2325e4a9c758170250b5daadfb3bec991bdeab141cd6fc864d4df4300430d94bffc8bbaac9abf3b4c1e7e7de9c7037f7124f815d2343e6f0b74ac31
+  data.tar.gz: 57732e831e03a50c242bbaf05661879b10781cf30bf389f374e1bca173889c06862a6a17cf40a43b3701806613561cb63bbcc9fe21bed69d20c9c02e6a8698b9

data/README.md

@@ -1,23 +1,68 @@
-# DarkFinger
+![Dark Finger](.github/dark_finger.jpg "Dark Finger")
 
-A Rubocop extension to check the layout of ActiveModel files. The cop will
-check that elements appear together, in the right order, and commented as
-desired.
+A Rubocop extension to check the layout of ActiveModel files.
 
-Supported elements:
+At work we've found that, as our model files grow in size, there are many
+"macro" methods (scopes, validations, etc) at the top that become messy and
+inconsistent across files.
 
-* associations
-* attributes
-* callbacks
-* constants
-* enums
-* includes
-* modules
-* scopes
-* validations
-* class_methods
-* instance_methods
+To help keep things orderly over time we wrote ... _**Dark Finger**_.  This
+Cop will issue warnings if the various model elements:
 
+1. Aren't grouped together
+2. The groups don't appear in the right order
+3. The groups aren't commented properly
+
+This is the kind of model file that we like. Notice how all the model elements
+are grouped, commented, and ordered (although ordering is not visible from just
+one file):
+
+```ruby
+class Horse < ApplicationRecord
+  ## Includes ##
+  include GallopingMagicPowers
+  include LazerEyes
+
+  ## Enums ##
+  enum breed: %i[thoroughbred
+                 arabian
+                 american quarter horse
+                 clydesdale
+                 mustang]
+
+  ## Associations ##
+  has_many :legs
+  belongs_to :brain
+  belongs_to :saddle
+
+  ## Validations ##
+  validates_presence_of :breed
+  validates_presence_of :age
+
+  ## Scopes ##
+  scope :dead, -> { where(state: 'dead') }
+  scope :alive, -> { where(state: 'alive') }
+
+  ## Attributes ##
+  attr_accessor :promote_to_demon_horse
+
+  ## Callbacks ##
+  after_save :callbacks_are_evil_you_should_be_ashamed
+
+  ## Misc ##
+  serialize :nose_hairs, Array
+  acts_as_taggable
+
+  def self.foobario
+    # foo
+  end
+
+  def gallop_hard
+    # ...
+  end
+end
+
+```
 
 ## Installation
 
@@ -35,23 +80,26 @@ Or install it yourself as:
 
     $ gem install dark_finger
 
-## Usage
+## Usage and Configuration
 
 Install the gem. Then, in your `.rubycop.yml` file, require `dark_finger` and
 add your desired config.
 
-For example, here is the default config:
+For example:
 
-```ruby
+```yaml
 # in .rubocop.yml
 
-
 # this is required
 require: dark_finger
 
 DarkFinger/ModelStructure:
+
+  # this is also required
   Include:
     - 'app/models/*'
+
+  # specify the order that the model elements must appear in
   required_order:
     - module
     - include
@@ -62,21 +110,44 @@ DarkFinger/ModelStructure:
     - scope
     - attributes
     - callback
+    - misc
+    - constructor
     - class_method
     - instance_method
-  required_comments:
-    association: '# Relationships'
-    attribute: '# Attributes'
-    callback: '# Callbacks'
-    constant: '# Constants'
-    enum: '# Enums'
-    include: '# Includes'
-    module: '# Modules'
-    scope: '# Scopes'
-    validation: '# Validations'
 
+  # specify the comments that must appear above each group of model elements
+  required_comments:
+    association: '## Relationships ##'
+    attribute: '## Attributes ##'
+    callback: '## Callbacks ##'
+    constant: '## Constants ##'
+    enum: '## Enums ##'
+    include: '## Includes ##'
+    module: '## Modules ##'
+    scope: '## Scopes ##'
+    validation: '## Validations ##'
 ```
 
+Supported model elements:
+
+
+| Config key      | Description (when not obvious)             |
+|-----------------|--------------------------------------------|
+| association     |                                            |
+| attribute       | `attr_reader` and friends                  |
+| callback        | `after_save` et al.                        |
+| class_method    |                                            |
+| constant        |                                            |
+| constructor     |                                            |
+| enum            |                                            |
+| include         |                                            |
+| instance_method |                                            |
+| misc            | This is a configurable set of method calls |
+| module          | Any `module Foo; ...; end` declarations    |
+| scope           | Any `scope` or `default_scope` calls       |
+| validation      |                                            |
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/dark_finger/version.rb

@@ -1,3 +1,3 @@
 module DarkFinger
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/rubocop/cop/dark_finger/active_model_node_decorator.rb

@@ -60,6 +60,10 @@ module RuboCop
           end
         end
 
+        def private_declaration?
+          method_name == :private && receiver.nil?
+        end
+
         private
 
         def nested_in_with_options?

data/lib/rubocop/cop/dark_finger/model_structure.rb

@@ -114,10 +114,16 @@ module RuboCop
 
         def process_node(node, seen_element: nil)
           return if @order_violation_reported
+          return if @seen_private_declaration
 
           node = ActiveModelNodeDecorator.new(node, misc_method_names: misc_method_names)
-          seen_element ||= node.node_type
 
+          if node.private_declaration?
+            @seen_private_declaration = true
+            return
+          end
+
+          seen_element ||= node.node_type
           return unless seen_element
 
           return if node.ignore_due_to_nesting?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dark_finger
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Professor Wang Matrix PhD
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-06 00:00:00.000000000 Z
+date: 2018-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dark_finger.jpg"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: ActiveModel layout cop for Rubocop