dark_finger 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6c89d85d00daa4de08f8ff85f9beb0e6a5bcd29
-  data.tar.gz: e969f72b56a52533992b579bd16944e3da275c85
+  metadata.gz: 2c5b4a2b9fd64fc712fe87e8217705c9fc10fb37
+  data.tar.gz: 01cf3213671f4e9a18ad2e355b549dc5ee38ab06
 SHA512:
-  metadata.gz: a72344c208f7cf1064a75054a384e8e7a11c1eb02fa8d9835741dbdc30c623b7bb7da614c60ab43122dd3c00155384068ead03b2349b8533c94ead24cc63a521
-  data.tar.gz: b9e7340a802adb0e5b2bd05cbe741685859e823f85595ef2688197d91b0deed505f25b6ccafd207712c422617004af644f7f4a807b576c7f92250e1b88b9a4bf
+  metadata.gz: 256aea1e41241022db13ec4c7f7dabdcd7eeeb878a96282833ab63b679c0411c4d8db2dd193116847c8d42d6f96ebf78c14c4ff152f46d93d01137f8bf917f10
+  data.tar.gz: 5a74ed3a93cbdb4951fa3b98acb9b7a4d37581452c04fc651009298ff0b3011abae28bf87915c80b6fdb3acc2bc6eaab981dbbdd93067f621fd3f4a3dff0b46a

data/lib/dark_finger/version.rb

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

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

@@ -4,6 +4,8 @@ module RuboCop
   module Cop
     module DarkFinger
       class ModelStructure < ::RuboCop::Cop::Cop
+        class InvalidConfigError < StandardError; end
+
         ASSOCIATION = :association
         ATTRIBUTES = :attribute
         CALLBACK = :callback
@@ -18,6 +20,22 @@ module RuboCop
         SCOPE = :scope
         VALIDATION = :validation
 
+        KNOWN_ELEMENTS = [
+          ASSOCIATION,
+          ATTRIBUTES,
+          CALLBACK,
+          CLASS_METHOD,
+          CONSTANT,
+          CONSTRUCTOR,
+          ENUM,
+          INCLUDE,
+          INSTANCE_METHOD,
+          MISC,
+          MODULE,
+          SCOPE,
+          VALIDATION,
+        ]
+
         DEFAULT_REQUIRED_ORDER = [
           MODULE,
           INCLUDE,
@@ -61,6 +79,8 @@ module RuboCop
           @required_order.map!(&:to_sym)
           @required_comments = Hash[ @required_comments.map {|k,v| [k.to_sym, v]} ]
           @misc_method_names.map!(&:to_sym)
+
+          validate_config!
         end
 
         def on_send(node)
@@ -132,13 +152,17 @@ module RuboCop
         def detect_order_violation(node)
           if order_violation_detected?
             @order_violation_reported = true
-            add_offense(
-              node,
-              message: "Model elements must appear in order: \n\n* #{required_order.join("\n* ")}\n".freeze
-            )
+            message = "Model elements must appear in order:#{to_bullet_list(required_order)}\n"
+            message << "Observed order:#{to_bullet_list(class_elements_seen)}"
+
+            add_offense(node, message: message)
           end
         end
 
+        def to_bullet_list(array)
+          "\n* #{array.join("\n* ")}\n"
+        end
+
         def order_violation_detected?
           required_order_for_elements_seen != class_elements_seen
         end
@@ -148,6 +172,20 @@ module RuboCop
             required_order.index(class_elem_1) <=> required_order.index(class_elem_2)
           end
         end
+
+        def validate_config!
+          required_order.each do |i|
+            if !KNOWN_ELEMENTS.include?(i)
+              raise(InvalidConfigError, "Unknown 'required_order' model element: #{i}")
+            end
+          end
+
+          required_comments.keys.each do |i|
+            if !KNOWN_ELEMENTS.include?(i)
+              raise(InvalidConfigError, "Unknown 'required_comments' model element: #{i}")
+            end
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dark_finger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Professor Wang Matrix PhD