rails_external_assets 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 401fb50bb26e74bd9809f5ae1ae36b25b3bee376
-  data.tar.gz: 5358ed54efd266a62a4dab5c34d0d420e579b750
+  metadata.gz: 1a8296d0928ee3d04fbba98fa47115bfb94ab2fd
+  data.tar.gz: 2a7ecabde06eb56b5a277999e50cceb6b81f55b8
 SHA512:
-  metadata.gz: 5235105c1e0824f8d66d818869ef4a7d79089da4424c7b4cb0e983d837ce47f4d0d6bf69fd16f13c2aea19c4eb2652ead91a08685ffe4aae4cf77644ed546f28
-  data.tar.gz: 973a6cb4201c7d2889d637fbfc6ff850bbb4414e19f3f8b652e486c33f1270dbe309fe64422e372db7a4a20a0fa459249f0be5953825de47c2c80bd9d142899f
+  metadata.gz: 9e4c283b7a59685d4bb0af2d9cd4f1300c4d822a277bf7b56763cff2aa6b7ff5103ecde44d49b99a0b5c46f50b60b0b672abdbb62e9cb698113be65213aada90
+  data.tar.gz: 93af807ba4ad0a0c95091b861f089364c2828fc5ead67148900cfd6660c12f681ad7716782780a280430c4fab25d74b15bc986a5a496663d358c95a439e9e2bf

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.3.0 (2016-6-2)
+
+Added:
+
+- Added `external_require_directory` and `external_require_tree` Sprockets directives. [c8adab7](../../commit/c8adab7)
+
+Changed:
+
+- Rails view helpers `external_asset_js` and `external_asset_css` no longer require file extensions. [5bb278b](../../commit/5bb278b)
+- `external_require` Sprockets directive does not need an explicit extension. It will be inferred if not provided. [d8be100](../../commit/d8be100)

data/README.md

@@ -9,7 +9,8 @@ RailsExternalAssets allows you to use the frontend build tool of your choice ([w
 {
   "js/module.js": "builds/js/module-12312abc.js",
   "js/react-component.jsx": "builds/components/react-component-ab123x.js",
-  "css/styling.sass": "builds/styles/styling-129xha.css"
+  "css/styling.sass": "builds/styles/styling-129xha.css",
+  "pathToPreBuiltAsset": "pathToBuiltAsset"
 }
 ```
 
@@ -45,7 +46,7 @@ RailsExternalAssets will also hook into the `assets:precompile` Rake command and
 
 #### JavaScript
 
-You can include a JavaScript file with `external_asset_js`. Note that the name of the file MUST include the file extension and the file name is the key in the asset manifest JSON file.
+You can include a JavaScript file with `external_asset_js`. Note that the string argument must correspond to an entry in the manifest file, including the file extension. If you do not include a file extension, `js` will be used by default.
 
 ```erb
 <%= external_asset_js 'myFile.js' %>
@@ -53,15 +54,15 @@ You can include a JavaScript file with `external_asset_js`. Note that the name o
 
 #### CSS
 
-You can include a CSS file with `external_asset_css`. Note that the name of the file MUST include the file extension and the file name is the key in the asset manifest JSON file.
+You can include a CSS file with `external_asset_css`. Note that the string argument must correspond to an entry in the manifest file, including the file extension. If you do not include a file extension, `css` will be used by default.
 
 ```erb
-<%= external_asset_css 'myFile.sass' %>
+<%= external_asset_css 'myFile.css' %>
 ```
 
 #### Image
 
-You can include a Image file with `external_asset_img`. Note that the name of the file MUST include the file extension and the file name is the key in the asset manifest JSON file.
+You can include a Image file with `external_asset_img`. Note that the string argument must correspond to an entry in the manifest file, including the file extension.
 
 ```erb
 <%= external_asset_img 'myFile.jpg' %>
@@ -71,27 +72,33 @@ You can include a Image file with `external_asset_img`. Note that the name of th
 
 By default, you can use the `external_require` directive in JavaScript and CSS manifest files, but you can add more (Sass, SCSS, CoffeeScript, etc) by setting the configuration (check out the configuration docks for `sprockets_directives`).
 
-In any file type you configure the Sprockets directive to be available in you, can use the `external_require` directive to include an external asset in the Sprockets manifest. Note that you MUST specify the file extension when using `external_require`.
+In any file type you configure the Sprockets directive to be available in you, can use the `external_require` directives to include an external asset in the Sprockets manifest. If you do not include an extension, Sprockets will try to use an extension based on the extension of the file you required it in. Sprockets will also ensure that each file is only included once, even if directives overlap and require the file more than once.
+
+The available directives are, `external_require`, `external_require_directory`, and `external_require_tree`, corresponding to the build in directives, `require`, `require_directory`, and `require_tree`.
 
 An example `application.js` Sprockets manifest file:
 
 ```js
 //= require normalAsset
-//= require more/anotherAsset.js
-//= external_require externals/firstAsset.js
-//= external_require externals/anotherAsset.js
+//= require more/anotherAsset
+//= external_require externals/firstAsset
+//= external_require externals/anotherAsset
+//= external_require_directory externals/myFolder
+//= external_require_tree externals/folderWithMoreFolders
 ```
 
-This will include the first two JS assets, `normalAsset` and `anotherAsset` from Rails' asset pipeline, and the last two JS assets, `firstAsset` and `anotherAsset` from your external assets. The external assets are resolved by looking up these files in the asset manifest JSON file provided.
+This will include the first two JS assets, `normalAsset` and `anotherAsset` from Rails' asset pipeline, and the other JS assets, `firstAsset`, `anotherAsset`, all JS files directly in `externals/myFolder`, and all JS files in the tree `externals/folderWithMoreFolders` from your external assets. The external assets are resolved by looking up these files in the asset manifest JSON file provided.
 
 ## With Plain Ruby
 
-RailsExternalAssets::AssetFinder provides two methods for your disposal.
+`RailsExternalAssets::AssetFinder` provides three methods for your disposal.
 
 `asset_path` takes a path to an external asset file, and returns the corresponding built asset path by looking up the key in the asset manifest JSON file.
 
 `exeternal_asset` takes a path and returns the built asset path (the result of `asset_path`) and joins it with the base path. If a block is provided, the external asset path is passed to the block and the resulting value is returned.
 
+`asset_manifest` is used by `asset_path`, and returns the asset manifest file parsed as JSON.
+
 ## Configuration
 
 Configuration settings can be modified within the `RailsExternalAssets.configure` block. Or set directly off of `RailsExternalAssets.config`

data/lib/rails_external_assets/asset_finder.rb

@@ -8,14 +8,17 @@ module RailsExternalAssets
     end
 
     def asset_path(path)
-      manifest_file = RailsExternalAssets.config.manifest_file
-      throw_invalid_manifest(manifest_file) unless File.file? manifest_file
-      asset_manifest = JSON.parse(File.read manifest_file)
       new_path = asset_manifest[path]
-      throw_unknown_path(path, manifest_file) unless new_path
+      throw_unknown_path(path, RailsExternalAssets.config.manifest_file) unless new_path
       new_path
     end
 
+    def asset_manifest
+      manifest_file = RailsExternalAssets.config.manifest_file
+      throw_invalid_manifest(manifest_file) unless File.file? manifest_file
+      JSON.parse(File.read manifest_file)
+    end
+
 
     private
 

data/lib/rails_external_assets/rails/view_helpers.rb

@@ -4,11 +4,15 @@ module RailsExternalAssets
       include RailsExternalAssets::AssetFinder
 
       def external_asset_js(path)
-        external_asset(path) { |p| javascript_include_tag p }
+        ext_name = File.extname(path)
+        ext = ext_name.empty? ? '.js' : ''
+        external_asset("#{path}#{ext}") { |p| javascript_include_tag p }
       end
 
       def external_asset_css(path)
-        external_asset(path) { |p| stylesheet_link_tag p }
+        ext_name = File.extname(path)
+        ext = ext_name.empty? ? '.css' : ''
+        external_asset("#{path}#{ext}") { |p| stylesheet_link_tag p }
       end
 
       def external_asset_img(path)

data/lib/rails_external_assets/sprockets/directive_processor.rb

@@ -4,9 +4,33 @@ module RailsExternalAssets
       include RailsExternalAssets::AssetFinder
 
        def process_external_require_directive(path)
-         new_path = asset_path(path)
+         ext_name = File.extname(path)
+         ext = ext_name.empty? ? file_extension : ''
+         new_path = asset_path("#{path}#{ext}")
          process_require_directive new_path
        end
+
+       def process_external_require_directory_directive(path)
+         selected_paths = asset_manifest.keys
+          .select { |key| key.match "#{File.join(path, '[^/]+\..+')}" }
+          .select { |path| File.extname(path) == file_extension }
+         selected_paths.each { |path| process_external_require_directive path }
+       end
+
+       def process_external_require_tree_directive(path)
+         selected_paths = asset_manifest.keys
+          .select { |key| key.match File.join(path) }
+          .select { |path| File.extname(path) == file_extension }
+         selected_paths.each { |path| process_external_require_directive path }
+       end
+
+
+       private
+
+       def file_extension
+         mime_ext = @environment.mime_exts.find { |_, value| value == @content_type }
+         mime_ext && mime_ext[0]
+       end
     end
   end
 end

data/lib/rails_external_assets/version.rb

@@ -1,3 +1,3 @@
 module RailsExternalAssets
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_external_assets
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonathan Lehman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,6 +63,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt