webpack_integration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8137d2b6f8d3b7eb9d0a579a568b8acd9d37b95
+  data.tar.gz: dd62598a0b54960ca81d18c367e871f1ccfd039c
+SHA512:
+  metadata.gz: 0fd05c93fbb4e2da52ad6e947a9ee52766ea95f9eedbf80b1c417baf1b0f7870e76846768a77c693060a302be2b3421fa879c448b95ca8771180d62addf6e642
+  data.tar.gz: 5e4039d724bf2cc8c0612c0cb97bb9ed90188f5f781eda018e73720e6006fe141c677fd0e1aada626caf8ee29073b88e0ac6adf700377b993f1b9a7df1ed9df4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.2
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler
+
+script: sh/test

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in webpack_integration.gemspec
+gemspec
+
+gem 'codecov', :require => false, :group => :test

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Roman Heinrich
+
+MIT License
+
+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,64 @@
+# WebpackIntegration
+
+[![Build Status](https://travis-ci.org/mindreframer/webpack_integration.svg?branch=master)](http://travis-ci.org/mindreframer/webpack_integration)
+[![codecov.io](https://codecov.io/github/mindreframer/webpack_integration/coverage.svg?branch=master)](https://codecov.io/github/mindreframer/webpack_integration?branch=master)
+
+A small gem for dead simple integration with any static assets compiler.
+It allows you to reference any file in a output folder for a compiler (webpack / gulp / grunt) that may have a hash digest in the file name by simple non-changeable filename part.
+
+Example:
+
+    public/webpack/reports_view-bundle-ab530a1.js
+    public/webpack/reports_view_styles-bundle-b94f982.js
+    public/webpack/common-2a55c40.js
+    public/webpack/invoices_view-bundle-e881f50.js
+    public/webpack/invoices_view_styles-bundle-0ebe2ec.js
+
+
+Refer to files in Rails views by:
+
+    <%= javascript_include_tag  webpack_file('reports_view_bundle') %>
+    <%= javascript_include_tag  webpack_file('reports_view_styles-bundle') %>
+
+
+Or anywhere in code by:
+
+    # fuzzy, forgiving matching
+    WebpackIntergration.fuzzy_file_for(filename)
+
+    # exact file name without the digest
+    WebpackIntergration.file_for(filename)
+
+
+## Installation
+
+      # add to your application's Gemfile:
+      gem 'webpack_integration'
+
+      # run
+      $ bundle
+
+## Usage
+
+    # in config/initializers/webpack_integration.rb
+    WebpackIntegration.configure do |config|
+      config.public_folder         = 'public'  # default 'public'
+      config.folder_in_public      = 'webpack' # default 'webpack'
+      config.reset_on_each_request = Rails.env.development?  # default false
+    end
+
+
+## Development
+    # run tests
+    $ sh/test
+
+## Todo
+  - make reloading more efficient, maybe in a background process.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/webpack_integration/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/webpack_integration.rb

@@ -0,0 +1,31 @@
+require "webpack_integration/version"
+require "webpack_integration/configuration"
+require "webpack_integration/assets"
+require "webpack_integration/store"
+require "webpack_integration/railtie" if defined?(Rails)
+
+
+module WebpackIntegration
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= WebpackIntegration::Configuration.new
+  end
+
+  # @example
+  #   WebpackIntergration.file_for('clients.css')
+  def self.file_for(filename)
+    WebpackIntegration::Store.file_for(filename)
+  end
+
+  def self.fuzzy_file_for(file_pattern)
+    WebpackIntegration::Store.fuzzy_file_for(file_pattern)
+  end
+
+  # should be called in development mode in after-request filter
+  def self.reset_assets_manifest!
+    WebpackIntegration::Store.reset
+  end
+end

data/lib/webpack_integration/assets.rb

@@ -0,0 +1,31 @@
+module WebpackIntegration
+  class Assets
+    def self.generate_assets_manifest
+      {}.tap do |res|
+        Dir[file_matcher].each do |f|
+          next if File.directory?(f)
+          key      = f.gsub(webpack_folder, '')
+          key      = key.gsub(/-[a-f\d]*(\.)/, '.') # remove md5 hash
+          value    = f.sub(public_folder, '')
+          res[key] = value
+        end
+      end
+    end
+
+    def self.file_matcher
+      File.join(configuration.full_path, '**/**/**/**')
+    end
+
+    def self.webpack_folder
+      configuration.full_path
+    end
+
+    def self.public_folder
+      configuration.public_folder
+    end
+
+    def self.configuration
+      WebpackIntegration.configuration
+    end
+  end
+end

data/lib/webpack_integration/configuration.rb

@@ -0,0 +1,14 @@
+module WebpackIntegration
+  class Configuration
+    attr_accessor :folder_in_public, :reset_on_each_request, :public_folder
+    def initialize
+      @folder_in_public      = 'webpack'
+      @public_folder         = 'public'
+      @reset_on_each_request = false
+    end
+
+    def full_path
+      File.join(public_folder, folder_in_public)
+    end
+  end
+end

data/lib/webpack_integration/store.rb

@@ -0,0 +1,33 @@
+module WebpackIntegration
+  class Store
+
+    # @example
+    #   Store.fuzzy_file_for('client.png')
+    def self.fuzzy_file_for(file_pattern)
+      alternatives = assets_keys.grep(Regexp.new(file_pattern))
+      raise "TOO MANY MATCHES for #{file_pattern}" if alternatives.size > 1
+      file_for(alternatives.first)
+    end
+
+    def self.file_for(filename)
+      assets_manifest.fetch(filename) # will raise on missing assets!
+    end
+
+    def self.load
+      assets_keys
+    end
+
+    def self.assets_keys
+      @assets_keys ||= assets_manifest.keys.sort!
+    end
+
+    def self.assets_manifest
+      @assets_manifest ||= WebpackIntegration::Assets.generate_assets_manifest
+    end
+
+    def self.reset
+      @assets_manifest = nil
+      @assets_keys     = nil
+    end
+  end
+end

data/lib/webpack_integration/version.rb

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

data/lib/webpack_integration/view_helper.rb

@@ -0,0 +1,7 @@
+module WebpackIntegration
+  module ViewHelper
+    def webpack_file(filename)
+      WebpackIntergration.fuzzy_file_for(filename)
+    end
+  end
+end

data/sh/c

@@ -0,0 +1 @@
+irb -r ./sh/env.rb

data/sh/env.rb

@@ -0,0 +1,3 @@
+require 'bundler'
+Bundler.setup
+require 'webpack_integration'

data/sh/test

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'rake/testtask'
+if ARGV[0]
+  testfiles = (Dir["test/**/**_test.rb"]).grep %r[#{ARGV[0]}]
+end
+Rake::TestTask.new("my_test") do |test|
+  if testfiles
+    test.test_files = testfiles
+  else
+    test.pattern = "test/**/*_test.rb"
+  end
+  test.verbose = true
+end
+
+Rake::Task['my_test'].invoke

data/test/fixtures/webpack/brand_view-bundle-3e23e81.js

@@ -0,0 +1 @@
+

data/test/fixtures/webpack/brand_view_styles-bundle-ca97811.js

@@ -0,0 +1 @@
+

data/test/fixtures/webpack/common-2e7d2c0.js

@@ -0,0 +1 @@
+

data/test/fixtures/webpack/executive_view-bundle-3f79bb7.js

@@ -0,0 +1 @@
+

data/test/fixtures/webpack/executive_view_styles-bundle-18ac3e7.js

@@ -0,0 +1 @@
+

data/test/public_api_test.rb

@@ -0,0 +1,36 @@
+require './test/test_helper'
+
+
+class PublicApiTest  < Minitest::Spec
+  before do
+    WebpackIntegration.configure do |config|
+      config.public_folder    = 'test/fixtures'
+      config.folder_in_public = 'webpack'
+    end
+  end
+
+  describe 'file_for' do
+    it "delegates to store" do
+      WebpackIntegration::Store.expects(:file_for).with('test')
+      WebpackIntegration.file_for('test')
+      WebpackIntegration::Store.unstub(:file_for)
+    end
+  end
+
+
+  describe 'fuzzy_file_for' do
+    it "delegates to store" do
+      WebpackIntegration::Store.expects(:fuzzy_file_for).with('test')
+      WebpackIntegration.fuzzy_file_for('test')
+      WebpackIntegration::Store.unstub(:fuzzy_file_for)
+    end
+  end
+
+  describe 'reset_assets_manifest!' do
+    it "delegates to store" do
+      WebpackIntegration::Store.expects(:reset)
+      WebpackIntegration.reset_assets_manifest!
+      WebpackIntegration::Store.unstub(:reset)
+    end
+  end
+end

data/test/store_test.rb

@@ -0,0 +1,71 @@
+require './test/test_helper'
+
+describe 'WebpackIntegration::Store' do
+  before do
+    WebpackIntegration.configure do |config|
+      config.public_folder    = 'test/fixtures'
+      config.folder_in_public = 'webpack'
+    end
+  end
+
+  describe 'load' do
+    it "can be loaded" do
+      WebpackIntegration::Store.load
+    end
+  end
+
+  describe 'assets_keys' do
+    it "works" do
+      WebpackIntegration::Store.assets_keys
+    end
+
+    it "contains cleaned up file names, that you want to use in your application" do
+      expected = ["/brand_view-bundle.js", "/brand_view_styles-bundle.js", "/common.js", "/executive_view-bundle.js", "/executive_view_styles-bundle.js", "/img/logo.png", "/img/logo_for_runaways.png"]
+      WebpackIntegration::Store.assets_keys.must_equal expected
+    end
+  end
+
+
+  describe 'assets_manifest' do
+    it "is a hash-map, that maps clean names to digested names with full path" do
+      expected = {"/brand_view-bundle.js"=>"/webpack/brand_view-bundle-3e23e81.js", "/brand_view_styles-bundle.js"=>"/webpack/brand_view_styles-bundle-ca97811.js", "/common.js"=>"/webpack/common-2e7d2c0.js", "/executive_view-bundle.js"=>"/webpack/executive_view-bundle-3f79bb7.js", "/executive_view_styles-bundle.js"=>"/webpack/executive_view_styles-bundle-18ac3e7.js", "/img/logo.png"=>"/webpack/img/logo-0ebe2ec.png", "/img/logo_for_runaways.png"=>"/webpack/img/logo_for_runaways-907b853.png"}
+      WebpackIntegration::Store.assets_manifest.must_equal(expected)
+    end
+  end
+
+  describe 'file_for' do
+    it "returns the exact match on keys" do
+      expected = '/webpack/brand_view-bundle-3e23e81.js'
+      WebpackIntegration::Store.file_for('/brand_view-bundle.js').must_equal expected
+    end
+
+    it "blows up otherwise" do
+      exception = lambda{
+        WebpackIntegration::Store.file_for('non-existant')
+      }.must_raise KeyError
+      exception.message.must_equal "key not found: \"non-existant\""
+    end
+  end
+
+  describe 'fuzzy_file_for' do
+    it "will return the only matching file" do
+      expected = '/webpack/brand_view-bundle-3e23e81.js'
+      WebpackIntegration::Store.fuzzy_file_for('brand_view-bundle').must_equal expected
+    end
+
+    it "blows up on ambiguous matches" do
+      exception = lambda{
+        WebpackIntegration::Store.fuzzy_file_for('brand_view')
+      }.must_raise RuntimeError
+      exception.message.must_equal "TOO MANY MATCHES for brand_view"
+    end
+  end
+
+  describe 'reset' do
+    it "sets the mainifest to nil" do
+      WebpackIntegration::Store.reset
+      WebpackIntegration::Store.instance_variable_get('@assets_manifest').must_equal nil
+      WebpackIntegration::Store.assets_manifest.wont_equal nil
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/test/"
+  add_filter "/.direnv/"
+end
+if ENV['CI']=='true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+
+Bundler.setup
+
+require 'webpack_integration'
+require 'maxitest'
+require 'mocha/mini_test'
+require 'maxitest/autorun'

data/webpack_integration.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webpack_integration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webpack_integration"
+  spec.version       = WebpackIntegration::VERSION
+  spec.authors       = ["Roman Heinrich"]
+  spec.email         = ["roman.heinrich@gmail.com"]
+  spec.summary       = %q{A small gem to integrated digested static files with Ruby / Rails apps}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/mindreframer/webpack_integration"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "maxitest"
+  spec.add_development_dependency "mocha"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: webpack_integration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Heinrich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: minitest
+  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: maxitest
+  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: mocha
+  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: A small gem to integrated digested static files with Ruby / Rails apps
+email:
+- roman.heinrich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webpack_integration.rb
+- lib/webpack_integration/assets.rb
+- lib/webpack_integration/configuration.rb
+- lib/webpack_integration/railtie.rb
+- lib/webpack_integration/store.rb
+- lib/webpack_integration/version.rb
+- lib/webpack_integration/view_helper.rb
+- sh/c
+- sh/env.rb
+- sh/test
+- test/fixtures/webpack/brand_view-bundle-3e23e81.js
+- test/fixtures/webpack/brand_view_styles-bundle-ca97811.js
+- test/fixtures/webpack/common-2e7d2c0.js
+- test/fixtures/webpack/executive_view-bundle-3f79bb7.js
+- test/fixtures/webpack/executive_view_styles-bundle-18ac3e7.js
+- test/fixtures/webpack/img/logo-0ebe2ec.png
+- test/fixtures/webpack/img/logo_for_runaways-907b853.png
+- test/public_api_test.rb
+- test/store_test.rb
+- test/test_helper.rb
+- webpack_integration.gemspec
+homepage: https://github.com/mindreframer/webpack_integration
+licenses:
+- MIT
+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.4.4
+signing_key: 
+specification_version: 4
+summary: A small gem to integrated digested static files with Ruby / Rails apps
+test_files:
+- test/fixtures/webpack/brand_view-bundle-3e23e81.js
+- test/fixtures/webpack/brand_view_styles-bundle-ca97811.js
+- test/fixtures/webpack/common-2e7d2c0.js
+- test/fixtures/webpack/executive_view-bundle-3f79bb7.js
+- test/fixtures/webpack/executive_view_styles-bundle-18ac3e7.js
+- test/fixtures/webpack/img/logo-0ebe2ec.png
+- test/fixtures/webpack/img/logo_for_runaways-907b853.png
+- test/public_api_test.rb
+- test/store_test.rb
+- test/test_helper.rb