webpack_driver 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d7a3afee77099a6ef19d926eaadc31999071f6e
+  data.tar.gz: 14c9d043282e752f1bb0fb517df7bb6e4c4b9448
+SHA512:
+  metadata.gz: a579d61d73775944319200da678cbdd9a0bd0ff668c9c736f3a8e8f4b38a0aa20f8e54b729b8f27eab21ab1cef7f14f932d224286d49e4a8d287786398f0ac83
+  data.tar.gz: df3cc01ef4950b7d48e27edd87df7471e386a84f98b60e3b7d42184bef3699ebcf7f4f874c6613fb2d9238693e1ce1f3a4ffae77120ecbe39128fd1e0f04bbdf

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+StringLiterals:
+  Enabled: false
+
+Style/IndentationWidth:
+  # Number of spaces for each indentation level.
+  Width: 4
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: ruby
+cache:
+  bundler: true
+  yarn: true
+  directories:
+    - node_modules
+rvm:
+  - 2.2.5
+  - 2.4.0
+before_install:
+  - nvm install 6.0
+before_script:
+  - npm install -g yarn
+script:
+  - bundle exec rake test

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+
+gemspec
+
+gem "knitter", git: "https://github.com/nathanstitt/knitter", branch: 'master'

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest, autorun: true, bundler: true, test_folders: ['test'] do
+    watch(%r{^test/test_(.*)\.rb$})
+    watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { |m| "test/test_#{m[2]}.rb" }
+    watch(%r{^test/test_helper\.rb$})  { 'test' }
+#    watch('templates/status-plugin.js.tt') { 'test/test_status_plugin.rb' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nathan Stitt
+
+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/README.md

@@ -0,0 +1,71 @@
+# WebpackDriver
+
+[![Build Status](https://travis-ci.org/nathanstitt/webpack_driver.svg?branch=master)](https://travis-ci.org/nathanstitt/webpack_driver)
+
+Control webpack from Ruby
+
+WebpackDriver controls execution of both webpack and webpack-dev-server to serve assets in developer mode and to compile assets for production.
+
+It runs the dev server in the background using the `childprocess` gem and monitors it's output to detect the current status.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_pack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_pack
+
+## Usage
+
+Initialization, will create a `package.json`, `yarn.lock`, a bare-bones `webpack.config.js` and then run yarn install (via the [Knitter](https://github.com/nathanstitt/knitter) gem).
+
+```ruby
+WebpackDriver.config do | config |
+  config.directory = '/tmp/test'
+end
+WebpackDriver::Configuration.generate
+```
+
+Production compilation (TODO):
+```ruby
+compiler = WebpackDriver::Compiler.new
+compiler.generate
+p compiler.files
+```
+
+Dev server:
+
+```ruby
+process = WebpackDriver::DevServer.new
+process.start
+fail("failed to start webpack #{process.output}") unless process.alive?
+puts "Webpack dev server running on port #{process.detected_port} url=#{process.detected_url}"
+p process.assets.map{|asset| asset.file }
+sleep 30
+process.stop
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rb_webpack.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/**/test_*.rb']
+end
+desc "Run tests"
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rb_webpack"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/config.rb

@@ -0,0 +1,14 @@
+module WebpackDriver
+
+    module Config
+
+        class << self
+
+            def generate
+                puts 'hi'
+            end
+        end
+
+    end
+
+end

data/lib/webpack_driver.rb

@@ -0,0 +1,21 @@
+require_relative "webpack_driver/version"
+require_relative "webpack_driver/config_options"
+require_relative "webpack_driver/configuration"
+require_relative "webpack_driver/asset"
+require_relative 'webpack_driver/process'
+require_relative "webpack_driver/dev_server"
+require_relative "webpack_driver/compile"
+require_relative "webpack_driver/errors"
+
+module WebpackDriver
+
+    def self.config
+        @config ||= WebpackDriver::ConfigOptions.new
+        if block_given?
+            yield @config
+            @config.after_configuration
+        end
+        @config
+    end
+
+end

data/lib/webpack_driver/asset.rb

@@ -0,0 +1,13 @@
+module WebpackDriver
+
+    class Asset
+        attr_reader :file, :size
+
+        def initialize(file, size)
+            @file = file
+            @size = size
+        end
+
+    end
+
+end

data/lib/webpack_driver/compile.rb

@@ -0,0 +1,15 @@
+module WebpackDriver
+
+    class Compile < Process
+
+        def initialize(*flags)
+            super(WebpackDriver.config.compile_script, *flags)
+        end
+
+        def valid?
+            !alive? && super
+        end
+
+    end
+
+end

data/lib/webpack_driver/config_options.rb

@@ -0,0 +1,23 @@
+module WebpackDriver
+
+    class ConfigOptions
+
+        attr_accessor :port
+        attr_accessor :directory
+        attr_accessor :environment
+        attr_accessor :compile_script
+        attr_accessor :dev_server_script
+
+        def initialize
+            @directory = Pathname.new(Dir.pwd)
+            @environment = 'development'
+            @compile_script = 'node_modules/webpack/bin/webpack.js'
+            @dev_server_script = 'node_modules/webpack-dev-server/bin/webpack-dev-server.js'        end
+
+        def after_configuration
+            @directory = Pathname.new(@directory)
+        end
+
+    end
+
+end

data/lib/webpack_driver/configuration.rb

@@ -0,0 +1,17 @@
+require_relative 'configuration/base'
+
+module WebpackDriver
+
+    module Configuration
+
+        class << self
+
+            def generate
+                Base.start
+            end
+
+        end
+
+    end
+
+end

data/lib/webpack_driver/configuration/base.rb

@@ -0,0 +1,40 @@
+require "thor"
+require 'knitter'
+
+module WebpackDriver
+
+    module Configuration
+
+        class Base < Thor::Group
+            include Thor::Actions
+
+            def self.source_root
+                Pathname.new(__FILE__).dirname.join("..","..","..","templates")
+            end
+
+            def set_destination_root
+                self.destination_root = WebpackDriver.config.directory
+            end
+
+            def install_using_yarn
+                yarn = Knitter::Yarn.new(WebpackDriver.config.directory)
+                yarn.init unless yarn.valid?
+                %w{webpack webpack-dev-server}.each do | package |
+                    package = Knitter::Package.new(package, yarn: yarn)
+                    unless package.installed?
+                        package.dependency_type = :development
+                        package.add
+                    end
+                end
+            end
+
+            def generate
+                template("webpack.config.js", verbose: false)
+                template("status-plugin.js", verbose: false, force: true)
+                template("index.js", verbose: false, force: true)
+            end
+        end
+
+    end
+
+end

data/lib/webpack_driver/dev_server.rb

@@ -0,0 +1,45 @@
+module WebpackDriver
+
+
+    class DevServer < Process
+
+        attr_reader :port, :host, :path
+
+#        URL = /(https?:\/\/)([\da-z\.-]+)\:(\d+)\/([\da-z\.-]+\/)?/
+
+        def initialize(*flags)
+
+            config = WebpackDriver.config
+            flags = ['--port', config.port] if config.port
+            super(config.dev_server_script, *flags)
+        end
+
+
+        def valid?
+            alive? && super
+        end
+
+        # def detected_url
+        #     match = URL.match(output)
+        #     match ? match[0] : nil
+        # end
+
+        # def detected_port
+
+        #     match = URL.match(output)
+        #     match ? match[3].to_i : nil
+        # end
+
+        private
+
+        def record_message(msg)
+            if msg['type'] == 'dev-server'
+                @port = msg['value']['port']
+                @host = msg['value']['host']
+                @path = msg['value']['outputPath']
+            end
+            super
+        end
+    end
+
+end

data/lib/webpack_driver/errors.rb

@@ -0,0 +1,2 @@
+class ProcessExists < RuntimeError
+end

data/lib/webpack_driver/process.rb

@@ -0,0 +1,77 @@
+require 'concurrent/array'
+require 'concurrent/map'
+require 'childprocess'
+require 'json'
+
+module WebpackDriver
+
+    class Process
+        READ_CHUNK_SIZE = 1024
+
+        extend Forwardable
+
+        attr_reader :assets, :buffer
+
+        def initialize(*flags)
+            self.reset!
+            args = ["node"] + flags
+            @proc = ::ChildProcess.build(*args)
+            @proc.environment['NODE_ENV'] = WebpackDriver.config.environment
+            @proc.cwd = WebpackDriver.config.directory
+        end
+
+        def alive?
+            @proc.alive?
+        end
+
+        def start
+            self.reset!
+            @output, w = IO.pipe
+            @proc.io.stdout = @proc.io.stderr = w
+            @proc.start
+            w.close
+            @listener = listen_for_status_updates
+        end
+
+        def stop
+            @output.close unless @output.closed?
+            @proc.stop
+            @listener.join
+        end
+
+        def valid?
+            last_compilation_message['operation'] == 'emit'
+        end
+
+        protected
+
+        def reset!
+            @assets = Concurrent::Map.new
+            @buffer = Concurrent::Array.new
+        end
+
+        def last_compilation_message
+            msg = @buffer.reverse_each.detect{ |l| l['type'] == 'compile' }
+            msg ? msg['value'] : {}
+        end
+
+        def record_message(msg)
+            if msg['type'] == 'asset'
+                name = msg['value']['name']
+                @assets[name] = Asset.new(name, msg['value']['size'])
+            end
+            @buffer << msg
+        end
+
+
+        def listen_for_status_updates
+            Thread.new do
+                @output.each_line do | l |
+                    match = l.match(/STATUS: (.*)/)
+                    record_message(JSON.parse(match[1])) if match
+                end
+            end
+        end
+
+    end
+end

data/lib/webpack_driver/version.rb

@@ -0,0 +1,3 @@
+module WebpackDriver
+  VERSION = "0.1.1"
+end

data/templates/index.js.tt

@@ -0,0 +1 @@
+console.log("Built using RubyPack");

data/templates/status-plugin.js.tt

@@ -0,0 +1,68 @@
+/* eslint-disable */
+"use strict";
+
+var webpack = require("webpack");
+// var net = require("net");
+// var SocketIOClient = require("socket.io-client");
+
+function noop() {}
+
+function DashboardPlugin(options) {
+    this.options = options;
+}
+
+function log(type, value) {
+    console.log('STATUS:', JSON.stringify({type, value}));
+}
+
+
+DashboardPlugin.prototype.apply = function(compiler) {
+    var timer;
+
+    // console.log(compiler.options);
+
+    if ( compiler.options.devServer ) {
+        let {port, host, outputPath} = compiler.options.devServer;
+        log("dev-server", { port, host, outputPath });
+    }
+
+    compiler.apply(new webpack.ProgressPlugin(function (percent, msg) {
+        log("compile", {
+            "progress":  percent,
+            "operation": msg,
+            "ms": Date.now() - timer
+        });
+    }));
+
+    compiler.plugin("compile", function() {
+        timer = Date.now();
+        log("compile", {
+            "progress":  0,
+            "operation": "idle"
+        })
+    });
+
+    compiler.plugin("invalid", function() {
+        log("status", "Invalidated");
+    });
+
+    compiler.plugin("after-emit", function(c) {
+        for (var k in c.assets){
+            log("asset", {name: k, size: c.assets[k].size()});
+        }
+    });
+
+    compiler.plugin("done", function(stats) {
+        log("status", "success");
+    });
+
+    compiler.plugin("failed", function() {
+        log("status", "failed");
+    });
+    compiler.plugin("valid", function() {
+        log("status", "valid");
+    });
+
+}
+
+module.exports = DashboardPlugin;

data/templates/webpack.config.js.tt

@@ -0,0 +1,25 @@
+// Responsible for reporting status back to webpack-driver
+var WebpackDriverStatusPlugin = require('./status-plugin.js');
+
+module.exports = {
+    entry: "./index.js",
+    debug: true,
+    plugins: [
+       new WebpackDriverStatusPlugin() // must not be removed
+    ],
+    info: false,
+    output: {
+        path: __dirname,
+        filename: "bundle.js"
+    },
+    module: {
+        loaders: [
+            { test: /\.css$/, loader: "style!css" }
+        ]
+    },
+    devServer: {
+        stats: {
+            colors: false
+        }
+    }
+};

data/webpack_driver.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webpack_driver/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = "webpack_driver"
+    spec.version       = WebpackDriver::VERSION
+    spec.authors       = ["Nathan Stitt"]
+    spec.email         = ["nathan@stitt.org"]
+
+    spec.summary       = %q{Run webpack-dev-server in a sub process}
+    spec.description   = %q{Run webpack and webpack-dev-server in a sub process.  Autodetects the port, url and assets that are generated.}
+    spec.homepage      = "https://github.com/nathanstitt/webpack_driver"
+    spec.license       = "MIT"
+
+    # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+    # to allow pushing to a single host or delete this section to allow pushing to any host.
+    if spec.respond_to?(:metadata)
+        spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    else
+        raise "RubyGems 2.0 or newer is required to protect against " \
+              "public gem pushes."
+    end
+
+    spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+    spec.add_dependency 'knitter',         '~> 0.1.2'
+    spec.add_dependency 'thor',            '~> 0.19'
+    spec.add_dependency 'concurrent-ruby', '~> 1.0.4'
+    spec.add_dependency 'childprocess',    '~> 0.5'
+
+    spec.add_development_dependency 'bundler',        '~> 1.13'
+    spec.add_development_dependency 'rake',           '~> 10.0'
+    spec.add_development_dependency 'guard',          '~> 2.13'
+    spec.add_development_dependency 'guard-minitest', '~> 2.3'
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: webpack_driver
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nathan Stitt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: knitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Run webpack and webpack-dev-server in a sub process.  Autodetects the
+  port, url and assets that are generated.
+email:
+- nathan@stitt.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/config.rb
+- lib/webpack_driver.rb
+- lib/webpack_driver/asset.rb
+- lib/webpack_driver/compile.rb
+- lib/webpack_driver/config_options.rb
+- lib/webpack_driver/configuration.rb
+- lib/webpack_driver/configuration/base.rb
+- lib/webpack_driver/dev_server.rb
+- lib/webpack_driver/errors.rb
+- lib/webpack_driver/process.rb
+- lib/webpack_driver/version.rb
+- templates/index.js.tt
+- templates/status-plugin.js.tt
+- templates/webpack.config.js.tt
+- webpack_driver.gemspec
+homepage: https://github.com/nathanstitt/webpack_driver
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: Run webpack-dev-server in a sub process
+test_files: []