japr 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87d28ef23acc5a0f92c4cd7d583b6d2fce8c8704
-  data.tar.gz: 5b09118929232fd3f5c18409c702781f67a39d46
+  metadata.gz: d8399905be227d867b7c97c93d2e93a799370edc
+  data.tar.gz: 70edcd27fb26e4bca05c307a7ec3b509527e8316
 SHA512:
-  metadata.gz: 95e903e0e43c4491dcde84b0a463c668e6ec4085523f9064e7e76eabafef913e8c312c5188a1dbb72396595e33f440adb92f85d4aa40a16e5e1b9e265f9ee89b
-  data.tar.gz: 81e8bbbc83d1f671906f3c4861c4a16645fac86f54347a51277db7af63ec070606ba35d193d918a4a509472af63e8b0e5fce0be63c2b40a65357b9cdbfc2abe9
+  metadata.gz: 5f2166720692d1f29c17c09292a5d6c5af4006ca9372138dab80bd465bb79b8ce81424478170de45e18cd0cf5196dc0e853bfbe1939693cfcd34b54f1d9f57e5
+  data.tar.gz: 5b9cc66015a6074ea1264b3e9030dadac7cec3f579285d5944a46e5cc8b2e0e3956dfffda2faf000fcef95fe5cf4f184f3df9f3d1fa61b2911cab19a6e78f334

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 0.4.1 (2017-12-08)
+
+* [#6]  __Test coverage increased to 100%__
+* [#35] __Updated rake dependency to 12.0__
+* [#34] __Fixed or mitigated all Rubocop offenses__
+* [#31] __Documented modules and classes__
+* [#29] Various README updates
+* [#28] Gemspec file updates (version dependencies and typos)
+* [#31] Fix random coverage jumps
+* [#33] Rescue StandardError instead of Exception
+* Removed CodeClimate integration
+
+## 0.4 (2017-12-03)
+
+* [#20] Support Jekyll 3.5, Liquid 4.0
+* [#25] Permit root level output of asset files
+* Fix and refactor to eliminate Rubocop offenses

data/README.md

@@ -1,10 +1,9 @@
 # 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/janosrusiczki/japr.png)](https://travis-ci.org/janosrusiczki/japr)
+[![Build Status](https://travis-ci.org/janosrusiczki/japr.svg?branch=master)](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.
 
@@ -34,8 +33,8 @@ This project is a fork of [Jekyll Asset Pipeline](https://github.com/matthodan/j
 ## Features
 
 - Declarative dependency management via asset manifests
-- Asset preprocessing/conversion (supports [CoffeeScript](http://coffeescript.org/), [Sass / Scss](http://sass-lang.com/), [Less](http://lesscss.org/), [Erb](http://ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html), etc.)
-- Asset compression (supports [YUI Compressor](http://developer.yahoo.com/yui/compressor/), [Closure Compiler](https://developers.google.com/closure/compiler/), etc.)
+- Asset preprocessing/conversion (supports [CoffeeScript](http://coffeescript.org/), [Sass / Scss](http://sass-lang.com/), [Less](http://lesscss.org/), [Erb](http://ruby-doc.org/stdlib-2.2.0/libdoc/erb/rdoc/ERB.html), etc.)
+- Asset compression (supports [YUI Compressor](http://yui.github.io/yuicompressor/), [Closure Compiler](https://developers.google.com/closure/compiler/), etc.)
 - Fingerprints bundled asset filenames with MD5 hashes for better browser caching
 - Automatic generation of HTML `link` and `script` tags that point to bundled assets
 - Integrates seamlessly into Jekyll's workflow, including auto site regeneration
@@ -61,7 +60,7 @@ JAPR is extremely easy to add to your Jekyll project and has no incremental depe
 
   If you are using [Bundler](http://gembundler.com/) to manage your project's gems, you can just add `japr` to your Gemfile and run `bundle install`.
 
-2. Add a `_plugins` folder to your project if you do not already have one. Within the `_plugins` folder, add a file named `jekyll_asset_pipeline.rb` with the following require statement as its contents.
+2. Add a `_plugins` folder to your project if you do not already have one. Within the `_plugins` folder, add a file named `japr.rb` with the following require statement as its contents.
 
   ``` ruby
   require 'japr'
@@ -107,21 +106,21 @@ In the following example, we will add a preprocessor that converts CoffeeScript
 
 ### CoffeeScript
 
-1. In the `jekyll_asset_pipeline.rb` file that we created in the [Getting Started](#getting-started) section, add the following code to the end of the file (i.e. after the `require` statement).
+1. In the `japr.rb` file that we created in the [Getting Started](#getting-started) section, add the following code to the end of the file (i.e. after the `require` statement).
 
   ``` ruby
   module JAPR
-      class CoffeeScriptConverter < JAPR::Converter
-        require 'coffee-script'
+    class CoffeeScriptConverter < JAPR::Converter
+      require 'coffee-script'
 
-        def self.filetype
-          '.coffee'
-        end
+      def self.filetype
+        '.coffee'
+      end
 
-        def convert
-          return CoffeeScript.compile(@content)
-        end
+      def convert
+        return CoffeeScript.compile(@content)
       end
+    end
   end
   ```
 
@@ -168,9 +167,9 @@ You can use the `@dirname` instance variable for this, which contains the path t
 
 ``` ruby
 ...
-    def convert
-      return Sass::Engine.new(@content, syntax: :scss, load_paths: [@dirname]).render
-    end
+def convert
+  return Sass::Engine.new(@content, syntax: :scss, load_paths: [@dirname]).render
+end
 ...
 ```
 
@@ -198,9 +197,9 @@ As with the SASS convertor, you'll probably need to specify a base load path and
 
 ``` ruby
 ...
-    def convert
-      return Less::Parser.new(paths: [@dirname]).parse(@content).to_css
-    end
+def convert
+  return Less::Parser.new(paths: [@dirname]).parse(@content).to_css
+end
 ...
 ```
 
@@ -218,7 +217,7 @@ In the following example, we will add a compressor that uses Yahoo's YUI Compres
 
 ### Yahoo's YUI Compressor
 
-1. In the `jekyll_asset_pipeline.rb` file that we created in the [Getting Started](#getting-started) section, add the following code to the end of the file (i.e. after the `require` statement).
+1. In the `japr.rb` file that we created in the [Getting Started](#getting-started) section, add the following code to the end of the file (i.e. after the `require` statement).
 
   ``` ruby
   module JAPR
@@ -288,7 +287,7 @@ When JAPR creates a bundle, it returns an HTML tag that points to the bundle. Th
 
 In the following example, we will override the default CSS link tag by adding a custom template that produces a link tag with a `media` attribute.
 
-1. In the `jekyll_asset_pipeline.rb` file that we created in the [Getting Started](#getting-started) section, add the following code.
+1. In the `japr.rb` file that we created in the [Getting Started](#getting-started) section, add the following code.
 
   ``` ruby
   module JAPR
@@ -298,7 +297,7 @@ In the following example, we will override the default CSS link tag by adding a
       end
 
       def html
-        "<link href='/#{@path}/#{@filename}' rel='stylesheet'" \
+        "<link href='#{output_path}/#{@filename}' rel='stylesheet' " \
           "type='text/css' media='screen' />\n"
       end
     end
@@ -307,7 +306,7 @@ In the following example, we will override the default CSS link tag by adding a
 
   If you already added a compressor and/or a converter, you can include your template class alongside your compressor and/or converter within the same JAPR module.
 
-  The “self.filetype” method defines the type of bundle a template will target (either `.js` or `.css`). The “html” method is where the magic happens. “@path” and `@filename` instance variables are available within the class and contain the path and filename of the generated bundle, respectively. The template should return a string that contains an HTML tag pointing to the generated bundle via an `html` method.
+  The “self.filetype” method defines the type of bundle a template will target (either `.js` or `.css`). The “html” method is where the magic happens. `output_path` is a helper method and `@filename` is an instance variable which are available within the class and contain the path and filename of the generated bundle, respectively. The template should return a string that contains an HTML tag pointing to the generated bundle via an `html` method.
 
 2. Run the `jekyll` command to compile your site.
 
@@ -341,7 +340,7 @@ Setting        | Default  | Description
 
 1. Octopress uses Bundler to manage your site's dependencies. You should add `gem japr` to your Gemfile and then run `bundle install` to install.
 
-2. Instead of adding a `_plugins` folder, you should put `jekyll_asset_pipeline.rb` in the `plugins` folder included by default in the root of your Octopress site.
+2. Instead of adding a `_plugins` folder, you should put `japr.rb` in the `plugins` folder included by default in the root of your Octopress site.
 
 3. You should still store your assets in an Jekyll ignored folder (i.e. a folder that begins with an underscore `_`), but note that this folder should be located within the `source` folder of your Octopress site (e.g. `source/_assets`).
 
@@ -355,18 +354,20 @@ If you have any difficulties using JAPR with Octopress, please [open an issue](h
 
 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.
+- __Tests, tests, tests.__ **This project is now fully tested.**
 - __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.**
+- __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.
 
 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/janosrusiczki/japr/wiki/Sites-that-use-JAPR). Feel free to add your site to the list if you want.
+- Here is [GitHub's list of projects that use the gem](https://github.com/janosrusiczki/japr/network/dependents).
+- Here is a currated 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
 
+* [Matt Hodan](https://github.com/matthodan) for creating [Jekyll Asset Pipeline](https://github.com/matthodan/jekyll-asset-pipeline).
 * [Moshen](https://github.com/moshen/) for creating the [Jekyll Asset Bundler](https://github.com/moshen/jekyll-asset_bundler).
 * [Mojombo](https://github.com/mojombo) for creating [Jekyll](https://github.com/mojombo/jekyll) in the first place.
 

data/lib/japr.rb

@@ -27,8 +27,8 @@ require 'japr/version'
 require 'japr/asset'
 require 'japr/converter'
 require 'japr/compressor'
-require 'japr/template'
 require 'japr/templates/template_helper'
+require 'japr/template'
 require 'japr/templates/javascript_tag_template'
 require 'japr/templates/css_tag_template'
 require 'japr/pipeline'

data/lib/japr/asset.rb

@@ -1,4 +1,5 @@
 module JAPR
+  # Holds an asset (file)
   class Asset
     def initialize(content, filename, dirname = '.')
       @content = content

data/lib/japr/compressor.rb

@@ -1,4 +1,6 @@
 module JAPR
+  # Base class for asset compressors
+  # See https://github.com/janosrusiczki/japr#asset-compression
   class Compressor
     extend JAPR::SubclassTracking
 
@@ -8,9 +10,7 @@ module JAPR
     end
 
     # Returns compressed content
-    def compressed
-      @compressed
-    end
+    attr_reader :compressed
 
     # Filetype to process (e.g. '.js')
     def self.filetype

data/lib/japr/converter.rb

@@ -1,4 +1,6 @@
 module JAPR
+  # Base class for asset converters
+  # See https://github.com/janosrusiczki/japr#asset-preprocessing
   class Converter
     extend JAPR::SubclassTracking
 
@@ -9,9 +11,7 @@ module JAPR
       @converted = convert
     end
 
-    def converted
-      @converted
-    end
+    attr_reader :converted
 
     # Filetype to process (e.g. '.coffee')
     def self.filetype

data/lib/japr/extensions/jekyll/site.rb

@@ -1,4 +1,6 @@
 module Jekyll
+  # Contains overrides for the needed Jekyll:Site methods
+  # The actual code is in JAPR::JekyllSiteExtensions
   class Site
     include JAPR::JekyllSiteExtensions
   end

data/lib/japr/extensions/jekyll/site_extensions.rb

@@ -1,4 +1,6 @@
 module JAPR
+  # Contains overrides for the needed Jekyll:Site methods
+  # Included in Jekyll::Site
   module JekyllSiteExtensions
     def self.included(base)
       base.class_eval do

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

@@ -1,4 +1,7 @@
 module JAPR
+  # This is a Liquid tag block extension
+  # See documentation here:
+  # https://github.com/Shopify/liquid/wiki/liquid-for-programmers#create-your-own-tag-blocks
   class AssetTag < ::Liquid::Block
     extend JAPR::LiquidBlockExtensions::ClassMethods
     include JAPR::LiquidBlockExtensions

data/lib/japr/extensions/liquid/asset_tags/css_asset_tag.rb

@@ -1,4 +1,8 @@
+# This comment is needed, otherwise Rubocop complains because of the
+# register_tag below and a verbose comment is better than a :nodoc: :)
 module JAPR
+  # css_asset_tag Liquid block
+  # See JAPR::AssetTag and JAPR::LiquidBlockExtensions
   class CssAssetTag < JAPR::AssetTag
     def self.tag_name
       'css_asset_tag'

data/lib/japr/extensions/liquid/asset_tags/javascript_asset_tag.rb

@@ -1,4 +1,8 @@
+# This comment is needed, otherwise Rubocop complains because of the
+# register_tag below and a verbose comment is better than a :nodoc: :)
 module JAPR
+  # javascript_asset_tag Liquid block
+  # See JAPR::AssetTag and JAPR::LiquidBlockExtensions
   class JavaScriptAssetTag < JAPR::AssetTag
     def self.tag_name
       'javascript_asset_tag'

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

@@ -1,5 +1,10 @@
 module JAPR
+  # Helper module used by JAPR::AssetTag as well as
+  # classed derived from it (Liquid tag block extensions)
+  # See documentation here:
+  # https://github.com/Shopify/liquid/wiki/liquid-for-programmers#create-your-own-tag-blocks
   module LiquidBlockExtensions
+    # Unsurprisingly, class methods
     module ClassMethods
       def output_type
         ''

data/lib/japr/extensions/ruby/subclass_tracking.rb

@@ -1,4 +1,5 @@
 module JAPR
+  # Allows classes that extend this to return an array of their subclasses
   module SubclassTracking
     # Record subclasses of this class (this method is automatically called by
     # ruby)

data/lib/japr/pipeline.rb

@@ -1,4 +1,5 @@
 module JAPR
+  # The pipeline itself, the run method is where it all happens
   # rubocop:disable ClassLength
   class Pipeline
     class << self
@@ -9,14 +10,19 @@ module JAPR
           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
-          puts "Failed to generate hash from provided manifest: #{e.message}"
-          raise e
+        rescue StandardError => se
+          puts "Failed to generate hash from provided manifest: #{se.message}"
+          raise se
         end
       end
 
-      # Run pipeline
+      # Run the pipeline
+      # This is called from JAPR::LiquidBlockExtensions.render or,
+      # to be more precise, from JAPR::CssAssetTag.render and
+      # JAPR::JavaScriptAssetTag.render
+      # rubocop:disable ParameterLists
       def run(manifest, prefix, source, destination, tag, type, config)
+        # rubocop:enable ParameterLists
         # Get hash for pipeline
         hash = hash(source, manifest, config)
 
@@ -27,12 +33,12 @@ module JAPR
           puts "Processing '#{tag}' manifest '#{prefix}'"
           pipeline = new(manifest, prefix, source, destination, type, config)
           process_pipeline(hash, pipeline)
-        rescue Exception => e
+        rescue StandardError => se
           # Add exception to cache
-          cache[hash] = e
+          cache[hash] = se
 
           # Re-raise the exception
-          raise e
+          raise se
         end
       end
 
@@ -51,10 +57,6 @@ 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
       end
 
       # Add prefix to output
@@ -79,7 +81,9 @@ module JAPR
     end
 
     # Initialize new pipeline
+    # rubocop:disable ParameterLists
     def initialize(manifest, prefix, source, destination, type, options = {})
+      # rubocop:enable ParameterLists
       @manifest = manifest
       @prefix = prefix
       @source = source
@@ -114,10 +118,10 @@ module JAPR
                           File.dirname(full_path))
         end
       end
-    rescue Exception => e
+    rescue StandardError => se
       puts 'Asset Pipeline: Failed to load assets from provided ' \
-           "manifest: #{e.message}"
-      raise e
+           "manifest: #{se.message}"
+      raise se
     end
 
     # Convert assets based on the file extension if converter is defined
@@ -152,10 +156,10 @@ module JAPR
       if File.extname(asset.filename) == ''
         asset.filename = "#{asset.filename}#{@type}"
       end
-    rescue Exception => e
+    rescue StandardError => se
       puts "Asset Pipeline: Failed to convert '#{asset.filename}' " \
-           "with '#{klass}': #{e.message}"
-      raise e
+           "with '#{klass}': #{se.message}"
+      raise se
     end
 
     # Bundle multiple assets into a single asset
@@ -178,10 +182,10 @@ module JAPR
 
         begin
           asset.content = klass.new(asset.content).compressed
-        rescue Exception => e
+        rescue StandardError => se
           puts "Asset Pipeline: Failed to compress '#{asset.filename}' " \
-               "with '#{klass}': #{e.message}"
-          raise e
+               "with '#{klass}': #{se.message}"
+          raise se
         end
       end
     end
@@ -219,10 +223,10 @@ module JAPR
         File.open(File.join(directory, asset.filename), 'w') do |file|
           file.write(asset.content)
         end
-      rescue Exception => e
+      rescue StandardError => se
         puts "Asset Pipeline: Failed to save '#{asset.filename}' to " \
-             "disk: #{e.message}"
-        raise e
+             "disk: #{se.message}"
+        raise se
       end
     end
 

data/lib/japr/template.rb

@@ -1,5 +1,8 @@
 module JAPR
+  # Base class for the tag templates
+  # See https://github.com/janosrusiczki/japr#templates
   class Template
+    include JAPR::TemplateHelper
     extend JAPR::SubclassTracking
 
     def initialize(path, filename)

data/lib/japr/templates/css_tag_template.rb

@@ -1,8 +1,6 @@
 module JAPR
   # Default output for CSS assets
   class CssTagTemplate < JAPR::Template
-    include JAPR::TemplateHelper
-
     def self.filetype
       '.css'
     end

data/lib/japr/templates/javascript_tag_template.rb

@@ -1,8 +1,6 @@
 module JAPR
   # Default output for JavaScript assets
   class JavaScriptTagTemplate < JAPR::Template
-    include JAPR::TemplateHelper
-
     def self.filetype
       '.js'
     end

data/lib/japr/templates/template_helper.rb

@@ -1,4 +1,5 @@
 module JAPR
+  # Contains helper methods used by the tag template classes
   module TemplateHelper
     def output_path
       root_path? ? '' : "/#{@path}"

data/lib/japr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: japr
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Matt Hodan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-03 00:00:00.000000000 Z
+date: 2017-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -58,23 +58,24 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.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.'
+      Compressor, Google Closure Compiler, etc.) to Jekyll.
 email: japr@clicktrackheart.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/japr.rb
@@ -106,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="