jetpacker 0.1.0 → 0.2.0

data/jetpacker.gemspec

@@ -1,28 +1,34 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.push File.expand_path("../lib", __FILE__)
 require "jetpacker/version"
 
-Gem::Specification.new do |spec|
-  spec.name          = "jetpacker"
-  spec.version       = Jetpacker::VERSION
-  spec.authors       = ["Tung Nguyen"]
-  spec.email         = ["tongueroo@gmail.com"]
+Gem::Specification.new do |s|
+  s.name     = "jetpacker"
+  s.version  = Jetpacker::VERSION
+  s.authors  = [ "Tung Nguyen" ]
+  s.email    = [ "tongueroo@gmail.com" ]
+  # Only commented out, so people do not accidentally contact incorrect person for jetspacker specific related issues.
+  # Credit goes to original authors of the work:
+  # s.authors  = [ "David Heinemeier Hansson", "Gaurav Tiwari" ]
+  # s.email    = [ "david@basecamp.com", "gaurav@gauravtiwari.co.uk" ]
+  s.summary  = "Use webpack to manage app-like JavaScript modules in Jets"
+  s.homepage = "https://github.com/tonguero/jetpacker"
+  s.license  = "MIT"
+
+  s.metadata = {
+    "source_code_uri" => "https://github.com/tongueroo/jetpacker/tree/v#{Jetpacker::VERSION}",
+    "changelog_uri"   => "https://github.com/tongueroo/jetpacker/blob/v#{Jetpacker::VERSION}/CHANGELOG.md"
+  }
+
+  s.required_ruby_version = ">= 2.2.0"
 
-  spec.summary       = %q{Jetpacker}
-  spec.homepage      = "https://github.com/tongueroo/jetpacker"
-  spec.license       = "MIT"
+  s.add_dependency "activesupport", ">= 4.2"
+  s.add_dependency "railties",      ">= 4.2"
+  s.add_dependency "rack-proxy",    ">= 0.6.1"
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  s.add_development_dependency "bundler", ">= 1.3.0"
+  s.add_development_dependency "rubocop", "< 0.69"
+  s.add_development_dependency "rubocop-performance"
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
 end

data/lib/install/angular.rb

@@ -0,0 +1,23 @@
+require "webpacker/configuration"
+
+say "Copying angular example entry file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/examples/angular/hello_angular.js", "#{Webpacker.config.source_entry_path}/hello_angular.js"
+
+say "Copying hello_angular app to #{Webpacker.config.source_path}"
+directory "#{__dir__}/examples/angular/hello_angular", "#{Webpacker.config.source_path}/hello_angular"
+
+say "Installing all angular dependencies"
+run "yarn add core-js zone.js rxjs @angular/core @angular/common @angular/compiler @angular/platform-browser @angular/platform-browser-dynamic"
+
+if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR > 1
+  say "You need to enable unsafe-eval rule.", :yellow
+  say "This can be done in Rails 5.2+ for development environment in the CSP initializer", :yellow
+  say "config/initializers/content_security_policy.rb with a snippet like this:", :yellow
+  say "if Jets.env.development?", :yellow
+  say "  policy.script_src :self, :https, :unsafe_eval", :yellow
+  say "else", :yellow
+  say "  policy.script_src :self, :https", :yellow
+  say "end", :yellow
+end
+
+say "Webpacker now supports angular 🎉", :green

data/lib/install/bin/webpack

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+ENV["JETS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"]  ||= "development"
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/webpack_runner"
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  Webpacker::WebpackRunner.run(ARGV)
+end

data/lib/install/bin/webpack-dev-server

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+ENV["JETS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"]  ||= "development"
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/dev_server_runner"
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  Webpacker::DevServerRunner.run(ARGV)
+end

data/lib/install/binstubs.rb

@@ -0,0 +1,4 @@
+say "Copying binstubs"
+directory "#{__dir__}/bin", "bin"
+
+chmod "bin", 0755 & ~File.umask, verbose: false

data/lib/install/coffee.rb

@@ -0,0 +1,25 @@
+require "webpacker/configuration"
+
+say "Copying coffee loader to config/webpack/loaders"
+copy_file "#{__dir__}/loaders/coffee.js", Jets.root.join("config/webpack/loaders/coffee.js").to_s
+
+say "Adding coffee loader to config/webpack/environment.js"
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "const coffee =  require('./loaders/coffee')\n",
+  after: /require\(('|")@rails\/webpacker\1\);?\n/
+
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "environment.loaders.prepend('coffee', coffee)\n",
+  before: "module.exports"
+
+say "Updating webpack paths to include .coffee file extension"
+insert_into_file Webpacker.config.config_path, "- .coffee\n".indent(4), after: /\s+extensions:\n/
+
+say "Copying the example entry file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/examples/coffee/hello_coffee.coffee",
+  "#{Webpacker.config.source_entry_path}/hello_coffee.coffee"
+
+say "Installing all Coffeescript dependencies"
+run "yarn add coffeescript@1.12.7 coffee-loader"
+
+say "Webpacker now supports Coffeescript 🎉", :green

data/lib/install/config/.browserslistrc

@@ -0,0 +1 @@
+defaults

data/lib/install/config/babel.config.js

@@ -0,0 +1,72 @@
+module.exports = function(api) {
+  var validEnv = ['development', 'test', 'production']
+  var currentEnv = api.env()
+  var isDevelopmentEnv = api.env('development')
+  var isProductionEnv = api.env('production')
+  var isTestEnv = api.env('test')
+
+  if (!validEnv.includes(currentEnv)) {
+    throw new Error(
+      'Please specify a valid `NODE_ENV` or ' +
+        '`BABEL_ENV` environment variables. Valid values are "development", ' +
+        '"test", and "production". Instead, received: ' +
+        JSON.stringify(currentEnv) +
+        '.'
+    )
+  }
+
+  return {
+    presets: [
+      isTestEnv && [
+        '@babel/preset-env',
+        {
+          targets: {
+            node: 'current'
+          }
+        }
+      ],
+      (isProductionEnv || isDevelopmentEnv) && [
+        '@babel/preset-env',
+        {
+          forceAllTransforms: true,
+          useBuiltIns: 'entry',
+          corejs: 3,
+          modules: false,
+          exclude: ['transform-typeof-symbol']
+        }
+      ]
+    ].filter(Boolean),
+    plugins: [
+      'babel-plugin-macros',
+      '@babel/plugin-syntax-dynamic-import',
+      isTestEnv && 'babel-plugin-dynamic-import-node',
+      '@babel/plugin-transform-destructuring',
+      [
+        '@babel/plugin-proposal-class-properties',
+        {
+          loose: true
+        }
+      ],
+      [
+        '@babel/plugin-proposal-object-rest-spread',
+        {
+          useBuiltIns: true
+        }
+      ],
+      [
+        '@babel/plugin-transform-runtime',
+        {
+          helpers: false,
+          regenerator: true,
+          corejs: false
+        }
+      ],
+      [
+        '@babel/plugin-transform-regenerator',
+        {
+          async: false
+        }
+      ]
+    ].filter(Boolean)
+  }
+}

data/lib/install/config/postcss.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  plugins: [
+    require('postcss-import'),
+    require('postcss-flexbugs-fixes'),
+    require('postcss-preset-env')({
+      autoprefixer: {
+        flexbox: 'no-2009'
+      },
+      stage: 3
+    })
+  ]
+}

data/lib/install/config/webpack/development.js

@@ -0,0 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
+const environment = require('./environment')
+
+module.exports = environment.toWebpackConfig()

data/lib/install/config/webpack/environment.js

@@ -0,0 +1,3 @@
+const { environment } = require('@rails/webpacker')
+
+module.exports = environment

data/lib/install/config/webpack/production.js

@@ -0,0 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'production'
+
+const environment = require('./environment')
+
+module.exports = environment.toWebpackConfig()

data/lib/install/config/webpack/test.js

@@ -0,0 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
+const environment = require('./environment')
+
+module.exports = environment.toWebpackConfig()

data/lib/install/config/webpacker.yml

@@ -0,0 +1,96 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: packs
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/cache/webpacker
+  check_yarn_integrity: false
+  webpack_compile_output: true
+
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  resolved_paths: []
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  # Extract and emit a css file
+  extract_css: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+    - .eot
+    - .otf
+    - .ttf
+    - .woff
+    - .woff2
+
+  extensions:
+    - .mjs
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .svg
+    - .gif
+    - .jpeg
+    - .jpg
+
+development:
+  <<: *default
+  compile: true
+
+  # Verifies that correct packages and versions are installed by inspecting package.json, yarn.lock, and node_modules
+  check_yarn_integrity: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    # Inline should be set to true if using HMR
+    inline: true
+    overlay: true
+    compress: true
+    disable_host_check: true
+    use_local_ip: false
+    quiet: false
+    pretty: false
+    headers:
+      'Access-Control-Allow-Origin': '*'
+    watch_options:
+      ignored: '**/node_modules/**'
+
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Extract and emit a css file
+  extract_css: true
+
+  # Cache manifest.json for performance
+  cache_manifest: true

data/lib/install/elm.rb

@@ -0,0 +1,39 @@
+require "webpacker/configuration"
+
+say "Copying elm loader to config/webpack/loaders"
+copy_file "#{__dir__}/loaders/elm.js", Jets.root.join("config/webpack/loaders/elm.js").to_s
+
+say "Adding elm loader to config/webpack/environment.js"
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "const elm =  require('./loaders/elm')\n",
+  after: /require\(('|")@rails\/webpacker\1\);?\n/
+
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "environment.loaders.prepend('elm', elm)\n",
+  before: "module.exports"
+
+say "Copying Elm example entry file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/examples/elm/hello_elm.js",
+  "#{Webpacker.config.source_entry_path}/hello_elm.js"
+
+say "Copying Elm app file to #{Webpacker.config.source_path}"
+copy_file "#{__dir__}/examples/elm/Main.elm",
+  "#{Webpacker.config.source_path}/Main.elm"
+
+say "Installing all Elm dependencies"
+run "yarn add elm elm-webpack-loader"
+run "yarn add --dev elm-hot-webpack-loader"
+run "yarn run elm init"
+run "yarn run elm make #{Webpacker.config.source_path}/Main.elm"
+
+say "Updating webpack paths to include .elm file extension"
+insert_into_file Webpacker.config.config_path, "- .elm\n".indent(4), after: /\s+extensions:\n/
+
+say "Updating Elm source location"
+gsub_file "elm.json", /\"src\"\n/,
+  %("#{Webpacker.config.source_path.relative_path_from(Jets.root)}"\n)
+
+say "Updating .gitignore to include elm-stuff folder"
+insert_into_file ".gitignore", "/elm-stuff\n", before: "/node_modules\n"
+
+say "Webpacker now supports Elm 🎉", :green

data/lib/install/erb.rb

@@ -0,0 +1,25 @@
+require "webpacker/configuration"
+
+say "Copying erb loader to config/webpack/loaders"
+copy_file "#{__dir__}/loaders/erb.js", Jets.root.join("config/webpack/loaders/erb.js").to_s
+
+say "Adding erb loader to config/webpack/environment.js"
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "const erb = require('./loaders/erb')\n",
+  after: /require\(('|")@rails\/webpacker\1\);?\n/
+
+insert_into_file Jets.root.join("config/webpack/environment.js").to_s,
+  "environment.loaders.prepend('erb', erb)\n",
+  before: "module.exports"
+
+say "Updating webpack paths to include .erb file extension"
+insert_into_file Webpacker.config.config_path, "- .erb\n".indent(4), after: /\s+extensions:\n/
+
+say "Copying the example entry file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/examples/erb/hello_erb.js.erb",
+  "#{Webpacker.config.source_entry_path}/hello_erb.js.erb"
+
+say "Installing all Erb dependencies"
+run "yarn add rails-erb-loader"
+
+say "Webpacker now supports Erb in JS 🎉", :green

data/lib/install/examples/angular/hello_angular.js

@@ -0,0 +1,7 @@
+// Run this Angular example by adding the following HTML markup to your view:
+//
+// <hello-angular>Loading...</hello-angular>
+//
+// <%= javascript_pack_tag 'hello_angular' %>
+
+require('../hello_angular')

data/lib/install/examples/angular/hello_angular/app/app.component.ts

@@ -0,0 +1,9 @@
+import { Component } from '@angular/core';
+
+@Component({
+  selector: 'hello-angular',
+  template: `<h1>Hello {{name}}</h1>`
+})
+export class AppComponent {
+  name = 'Angular!';
+}