frontrunner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ea87ed4e2b6ec196503d17a654df0f1dd7245b3
+  data.tar.gz: 304a3c9eb2c55cc4cbbd08809607fdfbd8c2aebd
+SHA512:
+  metadata.gz: 76d1d50882926e9f11e1d2029d8c0ffd1c588de1e1f331d78d8dbcf9bb69f83c18dba3ee4f6b8717b31dee28b12cef83d3a5b62371a773fb3e046c9414612d95
+  data.tar.gz: 42c914ffd62905639e9cd247c28c7da3233c7add2aa2272ced94464928604d691135fdf14dc2836b7ab34ccf1f62074444a2fb70b20469150d31f0db346f01fc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in frontrunner.gemspec
+gemspec

data/README.md

@@ -0,0 +1,230 @@
+# Frontrunner
+
+:fire: Webpack for Rails
+
+Why Webpack?
+
+- Manage your JavaScript and CSS dependencies with [npm](https://www.npmjs.com/), the JavaScript package manager
+- Use modules to keep your code organized
+- *Optional* Use hot module replacement for faster iteration
+
+But there are also a few drawbacks:
+
+- More complex development process
+- Longer build times, as there is currently no way to [cache between builds](https://github.com/webpack/webpack/issues/250)
+
+As with the Rails asset pipeline (Sprockets), you also get:
+
+- Minification and compression
+- Digests for long-term caching
+- Coffeescript and Sass support
+- Source maps (Sprockets 4+)
+- ES6 support (Sprockets 4+)
+- *Optional* JSX support for React
+
+Frontrunner plays nicely with the Rails asset pipeline. This makes it easy to transition existing apps at your own pace. While it may be tempting to remove Sprockets, some Rails engines like [RailsAdmin](https://github.com/sferik/rails_admin) depend on it.  You never know when you’ll want to add one of these, so we recommend keeping it around.
+
+Like Rails, [jQuery](https://github.com/jquery/jquery), [jQuery UJS](https://github.com/rails/jquery-ujs), and [Turbolinks](https://github.com/turbolinks/turbolinks) are added to start, but these can be easily removed if desired.
+
+## The Setup
+
+Here are the files and directories we’ll use.
+
+Files | Description
+--- | ---
+package.json | Gemfile for npm
+npm-shrinkwrap.json | Gemfile.lock for npm
+webpack.config.js | Webpack config
+node_modules | npm packages
+app/webpack | app/assets equivalent
+
+## Installation
+
+Add this line to your application’s Gemfile
+
+```ruby
+gem 'frontrunner'
+```
+
+And run:
+
+```sh
+bundle install
+```
+
+Generate files
+
+```sh
+rails generate frontrunner:install
+```
+
+And run:
+
+```sh
+npm install && npm shrinkwrap --dev
+```
+
+Then, add to your layout:
+
+```erb
+<%= webpack_include_tag "application" %>
+```
+
+## Development
+
+Run:
+
+```sh
+npm run server
+```
+
+This will start the [webpack-dev-server](https://webpack.github.io/docs/webpack-dev-server.html) at `http://localhost:8080`.
+
+It’s possible to serve Webpack assets through Sprockets rather than a separate web server in development, but this can be significantly slower.
+
+If you use [Foreman](https://github.com/ddollar/foreman), you can create a `Procfile.dev` with:
+
+```
+web: bin/rails server
+webpack: npm run server
+```
+
+And run it with:
+
+```sh
+foreman start -f Procfile.dev
+```
+
+## Packages
+
+Add new packages with npm.
+
+```sh
+npm install underscore -S
+```
+
+Use the `-S` option to save it to `package.json`.
+
+You can now include the package in your JavaScript.
+
+```js
+var _ = require("underscore");
+var trips = _.map([1, 2, 3], function (i) { return i * 3; });
+console.log(trips);
+```
+
+### Bootstrap
+
+Run:
+
+```sh
+npm install bootstrap-sass -S
+```
+
+For CSS, in `application.scss`, add:
+
+```scss
+$icon-font-path: "~bootstrap-sass/assets/fonts/bootstrap/";
+@import "bootstrap-sass/assets/stylesheets/bootstrap";
+```
+
+Or only include specific components with:
+
+```scss
+@import "bootstrap-sass/assets/stylesheets/bootstrap/variables";
+@import "bootstrap-sass/assets/stylesheets/bootstrap/mixins";
+@import "bootstrap-sass/assets/stylesheets/bootstrap/alerts";
+```
+
+For JavaScript, in `application.js`, add:
+
+```js
+require("bootstrap-sass/assets/javascripts/bootstrap");
+```
+
+Or only include specific components with:
+
+```js
+require("bootstrap-sass/assets/javascripts/bootstrap/alert");
+```
+
+### React
+
+Run:
+
+```sh
+npm install react react-dom -S
+```
+
+[React Hot Loader](http://gaearon.github.io/react-hot-loader/) and support for `jsx` are already included. See [Hot Module Replacement](#hot-module-replacement) for how to activate.
+
+## Entry Points
+
+During installation, a single [entry point](https://webpack.github.io/docs/multiple-entry-points.html) - `application` - is created.
+
+To add another entry point - for instance, for a blog - create `blog.js` and add it to `webpack.config.js`.
+
+```js
+{
+  entry: {
+    application: "application",
+    blog: "blog"
+  }
+}
+```
+
+To include it in your views, use:
+
+```erb
+<%= webpack_include_tag "blog" %>
+```
+
+## Hot Module Replacement
+
+Use [hot module replacement](https://webpack.github.io/docs/hot-module-replacement.html) to update code without reloading the page.
+
+Just run `npm run server:hot` instead of `npm run server`.
+
+If you use React, this includes the [React Hot Loader](http://gaearon.github.io/react-hot-loader/).
+
+## Deployment
+
+Node.js is required to build the assets. As part of the build process, run:
+
+```sh
+npm run assets:precompile
+```
+
+### Heroku
+
+On Heroku, you’ll need to use multiple buildpacks.
+
+```sh
+heroku buildpacks:add heroku/nodejs
+heroku buildpacks:add heroku/ruby
+```
+
+And ask Heroku to install dev dependencies from `package.json`.
+
+```sh
+heroku config:set NPM_CONFIG_PRODUCTION=false
+```
+
+And in `package.json`, under `scripts`, add:
+
+```json
+{
+  "scripts": {
+    "heroku-postbuild": "npm run assets:precompile"
+  }
+}
+```
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/frontrunner/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/frontrunner/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/frontrunner.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "frontrunner/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "frontrunner"
+  spec.version       = Frontrunner::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+
+  spec.summary       = "Webpack for Rails"
+  spec.homepage      = "https://github.com/ankane/frontrunner"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/frontrunner.rb

@@ -0,0 +1,11 @@
+require "frontrunner/helper"
+require "frontrunner/version"
+require "active_support/lazy_load_hooks"
+
+module Frontrunner
+  class Error < StandardError; end
+end
+
+ActiveSupport.on_load(:action_view) do
+  include Frontrunner::Helper
+end

data/lib/frontrunner/helper.rb

@@ -0,0 +1,21 @@
+module Frontrunner
+  module Helper
+    def webpack_include_tag(*sources)
+      options = sources.extract_options!
+      sources =
+        sources.map do |source|
+          @webpack_manifest = nil if Rails.env.development?
+          entry = webpack_manifest[source]
+          raise Frontrunner::Error, "Could not find webpack entry point: #{source}" unless entry
+          entry["js"]
+        end
+      javascript_include_tag *sources, options
+    end
+
+    def webpack_manifest
+      @webpack_manifest ||= JSON.parse(File.read(Rails.root.join("webpack-assets.json")))
+    rescue => e
+      raise Frontrunner::Error, "Error reading webpack manifest - be sure to start the dev server"
+    end
+  end
+end

data/lib/frontrunner/version.rb

@@ -0,0 +1,3 @@
+module Frontrunner
+  VERSION = "0.1.0"
+end

data/lib/generators/frontrunner/install_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators"
+
+module Frontrunner
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def perform
+        copy_file "package.json", "package.json"
+        copy_file "webpack.config.js", "webpack.config.js"
+        append_file ".gitignore", "\n# Webpack\n/node_modules/\nnpm-debug.log\nwebpack-assets.json\n"
+        create_file "app/webpack/images/.keep"
+        copy_file "application.js", "app/webpack/javascripts/application.js"
+        copy_file "hello.coffee", "app/webpack/javascripts/hello.coffee"
+        copy_file "application.scss", "app/webpack/stylesheets/application.scss"
+      end
+    end
+  end
+end

data/lib/generators/frontrunner/templates/application.js

@@ -0,0 +1,16 @@
+// Styles
+require("application.scss");
+
+// jQuery
+window.$ = window.jQuery = require("jquery");
+
+// Rails UJS
+require("jquery-ujs");
+
+// Turbolinks
+const Turbolinks = require("turbolinks");
+Turbolinks.start();
+
+// Hi!
+const hello = require("hello");
+console.log(hello("Webpack"));

data/lib/generators/frontrunner/templates/application.scss

@@ -0,0 +1,5 @@
+$primary-color: #ccc;
+
+body {
+  color: $primary-color;
+}

data/lib/generators/frontrunner/templates/hello.coffee

@@ -0,0 +1,2 @@
+module.exports = (name) ->
+  "Hello #{name}!"

data/lib/generators/frontrunner/templates/package.json

@@ -0,0 +1,33 @@
+{
+  "dependencies": {
+    "jquery": "^2.2.4",
+    "jquery-ujs": "^1.2.1",
+    "turbolinks": "^5.0.0-beta5"
+  },
+  "devDependencies": {
+    "assets-webpack-plugin": "^3.4.0",
+    "babel-core": "^6.9.0",
+    "babel-loader": "^6.2.4",
+    "babel-plugin-react-require": "^2.1.0",
+    "babel-preset-es2015": "^6.9.0",
+    "babel-preset-react": "^6.5.0",
+    "coffee-loader": "^0.7.2",
+    "coffee-script": "^1.10.0",
+    "compression-webpack-plugin": "^0.3.1",
+    "css-loader": "^0.23.1",
+    "file-loader": "^0.8.5",
+    "node-sass": "^3.7.0",
+    "react-hot-loader": "^1.3.0",
+    "sass-loader": "^3.2.0",
+    "style-loader": "^0.13.1",
+    "url-loader": "^0.5.7",
+    "webpack": "^1.13.1",
+    "webpack-dev-server": "^1.14.1"
+  },
+  "scripts": {
+    "assets:precompile": "webpack",
+    "server": "webpack-dev-server",
+    "server:hot": "webpack-dev-server --inline --hot"
+  },
+  "private": true
+}

data/lib/generators/frontrunner/templates/webpack.config.js

@@ -0,0 +1,61 @@
+var path = require("path");
+var webpack = require("webpack");
+var AssetsPlugin = require("assets-webpack-plugin");
+var CompressionPlugin = require("compression-webpack-plugin");
+
+var development = !process.env.RAILS_ENV || process.env.RAILS_ENV === "development";
+
+var config = {
+  entry: {
+    application: "application"
+  },
+  output: {
+    path: path.join(__dirname, "public", "webpack"),
+    filename: development ? "[name].js" : "[name]-[hash].js",
+    publicPath: development ? "http://localhost:8080/" : "/webpack/",
+  },
+  module: {
+    loaders: [
+      {test: /\.css$/, loader: "style-loader!css-loader"},
+      {test: /\.scss$/, loader: "style-loader!css-loader!sass-loader"},
+      {test: /\.jsx?$|\.tag$/, exclude: /node_modules/, loader: "react-hot!babel-loader?cacheDirectory&presets[]=es2015&presets[]=react&plugins[]=react-require"},
+      {test: /\.coffee$/, loader: "coffee-loader"},
+      {test: /\.woff2?$|\.ttf$|\.eot$|\.svg$/, loader: "file"}
+    ]
+  },
+  plugins: [
+    new webpack.DefinePlugin({
+      "process.env": JSON.stringify({
+        NODE_ENV: process.env.RAILS_ENV
+      })
+    }),
+    new AssetsPlugin({path: path.join(__dirname)})
+  ],
+  resolve: {
+    root: [
+      path.join(__dirname, "app", "webpack", "javascripts"),
+      path.join(__dirname, "app", "webpack", "stylesheets"),
+      path.join(__dirname, "app", "webpack", "images")
+    ],
+    extensions: ["", ".js", ".jsx", ".coffee"]
+  },
+  sassLoader: {
+    includePaths: [
+      path.join(__dirname, "node_modules")
+    ]
+  }
+};
+
+if (development) {
+  config.devtool = "#eval-cheap-module-inline-source-map";
+} else {
+  config.plugins.push(
+    new webpack.optimize.UglifyJsPlugin({sourceMap: false, compress: {warnings: false}}),
+    new webpack.optimize.DedupePlugin(),
+    new webpack.optimize.OccurenceOrderPlugin(),
+    new CompressionPlugin()
+  );
+  config.bail = true;
+}
+
+module.exports = config;

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: frontrunner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- frontrunner.gemspec
+- lib/frontrunner.rb
+- lib/frontrunner/helper.rb
+- lib/frontrunner/version.rb
+- lib/generators/frontrunner/install_generator.rb
+- lib/generators/frontrunner/templates/application.js
+- lib/generators/frontrunner/templates/application.scss
+- lib/generators/frontrunner/templates/hello.coffee
+- lib/generators/frontrunner/templates/package.json
+- lib/generators/frontrunner/templates/webpack.config.js
+homepage: https://github.com/ankane/frontrunner
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: Webpack for Rails
+test_files: []
+has_rdoc: