Add Excluded property to the rule

spec/ameba/base_spec.cr

@@ -17,6 +17,10 @@ module Ameba::Rule
       it "has a description property" do
         subject.description.should_not be_nil
       end
+
+      it "has excluded property" do
+        subject.excluded.should be_nil
+      end
     end
 
     describe "when a rule does not have defined properties" do

spec/ameba/config_spec.cr

@@ -46,5 +46,24 @@ module Ameba
         config.formatter.should eq formatter
       end
     end
+
+    describe "#update_rule" do
+      config = Config.load config_sample
+
+      it "updates enabled property" do
+        name = DummyRule.class_name
+        config.update_rule name, enabled: false
+        rule = config.rules.find(&.name.== name).not_nil!
+        rule.enabled.should be_false
+      end
+
+      it "updates excluded property" do
+        name = DummyRule.class_name
+        excluded = %w(spec/source.cr)
+        config.update_rule name, excluded: excluded
+        rule = config.rules.find(&.name.== name).not_nil!
+        rule.excluded.should eq excluded
+      end
+    end
   end
 end

spec/ameba/formatter/todo_formatter_spec.cr

@@ -1,43 +1,54 @@
 require "../../spec_helper"
 
 module Ameba
-  private def create_todo(formatter)
-    s = Source.new "a = 1"
+  private def create_todo
+    file = IO::Memory.new
+    formatter = Formatter::TODOFormatter.new IO::Memory.new, file
+
+    s = Source.new "a = 1", "source.cr"
     s.error DummyRule.new, s.location(1, 2), "message"
+
     formatter.finished [s]
+    file.to_s
   end
 
   describe Formatter::TODOFormatter do
-    file = IO::Memory.new
-    subject = Formatter::TODOFormatter.new IO::Memory.new, file
-
-    context "problems not reported" do
+    context "problems not found" do
       it "does not create todo" do
-        subject.finished [Source.new ""]
+        file = IO::Memory.new
+        formatter = Formatter::TODOFormatter.new IO::Memory.new, file
+        formatter.finished [Source.new ""]
         file.to_s.empty?.should be_true
       end
     end
 
-    context "problems reported" do
-      it "creates a todo with header" do
-        create_todo subject
-        file.to_s.should contain "# This configuration file was generated by"
-        file.to_s.should contain "Ameba version #{VERSION}"
+    context "problems found" do
+      it "creates a valid YAML document" do
+        YAML.parse(create_todo).should_not be_nil
       end
 
-      it "creates a todo with rule name" do
-        create_todo subject
-        file.to_s.should contain "DummyRule"
+      it "creates a todo with header" do
+        create_todo.should contain "# This configuration file was generated by"
+      end
+
+      it "creates a todo with version" do
+        create_todo.should contain "Ameba version #{VERSION}"
+      end
+
+      it "creates a todo with a rule name" do
+        create_todo.should contain "DummyRule"
       end
 
       it "creates a todo with problems count" do
-        create_todo subject
-        file.to_s.should contain "Problems found: 1"
+        create_todo.should contain "Problems found: 1"
       end
 
-      it "creates a valid YAML document" do
-        create_todo subject
-        YAML.parse(file.to_s).should_not be_nil
+      it "creates a todo with run details" do
+        create_todo.should contain "Run `ameba --only #{DummyRule.class_name}`"
+      end
+
+      it "excludes source from this rule" do
+        create_todo.should contain "Excluded:\n  - source.cr"
       end
     end
   end

spec/ameba/runner_spec.cr

@@ -6,6 +6,8 @@ module Ameba
     config.formatter = formatter
     config.files = files
 
+    config.update_rule ErrorRule.class_name, enabled: false
+
     Runner.new(config)
   end
 
@@ -36,6 +38,19 @@ module Ameba
         runner(formatter: formatter).run
         formatter.finished_source.should_not be_nil
       end
+
+      it "skips rule check if source is excluded" do
+        path = "source.cr"
+        source = Source.new "", path
+
+        rules = ([] of Rule::Base).tap do |rules|
+          rule = ErrorRule.new
+          rule.excluded = [path]
+          rules << rule
+        end
+
+        Runner.new(rules, [source], formatter).run.success?.should be_true
+      end
     end
 
     describe "#success?" do