jekyll-minibundle 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0e8eb69fc25d07f84cdd00cebe04669a4f0a09c
-  data.tar.gz: 3469c040798e5add50f205cd0327d10d8083743a
+  metadata.gz: c07644674d4019624ae3cd17463a8dc961df66ba
+  data.tar.gz: f512236902087572a1d618620ac87184f8590b28
 SHA512:
-  metadata.gz: 4953977ee09c4cdaf507b1c1f6a231e7778be1c9a84843968bd7e471baf678a3a4edf601b71d61f3b178dc63d1b72271ed291c4b23961d93790aae28175a7f1c
-  data.tar.gz: edcfeee786bbb756434e9e7576936891681060f92d90544e2cbef2367a230966c99eb289e3e3c24109e4d8f2ff2d06e5507131c727793dc099aad514815520b2
+  metadata.gz: 3886e4b0a47bfa8d9aa720c0b5630952fd876835f29b9cfe55b5df11bb726ff51f9ff91defd338e64e9b7e44687f692b069aeb246f21be126793b3f139963428
+  data.tar.gz: 320e44f066004bf6a701ea26a0bdc42a507211656d9f446ea20da84cb67b5f5c0468afe2d7b2e70ac4919a34cad2a41b773c3f6c8319faa03f7667a8abe1bb07

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.1.1 / 2017-01-14
+
+* Fix the file permissions of `minibundle` block's output file to
+  respect umask setting. Bug report from Alfonse Surigao.
+* Compatibility: conform to Jekyll 3.3's StaticFile public API
+
 # 2.1.0 / 2016-05-04
 
 * Allow attributes without values. Useful for `async` attribute, for

data/README.md

@@ -1,12 +1,12 @@
 # Jekyll Minibundle plugin
 
-A straightforward asset bundling plugin for [Jekyll][Jekyll],
-utilizing external minification tool of your choice. It provides asset
-concatenation for bundling and asset fingerprinting with MD5 digest
-for cache busting.
+A straightforward asset bundling plugin for [Jekyll][Jekyll], utilizing
+external minification tool of your choice. It provides asset
+concatenation for bundling and asset fingerprinting with MD5 digest for
+cache busting.
 
-There are no runtime dependencies, except for the minification tool
-used for bundling (fingerprinting has no dependencies).
+There are no runtime dependencies, except for the minification tool used
+for bundling (fingerprinting has no dependencies).
 
 The plugin requires Jekyll version 3.x. It is tested with Ruby MRI
 2.x. Ruby 1.8 and 1.9 are *not* supported.
@@ -20,28 +20,27 @@ option `--incremental`).
 
 ## Features
 
-There are two features: asset fingerprinting with MD5 digest over the
-contents of the asset, and asset bundling combined with the first
+There are two features: asset fingerprinting with [MD5 digest][MD5] over
+the contents of the asset, and asset bundling combined with the first
 feature.
 
 Asset bundling consists of concatenation and minification. The plugin
-implements concatenation and leaves choosing the minification tool up
-to you. [UglifyJS2][UglifyJS2] is a good and fast minifier, for
+implements concatenation and leaves choosing the minification tool up to
+you. [UglifyJS2][UglifyJS2] is a good and fast minifier, for
 example. The plugin connects to the minifier with standard unix pipe,
 feeding asset file contents to it in desired order via standard input,
 and reads the result from standard output.
 
-Why is this good? A fingerprint in asset's path is the
-[recommended way][GoogleWebFundamentalsHttpCaching] to handle caching
-of static resources, because you can allow browsers and intermediate
-proxies to cache the asset for a very long time. Calculating MD5
-digest over the contents of the asset is fast and the resulting digest
-is reasonably unique to be generated automatically.
+Why is this good? A fingerprint in asset's path is
+the [recommended way][GoogleWebFundamentalsHttpCaching] to handle
+caching of static resources, because you can allow browsers and
+intermediate proxies to cache the asset for a very long
+time. Calculating MD5 digest over the contents of the asset is fast and
+the resulting digest is reasonably unique to be generated automatically.
 
 Asset bundling is good for reducing the number of requests to the
 backend upon page load. The minification of stylesheets and JavaScript
-sources makes asset sizes smaller and thus faster to load over
-network.
+sources makes asset sizes smaller and thus faster to load over network.
 
 ## Usage
 
@@ -51,8 +50,7 @@ The plugin ships as a [RubyGem][MinibundleGem]. To install:
 $ gem install jekyll-minibundle
 ```
 
-(You should use [Bundler][GemBundler] to manage the gems in your
-project.)
+(You should use [Bundler][Bundler] to manage the gems in your project.)
 
 Then, instruct Jekyll to load the gem by adding this line to the
 [configuration file][JekyllConf] of your Jekyll site project
@@ -74,25 +72,27 @@ Jekyll's `safe` setting.
 
 ### Asset fingerprinting
 
-If you just want to have a fingerprint in your asset's path, use
-`ministamp` tag:
+If you just want to have an MD5 fingerprint in your asset's path, use
+`ministamp` [Liquid][Liquid] tag. For example:
 
 ``` html
 <link href="{{ site.baseurl }}{% ministamp _assets/site.css assets/site.css %}" rel="stylesheet" media="screen, projection">
 ```
 
-Output, when `site.baseurl` is `/`, containing the MD5 digest of the
-file in the filename:
+When it's time to render the `ministamp` tag, the plugin copies the
+source file (`_assets/site.css`, the first tag argument) to the
+specified destination path (`assets/site.css`, the second tag argument)
+in Jekyll's output directory. The filename will contain a fingerprint.
+
+Tag output, when `site.baseurl` is `/`:
 
 ``` html
 <link href="/assets/site-390be921ee0eff063817bb5ef2954300.css" rel="stylesheet" media="screen, projection">
 ```
 
-Jekyll's output directory will have the asset file at that path.
-
 This feature is useful when combined with asset generation tools
-external to Jekyll. For example, you can configure [Compass][Compass]
-to take inputs from `_assets/styles/*.scss` and to produce output to
+external to Jekyll. For example, you can configure [Sass][Sass] to take
+input files from `_assets/styles/*.scss` and to produce output to
 `_tmp/site.css`. Then, you use `ministamp` tag to copy the file with a
 fingerprint to Jekyll's output directory:
 
@@ -104,15 +104,16 @@ fingerprint to Jekyll's output directory:
 
 This is a straightforward way to bundle assets with any minification
 tool that supports reading input from STDIN and writing the output to
-STDOUT. You write the configuration for input sources directly into
-the content file where you want the markup tag for the bundle file to
-appear. The outcome will be a markup tag containing the path to the
-bundle file, and the Jekyll's output directory will have the bundle
-file at that path. The path will contain a fingerprint.
+STDOUT. You write the configuration for input sources directly into the
+content file where you want the markup tag for the bundle file to
+appear. The markup tag contains the path to the bundle file, and the
+Jekyll's output directory will have the bundle file at that path. The
+path will contain an MD5 fingerprint.
 
-Place `minibundle` block with configuration into your content file
-where you want the generated markup to appear. For example, to bundle
-a set of JavaScript sources:
+Place `minibundle` [Liquid][Liquid] block into your content file where
+you want the generated markup to appear. Write bundling configuration
+inside the block in [YAML][YAML] syntax. For example, to bundle a set of
+JavaScript sources:
 
 ``` text
 {% minibundle js %}
@@ -128,17 +129,27 @@ attributes:
 {% endminibundle %}
 ```
 
-Then, specify the command for launching your favorite minifier in `_config.yml`:
+Then, specify the command for launching your favorite minifier in
+`_config.yml`:
 
 ``` yaml
 baseurl: /
 
 minibundle:
   minifier_commands:
-    js: node_modules/.bin/uglifyjs --
+    js: node_modules/.bin/uglifyjs -
 ```
 
-Output in the content file:
+When it's time to render the `minibundle` block, the plugin launches the
+minifier and connects to it with a Unix pipe. The plugin feeds the
+contents of the asset files in `source_dir` directory as input to the
+minifier (STDIN). The feeding order is the order of the files in the
+`assets` key in the block configuration. The plugin expects the minifier
+to produce output (STDOUT) and writes it to the file at
+`destination_path` in Jekyll's output directory. The filename will
+contain a fingerprint.
+
+Block output in the content file:
 
 ``` html
 <script src="/assets/site-8e764372a0dbd296033cb2a416f064b5.js" type="text/javascript" id="my-scripts" async></script>
@@ -170,7 +181,7 @@ And then specify the minifier command in `_config.yml`:
 minibundle:
   minifier_commands:
     css: _bin/remove_whitespace
-    js: node_modules/.bin/uglifyjs --
+    js: node_modules/.bin/uglifyjs -
 ```
 
 ### Minifier command specification
@@ -183,14 +194,14 @@ You can specify minifier commands in three places:
    minibundle:
      minifier_commands:
        css: _bin/remove_whitespace
-       js: node_modules/.bin/uglifyjs --
+       js: node_modules/.bin/uglifyjs -
    ```
 
 2. as environment variables:
 
    ``` bash
    export JEKYLL_MINIBUNDLE_CMD_CSS=_bin/remove_whitespace
-   export JEKYLL_MINIBUNDLE_CMD_JS="node_modules/.bin/uglifyjs --"
+   export JEKYLL_MINIBUNDLE_CMD_JS="node_modules/.bin/uglifyjs -"
    ```
 
 3. inside the minibundle block with `minifier_cmd` setting, allowing
@@ -200,7 +211,7 @@ You can specify minifier commands in three places:
    {% minibundle js %}
    source_dir: _assets/scripts
    destination_path: assets/site
-   minifier_cmd: node_modules/.bin/uglifyjs --
+   minifier_cmd: node_modules/.bin/uglifyjs -
    assets:
      - dependency
      - app
@@ -239,9 +250,8 @@ character (`_`), consider using the following directory layout:
 
 * `_assets/` for JavaScript and CSS assets handled by the plugin that
   are in version control
-* `_tmp/` for temporary JavaScript and CSS assets handled by the
-  plugin that are not in version control (for example, Compass output
-  files)
+* `_tmp/` for temporary JavaScript and CSS assets handled by the plugin
+  that are not in version control (for example, Sass output files)
 * `assets/` for images and other assets handled by Jekyll directly
 
 See [Jekyll configuration][JekyllConf] for more about excluding files
@@ -249,11 +259,10 @@ and directories.
 
 ### Development mode
 
-The plugin has one more trick in its sleeves. If you set
-`$JEKYLL_MINIBUNDLE_MODE` environment variable to `development`, then
-the plugin will copy asset files as is to Jekyll's output directory
-and omit fingerprinting. The `destination_path` setting in
-`minibundle` block sets the destination directory for bundled
+If you set `$JEKYLL_MINIBUNDLE_MODE` environment variable to
+`development`, then the plugin will copy asset files as is to Jekyll's
+output directory and omit fingerprinting. The `destination_path` setting
+in `minibundle` block sets the destination directory for bundled
 files. This is useful in development workflow, where you need the
 filenames and line numbers of the original asset sources.
 
@@ -268,27 +277,48 @@ minibundle:
   mode: development
 ```
 
-Should both be defined, the setting from the environment variable
-wins.
+Should both be defined, the setting from the environment variable wins.
+
+### Capturing Liquid output
+
+Use Liquid's `capture` block to store output rendered inside the block
+to a variable, as a string. Then you can process the string.
+
+For example:
+
+``` html
+{% capture sitecss %}{% ministamp _assets/site.css assets/site.css %}{% endcapture %}
+<link href="{{ site.cdnbaseurl }}{{ sitecss | remove_first: "assets/"}}" rel="stylesheet" media="screen, projection">
+```
+
+Output, provided `site.cdnbaseurl` is set to `https://cdn.example.com/`:
+
+``` html
+<link href="https://cdn.example.com/site-390be921ee0eff063817bb5ef2954300.css" rel="stylesheet" media="screen, projection">
+```
 
 ## Example site
 
-See the contents of `test/fixture/site` directory.
+See the sources of [an example site][JekyllMinibundleExampleSite].
 
 ## Known caveats
 
-The plugin does not work with Jekyll's incremental rebuild feature (Jekyll
-option `--incremental`).
+The plugin does not work with Jekyll's incremental rebuild feature
+(Jekyll option `--incremental`).
 
 ## License
 
 MIT. See `LICENSE.txt`.
 
-[Compass]: http://compass-style.org/
-[GemBundler]: http://bundler.io/
+[Bundler]: http://bundler.io/
 [GoogleWebFundamentalsHttpCaching]: https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching#invalidating-and-updating-cached-responses
-[MinibundleGem]: https://rubygems.org/gems/jekyll-minibundle
-[MinibundleBuild]: https://travis-ci.org/tkareine/jekyll-minibundle
-[Jekyll]: https://jekyllrb.com/
 [JekyllConf]: https://jekyllrb.com/docs/configuration/
+[JekyllMinibundleExampleSite]: https://github.com/tkareine/jekyll-minibundle-example
+[Jekyll]: https://jekyllrb.com/
+[Liquid]: https://shopify.github.io/liquid/
+[MD5]: https://en.wikipedia.org/wiki/MD5
+[MinibundleBuild]: https://travis-ci.org/tkareine/jekyll-minibundle
+[MinibundleGem]: https://rubygems.org/gems/jekyll-minibundle
+[Sass]: http://sass-lang.com/
 [UglifyJS2]: https://github.com/mishoo/UglifyJS2
+[YAML]: http://www.yaml.org/

data/jekyll-minibundle.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |s|
   s.description = <<-END
 A straightforward asset bundling plugin for Jekyll, utilizing external
 minification tool of your choice. It provides asset concatenation for
-bundling and asset fingerprinting with MD5 digest for cache
-busting. There are no other runtime dependencies besides the
-minification tool (not even other gems).
+bundling and asset fingerprinting with MD5 digest for cache busting.
+There are no other runtime dependencies besides the minification tool
+(not even other gems).
   END
 
   s.files = %w{
@@ -30,8 +30,9 @@ minification tool (not even other gems).
   s.add_development_dependency 'jekyll',   '~> 3.0'
   s.add_development_dependency 'minitest', '~> 5.8'
   s.add_development_dependency 'nokogiri', '~> 1.6'
-  s.add_development_dependency 'rake',     '~> 11.1'
-  s.add_development_dependency 'rubocop',  '~> 0.39.0'
+  s.add_development_dependency 'pry',      '~> 0.10'
+  s.add_development_dependency 'rake',     '~> 12.0'
+  s.add_development_dependency 'rubocop',  '~> 0.46.0'
 
   s.required_ruby_version = '>= 2.0.0'
 

data/lib/jekyll/minibundle/asset_file_operations.rb

@@ -10,6 +10,7 @@ module Jekyll::Minibundle
       destination_path = destination(site_destination_dir)
       FileUtils.mkdir_p(File.dirname(destination_path))
       FileUtils.cp(path, destination_path)
+      destination_path
     end
   end
 end

data/lib/jekyll/minibundle/asset_file_properties.rb

@@ -1,7 +1,7 @@
 module Jekyll::Minibundle
   module AssetFileProperties
     def asset_destination_path
-      File.join(asset_destination_dir, asset_destination_basename)
+      File.join(asset_destination_dir, asset_destination_filename)
     end
 
     # Conformance to remaining Jekyll StaticFile public API methods
@@ -22,6 +22,10 @@ module Jekyll::Minibundle
       asset_destination_path
     end
 
+    def name
+      asset_destination_filename
+    end
+
     def modified_time
       File.stat(path).mtime
     end
@@ -40,9 +44,11 @@ module Jekyll::Minibundle
 
     def to_liquid
       {
-        'path'          => relative_path,
+        'basename'      => File.basename(name, extname),
+        'name'          => name,
+        'extname'       => extname,
         'modified_time' => modified_time,
-        'extname'       => extname
+        'path'          => relative_path
       }
     end
 

data/lib/jekyll/minibundle/bundle_file.rb

@@ -8,14 +8,16 @@ module Jekyll::Minibundle
     include AssetFileOperations
     include AssetFileProperties
 
-    attr_reader :stamped_at
+    attr_reader :asset_destination_dir, :stamped_at
 
     def initialize(site, config)
       @site = site
       @type = config.fetch('type')
       asset_source_dir = File.join(@site.source, config.fetch('source_dir'))
       @asset_paths = config.fetch('assets').map { |asset_path| File.join(asset_source_dir, "#{asset_path}.#{@type}") }
-      @destination_path = config.fetch('destination_path')
+      destination_path = config.fetch('destination_path')
+      @asset_destination_dir = File.dirname(destination_path)
+      @asset_destination_filename_prefix = File.basename(destination_path)
       @minifier_cmd = config.fetch('minifier_cmd')
       @stamped_at = nil
       @is_modified = false
@@ -30,8 +32,8 @@ module Jekyll::Minibundle
 
     def destination_path_for_markup
       # we must rebundle here, if at all, in order to make sure the
-      # markup destination and generated file paths have the same
-      # fingerprint
+      # destination path in the markup and the generated file path
+      # have the same fingerprint
       if modified?
         @stamped_at = mtime
         @is_modified = true
@@ -42,16 +44,12 @@ module Jekyll::Minibundle
       asset_destination_path
     end
 
-    def path
+    def asset_source_path
       asset_bundle.path
     end
 
-    def asset_destination_dir
-      File.dirname(@destination_path)
-    end
-
-    def asset_destination_path
-      "#{@destination_path}-#{asset_stamp}.#{@type}"
+    def asset_destination_filename
+      "#{@asset_destination_filename_prefix}-#{asset_stamp}#{extname}"
     end
 
     def extname
@@ -62,11 +60,15 @@ module Jekyll::Minibundle
       @asset_paths.map { |f| File.stat(f).mtime }.max
     end
 
-    # writes destination only after `destination_path_for_markup` has
-    # been called
+    # allows writing destination only after
+    # `destination_path_for_markup` has been called
     def write(site_destination_dir)
       if @is_modified
-        write_destination(site_destination_dir)
+        dst_path = write_destination(site_destination_dir)
+
+        # respect user's umask; Ruby's tempfile has mode 0o600
+        File.chmod(0o666 & ~File.umask, dst_path)
+
         @is_modified = false
         true
       else
@@ -77,7 +79,7 @@ module Jekyll::Minibundle
     private
 
     def asset_stamp
-      @_asset_stamp ||= AssetStamp.from_file(path)
+      @_asset_stamp ||= AssetStamp.from_file(asset_source_path)
     end
 
     def asset_bundle

data/lib/jekyll/minibundle/development_file.rb

@@ -6,20 +6,20 @@ module Jekyll::Minibundle
     include AssetFileOperations
     include AssetFileProperties
 
-    attr_reader :asset_source_path, :asset_destination_dir, :asset_destination_basename, :stamped_at
+    attr_reader :asset_source_path, :asset_destination_dir, :asset_destination_filename, :stamped_at
 
     def initialize(site, asset_source_path, asset_destination_path)
       @site = site
       @asset_source_path = asset_source_path
       @asset_destination_dir = File.dirname(asset_destination_path)
-      @asset_destination_basename = File.basename(asset_destination_path)
+      @asset_destination_filename = File.basename(asset_destination_path)
       @stamped_at = nil
     end
 
     alias destination_path_for_markup asset_destination_path
 
     def extname
-      File.extname(asset_destination_path)
+      File.extname(asset_destination_filename)
     end
 
     def write(site_destination_dir)