middleman-webpacker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adfa59b40717784472840824fa064fbc97d2a0ac
+  data.tar.gz: 592239fd7fe623e02f8454741d9fddf7df9fe3bd
+SHA512:
+  metadata.gz: 7a45408ba7a24ae2037c972f6097c8298bca8a6517cce153e809e2a072da7a32e31f22704711c9dc8cbc7d7b2851aa5fc33c21a19c14b475db55f7d072963536
+  data.tar.gz: f83fef594378fd4dd232095f285cf570346a6f0e88ebacef14045532dfe1c101c09ebd56f07e68e1d0f50fcc7672baba6e0190b6be7da57aa8c60bc3a9b30948

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+
+
+/pkg

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,18 @@
+Copyright (c) 2010-2017 Thomas Reynolds
+
+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,68 @@
+# Middleman Webpacker Extension
+
+This extensions allows to use Webpack in [Middleman](https://middlemanapp.com/) (>= 4) applications through the external pipeline feature introduced in Middleman 4.
+
+It's heavily inspired in the Webpacker gem for Rails.
+
+## Dependencies
+
+* Middleman >= 4
+
+## Installation
+
+If you're just getting started, install the middleman gem and generate a new project:
+
+```
+gem install middleman
+middleman init MY_PROJECT
+```
+
+If you already have a Middleman project: Add this to the Gemfile and run `bundle install`
+
+```
+gem 'middleman-webpacker'
+```
+
+## Configuration
+
+```
+activate :webpack
+```
+
+Then you need to provide your Webpack configuration inside the `config` folder. The extension requires to have 2 configuration files:
+* `development.js` used during development.
+* `production.js` used when building the site.
+
+The extension provides the following configuration options:
+
+`dist_path` (default: 'dist')
+
+Output directory configured in Webpack.
+
+`stylesheets_base_path` (default: '')
+
+Base path where stylesheets will be placed inside dist_path.
+
+`javascripts_base_path` (default: '')
+
+Base path where javascripts will be placed inside dist_path.
+
+`images_base_path` (default: 'img/')
+
+Base path where images will be placed inside dist_path.
+
+## Usage
+
+When activating the extension, Webpack will be used with the provided configuration. The extension is configured to have Webpack take care of all assets: Javascript, stylesheets, images and fonts.
+
+This means that all of these assets need to be covered in your Webpack configuration.
+
+In order to be able to use the assets compiled by Webpack from the HTML you can use the following helpers:
+* `javascript_pack_tag` which replaces `javascript_include_tag`
+* `stylesheet_pack_tag` which replaces `stylesheet_link_tag` 
+* `image_pack_tag` which replaces `image_tag`
+* `asset_pack_path` which replaces `asset_path`
+
+## TODO
+
+1. Provide a base Webpack configuration (a la webpacker)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,5 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-webpacker')

data/lib/middleman-webpacker/extension.rb

@@ -0,0 +1,39 @@
+require 'middleman-core'
+require 'middleman-webpacker/helpers'
+
+module MiddlemanWebpacker
+  class Extension < ::Middleman::Extension
+
+    DEVELOPMENT_WEBPACK_CMD = './node_modules/webpack/bin/webpack.js ' \
+      '--watch -d --progress --color --config config/webpack/development.js'
+    PRODUCTION_WEBPACK_CMD = 'NODE_ENV=production ./node_modules/webpack/bin/webpack.js ' \
+      '--bail -p --config config/webpack/production.js'
+
+    option :dist_path, 'dist', 'Output directory configured in Webpack'
+    option :stylesheets_base_path, '', 'Base path where stylesheets will be placed inside dist_path'
+    option :javascripts_base_path, '', 'Base path where javascripts will be placed inside dist_path'
+    option :images_base_path, 'img/', 'Base path where images will be placed inside dist_path'
+
+    self.defined_helpers = [MiddlemanWebpacker::Helpers]
+
+    def initialize(app, options_hash = {}, &block)
+      super
+
+      output_path = File.join(app.root, options.dist_path)
+      Manifest.file_path = File.join(output_path, 'manifest.json')
+    end
+
+    def after_configuration
+      @app.ignore /stylesheets/
+      @app.ignore /javascripts/
+      @app.ignore /images/
+      @app.ignore /fonts/
+
+      @app.activate :external_pipeline,
+        name: :webpack,
+        command: @app.build? ? PRODUCTION_WEBPACK_CMD : DEVELOPMENT_WEBPACK_CMD,
+        source: options.dist_path,
+        latency: 1
+    end
+  end
+end

data/lib/middleman-webpacker/file_loader.rb

@@ -0,0 +1,25 @@
+module MiddlemanWebpacker
+  class FileLoader
+    class NotFoundError < StandardError; end
+    class FileLoaderError < StandardError; end
+
+    class_attribute :instance
+    attr_accessor :data
+
+    def self.load(path = file_path)
+      self.instance = new(path)
+    end
+
+    private
+
+    def initialize(path)
+      @path = path
+      @data = load
+    end
+
+    def load
+      {}.freeze
+    end
+
+  end
+end

data/lib/middleman-webpacker/helpers.rb

@@ -0,0 +1,29 @@
+require 'middleman-webpacker/manifest'
+
+module MiddlemanWebpacker
+  module Helpers
+
+    def stylesheet_pack_tag(name, **options)
+      stylesheet_link_tag(Manifest.lookup("#{extension_options.stylesheets_base_path}#{name}.css"), **options)
+    end
+
+    def javascript_pack_tag(name, **options)
+      javascript_include_tag(Manifest.lookup("#{extension_options.javascripts_base_path}#{name}.js"), **options)
+    end
+
+    def image_pack_tag(name, **options)
+      image_tag(Manifest.lookup("#{extension_options.images_base_path}#{name}"), **options)
+    end
+
+    def asset_pack_path(name, **options)
+      asset_path(Manifest.lookup(name), **options)
+    end
+
+    private
+
+    def extension_options
+      app.extensions[:webpack].options
+    end
+
+  end
+end

data/lib/middleman-webpacker/manifest.rb

@@ -0,0 +1,26 @@
+require 'middleman-webpacker/file_loader'
+
+module MiddlemanWebpacker
+  class Manifest < FileLoader
+
+    class_attribute :file_path
+
+    def self.lookup(name)
+      load
+
+      unless instance
+        raise MiddlemanWebpacker::FileLoader::FileLoaderError.new('load must be called first')
+      end
+
+      instance.data[name.to_s] or raise(MiddlemanWebpacker::FileLoader::NotFoundError.new(
+        "Can't find #{name} in #{file_path}. Is webpack still compiling?"))
+    end
+
+    private
+
+    def load
+      return super unless File.exist?(@path)
+      JSON.parse(File.read(@path))
+    end
+  end
+end

data/lib/middleman-webpacker/version.rb

@@ -0,0 +1,3 @@
+module MiddlemanWebpacker
+  VERSION = '1.0.0'
+end

data/lib/middleman-webpacker.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+Middleman::Extensions.register(:webpack) do
+  require 'middleman-webpacker/extension'
+  MiddlemanWebpacker::Extension
+end

data/middleman-webpacker.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'middleman-webpacker/version'
+
+Gem::Specification.new do |s|
+  s.name                  = 'middleman-webpacker'
+  s.version               = MiddlemanWebpacker::VERSION
+  s.platform              = Gem::Platform::RUBY
+  s.authors               = [ 'MarsBased' ]
+  s.email                 = [ 'hello@marsbased.com' ]
+  s.homepage              = 'https://github.com/marsbased/middleman-webpacker'
+  s.summary               = %q{ Extension to use Middleman with Webpack }
+  s.description           = %q{ Extension to use Middleman with Webpack }
+  s.license               = 'MIT'
+
+  s.files                 = `git ls-files -z`.split("\0")
+  s.test_files            = `git ls-files -z -- {spec,features,fixtures}/*`.split("\0")
+  s.require_paths         = [ 'lib' ]
+
+  s.required_ruby_version = '>= 2.2.0'
+
+  s.add_runtime_dependency('middleman-core', ['>= 4.2.1'])
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('cucumber')
+  s.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: middleman-webpacker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MarsBased
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " Extension to use Middleman with Webpack "
+email:
+- hello@marsbased.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-webpacker.rb
+- lib/middleman-webpacker/extension.rb
+- lib/middleman-webpacker/file_loader.rb
+- lib/middleman-webpacker/helpers.rb
+- lib/middleman-webpacker/manifest.rb
+- lib/middleman-webpacker/version.rb
+- middleman-webpacker.gemspec
+homepage: https://github.com/marsbased/middleman-webpacker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.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: Extension to use Middleman with Webpack
+test_files:
+- features/support/env.rb