dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rubocop: test/test_configuration.rb

This commit is contained in:
Pat Hawks 2016-05-25 21:59:23 -05:00
parent 6ef2bcb29a
commit fd75f0f7b1
1 changed files with 195 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

255
test/test_configuration.rb
View File

@ -1,7 +1,7 @@
require 'helper'
require "helper"
class TestConfiguration < JekyllUnitTest
@@test_config = {
test_config = {
"source" => new(nil).source_dir,
"destination" => dest_dir
}
@ -19,16 +19,31 @@ class TestConfiguration < JekyllUnitTest
should "fix common mistakes" do
result = Configuration.from({ "paginate" => 0 })
assert_nil result["paginate"], "Expected 'paginate' to be corrected to 'nil', but was #{result["paginate"].inspect}"
assert_nil(
result["paginate"],
"Expected 'paginate' to be corrected to 'nil', " \
"but was #{result["paginate"].inspect}"
)
end
should "add default collections" do
result = Configuration.from({})
assert_equal result["collections"], {"posts" => {"output" => true, "permalink" => "/:categories/:year/:month/:day/:title:output_ext"}}
assert_equal(
result["collections"],
{
"posts" => {
"output" => true,
"permalink" => "/:categories/:year/:month/:day/:title:output_ext"
}
}
)
end
should "NOT backwards-compatibilize" do
assert Configuration.from("watch" => true)["watch"], "Expected the 'watch' key to not be removed."
assert(
Configuration.from("watch" => true)["watch"],
"Expected the 'watch' key to not be removed."
)
end
end
@ -39,21 +54,35 @@ class TestConfiguration < JekyllUnitTest
end
should "turn an array into a hash" do
result = Configuration[{"collections" => %w{methods}}].add_default_collections
result = Configuration[{ "collections" => %w(methods) }].add_default_collections
assert_instance_of Hash, result["collections"]
assert_equal result["collections"], {"posts" => {"output" => true}, "methods" => {}}
assert_equal(
result["collections"],
{ "posts" => { "output" => true }, "methods" => {} }
)
end
should "only assign collections.posts.permalink if a permalink is specified" do
result = Configuration[{"permalink" => "pretty", "collections" => {}}].add_default_collections
assert_equal result["collections"], {"posts" => {"output" => true, "permalink" => "/:categories/:year/:month/:day/:title/"}}
result = Configuration[{ "permalink" => "pretty", "collections" => {} }]
.add_default_collections
assert_equal(
result["collections"],
{
"posts" => {
"output" => true,
"permalink" => "/:categories/:year/:month/:day/:title/"
}
}
)
result = Configuration[{"permalink" => nil, "collections" => {}}].add_default_collections
result = Configuration[{ "permalink" => nil, "collections" => {} }]
.add_default_collections
assert_equal result["collections"], { "posts" => { "output" => true } }
end
should "forces posts to output" do
result = Configuration[{"collections" => {"posts" => {"output" => false}}}].add_default_collections
result = Configuration[{ "collections" => { "posts" => { "output" => false } } }]
.add_default_collections
assert_equal result["collections"]["posts"]["output"], true
end
end
@ -61,18 +90,18 @@ class TestConfiguration < JekyllUnitTest
context "#stringify_keys" do
setup do
@mixed_keys = Configuration[{
'markdown' => 'kramdown',
:permalink => 'date',
'baseurl' => '/',
:include => ['.htaccess'],
:source => './'
"markdown" => "kramdown",
:permalink => "date",
"baseurl" => "/",
:include => [".htaccess"],
:source => "./"
}]
@string_keys = Configuration[{
'markdown' => 'kramdown',
'permalink' => 'date',
'baseurl' => '/',
'include' => ['.htaccess'],
'source' => './'
"markdown" => "kramdown",
"permalink" => "date",
"baseurl" => "/",
"include" => [".htaccess"],
"source" => "./"
}]
end
should "stringify symbol keys" do
@ -87,7 +116,9 @@ class TestConfiguration < JekyllUnitTest
@config = Configuration[{ "source" => source_dir }]
@no_override = {}
@one_config_file = { "config" => "config.yml" }
@multiple_files = {"config" => %w[config/site.yml config/deploy.toml configuration.yml]}
@multiple_files = {
"config" => %w(config/site.yml config/deploy.toml configuration.yml)
}
end
should "always return an array" do
@ -108,22 +139,25 @@ class TestConfiguration < JekyllUnitTest
assert_equal [source_dir("_config.yml")], @config.config_files(@no_override)
end
should "return the config if given one config file" do
assert_equal %w[config.yml], @config.config_files(@one_config_file)
assert_equal %w(config.yml), @config.config_files(@one_config_file)
end
should "return an array of the config files if given many config files" do
assert_equal %w[config/site.yml config/deploy.toml configuration.yml], @config.config_files(@multiple_files)
assert_equal(
%w(config/site.yml config/deploy.toml configuration.yml),
@config.config_files(@multiple_files)
)
end
end
context "#read_config_file" do
setup do
@config = Configuration[{"source" => source_dir('empty.yml')}]
@config = Configuration[{ "source" => source_dir("empty.yml") }]
end
should "not raise an error on empty files" do
allow(SafeYAML).to receive(:load_file).with('empty.yml').and_return(false)
allow(SafeYAML).to receive(:load_file).with("empty.yml").and_return(false)
Jekyll.logger.log_level = :warn
@config.read_config_file('empty.yml')
@config.read_config_file("empty.yml")
Jekyll.logger.log_level = :info
end
end
@ -134,12 +168,15 @@ class TestConfiguration < JekyllUnitTest
end
should "continue to read config files if one is empty" do
allow(SafeYAML).to receive(:load_file).with('empty.yml').and_return(false)
allow(SafeYAML).to receive(:load_file).with('not_empty.yml').and_return({'foo' => 'bar', 'include' => '', 'exclude' => ''})
allow(SafeYAML).to receive(:load_file).with("empty.yml").and_return(false)
allow(SafeYAML)
.to receive(:load_file)
.with("not_empty.yml")
.and_return({ "foo" => "bar", "include" => "", "exclude" => "" })
Jekyll.logger.log_level = :warn
read_config = @config.read_config_files(['empty.yml', 'not_empty.yml'])
read_config = @config.read_config_files(["empty.yml", "not_empty.yml"])
Jekyll.logger.log_level = :info
assert_equal 'bar', read_config['foo']
assert_equal "bar", read_config["foo"]
end
end
context "#backwards_compatibilize" do
@ -153,7 +190,7 @@ class TestConfiguration < JekyllUnitTest
"pygments" => true,
"plugins" => true,
"layouts" => true,
"data_source" => true,
"data_source" => true
}]
end
should "unset 'auto' and 'watch'" do
@ -169,12 +206,18 @@ class TestConfiguration < JekyllUnitTest
should "transform string exclude into an array" do
assert @config.key?("exclude")
assert @config.backwards_compatibilize.key?("exclude")
assert_equal @config.backwards_compatibilize["exclude"], %w[READ-ME.md Gemfile CONTRIBUTING.hello.markdown]
assert_equal(
@config.backwards_compatibilize["exclude"],
%w(READ-ME.md Gemfile CONTRIBUTING.hello.markdown)
)
end
should "transform string include into an array" do
assert @config.key?("include")
assert @config.backwards_compatibilize.key?("include")
assert_equal @config.backwards_compatibilize["include"], %w[STOP_THE_PRESSES.txt .heloses .git]
assert_equal(
@config.backwards_compatibilize["include"],
%w(STOP_THE_PRESSES.txt .heloses .git)
)
end
should "set highlighter to pygments" do
assert @config.key?("pygments")
@ -195,62 +238,79 @@ class TestConfiguration < JekyllUnitTest
end
context "#fix_common_issues" do
setup do
@config = Proc.new do |val|
@config = proc do |val|
Configuration[{
'paginate' => val
"paginate" => val
}]
end
end
should "sets an invalid 'paginate' value to nil" do
assert_nil @config.call(0).fix_common_issues['paginate']
assert_nil @config.call(-1).fix_common_issues['paginate']
assert_nil @config.call(true).fix_common_issues['paginate']
assert_nil @config.call(0).fix_common_issues["paginate"]
assert_nil @config.call(-1).fix_common_issues["paginate"]
assert_nil @config.call(true).fix_common_issues["paginate"]
end
end
context "loading configuration" do
setup do
@path = source_dir('_config.yml')
@path = source_dir("_config.yml")
@user_config = File.join(Dir.pwd, "my_config_file.yml")
end
should "fire warning with no _config.yml" do
allow(SafeYAML).to receive(:load_file).with(@path) { raise SystemCallError, "No such file or directory - #{@path}" }
allow(SafeYAML).to receive(:load_file).with(@path) do
raise SystemCallError, "No such file or directory - #{@path}"
end
allow($stderr).to receive(:puts).with("Configuration file: none".yellow)
assert_equal site_configuration, Jekyll.configuration(@@test_config)
assert_equal site_configuration, Jekyll.configuration(test_config)
end
should "load configuration as hash" do
allow(SafeYAML).to receive(:load_file).with(@path).and_return(Hash.new)
allow(SafeYAML).to receive(:load_file).with(@path).and_return({})
allow($stdout).to receive(:puts).with("Configuration file: #{@path}")
assert_equal site_configuration, Jekyll.configuration(@@test_config)
assert_equal site_configuration, Jekyll.configuration(test_config)
end
should "fire warning with bad config" do
allow(SafeYAML).to receive(:load_file).with(@path).and_return(Array.new)
allow($stderr).to receive(:puts).and_return(("WARNING: ".rjust(20) + "Error reading configuration. Using defaults (and options).").yellow)
allow($stderr).to receive(:puts).and_return("Configuration file: (INVALID) #{@path}".yellow)
assert_equal site_configuration, Jekyll.configuration(@@test_config)
allow(SafeYAML).to receive(:load_file).with(@path).and_return([])
allow($stderr)
.to receive(:puts)
.and_return(
("WARNING: "
.rjust(20) + "Error reading configuration. Using defaults (and options).")
.yellow
)
allow($stderr)
.to receive(:puts)
.and_return("Configuration file: (INVALID) #{@path}".yellow)
assert_equal site_configuration, Jekyll.configuration(test_config)
end
should "fire warning when user-specified config file isn't there" do
allow(SafeYAML).to receive(:load_file).with(@user_config) { raise SystemCallError, "No such file or directory - #{@user_config}" }
allow($stderr).to receive(:puts).with(("Fatal: ".rjust(20) + "The configuration file '#{@user_config}' could not be found.").red)
allow(SafeYAML).to receive(:load_file).with(@user_config) do
raise SystemCallError, "No such file or directory - #{@user_config}"
end
allow($stderr)
.to receive(:puts)
.with((
"Fatal: ".rjust(20) + \
"The configuration file '#{@user_config}' could not be found."
).red)
assert_raises LoadError do
Jekyll.configuration({'config' => [@user_config]})
Jekyll.configuration({ "config" => [@user_config] })
end
end
should "not clobber YAML.load to the dismay of other libraries" do
assert_equal :foo, YAML.load(':foo')
assert_equal :foo, YAML.load(":foo")
# as opposed to: assert_equal ':foo', SafeYAML.load(':foo')
end
end
context "loading config from external file" do
setup do
@paths = {
:default => source_dir('_config.yml'),
:other => source_dir('_config.live.yml'),
:toml => source_dir('_config.dev.toml'),
:default => source_dir("_config.yml"),
:other => source_dir("_config.live.yml"),
:toml => source_dir("_config.dev.toml"),
:empty => ""
}
end
@ -258,16 +318,19 @@ class TestConfiguration < JekyllUnitTest
should "load default plus posts config if no config_file is set" do
allow(SafeYAML).to receive(:load_file).with(@paths[:default]).and_return({})
allow($stdout).to receive(:puts).with("Configuration file: #{@paths[:default]}")
assert_equal site_configuration, Jekyll.configuration(@@test_config)
assert_equal site_configuration, Jekyll.configuration(test_config)
end
should "load different config if specified" do
allow(SafeYAML).to receive(:load_file).with(@paths[:other]).and_return({"baseurl" => "http://wahoo.dev"})
allow(SafeYAML)
.to receive(:load_file)
.with(@paths[:other])
.and_return({ "baseurl" => "http://wahoo.dev" })
allow($stdout).to receive(:puts).with("Configuration file: #{@paths[:other]}")
Jekyll.configuration({ "config" => @paths[:other] })
assert_equal \
site_configuration({ "baseurl" => "http://wahoo.dev" }),
Jekyll.configuration(@@test_config.merge({ "config" => @paths[:other] }))
Jekyll.configuration(test_config.merge({ "config" => @paths[:other] }))
end
should "load default config if path passed is empty" do
@ -275,68 +338,94 @@ class TestConfiguration < JekyllUnitTest
allow($stdout).to receive(:puts).with("Configuration file: #{@paths[:default]}")
assert_equal \
site_configuration,
Jekyll.configuration(@@test_config.merge({ "config" => [@paths[:empty]] }))
Jekyll.configuration(test_config.merge({ "config" => [@paths[:empty]] }))
end
should "successfully load a TOML file" do
Jekyll.logger.log_level = :warn
assert_equal \
site_configuration({ "baseurl" => "/you-beautiful-blog-you", "title" => "My magnificent site, wut" }),
Jekyll.configuration(@@test_config.merge({ "config" => [@paths[:toml]] }))
site_configuration({ "baseurl" => "/you-beautiful-blog-you",
"title" => "My magnificent site, wut" }),
Jekyll.configuration(test_config.merge({ "config" => [@paths[:toml]] }))
Jekyll.logger.log_level = :info
end
should "load multiple config files" do
External.require_with_graceful_fail('toml')
External.require_with_graceful_fail("toml")
allow(SafeYAML).to receive(:load_file).with(@paths[:default]).and_return(Hash.new)
allow(SafeYAML).to receive(:load_file).with(@paths[:other]).and_return(Hash.new)
allow(TOML).to receive(:load_file).with(@paths[:toml]).and_return(Hash.new)
allow(SafeYAML).to receive(:load_file).with(@paths[:default]).and_return({})
allow(SafeYAML).to receive(:load_file).with(@paths[:other]).and_return({})
allow(TOML).to receive(:load_file).with(@paths[:toml]).and_return({})
allow($stdout).to receive(:puts).with("Configuration file: #{@paths[:default]}")
allow($stdout).to receive(:puts).with("Configuration file: #{@paths[:other]}")
allow($stdout).to receive(:puts).with("Configuration file: #{@paths[:toml]}")
assert_equal \
assert_equal(
site_configuration,
Jekyll.configuration(@@test_config.merge({ "config" => [@paths[:default], @paths[:other], @paths[:toml]] }))
Jekyll.configuration(
test_config.merge(
{ "config" => [@paths[:default], @paths[:other], @paths[:toml]] }
)
)
)
end
should "load multiple config files and last config should win" do
allow(SafeYAML).to receive(:load_file).with(@paths[:default]).and_return({"baseurl" => "http://example.dev"})
allow(SafeYAML).to receive(:load_file).with(@paths[:other]).and_return({"baseurl" => "http://wahoo.dev"})
allow($stdout).to receive(:puts).with("Configuration file: #{@paths[:default]}")
allow($stdout).to receive(:puts).with("Configuration file: #{@paths[:other]}")
allow(SafeYAML)
.to receive(:load_file)
.with(@paths[:default])
.and_return({ "baseurl" => "http://example.dev" })
allow(SafeYAML)
.to receive(:load_file)
.with(@paths[:other])
.and_return({ "baseurl" => "http://wahoo.dev" })
allow($stdout)
.to receive(:puts)
.with("Configuration file: #{@paths[:default]}")
allow($stdout)
.to receive(:puts)
.with("Configuration file: #{@paths[:other]}")
assert_equal \
site_configuration({ "baseurl" => "http://wahoo.dev" }),
Jekyll.configuration(@@test_config.merge({ "config" => [@paths[:default], @paths[:other]] }))
Jekyll.configuration(
test_config.merge({ "config" => [@paths[:default], @paths[:other]] })
)
end
end
context "#add_default_collections" do
should "not do anything if collections is nil" do
conf = Configuration[default_configuration].tap {|c| c['collections'] = nil }
conf = Configuration[default_configuration].tap { |c| c["collections"] = nil }
assert_equal conf.add_default_collections, conf
assert_nil conf.add_default_collections['collections']
assert_nil conf.add_default_collections["collections"]
end
should "converts collections to a hash if an array" do
conf = Configuration[default_configuration].tap {|c| c['collections'] = ['docs'] }
conf = Configuration[default_configuration].tap do |c|
c["collections"] = ["docs"]
end
assert_equal conf.add_default_collections, conf.merge({
"collections" => {
"docs" => {},
"posts" => {
"output" => true,
"permalink" => "/:categories/:year/:month/:day/:title:output_ext"
}}})
}
}
})
end
should "force collections.posts.output = true" do
conf = Configuration[default_configuration].tap {|c| c['collections'] = {'posts' => {'output' => false}} }
conf = Configuration[default_configuration].tap do |c|
c["collections"] = { "posts" => { "output" => false } }
end
assert_equal conf.add_default_collections, conf.merge({
"collections" => {
"posts" => {
"output" => true,
"permalink" => "/:categories/:year/:month/:day/:title:output_ext"
}}})
}
}
})
end
should "set collections.posts.permalink if it's not set" do
@ -346,13 +435,15 @@ class TestConfiguration < JekyllUnitTest
"posts" => {
"output" => true,
"permalink" => "/:categories/:year/:month/:day/:title:output_ext"
}}})
}
}
})
end
should "leave collections.posts.permalink alone if it is set" do
posts_permalink = "/:year/:title/"
conf = Configuration[default_configuration].tap do |c|
c['collections'] = {
c["collections"] = {
"posts" => { "permalink" => posts_permalink }
}
end
@ -361,7 +452,9 @@ class TestConfiguration < JekyllUnitTest
"posts" => {
"output" => true,
"permalink" => posts_permalink
}}})
}
}
})
end
end
end