dark_finger 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06f1588f5fdba7fd43a67007cd3c4639b7354fd2ffd087c1e0c8bd08e50354e8
-  data.tar.gz: 7953b82963fb8e05b7399d3da7f2128bd6b0f7533137ca396ceac7a0fd209dcb
+  metadata.gz: 23fb62829315ff2c6ee77ff2d0731948250480c1bdf23abcb97efb85c23139b7
+  data.tar.gz: 9959e4a1995a033feab1361ee74b32a3a948767654bb81fce6687d76f40c1fdf
 SHA512:
-  metadata.gz: d29b4d1db2264e116e727558943b4d02a07db7adfc8ce909ec44be254a9981414c851a8fb88db291a2312645c1ff358dd8327599188a1bcc00e6a3bfcca1bc8b
-  data.tar.gz: a0e8ee91d508ba696a3898350ede3b205f08c496bc780102468fa15b4496afe26b5f645eb2abab6ddd22777beb7b8c16b67b2004b96c69af960c60b6109ccf1e
+  metadata.gz: 30d0f1666e440e035521415e3be596880725f286b2fbbd49fc342c4c34630ddc8ea3c4574d532c8118707c02a6edc8d4394275aff3c333feea4a4e91446edb99
+  data.tar.gz: 61e46f1213ff59c53de7ae8fad863a68d1c4e7f9f307a3392058ab1b5409d0a4fb2f8cab881f27012667ac5332fb729916594277129b3175f934db86a4a21087

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 tags
+vendor/

data/README.md

@@ -1,68 +1,13 @@
 ![Dark Finger](.github/dark_finger.jpg "Dark Finger")
 
-A Rubocop extension to check the layout of ActiveModel files.
+A Rubocop extension containing two cops:
 
-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.
+1. [Model Structure](docs/model_structure.md). Keep those "macro" methods at the top
+   of your model files clean and consistent across the project.
 
-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
-
-```
+2. [Migration Constants](docs/migration_constants.md). Prevent a common source of
+   migration breakage - dependencies on things that are likely to change by the
+   time the migration is actually run.
 
 ## Installation
 
@@ -80,88 +25,9 @@ Or install it yourself as:
 
     $ gem install dark_finger
 
-## Usage and Configuration
-
-Install the gem. Then, in your `.rubycop.yml` file, require `dark_finger` and
-add your desired config.
-
-For example:
-
-```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
-    - enum
-    - constant
-    - association
-    - validation
-    - scope
-    - attributes
-    - callback
-    - misc
-    - constructor
-    - class_method
-    - instance_method
-
-  # 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 ##'
-    misc: '## Misc ##'
-    module: '## Modules ##'
-    scope: '## Scopes ##'
-    validation: '## Validations ##'
-
-  # specify the methods that are categorized as "misc"
-  misc_method_names:
-    - acts_as_list
-    - acts_as_taggable
-    - friendly_id
-    - serialize
-    - workflow
-```
-
-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      |                                            |
-
-
-Any model elements that are not included in "required order" will be ignored.
+## Usage
 
-Dark Finger ignores everything that appears after `private`. This may change in
-future, but for now we have just agreed that anything goes in the private
-section of our models.
+See the guides for each of the Cops for details.
 
 ## License
 

data/docs/migration_constants.md

@@ -0,0 +1,59 @@
+# The Migration Constants Cop
+
+In our rails migration files we don't want dependencies on, for example,
+ActiveRecord model files.
+
+This is because migration files should be "timeless" and able to run at any
+point in the future. Our model files change very frequently - and therefore
+cannot be depended on directly. We must redeclare the model inside the
+migration file.
+
+For example:
+
+```ruby
+  # BAD :'(
+  #
+  # This migration depends on `SomeModel` and `.some_scope`. When this
+  # migration is actually run, either of those things could have changed name,
+  # or perhaps `some_scope` might behave differently by then or have been
+  # deleted.
+  class FooMigration < ActiveRecord::Migration[5.1]
+    def up
+      SomeModel.some_scope.each do
+        # stuff
+      end
+    end
+  end
+
+  # GOOD :-D
+  #
+  # This migration has no external dependencies on our app. It is unlikely to
+  # break in the future as our app changes.
+  class FooMigration < ActiveRecord::Migration[5.1]
+    class SomeModel < ActiveRecord::Base
+      scope :some_scope, -> { ... }
+    end
+
+    def up
+      SomeModel.some_scope.each do
+        # stuff
+      end
+    end
+  end
+```
+
+This cop will issue warnings if a migration file depends on certain constants
+(like model files) that it doesn't declare.
+
+## Usage
+
+Install the gem and then add this to your `.rubocop.yml` file:
+
+```yaml
+# this is required
+require: dark_finger
+
+DarkFinger/MigrationConstants:
+  Include:
+    - 'db/migrate/*.rb'
+```

data/docs/model_structure.md

@@ -0,0 +1,145 @@
+# The Model Structure Cop
+
+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.
+
+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
+
+```
+
+## Usage and Configuration
+
+Install the gem. Then, in your `.rubycop.yml` file, require `dark_finger` and
+add your desired config.
+
+For example:
+
+```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
+    - enum
+    - constant
+    - association
+    - validation
+    - scope
+    - attributes
+    - callback
+    - misc
+    - constructor
+    - class_method
+    - instance_method
+
+  # 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 ##'
+    misc: '## Misc ##'
+    module: '## Modules ##'
+    scope: '## Scopes ##'
+    validation: '## Validations ##'
+
+  # specify the methods that are categorized as "misc"
+  misc_method_names:
+    - acts_as_list
+    - acts_as_taggable
+    - friendly_id
+    - serialize
+    - workflow
+```
+
+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      |                                            |
+
+
+Any model elements that are not included in "required order" will be ignored.
+
+Dark Finger ignores everything that appears after `private`. This may change in
+future, but for now we have just agreed that anything goes in the private
+section of our models.

data/lib/dark_finger/version.rb

@@ -1,3 +1,3 @@
 module DarkFinger
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

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

@@ -1,3 +1,5 @@
+require 'delegate'
+
 module RuboCop
   module Cop
     module DarkFinger
@@ -61,7 +63,8 @@ module RuboCop
         end
 
         def private_declaration?
-          method_name == :private && receiver.nil?
+          # need to check respond_to since this may not be called only "on_send"
+          respond_to?(:method_name) && method_name == :private && receiver.nil?
         end
 
         private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dark_finger
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Professor Wang Matrix PhD
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,8 @@ files:
 - bin/console
 - bin/setup
 - dark_finger.gemspec
+- docs/migration_constants.md
+- docs/model_structure.md
 - lib/dark_finger.rb
 - lib/dark_finger/version.rb
 - lib/rubocop/cop/dark_finger/active_model_node_decorator.rb