condenser 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e7abbeccce903c2ecbdf3f01c0c8165a3d21f9a38181f65e761a1e80d4dcf04
-  data.tar.gz: 713104a8b2287eb00fc1e468d64febb6186f308bd5fa8b600a1f6cca03f6d23c
+  metadata.gz: ab40d1eb05ff854d115ac6c4118dc6c8f963f96a71f52d9f0ef326eea9867d66
+  data.tar.gz: 3f0fe2328e3b53f3e42d6c248267f16e631602ad0e67e8b669af08690f4df208
 SHA512:
-  metadata.gz: 531495f24e6469440b908b30416b18ac7abad35aaabc1f0a714013879e3b76803ea543120f5d21484498684868e43a740c1f84382e498e45c69891061bbada4b
-  data.tar.gz: 2a2253ef0137a4540c486081f37a5a031f85dc2fa902e8577a68dee2dd824098f87ad51edb3a3a512dd3b6e558755e28652a53f15f6a7741c996db67d91c66b2
+  metadata.gz: a5f165dc1e99735799efca86ba2ceb76660750ed92a1dfb4143e39654b472b5f1664a49fe1b6967b687e54e3c06209de3a075ac882e2bb1e0a231361f8de13b4
+  data.tar.gz: bf13599783b114ef0f520f48cc613a3ec4ace5174e6867f3c01ae79c50044455a8354d498dd90800effe561c479e89661a80701deefeddd69721376af04f5c47

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Jon Bracy
+Copyright (c) 2020 Jon Bracy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1 +1,283 @@
-# condenser
+
+# Condenser
+
+Condenser is a Ruby library for compiling and serving static web assets
+inspired by [Sprockets](https://github.com/rails/sprockets). It features
+a powerful pipeline that allows you to write assets in languages like Sass
+and SCSS.
+
+## Installation
+
+Install Sprockets from RubyGems:
+
+``` sh
+$ gem install condenser
+```
+
+Or include it in your project's `Gemfile` with Bundler:
+
+``` ruby
+gem 'condenser'
+```
+
+## Guides
+
+For most people interested in Condenser, you will want to see the README below.
+
+If you are a framework developer see [Building an Asset Processing Framework](guides/building_an_asset_processing_framework.md).
+
+If you are a library developer who is extending Condenser, see [Extending Condenser](guides/extending_condenser.md).
+
+If you want to work on Condenser or better understand how it works read [How Condenser Works](guides/how_condenser_works.md).
+
+## Overview
+
+Since you are likely using Condenser through another framework, there will be
+configuration options you can toggle that will change behavior such as what
+directories or files get compiled. For that documentation you should see your
+framework's documentation.
+
+#### Accessing Assets
+
+Assets in Condenser are always referenced by their *logical path*.
+
+The logical path is the path of the asset source file relative to its
+containing directory in the load path. For example, if your load path
+contains the directory `app/assets/javascripts`:
+
+<table>
+  <tr>
+    <th>Logical path</th>
+    <th>Source file on disk</th>
+  </tr>
+  <tr>
+    <td>application.js</td>
+    <td>app/assets/javascripts/application.js</td>
+  </tr>
+  <tr>
+    <td>models/project.js</td>
+    <td>app/assets/javascripts/models/project.js</td>
+  </tr>
+  <tr>
+    <td>hello.js</td>
+    <td>app/assets/javascripts/hello.coffee</td>
+  </tr>
+</table>
+
+> Note: For assets that are compiled or transpiled, you may want to specify the
+  extension that you want, not the extension on disk. For example we specified
+  `hello.js` even if the file on disk is a coffeescript file, since the asset
+  it will generate is javascript.
+
+## File Order Processing
+
+By default files are processed in alphabetical order. This behavior can impact your asset compilation when one asset needs to be loaded before another.
+
+For example if you have an `application.js` and it loads another directory
+
+```js
+import initializers from 'config/initializers/*';
+
+initializers.forEach((i) => i());
+```
+
+The files in that directory will be loaded in alphabetical order. If the directory looks like this:
+
+```sh
+$ ls -1 config/initializers/
+
+alpha.js
+beta.js
+gamma.js
+```
+
+Then `alpha.js` will be loaded before either of the other two. This can be a problem if `gamma.js` needs to be called before `alpha.js`. For files that are ordering dependent you can either require individual files manually:
+
+```js
+import alpha from 'config/initializers/alpha';
+import beta from 'config/initializers/beta';
+import gamma from 'config/initializers/gamma';
+
+gamma();
+alpha();
+beta();
+```
+
+## Cache
+
+Compiling assets is slow. It requires a lot of disk use to pull assets off of hard drives, a lot of RAM to manipulate those files in memory, and a lot of CPU for compilation operations. Because of this Condenser has a cache to speed up asset compilation times. That's the good news. The bad news, is that Condenser has a cache and if you've found a bug it's likely going to involve the cache.
+
+By default Condenser uses the file system to cache assets. It makes sense that Condenser does not want to generate assets that already exist on disk in `public/assets`, what might not be as intuitive is that Condenser needs to cache "partial" assets.
+
+For example if you have an `application.js` and it is made up of `a.js`, `b.js`, all the way to `z.js`
+
+```js
+import 'a';
+import 'b';
+// ...
+import 'z';
+```
+
+The first time this file is compiled the `application.js` output will be written to disk, but also intermediary compiled files for `a.js` etc. will be written to the cache directory (usually `tmp/cache/assets`).
+
+So, if `b.js` changes it will get recompiled. However instead of having to recompile the other files from `a.js` to `z.js` since they did not change, we can use the prior intermediary files stored in the cached values . If these files were expensive to generate, then this "partial" asset cache strategy can save a lot of time.
+
+Directives such as `import` in Javascript and `@import` in SCSS tell Condenser what assets need to be re-compiled when a file changes. Files are considered "fresh" based on their inode number, mtime, size and a combination of cache keys.
+
+In Rails you can force a "clean" install by clearing the `public/assets` and `tmp/cache/assets` directories.
+
+### Invoking Ruby with ERB
+
+Condenser provides an ERB engine for preprocessing assets using
+embedded Ruby code. Append `.erb` to a CSS or JavaScript asset's
+filename to enable the ERB engine.
+
+For example if you have an `app/application/javascripts/app_name.js.erb`
+you could have this in the template
+
+```js
+var app_name = "<%= ENV['APP_NAME'] %>";
+```
+
+Generated files are cached. If you're using an `ENV` var then
+when you change then ENV var the asset will be forced to
+recompile. This behavior is only true for environment variables,
+if you are pulling a value from somewhere else, such as a database,
+must manually invalidate the cache to see the change.
+
+If you're using Rails, there are helpers you can use such as `asset_url`
+that will cause a recompile if the value changes.
+
+For example if you have this in your `application.css.erb`
+
+``` css.erb
+.logo {
+  background: url(<%= asset_url("logo.png") %>)
+}
+```
+
+When you modify the `logo.png` on disk, it will force `application.css` to be
+recompiled so that the fingerprint will be correct in the generated asset.
+
+### Styling with Sass and SCSS
+
+[Sass](http://sass-lang.com/) is a language that compiles to CSS and
+adds features like nested rules, variables, mixins and selector
+inheritance.
+
+If the `sassc` gem is available to your application, you can use Sass
+to write CSS assets in Condenser.
+
+Condenser supports both Sass syntaxes. For the original
+whitespace-sensitive syntax, use the extension `.sass`. For the
+new SCSS syntax, use the extension `.scss`.
+
+In Rails if you have `app/application/stylesheets/foo.scss` it can
+be referenced with `<%= asset_path("foo.css") %>`. When referencing
+an asset in Rails, always specify the extension you want. Condenser will
+convert `foo.scss` to `foo.css`.
+
+## Javascript, ES#, & ES Modules
+
+Condenser transforms Javascript for the browser by transpiling all the files `.js` through [babel](https://babeljs.io) and bundled together via [rollup.js](https://rollupjs.org/).
+
+```js
+// app/assets/javascript/application.js
+
+var square = (n) => n * n
+
+console.log(square);
+```
+
+Start a Rails server in development mode and visit `localhost:3000/assets/application.js`, and this asset will be transpiled to JavaScript:
+
+```js
+var square = function square(n) {
+  return n * n;
+};
+
+console.log(square);
+```
+
+
+### JavaScript Templating with EJS
+
+Condenser supports *JavaScript templates* for client-side rendering of
+strings or markup. JavaScript templates have the special format
+extension `.jst` and are compiled to JavaScript functions.
+
+The templates can then be imported. When invoked they will render the template
+as a string that can be inserted into the DOM.
+
+```javascript
+<!-- templates/hello.jst.ejs -->
+<div>Hello, <span><%= name %></span>!</div>
+
+import hello from 'templates/hello';
+
+$("#hello").html(hello({ name: "Sam" }));
+```
+
+If the `ejs` gem is available to your application, you can use EJS
+templates in Condenser. EJS templates have the extension `.jst.ejs`.
+
+### Minifying Assets
+
+Several JavaScript and CSS minifiers are available through shorthand.
+
+In Rails you will specify them with:
+
+```ruby
+config.assets.js_minifier  = :uglify
+config.assets.css_minifier = :scss
+```
+
+If you're not using Rails, configure this directly on the "environment".
+
+``` ruby
+environment.register_minifier 'text/css', Condenser::SassMinifier
+environment.register_minifier 'application/javascript', Condenser::UglifyMinifier
+```
+
+If you are using Condenser directly with a Rack app, don't forget to add
+the dependencies (the `sassc` gem in the example above) to your Gemfile.
+
+### Gzip
+
+By default when Condenser generates a compiled asset file it will also produce a
+gzipped copy of that file. Condenser only gzips non-binary files such as CSS,
+javascript, and SVG files.
+
+For example if Condenser is generating
+
+```
+application-12345.css
+```
+
+Then it will also generate a compressed copy in
+
+```
+application-12345.css.gz
+```
+
+This behavior can be disabled, refer to your framework specific documentation.
+
+### Serving Assets
+
+In production you should generate your assets to a directory on disk and serve
+them either via Nginx or a feature like Rail's `config.public_file_server.enabled = true`.
+
+On Rails you can generate assets by running:
+
+```term
+$ RAILS_ENV=production rails assets:precompile
+```
+
+In development Rails will serve assets from `Condenser::Server`.
+
+### Version History
+
+Please see the [CHANGELOG](https://github.com/malomalo/condenser/tree/master/CHANGELOG.md)
+
+## License
+Condenser is released under the [MIT License](MIT-LICENSE).

data/lib/condenser/manifest.rb

@@ -60,7 +60,7 @@ class Condenser
       
       outputs = []
       args.each do |arg|
-        @environment.resolve!(arg).each do |asset|
+        @environment.resolve(arg).each do |asset|
           outputs += add_asset(asset)
         end
       end
@@ -122,6 +122,9 @@ class Condenser
     def clobber
       return if !Dir.exist?(dir)
       
+      FileUtils.rm(filename)
+      logger.info "Removed #{filename}"
+      
       Dir.each_child(dir) do |child|
         FileUtils.rm_r(File.join(dir, child))
       end

data/lib/condenser/version.rb

@@ -1,3 +1,3 @@
 class Condenser
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/condenser/writers/file_writer.rb

@@ -9,8 +9,12 @@ class Condenser::FileWriter
     @mime_types = mime_types || '*/*'
   end
 
+  def path(asset)
+    asset.path
+  end
+  
   def exist?(asset)
-    ::File.exist?(asset.path)
+    ::File.exist?(path(asset))
   end
 
   def call(output_directory, asset)

data/lib/condenser/writers/zlib_writer.rb

@@ -22,8 +22,12 @@ class Condenser::ZlibWriter
     @added_mime_types = added_mime_types || ADDED_MIME_TYPES
   end
   
+  def path(asset)
+    "#{asset.path}.gz"
+  end
+  
   def exist?(asset)
-    ::File.exist?("#{asset.path}.gz")
+    ::File.exist?(path(asset))
   end
 
   def call(output_directory, asset)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: condenser
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Jon Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-ejs