shard-ameba/spec/ameba/config_spec.cr
2023-08-05 19:28:58 +01:00

236 lines
6.4 KiB
Crystal

require "../spec_helper"
module Ameba
describe Config do
config_sample = "spec/fixtures/config.yml"
it "should have a list of available formatters" do
Config::AVAILABLE_FORMATTERS.should_not be_nil
end
describe ".new" do
context "when config is empty" do
it "loads default globs" do
yml = YAML.parse "{}"
config = Config.new(yml)
config.globs.should eq ["**/*.cr"]
end
it "sets !lib as a default glob when there are .cr files in lib" do
File.touch "lib/shard.cr"
yml = YAML.parse "{}"
config = Config.new(yml)
config.globs.should eq ["**/*.cr", "!lib"]
ensure
File.delete "lib/shard.cr"
end
end
it "initializes globs as string" do
yml = YAML.parse <<-CONFIG
---
Globs: src/*.cr
CONFIG
config = Config.new(yml)
config.globs.should eq %w(src/*.cr)
end
it "initializes globs as array" do
yml = YAML.parse <<-CONFIG
---
Globs:
- "src/*.cr"
- "!spec"
CONFIG
config = Config.new(yml)
config.globs.should eq %w(src/*.cr !spec)
end
it "raises if Globs has a wrong type" do
yml = YAML.parse <<-CONFIG
---
Globs: 100
CONFIG
expect_raises(Exception, "Incorrect 'Globs' section in a config file") do
Config.new(yml)
end
end
it "initializes excluded as string" do
yml = YAML.parse <<-CONFIG
---
Excluded: spec
CONFIG
config = Config.new(yml)
config.excluded.should eq %w(spec)
end
it "initializes excluded as array" do
yml = YAML.parse <<-CONFIG
---
Excluded:
- spec
- lib/*.cr
CONFIG
config = Config.new(yml)
config.excluded.should eq %w(spec lib/*.cr)
end
it "raises if Excluded has a wrong type" do
yml = YAML.parse <<-CONFIG
---
Excluded: true
CONFIG
expect_raises(Exception, "Incorrect 'Excluded' section in a config file") do
Config.new(yml)
end
end
end
describe ".load" do
it "loads custom config" do
config = Config.load config_sample
config.should_not be_nil
config.globs.should_not be_nil
config.formatter.should_not be_nil
end
it "raises when custom config file doesn't exist" do
expect_raises(Exception, "Unable to load config file: Config file does not exist foo.yml") do
Config.load "foo.yml"
end
end
it "loads default config" do
config = Config.load
config.should_not be_nil
config.globs.should_not be_nil
config.formatter.should_not be_nil
end
end
describe "#globs, #globs=" do
config = Config.load config_sample
it "holds source globs" do
config.globs.should eq ["**/*.cr"]
end
it "allows to set globs" do
config.globs = ["file.cr"]
config.globs.should eq ["file.cr"]
end
end
describe "#excluded, #excluded=" do
config = Config.load config_sample
it "defaults to empty array" do
config.excluded.should be_empty
end
it "allows to set excluded" do
config.excluded = ["spec"]
config.excluded.should eq ["spec"]
end
end
describe "#sources" do
config = Config.load config_sample
it "returns list of sources" do
config.sources.size.should be > 0
config.sources.first.should be_a Source
config.sources.any?(&.fullpath.==(__FILE__)).should be_true
end
it "returns a list of sources matching globs" do
config.globs = %w(**/config_spec.cr)
config.sources.size.should eq(1)
end
it "returns a list of sources excluding 'Excluded'" do
config.excluded = %w(**/config_spec.cr)
config.sources.any?(&.fullpath.==(__FILE__)).should be_false
end
end
describe "#formatter, formatter=" do
config = Config.load config_sample
formatter = DummyFormatter.new
it "contains default formatter" do
config.formatter.should_not be_nil
end
it "allows to set formatter" do
config.formatter = formatter
config.formatter.should eq formatter
end
it "allows to set formatter using a name" do
config.formatter = :progress
config.formatter.should_not be_nil
end
it "raises an error if not available formatter is set" do
expect_raises(Exception) do
config.formatter = :no_such_formatter
end
end
end
describe "#update_rule" do
config = Config.load config_sample
it "updates enabled property" do
name = DummyRule.rule_name
config.update_rule name, enabled: false
rule = config.rules.find!(&.name.== name)
rule.enabled?.should be_false
end
it "updates excluded property" do
name = DummyRule.rule_name
excluded = %w(spec/source.cr)
config.update_rule name, excluded: excluded
rule = config.rules.find!(&.name.== name)
rule.excluded.should eq excluded
end
end
describe "#update_rules" do
config = Config.load config_sample
it "updates multiple rules by enabled property" do
name = DummyRule.rule_name
config.update_rules [name], enabled: false
rule = config.rules.find!(&.name.== name)
rule.enabled?.should be_false
end
it "updates multiple rules by excluded property" do
name = DummyRule.rule_name
excluded = %w(spec/source.cr)
config.update_rules [name], excluded: excluded
rule = config.rules.find!(&.name.== name)
rule.excluded.should eq excluded
end
it "updates a group of rules by enabled property" do
group = DummyRule.group_name
config.update_rules [group], enabled: false
rule = config.rules.find!(&.name.== DummyRule.rule_name)
rule.enabled?.should be_false
end
it "updates a group by excluded property" do
name = DummyRule.group_name
excluded = %w(spec/source.cr)
config.update_rules [name], excluded: excluded
rule = config.rules.find!(&.name.== DummyRule.rule_name)
rule.excluded.should eq excluded
end
end
end
end