dark_finger 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0962a291b4b5701f5523c84ecbd4865afe91953e5a40ce3c3467a92d31dfba1a'
-  data.tar.gz: b6bbe7abfa4d16caca2ec60a3090435d4498db374ec2e0bd451608ccaa747ee8
+  metadata.gz: 06f1588f5fdba7fd43a67007cd3c4639b7354fd2ffd087c1e0c8bd08e50354e8
+  data.tar.gz: 7953b82963fb8e05b7399d3da7f2128bd6b0f7533137ca396ceac7a0fd209dcb
 SHA512:
-  metadata.gz: 5f60cc6dd2325e4a9c758170250b5daadfb3bec991bdeab141cd6fc864d4df4300430d94bffc8bbaac9abf3b4c1e7e7de9c7037f7124f815d2343e6f0b74ac31
-  data.tar.gz: 57732e831e03a50c242bbaf05661879b10781cf30bf389f374e1bca173889c06862a6a17cf40a43b3701806613561cb63bbcc9fe21bed69d20c9c02e6a8698b9
+  metadata.gz: d29b4d1db2264e116e727558943b4d02a07db7adfc8ce909ec44be254a9981414c851a8fb88db291a2312645c1ff358dd8327599188a1bcc00e6a3bfcca1bc8b
+  data.tar.gz: a0e8ee91d508ba696a3898350ede3b205f08c496bc780102468fa15b4496afe26b5f645eb2abab6ddd22777beb7b8c16b67b2004b96c69af960c60b6109ccf1e

data/README.md

@@ -123,9 +123,18 @@ DarkFinger/ModelStructure:
     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:
@@ -148,6 +157,12 @@ Supported model elements:
 | 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.
+
 ## 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.4.0"
+  VERSION = "0.5.0"
 end

data/lib/dark_finger.rb

@@ -2,3 +2,5 @@ require 'rubocop'
 require "dark_finger/version"
 require File.dirname(__FILE__) + "/rubocop/cop/dark_finger/model_structure"
 require File.dirname(__FILE__) + "/rubocop/cop/dark_finger/active_model_node_decorator"
+require File.dirname(__FILE__) + "/rubocop/cop/dark_finger/migration_constants"
+require File.dirname(__FILE__) + "/rubocop/cop/dark_finger/module_ancestor_chain_extractor"

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

@@ -0,0 +1,64 @@
+module RuboCop
+  module Cop
+    module DarkFinger
+      class MigrationConstants < ::RuboCop::Cop::Cop
+        DEFAULT_ALLOWED_CONSTANTS = [
+          'Migration',
+          'ActiveRecord',
+          'ActiveRecord::Migration',
+          'ActiveRecord::Base'
+        ]
+
+        attr_reader :allowed_constants
+
+        def initialize(*args)
+          super
+          @allowed_constants = DEFAULT_ALLOWED_CONSTANTS + allowed_top_level_constants
+        end
+
+        def on_const(node)
+          return if allowed_constants.include?(node.const_name)
+          add_offense(node, message: %Q(Undeclared constant: "#{node.const_name}"))
+        end
+
+        def on_casgn(node)
+          add_allowed_constant(node.children[1])
+        end
+
+        def on_class(node)
+          add_allowed_constant(node.children.first.const_name)
+          add_module_parent_chain_for(node)
+        end
+
+        def on_module(node)
+          add_allowed_constant(node.children.first.const_name)
+          add_module_parent_chain_for(node)
+        end
+
+        private
+
+        def allowed_top_level_constants
+          Module.constants.map(&:to_s) - top_level_model_classes_and_containing_modules
+        end
+
+        def top_level_model_classes_and_containing_modules
+          return [] unless Object.const_defined?('ActiveRecord::Base')
+
+          ::ActiveRecord::Base.descendants.map do |klass|
+            klass.name.sub(/::.*/, '').to_s
+          end.uniq
+        end
+
+        def add_allowed_constant(constant)
+          @allowed_constants << constant.to_s
+          @allowed_constants.uniq!
+        end
+
+        def add_module_parent_chain_for(node)
+          chain = ModuleAncestorChainExtractor.new(node).perform
+          add_allowed_constant(chain)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module RuboCop
+  module Cop
+    module DarkFinger
+      class ModuleAncestorChainExtractor
+        attr_reader :node
+
+        def initialize(node)
+          @node = node
+        end
+
+        def perform
+          module_chain = [node.children.first.const_name]
+
+          current_node = node
+          while current_node.parent && current_node.parent.module_type?
+            module_chain << current_node.parent.children.first.const_name
+            current_node = current_node.parent
+          end
+
+          module_chain.reverse.join("::")
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dark_finger
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Professor Wang Matrix PhD
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-21 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,7 +103,9 @@ files:
 - lib/dark_finger.rb
 - lib/dark_finger/version.rb
 - lib/rubocop/cop/dark_finger/active_model_node_decorator.rb
+- lib/rubocop/cop/dark_finger/migration_constants.rb
 - lib/rubocop/cop/dark_finger/model_structure.rb
+- lib/rubocop/cop/dark_finger/module_ancestor_chain_extractor.rb
 homepage: https://github.com/the-suBLAM-executive-council/dark_finger
 licenses:
 - MIT