jekyll-minibundle 2.1.2 → 2.2.0

data/test/unit/environment_test.rb

@@ -4,18 +4,18 @@ require 'jekyll/minibundle/environment'
 module Jekyll::Minibundle::Test
   class EnvironmentTest < TestCase
     def test_find_site_config_returns_value_when_found
-      assert_equal 1, Environment.find_site_config(make_site(top: {leaf: 1}), [:top, :leaf], Integer)
+      assert_equal(1, Environment.find_site_config(make_site(top: {leaf: 1}), [:top, :leaf], Integer))
     end
 
     def test_find_site_config_returns_nil_when_not_found
-      assert_nil Environment.find_site_config(make_site, [:top, :leaf], Integer)
+      assert_nil(Environment.find_site_config(make_site, [:top, :leaf], Integer))
     end
 
     def test_find_site_config_raises_exception_if_found_value_is_of_unexpected_type
       err = assert_raises(RuntimeError) do
         Environment.find_site_config(make_site(top: {leaf: '1'}), [:top, :leaf], Integer)
       end
-      assert_equal 'Invalid site configuration for key top.leaf; expecting type Integer', err.to_s
+      assert_equal('Invalid site configuration for key top.leaf; expecting type Integer', err.to_s)
     end
 
     private

data/test/unit/files_test.rb

@@ -8,7 +8,7 @@ module Jekyll::Minibundle::Test
         File.write('foo', 'content')
         Files.copy_p('foo', 'bar/zap')
         copied = File.read('bar/zap')
-        assert_equal 'content', copied
+        assert_equal('content', copied)
       end
     end
 
@@ -20,7 +20,7 @@ module Jekyll::Minibundle::Test
       Tempfile.open('test') do |file|
         file.close
 
-        assert_equal '', Files.read_last(file.path, 4)
+        assert_equal('', Files.read_last(file.path, 4))
       end
     end
 
@@ -29,7 +29,7 @@ module Jekyll::Minibundle::Test
         file.write("1\n2\n3\n4")
         file.close
 
-        assert_equal "\n3\n4", Files.read_last(file.path, 4)
+        assert_equal("\n3\n4", Files.read_last(file.path, 4))
       end
     end
 
@@ -38,7 +38,7 @@ module Jekyll::Minibundle::Test
         file.write("1\n2")
         file.close
 
-        assert_equal "1\n2", Files.read_last(file.path, 100)
+        assert_equal("1\n2", Files.read_last(file.path, 100))
       end
     end
 
@@ -47,13 +47,13 @@ module Jekyll::Minibundle::Test
         file.write("1\n2")
         file.close
 
-        assert_equal '', Files.read_last(file.path, 0)
-        assert_equal '', Files.read_last(file.path, -1)
+        assert_equal('', Files.read_last(file.path, 0))
+        assert_equal('', Files.read_last(file.path, -1))
       end
     end
 
     def test_strip_dot_slash_from_path_start
-      assert_equal 'path', Files.strip_dot_slash_from_path_start('./path')
+      assert_equal('path', Files.strip_dot_slash_from_path_start('./path'))
     end
   end
 end

data/test/unit/hashes_test.rb

@@ -4,28 +4,28 @@ require 'jekyll/minibundle/hashes'
 module Jekyll::Minibundle::Test
   class HashesTest < TestCase
     def test_dig_returns_value_when_found
-      assert_equal 1, Hashes.dig({top: {middle: {leaf: 1}}}, :top, :middle, :leaf)
-      assert_equal 1, Hashes.dig({top: [{}, {leaf: 1}]}, :top, 1, :leaf)
-      assert_equal 1, Hashes.dig([{}, {middle: [{}, {leaf: 1}]}], 1, :middle, 1, :leaf)
+      assert_equal(1, Hashes.dig({top: {middle: {leaf: 1}}}, :top, :middle, :leaf))
+      assert_equal(1, Hashes.dig({top: [{}, {leaf: 1}]}, :top, 1, :leaf))
+      assert_equal(1, Hashes.dig([{}, {middle: [{}, {leaf: 1}]}], 1, :middle, 1, :leaf))
     end
 
     def test_dig_returns_same_found_object
       leaf_obj = {leaf: 1}
-      assert_same leaf_obj, Hashes.dig({top: {middle: leaf_obj}}, :top, :middle)
+      assert_same(leaf_obj, Hashes.dig({top: {middle: leaf_obj}}, :top, :middle))
     end
 
     def test_dig_returns_nil_when_not_found
-      assert_nil Hashes.dig({}, :no_such)
-      assert_nil Hashes.dig([], 0)
-      assert_nil Hashes.dig({top: {}}, :top, :no_such_leaf)
-      assert_nil Hashes.dig({top: {leaf: 1}}, :top, :no_such_leaf)
-      assert_nil Hashes.dig({top: []}, :top, 0)
-      assert_nil Hashes.dig([{leaf: 1}], 0, :no_such)
+      assert_nil(Hashes.dig({}, :no_such))
+      assert_nil(Hashes.dig([], 0))
+      assert_nil(Hashes.dig({top: {}}, :top, :no_such_leaf))
+      assert_nil(Hashes.dig({top: {leaf: 1}}, :top, :no_such_leaf))
+      assert_nil(Hashes.dig({top: []}, :top, 0))
+      assert_nil(Hashes.dig([{leaf: 1}], 0, :no_such))
     end
 
     def test_dig_returns_nil_for_nil
-      assert_nil Hashes.dig(nil, :no_such_key)
-      assert_nil Hashes.dig(nil, 0)
+      assert_nil(Hashes.dig(nil, :no_such_key))
+      assert_nil(Hashes.dig(nil, 0))
     end
 
     def test_pick_returns_hash_with_specified_keys

data/test/unit/jekyll_static_file_api_test.rb

@@ -1,36 +1,82 @@
 require 'support/test_case'
+require 'support/static_file_config'
 require 'jekyll/minibundle/development_file'
 require 'jekyll/minibundle/bundle_file'
 require 'jekyll/minibundle/stamp_file'
 
 module Jekyll::Minibundle::Test
   class JekyllStaticFileAPITest < TestCase
-    def test_development_file_conforms_to_static_file_api
-      assert_empty missing_api_methods(DevelopmentFile)
+    include StaticFileConfig
+
+    def test_development_file_has_all_static_file_methods
+      assert_empty(missing_static_file_methods(DevelopmentFile))
+    end
+
+    def test_bundle_file_has_all_static_file_methods
+      assert_empty(missing_static_file_methods(BundleFile))
+    end
+
+    def test_stamp_file_has_all_static_file_methods
+      assert_empty(missing_static_file_methods(StampFile))
+    end
+
+    def test_development_file_properties_has_similar_return_types_to_static_file_properties
+      with_real_site do |site|
+        FileUtils.touch('static.txt')
+        FileUtils.touch('dev.js')
+
+        return_type_diff = diff_non_nil_response_types_of_static_file_properties(
+          make_static_file(site, 'static.txt'),
+          make_development_file(site, 'dev.js')
+        )
+
+        assert_empty(return_type_diff)
+      end
     end
 
-    def test_bundle_file_conforms_to_static_file_api
-      assert_empty missing_api_methods(BundleFile)
+    def test_bundle_file_properties_has_similar_return_types_to_static_file_properties
+      with_real_site do |site|
+        FileUtils.touch('static.txt')
+        FileUtils.touch('dependency.js')
+        FileUtils.touch('app.js')
+
+        return_type_diff = diff_non_nil_response_types_of_static_file_properties(
+          make_static_file(site, 'static.txt'),
+          make_bundle_file(site, %w{dependency app})
+        )
+
+        assert_empty(return_type_diff)
+      end
     end
 
-    def test_stamp_file_conforms_to_static_file_api
-      assert_empty missing_api_methods(StampFile)
+    def test_stamp_file_properties_has_similar_return_types_to_static_file_properties
+      with_real_site do |site|
+        FileUtils.touch('static.txt')
+        FileUtils.touch('stamp.js')
+
+        return_type_diff = diff_non_nil_response_types_of_static_file_properties(
+          make_static_file(site, 'static.txt'),
+          make_stamp_file(site, 'stamp.js')
+        )
+
+        assert_empty(return_type_diff)
+      end
     end
 
     def test_development_file_has_same_to_liquid_hash_keys_as_static_file
-      with_empty_site do |site|
+      with_real_site do |site|
         FileUtils.touch('static.txt')
         FileUtils.touch('dev.js')
 
         expected_keys = make_static_file(site, 'static.txt').to_liquid.keys.sort
         actual_keys = make_development_file(site, 'dev.js').to_liquid.keys.sort
 
-        assert_equal expected_keys, actual_keys
+        assert_equal(expected_keys, actual_keys)
       end
     end
 
     def test_bundle_file_has_same_to_liquid_hash_keys_as_static_file
-      with_empty_site do |site|
+      with_real_site do |site|
         FileUtils.touch('static.txt')
         FileUtils.touch('dependency.js')
         FileUtils.touch('app.js')
@@ -38,40 +84,65 @@ module Jekyll::Minibundle::Test
         expected_keys = make_static_file(site, 'static.txt').to_liquid.keys.sort
         actual_keys = make_bundle_file(site, %w{dependency app}).to_liquid.keys.sort
 
-        assert_equal expected_keys, actual_keys
+        assert_equal(expected_keys, actual_keys)
       end
     end
 
     def test_stamp_file_has_same_to_liquid_hash_keys_as_static_file
-      with_empty_site do |site|
+      with_real_site do |site|
         FileUtils.touch('static.txt')
         FileUtils.touch('stamp.js')
 
         expected_keys = make_static_file(site, 'static.txt').to_liquid.keys.sort
         actual_keys = make_stamp_file(site, 'stamp.js').to_liquid.keys.sort
 
-        assert_equal expected_keys, actual_keys
+        assert_equal(expected_keys, actual_keys)
       end
     end
 
     private
 
-    def missing_api_methods(clazz)
+    def missing_static_file_methods(clazz)
       Jekyll::StaticFile.public_instance_methods - clazz.public_instance_methods
     end
 
-    def with_empty_site(&block)
-      with_tmp_dir do |dir|
-        block.call(make_fake_site(dir))
+    def response_types_of_methods(file, methods)
+      methods.each_with_object({}) do |method_name, acc|
+        acc[method_name] =
+          begin
+            value = file.send(method_name)
+            {returned_type: value.class}
+          rescue => e
+            {raised: e}
+          end
+      end
+    end
+
+    def diff_non_nil_response_types_of_static_file_properties(file_master, file_conforming)
+      methods = STATIC_FILE_PROPERTIES - [:to_liquid]
+
+      master_response_types = response_types_of_methods(file_master, methods)
+      conforming_response_types = response_types_of_methods(file_conforming, methods)
+
+      master_to_compare = master_response_types.select do |_, value|
+        value.key?(:returned_type) && value.fetch(:returned_type) != NilClass
+      end
+
+      master_to_compare.to_a - conforming_response_types.to_a
+    end
+
+    def with_real_site(&block)
+      with_site_dir do |dir|
+        block.call(make_real_site(dir))
       end
     end
 
-    def make_static_file(site, filename)
+    def make_static_file(site, path)
       ::Jekyll::StaticFile.new(
         site,
-        nil,
-        nil,
-        filename
+        site.source,
+        "/#{File.dirname(path)}",
+        File.basename(path)
       )
     end
 

data/test/unit/mini_bundle_block_test.rb

@@ -6,11 +6,46 @@ module Jekyll::Minibundle::Test
   class MiniBundleBlockTest < TestCase
     include FixtureConfig
 
+    def setup
+      AssetFileRegistry.clear_all
+    end
+
     def test_raise_exception_if_no_type_argument
       err = assert_raises(ArgumentError) do
         Liquid::Template.parse('{% minibundle %} {% endminibundle %}')
       end
-      assert_equal "No asset type for minibundle block; pass value such as 'css' or 'js' as the argument", err.to_s
+      assert_equal("Missing asset type for minibundle block; pass value such as 'css' or 'js' as the argument", err.to_s)
+    end
+
+    def test_raise_exception_if_missing_block_contents
+      rendered = render_template(<<-END)
+{% minibundle css %}
+
+{% endminibundle %}
+        END
+      expected = "Liquid error: Missing configuration for minibundle block; pass configuration in YAML syntax\n"
+      assert_equal(expected, rendered)
+    end
+
+    def test_raise_exception_if_invalid_block_contents_syntax
+      rendered = render_template(<<-END)
+{% minibundle css %}
+}
+{% endminibundle %}
+        END
+      expected =
+        'Liquid error: Failed parsing minibundle block contents syntax as YAML: "}". ' \
+        "Cause: (<unknown>): did not find expected node content while parsing a block node at line 2 column 1\n"
+      assert_equal(expected, rendered)
+    end
+
+    def test_raise_exception_if_unsupported_block_contents_type
+      rendered = render_template(<<-END)
+{% minibundle css %}
+str
+{% endminibundle %}
+        END
+      assert_equal("Liquid error: Unsupported minibundle block contents type (String), only Hash is supported: \nstr\n\n", rendered)
     end
 
     [
@@ -29,6 +64,16 @@ module Jekyll::Minibundle::Test
         baseurl_config:     'baseurl: /',
         expected_asset_url: "/#{CSS_BUNDLE_DESTINATION_FINGERPRINT_PATH}"
       },
+      {
+        description:        'dot_baseurl_results_in_asset_url_without_baseurl',
+        baseurl_config:     'baseurl: .',
+        expected_asset_url: CSS_BUNDLE_DESTINATION_FINGERPRINT_PATH
+      },
+      {
+        description:        'dot_slash_baseurl_results_in_asset_url_without_baseurl',
+        baseurl_config:     'baseurl: ./',
+        expected_asset_url: CSS_BUNDLE_DESTINATION_FINGERPRINT_PATH
+      },
       {
         description:        'slash_root_baseurl_results_in_asset_url_with_baseurl',
         baseurl_config:     'baseurl: /root',
@@ -41,9 +86,7 @@ module Jekyll::Minibundle::Test
       }
     ].each do |spec|
       define_method :"test_normalizing_baseurl_with_#{spec.fetch(:description)}" do
-        AssetFileRegistry.clear_all
-
-        template = Liquid::Template.parse(<<-END)
+        actual_output = render_template(<<-END)
 {% minibundle css %}
 source_dir: _assets/styles
 destination_path: assets/site
@@ -55,14 +98,21 @@ minifier_cmd: #{minifier_cmd_to_remove_comments}
 {% endminibundle %}
         END
 
-        actual_output = nil
-        capture_io do
-          actual_output = template.render({}, registers: {site: make_fake_site(site_fixture_path)})
-        end
         expected_output = %{<link rel="stylesheet" href="#{spec.fetch(:expected_asset_url)}">\n}
 
-        assert_equal expected_output, actual_output
+        assert_equal(expected_output, actual_output)
+      end
+    end
+
+    private
+
+    def render_template(template)
+      compiled = Liquid::Template.parse(template)
+      rendered = nil
+      capture_io do
+        rendered = compiled.render({}, registers: {site: make_fake_site(site_fixture_path)})
       end
+      rendered
     end
   end
 end

data/test/unit/mini_stamp_tag_test.rb

@@ -6,26 +6,57 @@ module Jekyll::Minibundle::Test
   class MiniStampTagTest < TestCase
     include FixtureConfig
 
-    def test_raise_exception_if_no_asset_source_argument
+    def test_raise_exception_if_argument_is_missing
       err = assert_raises(ArgumentError) do
         Liquid::Template.parse('{% ministamp %}')
       end
-      assert_equal "No asset source for ministamp tag; pass value such as '_assets/site.css' as the first argument", err.to_s
+      assert_equal('Missing asset source and destination paths for ministamp tag; specify value such as "_assets/source.css assets/destination.css" as the argument', err.to_s)
     end
 
-    def test_raise_exception_if_no_asset_destination_argument
+    def test_raise_exception_if_asset_destination_is_missing_in_string_argument_type
       err = assert_raises(ArgumentError) do
         Liquid::Template.parse('{% ministamp /_assets/site.css %}')
       end
-      assert_equal "No asset destination for ministamp tag; pass value such as 'assets/site.css' as the second argument", err.to_s
+      assert_equal('Missing asset destination path for ministamp tag; specify value such as "assets/destination.css" after asset source path argument, separated with a space', err.to_s)
     end
 
-    def test_ignore_rest_arguments
+    def test_ignores_arguments_after_asset_destination_in_string_argument_type
       AssetFileRegistry.clear_all
       output = Liquid::Template
                .parse("{% ministamp #{STAMP_SOURCE_PATH} #{STAMP_DESTINATION_PATH} rest %}")
                .render({}, registers: {site: make_fake_site(site_fixture_path)})
-      assert_equal STAMP_DESTINATION_FINGERPRINT_PATH, output
+      assert_equal(STAMP_DESTINATION_FINGERPRINT_PATH, output)
+    end
+
+    def test_raise_exception_if_invalid_arguments_syntax
+      err = assert_raises(ArgumentError) do
+        Liquid::Template.parse('{% ministamp source_path: src, destination_path: dst %}')
+      end
+      expected =
+        'Failed parsing ministamp tag argument syntax as YAML: "source_path: src, destination_path: dst". ' \
+        'Cause: (<unknown>): mapping values are not allowed in this context at line 1 column 35'
+      assert_equal(expected, err.to_s)
+    end
+
+    def test_raise_exception_if_unsupported_argument_type
+      err = assert_raises(ArgumentError) do
+        Liquid::Template.parse("{% ministamp ['source_path', 'src', 'destination_path', 'dst'] %}")
+      end
+      assert_equal("Unsupported ministamp tag argument type (Array), only String and Hash are supported: ['source_path', 'src', 'destination_path', 'dst']", err.to_s)
+    end
+
+    def test_raise_exception_if_asset_source_is_missing_in_hash_argument_type
+      err = assert_raises(ArgumentError) do
+        Liquid::Template.parse('{% ministamp {} %}')
+      end
+      assert_equal('Missing asset source path for ministamp tag; specify Hash entry such as "source_path: _assets/site.css"', err.to_s)
+    end
+
+    def test_raise_exception_if_asset_destination_is_missing_in_hash_argument_type
+      err = assert_raises(ArgumentError) do
+        Liquid::Template.parse('{% ministamp { source_path: src } %}')
+      end
+      assert_equal('Missing asset destination path for ministamp tag; specify Hash entry such as "destination_path: assets/site.css"', err.to_s)
     end
   end
 end