jekyll-webp 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80ba6286b2216fafd1e971367ba4b31ac867d03c
-  data.tar.gz: e2df650ac6d08f7801ec9bb23fa1e62011161a55
+  metadata.gz: f9566892837b2ba7870b279d0381dc8c8e9158d5
+  data.tar.gz: 2e8aeb32f03eb687a7c1bb28c0fdd954623bf254
 SHA512:
-  metadata.gz: baa7c2aaacdd3e6715087566dc1136adccb928bf5b914194fb88bdda4160393c1d91bd57489f4b3c5e6c3f182aa0851323cb6a3f3dc33403ffda59fd719de162
-  data.tar.gz: d962aa0179ac79b319555f498eedb7b7c432f051d8490ba6f940d5cc88cc480a0f40be48bb0108ea4d548881b6c7c132e10db292966b4a4ef588a48cf8188077
+  metadata.gz: b3cacb25d5b0ffc941f026246c37e92fc43b31188e5c6f5e1fade6c86be3adb9de69d027faee878981713e88eadc16dff337e0263c0ed9101488e5e06466cce4
+  data.tar.gz: ee976ec33274355dd4378d77a5c30c639e32536d96ed51acf75e6b6c5d8a62e652d9dda62d0ccc2aa30321acbf85651a32c612b7e17c9718200a8c979729efd2

data/README.md

@@ -1,6 +1,7 @@
 
 # WebP Generator for Jekyll
-WebP Image Generator for Jekyll Sites can automatically generate WebP images for all images on your static site and serve them when possible.
+WebP Image Generator for Jekyll Sites can automatically generate WebP images for all images on your static site and serve them when possible. View on [rubygems.org](https://rubygems.org/gems/jekyll-webp).
+
 > Read more about this tool on my blog at <a href="https://blog.sverrirs.com/2016/06/webp-generator-for-jekyll-sites.html" target="_blank">blog.sverrirs.com</a>
 
 ## Installation
@@ -11,7 +12,7 @@ gem install jekyll-webp
 
 The release includes all necessary files to run, including the WebP redistributable executable files.
 
-> Currently the release includes the v0.5.1 version of the WebP utilities for Windows, Linux and Mac OS X 10.9 (Mountain Lion). Other versions and releases can be downloaded directly from <a href="https://developers.google.com/speed/webp/docs/precompiled" target="_blank">the Google page</a>.
+> Currently the release includes the v0.6.1 version of the WebP utilities for Windows, Linux and Mac OS X 10.9 (Mountain Lion). Other versions and releases can be downloaded directly from <a href="https://developers.google.com/speed/webp/docs/precompiled" target="_blank">the Google page</a>.
 
 Add the gem to your `Gemfile` and to Jekyll's `_config.yml` then run `jekyll serve` again and you should see the generator run during site generation.
 
@@ -62,7 +63,7 @@ In case you don't have control over your webserver then using the `<picture>` el
 ```
 
 ## Advanced use: Webserver Configuration
-If you can then configuring your webserver to serve your new _.webp_ files to clients that support the format is probably the least problematic approach. This way you don't need to make any changes to your HTML files as your webserver will automatically serve WebP images when the client supports them. 
+If you can, then configuring your webserver to serve your new _.webp_ files to clients that support the format is probably the least problematic approach. This way you don't need to make any changes to your HTML files as your webserver will automatically serve WebP images when the client supports them. 
 
 Below is an example for a .htaccess configuration section in an Apache web-server. It will redirect users to webp images whenever possible.
 

data/jekyll-webp.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.summary       = %q{WebP image generator for Jekyll 3 websites}
-  spec.description   = %q{WebP Image Generator for Jekyll 3 Sites that automatically generate WebP images for all images on your static site and serves them when possible.}
+  spec.description   = %q{WebP Image Generator for Jekyll 3 Sites that automatically generate WebP images for all images on your static site and serves them when possible. Includes the v0.6.1 version of the WebP utilities for Windows, Linux and Mac OS X 10.9 (Mountain Lion)}
   
   spec.files         = Dir['CODE_OF_CONDUCT.md', 'README.md', 'LICENSE', 'Rakefile', '*.gemspec', 'Gemfile', 'lib/**/*', 'spec/**/*', 'bin/**/*']
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/jekyll-webp/defaults.rb

@@ -9,6 +9,10 @@ module Jekyll
       # The quality of the webp conversion 0 to 100 (where 100 is least lossy)
       'quality'   => 75,
 
+      # Other flags to pass to the webp binary. For a list of valid parameters check here:
+      # https://developers.google.com/speed/webp/docs/cwebp#options
+      'flags'     => "-m 4 -pass 4 -af",
+
       # List of directories containing images to optimize, Nested directories will not be checked
       'img_dir'   => ["/img"],
 
@@ -35,4 +39,4 @@ module Jekyll
     }
 
   end # module Webp
-end # module Jekyll
+end # module Jekyll

data/lib/jekyll-webp/version.rb

@@ -1,8 +1,8 @@
 module Jekyll
   module Webp
-    VERSION = "0.1.0"
+    VERSION = "1.0.0"
     # When modifying remember to issue a new tag command in git before committing, then push the new tag
-    # git tag -a v0.1.0 -m "Gem v0.1.0"
+    # git tag -a v1.0.0 -m "Gem v1.0.0"
     # git push origin --tags
   end #module Webp
-end #module Jekyll
+end #module Jekyll

data/lib/jekyll-webp/webpExec.rb

@@ -9,7 +9,7 @@ module Jekyll
       # Runs the WebP executable for the given input parameters
       # the function detects the OS platform and architecture automatically
       #
-      def self.run(quality, input_file, output_file)
+      def self.run(quality, flags, input_file, output_file)
 
         # What is the path to the execs inside the gem? perhaps just bin/?
         bin_path = "bin/"
@@ -27,13 +27,26 @@ module Jekyll
         full_path = File.join(gem_root, bin_path, exe_name)
 
         # Construct the full program call
-        cmd = "\"#{full_path}\" -quiet -mt -q #{quality.to_s} \"#{input_file}\" -o \"#{output_file}\""
+        cmd = "\"#{full_path}\" -quiet -mt -q #{quality.to_s} #{flags} \"#{input_file}\" -o \"#{output_file}\""
         
         # Execute the command
-        stdin, stdout, stderr = Open3.popen3(cmd)
+        exit_code = 0
+        error = ""
+        output = ""
+        Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+          stdin.close # we don't pass any input to the process
+          output = stdout.gets
+          error = stderr.gets
+          exit_code = wait_thr.value
+        end
+
+        if exit_code != 0
+          Jekyll.logger.error("WebP:","Conversion for image #{input_file} failed, no webp version could be created for this image")
+          Jekyll.logger.debug("WebP:","cwebp returned #{exit_code} with error #{error}")
+        end
 
         # Return any captured return value
-        return [stdin, stdout, stderr]
+        return [output, error]
       end #function run
 
       #
@@ -88,4 +101,4 @@ module Jekyll
       return 1.size == 8
     end
   end #module OS
-end #module Jekyll
+end #module Jekyll

data/lib/jekyll-webp/webpGenerator.rb

@@ -1,4 +1,5 @@
 require 'jekyll/document'
+require 'fileutils'
 
 module Jekyll
   module Webp
@@ -10,7 +11,7 @@ module Jekyll
       def write(dest)
         true # Recover from strange exception when starting server without --auto
       end
-    end #class WebPImageFile
+    end #class WebpFile
 
     class WebpGenerator < Generator
       # This generator is safe from arbitrary code execution.
@@ -34,25 +35,27 @@ module Jekyll
           return
         end
 
-        Jekyll.logger.info "WebP:","Starting"
+        Jekyll.logger.debug "WebP:","Starting"
 
         # If the site destination directory has not yet been created then create it now. Otherwise, we cannot write our file there.
         Dir::mkdir(site.dest) if !File.directory? site.dest
 
         # Counting the number of files generated
         file_count = 0
-        
+
         # Iterate through every image in each of the image folders and create a webp image
         # if one has not been created already for that image.
         for imgdir in @config['img_dir']
           imgdir_source = File.join(site.source, imgdir)
+          imgdir_destination = File.join(site.dest, imgdir)
+          FileUtils::mkdir_p(imgdir_destination)
           Jekyll.logger.info "WebP:","Processing #{imgdir_source}"
           
           # handle only jpg, jpeg, png and gif
-          Dir.foreach(imgdir_source) do |imgfile|
+          for imgfile in Dir[imgdir_source + "**/*.*"]
+              imgfile_relative_path = File.dirname(imgfile.sub(imgdir_source, ""))
           
               # Skip empty stuff
-              next if imgfile == '.' or imgfile == '..'
               file_ext = File.extname(imgfile).downcase
 
               # If the file is not one of the supported formats, exit early
@@ -63,32 +66,28 @@ module Jekyll
               # Create the output file path
               file_noext = File.basename(imgfile, file_ext)
               outfile_filename = file_noext+ ".webp"
-              outfile_fullpath_webp = File.join(imgdir_source, outfile_filename)
+              FileUtils::mkdir_p(imgdir_destination + imgfile_relative_path)
+              outfile_fullpath_webp = File.join(imgdir_destination + imgfile_relative_path, outfile_filename)
 
-              # Create the full input file name
-              infile_fullpath = File.join(imgdir_source, imgfile)
-          
               # Check if the file already has a webp alternative?
               # If we're force rebuilding all webp files then ignore the check
               # also check the modified time on the files to ensure that the webp file
               # is newer than the source file, if not then regenerate
-              next if !@config['regenerate'] && File.file?(outfile_fullpath_webp) &&
-                      File.mtime(outfile_fullpath_webp) > File.mtime(infile_fullpath)      
-              
-              if( File.file?(outfile_fullpath_webp) && 
-                  File.mtime(outfile_fullpath_webp) <= File.mtime(infile_fullpath) )
+              if @config['regenerate'] || !File.file?(outfile_fullpath_webp) ||
+                 File.mtime(outfile_fullpath_webp) <= File.mtime(imgfile)
                 Jekyll.logger.info "WebP:", "Change to source image file #{imgfile} detected, regenerating WebP"
-                #puts "      WebP: "+File.mtime(outfile_fullpath_webp).strftime('%Y-%m-%d %H:%M:%S')
-                #puts "      Source: "+File.mtime(infile_fullpath).strftime('%Y-%m-%d %H:%M:%S')
-              end
 
-              # Generate the file
-              WebpExec.run(@config['quality'], infile_fullpath, outfile_fullpath_webp)
-              
-              # Keep the webp file from being cleaned by Jekyll
-              site.static_files << WebpFile.new(site, site.dest, imgdir, outfile_filename)
-              file_count += 1
-              
+                # Generate the file
+                WebpExec.run(@config['quality'], @config['flags'], imgfile, outfile_fullpath_webp)
+                file_count += 1
+              end
+              if File.file?(outfile_fullpath_webp)
+                # Keep the webp file from being cleaned by Jekyll
+                site.static_files << WebpFile.new(site,
+                                                  site.dest,
+                                                  File.join(imgdir, imgfile_relative_path),
+                                                  outfile_filename)
+              end
           end # dir.foreach
         end # img_dir
 
@@ -99,4 +98,4 @@ module Jekyll
     end #class WebPGenerator
     
   end #module Webp
-end #module Jekyll
+end #module Jekyll

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-webp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sverrir Sigmundarson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2018-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -73,7 +73,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.4.3
 description: WebP Image Generator for Jekyll 3 Sites that automatically generate WebP
-  images for all images on your static site and serves them when possible.
+  images for all images on your static site and serves them when possible. Includes
+  the v0.6.1 version of the WebP utilities for Windows, Linux and Mac OS X 10.9 (Mountain
+  Lion)
 email:
 - jekyll@sverrirs.com
 executables: