japr 0.3.2 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87d28ef23acc5a0f92c4cd7d583b6d2fce8c8704
+  data.tar.gz: 5b09118929232fd3f5c18409c702781f67a39d46
+SHA512:
+  metadata.gz: 95e903e0e43c4491dcde84b0a463c668e6ec4085523f9064e7e76eabafef913e8c312c5188a1dbb72396595e33f440adb92f85d4aa40a16e5e1b9e265f9ee89b
+  data.tar.gz: 81e8bbbc83d1f671906f3c4861c4a16645fac86f54347a51277db7af63ec070606ba35d193d918a4a509472af63e8b0e5fce0be63c2b40a65357b9cdbfc2abe9

data/README.md

@@ -1,10 +1,10 @@
 # JAPR (Jekyll Asset Pipeline Reborn)
 
 [![Gem Version](https://badge.fury.io/rb/japr.png)](http://badge.fury.io/rb/japr)
-[![Build Status](https://secure.travis-ci.org/kitsched/japr.png)](https://travis-ci.org/kitsched/japr)
-[![Coverage Status](https://coveralls.io/repos/kitsched/japr/badge.png?branch=master)](https://coveralls.io/r/kitsched/japr?branch=master)
-[![Dependency Status](https://gemnasium.com/kitsched/japr.png)](https://gemnasium.com/kitsched/japr)
-[![Code Climate](https://codeclimate.com/github/kitsched/japr.png)](https://codeclimate.com/github/kitsched/japr)
+[![Build Status](https://secure.travis-ci.org/janosrusiczki/japr.png)](https://travis-ci.org/janosrusiczki/japr)
+[![Coverage Status](https://coveralls.io/repos/janosrusiczki/japr/badge.png?branch=master)](https://coveralls.io/r/janosrusiczki/japr?branch=master)
+[![Dependency Status](https://gemnasium.com/janosrusiczki/japr.png)](https://gemnasium.com/janosrusiczki/japr)
+[![Code Climate](https://codeclimate.com/github/janosrusiczki/japr.png)](https://codeclimate.com/github/janosrusiczki/japr)
 
 JAPR is a powerful asset pipeline that automatically collects, converts and compresses / minifies your site's JavaScript and CSS assets when you compile your [Jekyll](http://jekyllrb.com/) site.
 
@@ -349,21 +349,21 @@ Setting        | Default  | Description
 
 5. Instead of running the `jekyll` command to compile your site, you should use Octopress' rake commands (e.g. `rake generate`) as outlined [here](http://octopress.org/docs/blogging/).
 
-If you have any difficulties using JAPR with Octopress, please [open an issue](http://github.com/kitsched/japr/issues).
+If you have any difficulties using JAPR with Octopress, please [open an issue](http://github.com/janosrusiczki/japr/issues).
 
 ## Contribute
 
-You can contribute to the JAPR by submitting a pull request [via GitHub](https://github.com/kitsched/japr). There are a few areas that need improvement:
+You can contribute to the JAPR by submitting a pull request [via GitHub](https://github.com/janosrusiczki/japr). There are a few areas that need improvement:
 
 - __Tests, tests, tests.__ **This project is now almost fully tested.**
 - __Handle remote assets.__ Right now, JAPR does not provide any way to include remote assets in bundles unless you save them locally before generating your site. Moshen's [Jekyll Asset Bundler](https://github.com/moshen/jekyll-asset_bundler) allows you to include remote assets, which is pretty interesting. That said, it is generally better to keep remote assets separate so that they load asynchronously.
 - __Successive preprocessing.__ Currently you can only preprocess a file once. It would be better if you could run an asset through multiple preprocessors before it gets compressed and bundled. **As of v0.1.0, JAPR now supports successive preprocessing.**
 
-If you have any ideas or you would like to see anything else improved please use the [issues section](https://github.com/kitsched/japr/issues).
+If you have any ideas or you would like to see anything else improved please use the [issues section](https://github.com/janosrusiczki/japr/issues).
 
 ## Community
 
-- Here is a list of [sites that use JAPR](http://github.com/kitsched/japr/wiki/Sites-that-use-JAPR). Feel free to add your site to the list if you want.
+- Here is a list of [sites that use JAPR](http://github.com/janosrusiczki/japr/wiki/Sites-that-use-JAPR). Feel free to add your site to the list if you want.
 
 ## Credits
 

data/lib/japr.rb

@@ -28,6 +28,7 @@ require 'japr/asset'
 require 'japr/converter'
 require 'japr/compressor'
 require 'japr/template'
+require 'japr/templates/template_helper'
 require 'japr/templates/javascript_tag_template'
 require 'japr/templates/css_tag_template'
 require 'japr/pipeline'
@@ -50,5 +51,5 @@ module JAPR
     'bundle'        => true,
     'compress'      => true,
     'gzip'          => false
-  }
+  }.freeze
 end

data/lib/japr/converter.rb

@@ -18,6 +18,13 @@ module JAPR
       ''
     end
 
+    # Finds a converter class based on a filename
+    def self.klass(filename)
+      JAPR::Converter.subclasses.select do |c|
+        c.filetype == File.extname(filename).downcase
+      end.last
+    end
+
     # Logic to convert assets
     #
     # Available instance variables:

data/lib/japr/extensions/liquid/liquid_block_extensions.rb

@@ -12,30 +12,35 @@ module JAPR
 
     def render(context)
       site = context.registers[:site]
-      config = site.config['asset_pipeline'] || {}
+      config = site.config.fetch('asset_pipeline', {})
 
       # Run Jekyll Asset Pipeline
-      pipeline, cached = Pipeline.run(@nodelist.first, @markup.strip,
-                                      site.source, site.dest,
-                                      self.class.tag_name,
-                                      self.class.output_type, config)
-
-      if pipeline.is_a?(Pipeline)
-        # Prevent Jekyll from cleaning up saved assets if new pipeline
-        pipeline.assets.each do |asset|
-          config = JAPR::DEFAULTS.merge(config)
-          staging_path = File.expand_path(File.join(site.source,
-                                                    config['staging_path']))
-          site.static_files << Jekyll::StaticFile.new(site, staging_path,
-                                                      asset.output_path,
-                                                      asset.filename)
-        end unless cached
-
-        # Return HTML tag pointing to asset
-        return pipeline.html
-      else
-        # Return nothing
-        return nil
+      pipeline, cached = run_pipeline(site, config)
+
+      return nil unless pipeline.is_a?(Pipeline)
+
+      # Prevent Jekyll from cleaning up saved assets if new pipeline
+      preserve_assets(site, config, pipeline) unless cached
+
+      # Return HTML tag pointing to asset
+      pipeline.html
+    end
+
+    private
+
+    def run_pipeline(site, config)
+      Pipeline.run(nodelist.first, @markup.strip, site.source, site.dest,
+                   self.class.tag_name, self.class.output_type, config)
+    end
+
+    def preserve_assets(site, config, pipeline)
+      pipeline.assets.each do |asset|
+        config = JAPR::DEFAULTS.merge(config)
+        staging_path = File.expand_path(File.join(site.source,
+                                                  config['staging_path']))
+        site.static_files << Jekyll::StaticFile.new(site, staging_path,
+                                                    asset.output_path,
+                                                    asset.filename)
       end
     end
   end

data/lib/japr/pipeline.rb

@@ -1,11 +1,12 @@
 module JAPR
+  # rubocop:disable ClassLength
   class Pipeline
     class << self
       # Generate hash based on manifest
       def hash(source, manifest, options = {})
         options = DEFAULTS.merge(options)
         begin
-          Digest::MD5.hexdigest(YAML.load(manifest).map! do |path|
+          Digest::MD5.hexdigest(YAML.safe_load(manifest).map! do |path|
             "#{path}#{File.mtime(File.join(source, path)).to_i}"
           end.join.concat(options.to_s))
         rescue Exception => e
@@ -20,32 +21,18 @@ module JAPR
         hash = hash(source, manifest, config)
 
         # Check if pipeline has been cached
-        if cache.key?(hash)
-          # Return cached pipeline and cached status
-          return cache[hash], true
-        else
-          begin
-            puts "Processing '#{tag}' manifest '#{prefix}'"
-
-            # Create and process new pipeline
-            pipeline = new(manifest, prefix, source, destination, type, config)
-            pipeline.assets.each do |asset|
-              puts "Saved '#{asset.filename}' to " \
-                   "'#{destination}/#{asset.output_path}'"
-            end
-
-            # Add processed pipeline to cache
-            cache[hash] = pipeline
-
-            # Return newly processed pipeline and cached status
-            return pipeline, false
-          rescue Exception => e
-            # Add exception to cache
-            cache[hash] = e
-
-            # Re-raise the exception
-            raise e
-          end
+        return cache[hash], true if cache.key?(hash)
+
+        begin
+          puts "Processing '#{tag}' manifest '#{prefix}'"
+          pipeline = new(manifest, prefix, source, destination, type, config)
+          process_pipeline(hash, pipeline)
+        rescue Exception => e
+          # Add exception to cache
+          cache[hash] = e
+
+          # Re-raise the exception
+          raise e
         end
       end
 
@@ -64,17 +51,31 @@ module JAPR
         config = DEFAULTS.merge(config)
         staging_path = File.join(source, config['staging_path'])
         FileUtils.rm_rf(staging_path)
-        rescue Exception => e
-          puts "Failed to remove staged assets: #{e.message}"
-
-          # Re-raise the exception
-          raise e
+      rescue Exception => e
+        puts "Failed to remove staged assets: #{e.message}"
+        # Re-raise the exception
+        raise e
       end
 
       # Add prefix to output
       def puts(message)
         $stdout.puts("Asset Pipeline: #{message}")
       end
+
+      private
+
+      def process_pipeline(hash, pipeline)
+        pipeline.assets.each do |asset|
+          puts "Saved '#{asset.filename}' to " \
+            "'#{pipeline.destination}/#{asset.output_path}'"
+        end
+
+        # Add processed pipeline to cache
+        cache[hash] = pipeline
+
+        # Return newly processed pipeline and cached status
+        [pipeline, false]
+      end
     end
 
     # Initialize new pipeline
@@ -89,7 +90,7 @@ module JAPR
       process
     end
 
-    attr_reader :assets, :html
+    attr_reader :assets, :html, :destination
 
     private
 
@@ -106,17 +107,17 @@ module JAPR
 
     # Collect assets based on manifest
     def collect
-      @assets = YAML.load(@manifest).map! do |path|
+      @assets = YAML.safe_load(@manifest).map! do |path|
         full_path = File.join(@source, path)
         File.open(File.join(@source, path)) do |file|
           JAPR::Asset.new(file.read, File.basename(path),
                           File.dirname(full_path))
         end
       end
-      rescue Exception => e
-        puts 'Asset Pipeline: Failed to load assets from provided ' \
-             "manifest: #{e.message}"
-        raise e
+    rescue Exception => e
+      puts 'Asset Pipeline: Failed to load assets from provided ' \
+           "manifest: #{e.message}"
+      raise e
     end
 
     # Convert assets based on the file extension if converter is defined
@@ -126,36 +127,37 @@ module JAPR
         finished = false
         while finished == false
           # Find a converter to use
-          klass = JAPR::Converter.subclasses.select do |c|
-            c.filetype == File.extname(asset.filename).downcase
-          end.last
+          klass = JAPR::Converter.klass(asset.filename)
 
           # Convert asset if converter is found
           if klass.nil?
             finished = true
           else
-            begin
-              # Convert asset content
-              converter = klass.new(asset)
-
-              # Replace asset content and filename
-              asset.content = converter.converted
-              asset.filename = File.basename(asset.filename, '.*')
-
-              # Add back the output extension if no extension left
-              if File.extname(asset.filename) == ''
-                asset.filename = "#{asset.filename}#{@type}"
-              end
-            rescue Exception => e
-              puts "Asset Pipeline: Failed to convert '#{asset.filename}' " \
-                   "with '#{klass}': #{e.message}"
-              raise e
-            end
+            convert_asset(klass, asset)
           end
         end
       end
     end
 
+    # Convert an asset with a given converter class
+    def convert_asset(klass, asset)
+      # Convert asset content
+      converter = klass.new(asset)
+
+      # Replace asset content and filename
+      asset.content = converter.converted
+      asset.filename = File.basename(asset.filename, '.*')
+
+      # Add back the output extension if no extension left
+      if File.extname(asset.filename) == ''
+        asset.filename = "#{asset.filename}#{@type}"
+      end
+    rescue Exception => e
+      puts "Asset Pipeline: Failed to convert '#{asset.filename}' " \
+           "with '#{klass}': #{e.message}"
+      raise e
+    end
+
     # Bundle multiple assets into a single asset
     def bundle
       content = @assets.map(&:content).join("\n")
@@ -172,7 +174,7 @@ module JAPR
           c.filetype == @type
         end.last
 
-        return unless klass
+        break unless klass
 
         begin
           asset.content = klass.new(asset.content).compressed
@@ -202,34 +204,35 @@ module JAPR
 
       @assets.each do |asset|
         directory = File.join(@source, staging_path, output_path)
-        FileUtils.mkpath(directory) unless File.directory?(directory)
-
-        begin
-          # Save file to disk
-          File.open(File.join(directory, asset.filename), 'w') do |file|
-            file.write(asset.content)
-          end
-        rescue Exception => e
-          puts "Asset Pipeline: Failed to save '#{asset.filename}' to " \
-               "disk: #{e.message}"
-          raise e
-        end
+        write_asset_file(directory, asset)
 
         # Store output path of saved file
         asset.output_path = output_path
       end
     end
 
+    # Write asset file to disk
+    def write_asset_file(directory, asset)
+      FileUtils.mkpath(directory) unless File.directory?(directory)
+      begin
+        # Save file to disk
+        File.open(File.join(directory, asset.filename), 'w') do |file|
+          file.write(asset.content)
+        end
+      rescue Exception => e
+        puts "Asset Pipeline: Failed to save '#{asset.filename}' to " \
+             "disk: #{e.message}"
+        raise e
+      end
+    end
+
     # Generate html markup pointing to assets
     def markup
       # Use display_path if defined, otherwise use output_path in url
       display_path = @options['display_path'] || @options['output_path']
 
       @html = @assets.map do |asset|
-        klasses = JAPR::Template.subclasses.select do |t|
-          t.filetype == File.extname(asset.filename).downcase
-        end
-        klass = klasses.sort! { |x, y| x.priority <=> y.priority }.last
+        klass = JAPR::Template.klass(asset.filename)
         html = klass.new(display_path, asset.filename).html unless klass.nil?
 
         html

data/lib/japr/template.rb

@@ -17,6 +17,14 @@ module JAPR
       0
     end
 
+    # Finds a template class based on a filename
+    def self.klass(filename)
+      klasses = JAPR::Template.subclasses.select do |t|
+        t.filetype == File.extname(filename).downcase
+      end
+      klasses.sort! { |x, y| x.priority <=> y.priority }.last
+    end
+
     # HTML output to return
     #
     # Available instance variables:

data/lib/japr/templates/css_tag_template.rb

@@ -1,6 +1,8 @@
 module JAPR
   # Default output for CSS assets
   class CssTagTemplate < JAPR::Template
+    include JAPR::TemplateHelper
+
     def self.filetype
       '.css'
     end
@@ -10,7 +12,8 @@ module JAPR
     end
 
     def html
-      "<link href='/#{@path}/#{@filename}' rel='stylesheet' type='text/css' />"
+      "<link href='#{output_path}/#{@filename}' " \
+        "rel='stylesheet' type='text/css' />"
     end
   end
 end

data/lib/japr/templates/javascript_tag_template.rb

@@ -1,6 +1,8 @@
 module JAPR
   # Default output for JavaScript assets
   class JavaScriptTagTemplate < JAPR::Template
+    include JAPR::TemplateHelper
+
     def self.filetype
       '.js'
     end
@@ -10,7 +12,8 @@ module JAPR
     end
 
     def html
-      "<script src='/#{@path}/#{@filename}' type='text/javascript'></script>"
+      "<script src='#{output_path}/#{@filename}' " \
+        "type='text/javascript'></script>"
     end
   end
 end

data/lib/japr/templates/template_helper.rb

@@ -0,0 +1,14 @@
+module JAPR
+  module TemplateHelper
+    def output_path
+      root_path? ? '' : "/#{@path}"
+    end
+
+    def root_path?
+      stripped_path = @path.to_s.strip
+      stripped_path.nil? ||
+        stripped_path.empty? ||
+        stripped_path == '/'
+    end
+  end
+end

data/lib/japr/version.rb

@@ -1,3 +1,3 @@
 module JAPR
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,130 +1,122 @@
 --- !ruby/object:Gem::Specification
 name: japr
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Hodan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2017-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
-description: ! "    Jekyll Asset Pipeline reborn adds asset preprocessing (CoffeeScript,
-  Sass,\n    Less, ERB, etc.) and asset compression / minification / gzip (Yahoo YUI\n
-  \   Compressor, Google Closure Compiler, etc.) to Jekyll.'\n"
+        version: '10.0'
+description: |2
+      Jekyll Asset Pipeline reborn adds asset preprocessing (CoffeeScript, Sass,
+      Less, ERB, etc.) and asset compression / minification / gzip (Yahoo YUI
+      Compressor, Google Closure Compiler, etc.) to Jekyll.'
 email: japr@clicktrackheart.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/japr.rb
+- lib/japr/asset.rb
 - lib/japr/compressor.rb
 - lib/japr/converter.rb
-- lib/japr/templates/javascript_tag_template.rb
-- lib/japr/templates/css_tag_template.rb
-- lib/japr/version.rb
-- lib/japr/template.rb
-- lib/japr/extensions/liquid/asset_tags/javascript_asset_tag.rb
-- lib/japr/extensions/liquid/asset_tags/css_asset_tag.rb
+- lib/japr/extensions/jekyll/site.rb
+- lib/japr/extensions/jekyll/site_extensions.rb
 - lib/japr/extensions/liquid/asset_tag.rb
+- lib/japr/extensions/liquid/asset_tags/css_asset_tag.rb
+- lib/japr/extensions/liquid/asset_tags/javascript_asset_tag.rb
 - lib/japr/extensions/liquid/liquid_block_extensions.rb
-- lib/japr/extensions/jekyll/site_extensions.rb
-- lib/japr/extensions/jekyll/site.rb
 - lib/japr/extensions/ruby/subclass_tracking.rb
 - lib/japr/pipeline.rb
-- lib/japr/asset.rb
-- lib/japr.rb
-- LICENSE
-- README.md
-homepage: https://github.com/kitsched/japr
+- lib/japr/template.rb
+- lib/japr/templates/css_tag_template.rb
+- lib/japr/templates/javascript_tag_template.rb
+- lib/japr/templates/template_helper.rb
+- lib/japr/version.rb
+homepage: https://github.com/janosrusiczki/japr
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.6.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A powerful asset pipeline for Jekyll that bundles, converts, and minifies
   CSS and JavaScript assets.
 test_files: []