opal-webpack-loader 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e38eb7715652124bd768935c886cf8eac35e9cba389c331a5cdedb02309da6c
-  data.tar.gz: 1ee22be3cbc82393fa4c96bfbb46f03e4fc10832e3d3585994a2d8a5f35a7d20
+  metadata.gz: b9bfab5e0fa697ff318110425f9d31c8b7778ca8f8b0459ef9aa7a6896ff2b0e
+  data.tar.gz: 8317f60c83191b8a9089675c0fcc9bdb4049ae2b29bb1e1009c3fb88ce7c8d6e
 SHA512:
-  metadata.gz: 92447360d5f475c9d914b508d35f1deb4add5ac8b94d253cc55c8821a933855644f5c2b939660beaa8040b4c31abc338b1a76df168df0d1da5221f999c7365c7
-  data.tar.gz: 7fe89a6a56545d637bda8174b0ae8fef1e0843ad6543b1ead6f2c16dc2b77f5ac04a94a1f01b8688a0b998e2ac01a75f2539989a1066a1053a01740ba2023d68
+  metadata.gz: 1327659b282452073e130dba988a5722071c6ac74b65598021f8e1b2f4a55e3e527ddab6e7770a5a03d35fb298aeabbd2c3e99480fda1b3ee189a83cac97bc91
+  data.tar.gz: c9c470768b357e3e13ff7210db09f39453595ba837bf7d96e279cfb9487f56c39dda004c4589e251d1db185e0ee4af5fbd4aa83e47e02a6a507ab8911a9ee420

data/lib/opal-webpack-loader/installer_cli.rb

@@ -46,7 +46,7 @@ module OpalWebpackLoader
         FileUtils.touch(File.join(@asset_output_directory, '.keep'))
         install_webpack_config
         install_gitignore
-        create_file_from_template('initializer.rb.erb', File.join('owl_init.rb'), { opal_directory: @opal_directory })
+        create_file_from_template('initializer.rb.erb', File.join('owl_init.rb'), { opal_load_path: '' })
         # add_gem
       end
 
@@ -83,8 +83,8 @@ module OpalWebpackLoader
         create_common_directories
         install_common_things
         create_file_from_template('application.css.erb', File.join('styles', 'application.css'), {})
-        create_file_from_template('initializer.rb.erb', 'owl_init.rb', { opal_directory: @opal_directory })
-        create_file_from_template('app_loader.rb.erb', 'app_loader.rb', {})
+        create_file_from_template('initializer.rb.erb', 'owl_init.rb', { opal_load_path: '' })
+        create_file_from_template('app_loader.rb.erb', 'app_loader.rb', { opal_directory: @opal_directory })
         add_gem
         print_message
       end
@@ -127,7 +127,7 @@ module OpalWebpackLoader
         create_common_directories
         install_common_things
         create_file_from_template('initializer.rb.erb', File.join('config', 'initializers', 'opal_webpack_loader.rb'),
-                                  { opal_directory: @opal_directory })
+                                  { opal_load_path: "Opal.append_path(File.realdirpath('#{@opal_directory}'))" })
         add_gem
         print_message
       end
@@ -174,7 +174,7 @@ module OpalWebpackLoader
         install_opal_entries
         install_gitignore
         create_file_from_template('initializer.rb.erb', File.join('config', 'initializers', 'opal_webpack_loader.rb'),
-                                  { opal_directory: @opal_directory })
+                                  { opal_load_path: "Opal.append_path(File.realdirpath('#{@opal_directory}'))" })
         add_gem
         print_message
       end

data/lib/opal-webpack-loader/templates/app_loader.rb.erb

@@ -1,11 +1,9 @@
 require 'bundler/setup'
-# change OWL_ENV to the projects name env, like MY_PROJECT_ENV
-env_name = 'OWL_ENV'
-if ENV[env_name] && ENV[env_name] == 'test'
+if ENV['RACK_ENV'] && ENV['RACK_ENV'] == 'test'
   Bundler.require(:default, :test)
-elsif ENV[env_name] && ENV[env_name] == 'production'
+elsif ENV['RACK_ENV'] && ENV['RACK_ENV'] == 'production'
   Bundler.require(:default, :production)
 else
   Bundler.require(:default, :development)
 end
-require './owl_init'
+Opal.append_path(File.realdirpath('<%= opal_directory %>'))

data/lib/opal-webpack-loader/templates/debug.js.erb

@@ -41,9 +41,7 @@ const common_config = {
         new webpack.NamedModulesPlugin(),
         new webpack.HotModuleReplacementPlugin(),
         // watch for added files in opal dir
-        new ExtraWatchWebpackPlugin({
-            dirs: [ path.resolve(__dirname, '<%= opal_directory %>') ]
-        })
+        new ExtraWatchWebpackPlugin({ dirs: [ path.resolve(__dirname, '<%= opal_directory %>') ] })
     ],
     module: {
         rules: [
@@ -55,15 +53,11 @@ const common_config = {
                     { loader: "cache-loader" },
                     {
                         loader: "style-loader",
-                        options: {
-                            hmr: true
-                        }
+                        options: { hmr: true }
                     },
                     {
                         loader: "css-loader",
-                        options: {
-                            sourceMap: true // set to false to speed up hot reloads
-                        }
+                        options: { sourceMap: true }
                     },
                     {
                         loader: "sass-loader",
@@ -81,15 +75,11 @@ const common_config = {
                     { loader: "cache-loader" },
                     {
                         loader: "style-loader",
-                        options: {
-                            hmr: true
-                        }
+                        options: { hmr: true }
                     },
                     {
                         loader: "css-loader",
-                        options: {
-                            sourceMap: true // set to false to speed up hot reloads
-                        }
+                        options: { sourceMap: true }
                     }
                 ]
             },
@@ -137,8 +127,6 @@ const common_config = {
             ignored: /\bnode_modules\b/
         },
         contentBase: path.resolve(__dirname, 'public'),
-        // watchContentBase: true,
-        // writeToDisk: true, // TODO this may need to be activated for ssr to work in development
         useLocalIp: false
     }
 };

data/lib/opal-webpack-loader/templates/development.js.erb

@@ -32,9 +32,7 @@ const common_config = {
         new webpack.NamedModulesPlugin(),
         new webpack.HotModuleReplacementPlugin(),
         // watch for added files in opal dir
-        new ExtraWatchWebpackPlugin({
-            dirs: [ path.resolve(__dirname, '<%= opal_directory %>') ]
-        })
+        new ExtraWatchWebpackPlugin({ dirs: [ path.resolve(__dirname, '<%= opal_directory %>') ] })
     ],
     module: {
         rules: [
@@ -46,18 +44,12 @@ const common_config = {
                     { loader: "cache-loader" },
                     {
                         loader: "style-loader",
-                        options: {
-                            hmr: true
-                        }
-                    },
-                    {
-                        loader: "css-loader"
+                        options: { hmr: true }
                     },
+                    { loader: "css-loader" },
                     {
                         loader: "sass-loader",
-                        options: {
-                            includePaths: [path.resolve(__dirname, '<%= stylesheets_directory %>')],
-                        }
+                        options: { includePaths: [path.resolve(__dirname, '<%= stylesheets_directory %>')] }
                     }
                 ]
             },
@@ -68,13 +60,9 @@ const common_config = {
                     { loader: "cache-loader" },
                     {
                         loader: "style-loader",
-                        options: {
-                            hmr: true
-                        }
+                        options: { hmr: true }
                     },
-                    {
-                        loader: "css-loader"
-                    }
+                    { loader: "css-loader" }
                 ]
             },
             {
@@ -121,8 +109,6 @@ const common_config = {
             ignored: /\bnode_modules\b/
         },
         contentBase: path.resolve(__dirname, 'public'),
-        // watchContentBase: true,
-        // writeToDisk: true,
         useLocalIp: false
     }
 };

data/lib/opal-webpack-loader/templates/initializer.rb.erb

@@ -1,6 +1,4 @@
-Opal.append_path(File.realdirpath('<%= opal_directory %>'))
-
-env = defined?(Rails) ? Rails.env : ENV['OWL_ENV']
+env = defined?(Rails) ? Rails.env : ENV['RACK_ENV']
 env = 'development' unless env
 if env != 'development'
   OpalWebpackLoader.client_asset_path = '' # the full path is in the manifest already, like: /assets/application-97fd9c2b7e7bdb112fc1.js
@@ -10,4 +8,5 @@ else
   OpalWebpackLoader.client_asset_path = 'http://localhost:3035/assets/'
   OpalWebpackLoader.manifest_path = nil
   OpalWebpackLoader.use_manifest = false
-end
+end
+<%= opal_load_path %>

data/lib/opal-webpack-loader/templates/package.json.erb

@@ -20,8 +20,8 @@
     "style-loader": "^0.23.1",
     "terser-webpack-plugin": "^1.2.3",
     "webpack": "^4.30.0",
+    "webpack-assets-manifest": "^3.1.1",
     "webpack-cli": "^3.3.0",
-    "webpack-dev-server": "^3.3.1",
-    "webpack-manifest-plugin": "^2.0.4"
+    "webpack-dev-server": "^3.3.1"
   }
 }

data/lib/opal-webpack-loader/templates/production.js.erb

@@ -1,7 +1,7 @@
 const path = require('path');
 const OwlResolver = require('opal-webpack-loader/resolver');
 const CompressionPlugin = require("compression-webpack-plugin"); // for gzipping the packs
-const ManifestPlugin = require('webpack-manifest-plugin');  // for generating the manifest
+const WebpackAssetsManifest = require('webpack-assets-manifest');
 const TerserPlugin = require('terser-webpack-plugin');
 
 const common_config = {
@@ -10,9 +10,7 @@ const common_config = {
     optimization: {
         minimize: true, // minimize
         minimizer: [
-            new TerserPlugin({
-                cache: true
-            })
+            new TerserPlugin({ cache: true })
         ]
     },
     performance: {
@@ -31,7 +29,7 @@ const common_config = {
     },
     plugins: [
         new CompressionPlugin({ test: /^((?!application_ssr).)*$/, cache: true }), // gzip compress, exclude application_ssr.js
-        new ManifestPlugin({ fileName: 'manifest.json' }) // generate manifest
+        new WebpackAssetsManifest({ publicPath: true }) // generate manifest
     ],
     module: {
         rules: [
@@ -41,9 +39,7 @@ const common_config = {
                     { loader: "cache-loader" },
                     {
                         loader: "style-loader",
-                        options: {
-                            hmr: false
-                        }
+                        options: { hmr: false }
                     },
                     {
                         loader: "css-loader",

data/lib/opal-webpack-loader/version.rb

@@ -1,3 +1,3 @@
 module OpalWebpackLoader
-  VERSION="0.8.4"
+  VERSION="0.8.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-webpack-loader
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -205,7 +205,6 @@ files:
 - lib/opal-webpack-loader/templates/webpacker_development.js_example
 - lib/opal-webpack-loader/version.rb
 - lib/opal-webpack-loader/view_helper.rb
-- readme.md
 homepage: http://isomorfeus.com
 licenses:
 - MIT

data/readme.md

@@ -1,217 +0,0 @@
-<h1 align="center">
-  <img src="https://raw.githubusercontent.com/isomorfeus/opal-webpack-loader/master/docs/owl.png" 
-  align="center" title="Opal logo by Elia Schito combined with Webpack Logo" width="111" height="125" />
-  <br/>
-  opal-webpack-loader<br/>
-  <img src="https://img.shields.io/badge/Opal-Ruby%20💛%20JavaScript%20💛%20Webpack-yellow.svg?logo=ruby&style=social&logoColor=777"/>
-</h1>
-
-Bundle assets with webpack, resolve and compile opal ruby files and import them in the bundle, without sprockets or the webpacker gem
- (but can be used with both of them too).
-Includes a loader and resolver plugin for webpack.
-
-### Community and Support
-At the [Isomorfeus Framework Project](http://isomorfeus.com) 
-
-### Tested
-[TravisCI](https://travis-ci.org): [![Build Status](https://travis-ci.org/isomorfeus/opal-webpack-loader.svg?branch=master)](https://travis-ci.org/isomorfeus/opal-webpack-loader)
-
-### Features
-- comes with a installer for rails and other frameworks
-- webpack based build process
-- very fast, asynchronous and parallel builds of opal code:
-opal-webpack-loader-0.7.1 compiles all of opal, a bunch of gems and over 19000SLC on a
-Intel® Core™ i7-7700HQ CPU @ 2.80GHz × 8, with 8 workers in around 1850ms
-- opal modules are packaged as es6 modules
-- support for rails with webpacker
-- other webpack features become available, like:
-  - source maps
-  - multiple targets: web (for browsers), node (for server side rendering) and webworker (for Web Workers)
-  - hot module reloading for opal ruby code and stylesheets and html views
-  - tree shaking
-  - code splitting
-  - lazy loading
-  - everything else webpack can do, like loading stylesheets, etc.
-
-### Requirements
-- opal-webpack-loader consists of 2 parts, the npm package and the gem, both are required and must be the same version.
-- webpack 4.30
-- webpack-dev-server 3.3.0
-- one of the ES6 modules branches of opal
-  - [PR#1970](https://github.com/opal/opal/pull/1969), (recommended)  implementing ES6 modules and changes for 'strict' mode,
-    based on Opal master 1.0.0 using javascript string primitives
-    
-    `gem 'opal', github: 'janbiedermann/opal', branch: 'es6_modules'`
-    
-  - [PR#1973](https://github.com/opal/opal/pull/1973), (experimental) implementing ES6 modules and changes for 'strict' mode,
-    based on Opal master 1.0.0 using javascript string objects "mutable strings" by default for all strings
-    
-    `gem 'opal', github: 'janbiedermann/opal', branch: 'es6_modules_string'`
-    
-  - [PR#1976](https://github.com/opal/opal/pull/1976), (experimental) implementing ES6 modules and changes for 'strict' mode,
-    based on Opal master 1.1.0 using javascript string primitives and providing nice features like `require_lazy 'my_module'`
-    
-    `gem 'opal', github: 'janbiedermann/opal', branch: 'es6_modules_1_1'`
-    
-- if you have the webpacker gem installed somewhere, it should be a version supporting webpack 4
-- ruby, version 2.5 or higher recommended
-- bundler, latest version recommended
-
-### Installation
-
-#### Using the installer
-First install the gem:
-```
-gem install 'opal-webpack-loader'
-```
-
-Continue here:
-- [Install for Rails like projects](https://github.com/isomorfeus/opal-webpack-loader/blob/master/docs/installation_rails.md)
-- [Install for Cuba, Roda, Sinatra and other projects with a flat structure](https://github.com/isomorfeus/opal-webpack-loader/blob/master/docs/installation_flat.md)           
-- [Manual Installation](https://github.com/isomorfeus/opal-webpack-loader/blob/master/docs/installation_manual.md)
-
-### Example applications
-[are here](https://github.com/isomorfeus/opal-webpack-loader/tree/master/example_apps/)
-
-### General Usage without Webpacker
-
-After installing owl with the installer, three scripts are provided in package.json:
-- `development` - runs the webpack-dev-server, use for general development, provides fast reloads, entry is application.js
-- `debug` - runs the webpack-dev-server, use for debugging, provides source maps, entry is application_debug.js. Additional debugging tools may be added there.
-- `production_build` - runs webpack to build assets for production, entry is application.js
-
-These scripts can for example be run with:
-`yarn run debug` or `npm run debug`
-
-The default config provides several targets and entries:
-
-- **Browser**: the webpack target is 'web' and the javascript entry file for imports is `application.js` - general use for the application with all
-browser features, the opal ruby entry file is `opal_loader.rb` in the opal or app/opal directory of the app.
-- **Server Side Rendering**: the webpack target is `node` and the javascript entry file for imports is `application_ssr.js` - general use for the
-application server side rendering, several Browser features are unavailable, no `window`, no `document`, some node features are available,
-like `Buffer`, the opal ruby entry file is `opal_loader.rb` in the opal or app/opal directory of the app.
-(meant to be used with isomorfeus-speednode, standard ExecJS limitations prevent certain webpack features)
-- **Web Worker**: the webpack target is 'webworker' and the javascript entry file for imports is `application_webworker.js` - used to initialize Web
-Workers in the browser, the opal ruby entry file is `opal_webworker_loader.rb` in the opal or app/opal directory of the app.
-
-Only the browser target is build by default. To builds the other target, just add the needed targets to the last line of the webpack config,
-for example to `development.js`:
-default config:
-```javascript
-module.exports = [ browser ];
-```
-modified config with ssr and web_worker targets enabled:
-```javascript
-module.exports = [ browser, ssr, web_worker ];
-```
-Same works for the `debug.js` and `production.js` webpack config files.
-
-Also a Procfile has been installed, for rails its easy to startup rails and webpack with foreman:
-`foreman start` (`gem install foreman` if you dont have it already). It will start rails and webpack-dev-server with the development script.
-
-For non rails installation check the Procfile and add a starter for your app.
-
-#### Opal Ruby Application Files
-For rails installations with the installer they all go into: `app/opal`, for flat installations in the `opal` directory.
-In this directory there already is a `opal_loader.rb` which is the entry point for your app.
-
-#### Stylesheets
-Stylesheets are hot reloaded too with the default config installed by the installer. Also they are imported into application.js by default.
-For rails like applications stylesheets are in `app/assets/stylesheets/application.css`, for flat applications they are in `styles/application.css`.
-SCSS is supported too by the default config.
-
-#### Views
-For rails like applications a watcher for `app/views` is installed by default. The watcher will trigger a page reload when views are changed.
-For flat applications nothing is configured by default, as there are to many ways to generate views, they are not even needed with
-frameworks like isomorfeus. Instead the section for configuring a view watcher is included in the development.js and debug.js webpack
-config, but it is commented out. Please see those files and adjust to your liking.
-
-#### Parallel compilation for speed
-
-Since version 0.8.0 the number of CPUs is automatically determined and a appropriate number of of compile server workers is started automatically.
-
-### Source Maps
-
-[Source Maps](https://github.com/isomorfeus/opal-webpack-loader/blob/master/docs/source_maps.md)
-
-### Hot Module Reloading
-[Hot Module Reloading](https://github.com/isomorfeus/opal-webpack-loader/blob/master/docs/hot_module_reloading.md)
-
-### Opal Load Path
-The projects directory for opal ruby files must be in the opal load path. This is done in the initializer for rails apps in
-config/initializers/opal_webpack_loader.rb or in 'owl_init.rb' for non rails apps, for example:
-```ruby
-Opal.append_path(File.realdirpath('app/opal'))
-```
-
-### View Helper
-In Rails or frameworks that support `javscript_include_tag`, add to the app/helpers/application_helper.rb
-```ruby
-module ApplicationHelper
-  include OpalWebpackLoader::RailsViewHelper
-```
-in other frameworks that dont have a `javascript_include_tag`:
-```ruby
-module MyProjectsViewThings
-  include OpalWebpackLoader::ViewHelper
-```
-
-Then you can use in your views:
-```ruby
-owl_script_tag('application.js')
-```
-#### Compile Server and app_loader.rb
-For non rails projects, determining Opal load paths, for the resolver and compile server to work properly, may not be obvious. For these cases
-a file `app_loader.rb` in the projects root can be created which just loads all requirements without starting anything.
-Usually it would just setup bundler with the appropriate options, for example:
-```ruby
-require 'bundler/setup'
-if ENV['MY_PROJECT_ENV'] && ENV['MY_PROJECT_ENV'] == 'test'
-  Bundler.require(:default, :test)
-elsif ENV['MY_PROJECT_ENV'] && ENV['MY_PROJECT_ENV'] == 'production'
-  Bundler.require(:default, :production)
-else
-  Bundler.require(:default, :development)
-end
-require './owl_init.rb' # this is a good place to require the opal-webpack-loader initializer, to get the apps opal load path
-```
-When this file exists, the compile server will load it and generate Opal load paths accordingly for the resolver.
-
-#### Project configuration options for the view helper
-These setting are in the initializer in config/initializers/opal_webpack_loader.rb for rails like apps, or owl_init.rb for others.
-```ruby
-OpalWebpackLoader.use_manifest = false
-```
-If the manifest file should be used, use_manifest should be true.
-```ruby
-OpalWebpackLoader.manifest_path = File.join(Dir.getwd, 'public', 'assets', 'manifest.json')
-```
-Sets the path to the webpack (with the [webpack-manifest-plugin](https://www.npmjs.com/package/webpack-manifest-plugin)) generated manifest.json to look up assets.
-```ruby
-OpalWebpackLoader.client_asset_path = 'http://localhost:3035/assets/'
-```
-The path to prepend to the assets as configured in the webpack config 'publicPath'. 
-In the config example below its `publicPath: 'http://localhost:3025/assets'` so
-client_asset_path should be set to the same.
-
-For **production** use with readily precompiled and compressed assets which contain a fingerprint in the name (webpacks [chunkhash]),
-and if the path in the manifest is the full path to the asset as configured in webpack,
-these settings would work:
-```ruby
-OpalWebpackLoader.use_manifest = true
-OpalWebpackLoader.manifest_path = File.join(Dir.getwd, 'public', 'assets', 'manifest.json')
-OpalWebpackLoader.client_asset_path = ''
-```
-
-For **development** use with webpack-dev-server, with no manifest, these settings would work:
-```ruby
-OpalWebpackLoader.use_manifest = false
-OpalWebpackLoader.manifest_path = File.join(Dir.getwd, 'public', 'assets', 'manifest.json') # doesn't matter, not used
-OpalWebpackLoader.client_asset_path = 'http://localhost:3035/assets/'
-```
-### Advanced Options
-[Advanced Options](https://github.com/isomorfeus/opal-webpack-loader/blob/master/docs/advanced_options.md)
-### Tests
-- clone the repo
-- `bundle install`
-- `bundle exec rspec`