generated-assets 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4cf81eebd83b1acc69275bd1fe965a32898c536
-  data.tar.gz: 51fdabfa4a74c4a655af7065cb6b7d0f4198422a
+  metadata.gz: 71e9c2a099eb83446024318fc648d1f2a57ef50b
+  data.tar.gz: 7ac07e9534630ac83a82e98827a3c3c2cd13bca4
 SHA512:
-  metadata.gz: 3909ae41e89c248431a372d19ccc8e7208cf05180423a75f141af0859d42e3935fc0d75fdd1841d8671bf6b5b1bd1888af6fb68121db9e3552a62e6b69322254
-  data.tar.gz: 664275e1ea404113a537dcff559b430943664171f415c6be11c49d398f4986c91e694c927274c012851f0936a03c34a5fcd0c63b6e4d0aa71a595a93041d0476
+  metadata.gz: a6b189e44deb8ce5769fd3ea675ffe6c83c7c6d97162797508672228f6ee0ad2703bc83b276e6c89bde82c3b306c9f68930ec508ffffd21db4288642886e2a1a
+  data.tar.gz: d1fd3b855001ab803d6c92489db691cf1845af61df1e474be98b50ee15e6aa4441dbaca6a4fcba6bc5d375f2ee342bfa5b1a66c14e61f0d0b2fc43990806cc43

data/README.md

@@ -0,0 +1,56 @@
+## generated-assets
+Programmatically generate assets for the Rails asset pipeline.
+
+## Installation
+
+`gem install generated-assets`
+
+or put it in your Gemfile:
+
+```ruby
+gem 'generated-assets'
+```
+
+This gem is designed to work with Rails. Adding it to your Gemfile should be enough to add it to your project - you shouldn't need to manually require it.
+
+### Rationale
+
+The Rails asset pipeline is great, but not super extensible. Generally speaking, any file you want it to recognize has to be on disk somewhere. That's pretty limiting, especially if you have a bunch of similar resources you'd like to add, but don't want to create individual files for. A great example is translations in Javascript. You probably don't want to include the translations for every locale in your Javascript bundle. Wouldn't it be nice if you could iterate over a list of locales and add translation files programmatically? This gem can help.
+
+### Getting Started
+
+The generated-assets gem adds an attribute called `generated` to the Rails configuration object. Adding assets is easy:
+
+```ruby
+# config/application.rb
+
+I18n.available_locales.each do |locale|
+  config.assets.generated.add("translations-#{locale}.js") do
+    "window.translations ||= {}; window.translations.#{locale} = { ... }"
+  end
+end
+```
+
+The `add` method expects to be given the path of the new asset and a block. The return value of the block gets written inside the new asset file.
+
+### Asset Precompilation
+
+The gem also supports adding any generated assets to your application's precompile list. Just include `precompile: true`:
+
+```ruby
+config.assets.generated.add("my_asset.css", precompile: true) do
+  ...
+end
+```
+
+### How Does it Work?
+
+Under the covers, generated-assets creates a temporary directory that it adds to the asset pipeline's load path. It then writes each file you've requested to the temporary directory. As far as the asset pipeline is concerned, those files are accessible and available as if they lived in your `app/assets` directory.
+
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/lib/generated-assets.rb

@@ -1,6 +1,5 @@
 # encoding: UTF-8
 
-require 'fileutils'
 require 'generated-assets/railtie'
 require 'securerandom'
 require 'tmpdir'
@@ -14,9 +13,7 @@ module GeneratedAssets
   class << self
     def asset_dir
       @asset_dir ||= begin
-        dir = File.join(Dir.tmpdir, SecureRandom.hex)
-        FileUtils.mkdir_p(dir)
-        dir
+        File.join(Dir.tmpdir, SecureRandom.hex)
       end
     end
   end

data/lib/generated-assets/manifest.rb

@@ -1,5 +1,7 @@
 # encoding: UTF-8
 
+require 'fileutils'
+
 module GeneratedAssets
   class Manifest
     attr_reader :app, :prefix, :entries
@@ -37,11 +39,17 @@ module GeneratedAssets
     private
 
     def write_files
+      ensure_prefix_dir_exists unless entries.empty?
+
       entries.each do |entry|
         entry.write_to(prefix)
       end
     end
 
+    def ensure_prefix_dir_exists
+      FileUtils.mkdir_p(prefix)
+    end
+
     def add_precompile_paths
       entries.each do |entry|
         if entry.precompile?

data/lib/generated-assets/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module GeneratedAssets
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/spec/log/test.log

@@ -75,3 +75,6 @@ Compiled application.js  (0ms)  (pid 48920)
 Compiled application.js  (0ms)  (pid 68040)
 Compiled application.js  (0ms)  (pid 68194)
 Compiled application.js  (0ms)  (pid 68208)
+Compiled application.js  (0ms)  (pid 8591)
+Compiled application.js  (0ms)  (pid 8597)
+Compiled application.js  (0ms)  (pid 8602)

data/spec/precomp_spec.rb

@@ -16,19 +16,29 @@ describe 'precompilation' do
     )
   end
 
-  it 'precompiles generated assets correctly' do
-    assets_config.generated.add('foo/bar.txt', precompile: true) do
-      'bar text'
-    end
-
-    assets_config.generated.apply!
+  let(:prefix) do
+    Pathname(assets_config.generated.prefix)
+  end
 
+  def run_precompile_task
     begin
       Rake::Task['assets:precompile:primary'].invoke
       Rake::Task['assets:precompile:nondigest'].invoke
     rescue RuntimeError
       Rake::Task['assets:precompile'].invoke
     end
+  end
+
+  it 'precompiles generated assets correctly' do
+    assets_config.generated.add('foo/bar.txt', precompile: true) do
+      'bar text'
+    end
+
+    expect(prefix).to_not exist
+    assets_config.generated.apply!
+    expect(prefix).to exist
+
+    run_precompile_task
 
     rails_manifest = RailsManifest.load_for(app)
     digest_file = rails_manifest.find_by_logical('foo/bar.txt')
@@ -37,4 +47,12 @@ describe 'precompilation' do
     contents = asset_path.join(digest_file).read
     expect(contents).to eq('bar text')
   end
+
+  it 'does not create a temp directory if no assets have been added' do
+    expect(prefix).to_not exist
+    assets_config.generated.apply!
+    expect(prefix).to_not exist
+    run_precompile_task
+    expect(prefix).to_not exist
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generated-assets
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -66,6 +66,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- README.md
 - Rakefile
 - generated-assets.gemspec
 - lib/generated-assets.rb