webpack_react_on_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 766f5913515bf02700aaa8ea1051189f5127e81c
+  data.tar.gz: 6c80b1aef5e937754eb1a14c0880d7510fd7392a
+SHA512:
+  metadata.gz: fce2950142224238c91afb22002727152aef1e9b20040d33df3bd561536a9aad1c57f7b078eb4435124d359f58a5ded920351a57987c8cad6ab46822a078aacb
+  data.tar.gz: 0c6f505d0cd7d148031f395987f53e81925f5d926ff5aabe689964e93cc8d6bc40dfcffcff0b7651ea4e81660dab8d9017119de4096021f8b347fc67a8b78175

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Hyun Sik Kang
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WebpackReactOnRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/webpack_react_on_rails/install_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators'
+
+module WebpackReactOnRails
+  class InstallGenerator < Rails::Generators::Base
+    TEMPLATES_DIR = File.join(File.expand_path(File.dirname(__FILE__)), '../../templates')
+
+    def create_scaffold_file
+      generate_package_file('package', "#{Rails.root}/package.json")
+
+      generate_config_file('webpack_development_config', "#{Rails.root}/webpack_development.config.js")
+
+      generate_config_file('webpack_production_config', "#{Rails.root}/webpack_production.config.js")
+
+      generate_config_file('webpack_initializer', "#{Rails.root}/config/initializers/webpack.rb")
+
+      inject_into_file "config/application.rb", "  config.webpack = {\n    :use_manifest => false,\n    :asset_manifest => {},\n      :common_manifest => {}\n  }\n", before: /^end/
+
+      inject_into_file "config/environments/production.rb", "  config.webpack[:use_manifest] = true\n", before: /^end/
+
+      # Update .gitignore to include app/assets/javascripts, /node_modules
+      gitignore_path = File.join(Rails.root, '.gitignore')
+      File.open(gitignore_path, 'a+') do |f|
+        if !/\/node_modules\n/.match(f.read)
+          f.write "/public/assets/javascripts/bundle\n"
+          f.write "/node_modules\n"
+        end
+      end
+    end
+
+    private
+
+    def rails_application_name
+      Rails.application.class.parent.to_s
+    end
+
+    def generate_package_file(template_name, file_path)
+      template = File.read(File.join(TEMPLATES_DIR, template_name))
+      template.gsub!('APPLICATION_NAME', rails_application_name)
+      create_file file_path, template
+    end
+
+    def generate_config_file(template_name, file_path)
+      template = File.read(File.join(TEMPLATES_DIR, template_name))
+      create_file file_path, template
+    end
+  end
+end

data/lib/tasks/webpack/compile.rake

@@ -0,0 +1,13 @@
+namespace :webpack do
+  desc 'compile bundles using webpack'
+  task :compile do
+    cmd = 'node_modules/.bin/webpack --config ./webpack_production.config.js --json'
+    output = `#{cmd}`
+
+    stats = JSON.parse(output)
+
+    File.open('./public/assets/webpack-asset-manifest.json', 'w') do |f|
+      f.write stats['assetsByChunkName'].to_json
+    end
+  end
+end

data/lib/templates/package

@@ -0,0 +1,38 @@
+{
+  "name": "APPLICATION_NAME",
+  "description": "TODO: Add a brief description for the application",
+  "version": "1.0.0",
+  "babel": {
+    "presets": [
+      "es2015",
+      "react"
+    ],
+    "plugins": [
+      "transform-object-assign"
+    ]
+  },
+  "devDependencies": {
+    "react-hot-loader": "^1.3.0"
+  },
+  "dependencies": {
+    "babel-core": "^6.13.2",
+    "babel-loader": "^6.2.5",
+    "babel-preset-es2015": "^6.13.2",
+    "babel-preset-react": "^6.11.1",
+    "chunk-manifest-webpack-plugin": "^0.1.0",
+    "exports-loader": "~0.6.2",
+    "expose-loader": "~0.6.0",
+    "imports-loader": "~0.6.3",
+    "lodash": "~2.4.1",
+    "babel-plugin-transform-object-assign": "^6.8.0",
+    "immutable": "^3.8.1",
+    "isomorphic-fetch": "^2.2.1",
+    "react": "^15.3.1",
+    "react-dom": "^15.3.1",
+    "react-redux": "^4.4.5",
+    "react-router": "^2.8.0",
+    "redux": "^3.5.2",
+    "redux-thunk": "^2.1.0",
+    "webpack": "^1.4.13"
+  }
+}

data/lib/templates/webpack_development_config

@@ -0,0 +1,44 @@
+var path = require('path');
+var webpack = require('webpack');
+
+var config = module.exports = {
+  // the base path which will be used to resolve entry points
+  context: __dirname,
+
+  // the main entry point for our application's frontend js
+  // anything not required by this file will never end up in the compiled bundle
+  // passing an object provides multiple entries points
+  entry: {
+    webpackDev: 'webpack/hot/only-dev-server',
+    // The entry point for the application js i.e. './app/frontend/javascripts/app.js'
+  }
+};
+
+config.module = {
+  loaders: [{
+    test: /\.jsx?$/,
+    exclude: /node_modules/,
+    loader: 'babel'
+  }]
+};
+
+// this config dicates where compiled bundles end up
+config.output = {
+  // this is our app/assets/javascripts directory, which is part of the Sprockets pipeline
+  path: path.join(__dirname, 'app', 'assets', 'javascript', 'bundle'),
+
+  // the filename of the compiled bundle, e.g. app/assets/javascripts/bundle.js
+  filename: '[name]-bundle.js',
+
+  // if the webpack code-splitting feature is enabled, this is the path it'll use to download bundles
+  publicPath: '/assets',
+};
+
+config.resolve = {
+  extensions: ['', '.js', '.jsx'],
+  modulesDirectories: ['node_modules'],
+};
+
+config.plugins = [
+  new webpack.HotModuleReplacementPlugin()
+];

data/lib/templates/webpack_initializer

@@ -0,0 +1,12 @@
+if Rails.configuration.webpack[:use_manifest]
+  Rails.application.load_tasks
+  Rake::Task['webpack:compile'].invoke
+
+  asset_manifest = Rails.root.join('public', 'assets', 'webpack-asset-manifest.json')
+
+  if File.exist?(asset_manifest)
+    Rails.configuration.webpack[:asset_manifest] = JSON.parse(
+      File.read(asset_manifest),
+    ).with_indifferent_access
+  end
+end

data/lib/templates/webpack_production_config

@@ -0,0 +1,46 @@
+var path = require('path');
+var webpack = require('webpack');
+var ChunkManifestPlugin = require('chunk-manifest-webpack-plugin');
+
+var config = module.exports = {
+  entry: {
+    // The entry point for the application js i.e. './app/frontend/javascripts/app.js'
+  }
+};
+
+config.module = {
+  loaders: [{
+    test: /\.jsx?$/,
+    exclude: /node_modules/,
+    loader: 'babel'
+  }]
+};
+
+config.output = {
+  path: path.join(__dirname, 'public', 'assets', 'bundle'),
+  filename: '[name]-bundle-[chunkhash].js',
+  chunkFilename: '[id]-bundle-[chunkhash].js'
+};
+
+config.resolve = {
+  extensions: ['', '.js', '.jsx'],
+  modulesDirectories: ['node_modules'],
+};
+
+config.plugins = [
+  new webpack.optimize.UglifyJsPlugin({
+    minimize: true,
+    compress: {
+      warnings: false
+    }
+  }),
+  new ChunkManifestPlugin({
+    filename: 'webpack-common-manifest.json',
+    manifestVariable: 'webpackBundleManifest'
+  }),
+  new webpack.DefinePlugin({
+    'process.env': {
+      'NODE_ENV': JSON.stringify('production')
+    }
+  })
+];

data/lib/webpack_react_on_rails.rb

@@ -0,0 +1,4 @@
+module WebpackReactOnRails
+  require 'webpack_react_on_rails/action_view/webpack_helpers'
+  require 'webpack_react_on_rails/railtie' if defined? Rails
+end

data/lib/webpack_react_on_rails/action_view/webpack_helpers.rb

@@ -0,0 +1,24 @@
+module WebpackReactOnRails
+  module ActionView::WebpackHelpers
+    include ActionView::Helpers
+    include ActionView::Context
+
+    def webpack_bundle_tag(bundle)
+      if Rails.configuration.webpack[:use_manifest]
+        manifest = Rails.configuration.webpack[:asset_manifest]
+        filename = manifest[bundle]
+
+        src = "#{compute_asset_host}/assets/#{filename}"
+      else
+        src = "#{compute_asset_host}/assets/#{bundle}-bundle"
+      end
+
+      javascript_include_tag(src)
+    end
+
+    def webpack_manifest_script
+      return '' unless Rails.configuration.webpack[:use_manifest]
+      javascript_tag "window.webpackManifest = #{Rails.configuration.webpack[:common_manifest]}"
+    end
+  end
+end

data/lib/webpack_react_on_rails/railtie.rb

@@ -0,0 +1,13 @@
+module WebpackReactOnRails
+  class Railtie < Rails::Railtie
+    initializer "railtie.configure_view_controller" do
+      ActiveSupport.on_load :action_view do
+        include ActionView::WebpackHelpers
+      end
+    end
+
+    rake_tasks do
+      load 'tasks/webpack/compile.rake'
+    end
+  end
+end

data/lib/webpack_react_on_rails/version.rb

@@ -0,0 +1,3 @@
+module WebpackReactOnRails
+  VERSION = "1.0.0"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end