webpack-assets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d00f84da28bbfed1dbad13321cfe342a49d54cf0
+  data.tar.gz: aec9cdd15326d352bea1e66555c93f5223caa2e3
+SHA512:
+  metadata.gz: ea027ecf2b0c27ece780210558ec43d121f318f0e34f1fdccce062023ca4b6070cf8bebb79a62155f5f89798cd44c501ec1722ada91d6accf4ad037217c85f86
+  data.tar.gz: 835edf46dcbbdaeaa2901eaea5ae29264d65440c86779a1481058a4460a5983e14c9facee560500e273b130654b4cfa31cf64e1fa7aefff862e474127b8ebc5d

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,21 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%r': '{}'
+    '%i': '[]'
+    '%w': '[]'
+    '%W': '[]'
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Style/AndOr:
+  EnforcedStyle: conditionals

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing
+
+If you discover issues, have ideas for improvements or new features,
+please report them to the [issue tracker][1] of the repository or
+submit a pull request. Please, try to follow these guidelines when you
+do so.
+
+## Issue reporting
+
+* Check that the issue has not already been reported.
+* Check that the issue has not already been fixed in the latest code
+  (a.k.a. `master`).
+* Be clear, concise and precise in your description of the problem.
+* Open an issue with a descriptive title and a summary in grammatically correct,
+  complete sentences.
+* Include any relevant code to the issue summary.
+
+## Pull requests
+
+* Read [how to properly contribute to open source projects on Github][2].
+* Fork the project.
+* Use a topic/feature branch to easily amend a pull request later, if necessary.
+* Write [good commit messages][3].
+* Use the same coding conventions as the rest of the project.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If
+  you want to have your own version, or is otherwise necessary, that
+  is fine, but please isolate to its own commit so I can cherry-pick
+  around it.
+* Make sure the test suite is passing and the code you wrote doesn't produce
+  RuboCop offenses.
+* [Squash related commits together][5].
+* Open a [pull request][4] that relates to *only* one subject with a clear title
+  and description in grammatically correct, complete sentences.
+
+[1]: https://github.com/toptal/webpack-assets/issues
+[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[4]: https://help.github.com/articles/using-pull-requests
+[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Toptal LLC
+
+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,96 @@
+# Webpack Assets
+
+`webpack-assets` gem is a lightweight
+[webpack](https://github.com/webpack/webpack)-[Rails](https://github.com/rails/rails)
+integration. It provides the necessary view helpers to completely replace Rails
+Asset Pipeline with webpack. Any custom webpack configuration should be
+supported if it satisfies the assumptions described in
+[the corresponding section](#webpack-configuration).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webpack-assets'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webpack-assets
+
+## Usage
+
+Minimal configuration (`config/initializers/webpack.rb`):
+
+```ruby
+Webpack.configure do |config|
+  config.port = 4000
+  config.public_path = '/assets'
+  config.static_path = 'front/static'
+end
+```
+
+Required settings:
+
+- `port` - the port webpack dev server is running on.
+- `public_path` - the base path for assets.
+- `static_path` - the root path for static files.
+
+Optional settings:
+
+- `use_server` - whether webpack dev server is being used (`Rails.env.development?` by default).
+
+- `extract_css` - whether css is extracted to a separate file (`!Rails.env.development?` by default).
+
+- `host` - the host with the port webpack dev server is running on (can be used instead of `port` option).
+
+  Example usage:
+
+  ```ruby
+  Webpack.configure do |config|
+    if ENV['WEBPACK_HOST']
+      config.host = ENV['WEBPACK_HOST']
+    else
+      config.port = 4000
+    end
+  end
+  ```
+
+View helpers:
+
+- `webpack_js_tag` is a replacement for `javascript_include_tag`.
+
+- `webpack_css_tag` is a replacement for `stylesheet_link_tag`.
+
+- `webpack_static_file_url` resolves paths to static files (assets used directly from HTML), e.g.:
+
+  ```erb
+  <%= image_tag webpack_static_file_url('img/logo.png') %>
+  ```
+
+## Webpack configuration
+
+`webpack-assets` makes several assumptions:
+
+- [`assets-webpack-plugin`](https://github.com/sporto/assets-webpack-plugin) is used to prepare `webpack-assets.json` assets manifest.
+
+- [`static-files-webpack-plugin`](https://github.com/kossnocorp/static-files-webpack-plugin) is used to prepare `static.json` assets manifest.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+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/toptal/webpack-assets. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/webpack.rb

@@ -0,0 +1,51 @@
+require 'webpack/assets/version'
+require 'webpack/configuration'
+
+module Webpack
+  class << self
+    # @return [Webpack::Configuration]
+    def config
+      @config ||= Configuration.new
+    end
+
+    # @yield config
+    # @yieldparam [Webpack::Configuration]
+    # @example
+    #   Webpack.configure do |config|
+    #     config.port = 4000
+    #     config.path = '/assets'
+    #   end
+    def configure
+      yield config
+      config.validate!
+    end
+
+    # @param entries [Hash]
+    def load_entries(entries)
+      @entries = entries
+    end
+
+    # @param name [String]
+    # @param ext [String]
+    # @return [String]
+    def fetch_entry(name, ext)
+      entries = @entries[name]
+      entry = entries[ext] if entries
+      fail "#{name}.#{ext} does not exist" unless entry
+      entry
+    end
+
+    # @param static_files [Hash]
+    def load_static_files(static_files)
+      @static_files = static_files
+    end
+
+    # @param path [String]
+    # @return [String]
+    def fetch_static_file(path)
+      static_file = @static_files[path]
+      fail "#{path} does not exist" unless static_file
+      static_file
+    end
+  end
+end

data/lib/webpack/assets.rb

@@ -0,0 +1,8 @@
+require 'webpack'
+require 'webpack/view_helpers'
+require 'webpack/rails' if defined?(Rails)
+require 'active_support/lazy_load_hooks'
+
+ActiveSupport.on_load(:action_view) do
+  include Webpack::ViewHelpers
+end

data/lib/webpack/assets/version.rb

@@ -0,0 +1,5 @@
+module Webpack
+  module Assets
+    VERSION = '0.1.0'
+  end
+end

data/lib/webpack/configuration.rb

@@ -0,0 +1,26 @@
+module Webpack
+  class Configuration
+    # @attribute port [Integer]
+    attr_accessor :port
+
+    # @attribute host [String]
+    attr_accessor :host
+
+    # @attribute public_path [String]
+    attr_accessor :public_path
+
+    # @attribute static_path [String]
+    attr_accessor :static_path
+
+    # @attribute use_server [Boolean]
+    attr_accessor :use_server
+
+    # @attribute extract_css [Boolean]
+    attr_accessor :extract_css
+
+    def validate!
+      fail 'Webpack public_path is not configured' unless public_path
+      fail 'Webpack port is not configured' unless port || host
+    end
+  end
+end

data/lib/webpack/rails.rb

@@ -0,0 +1,24 @@
+require 'rails/railtie'
+
+module Webpack
+  module Assets
+    class Railtie < Rails::Railtie
+      config.before_initialize do
+        Webpack.config.use_server  =  Rails.env.development?
+        Webpack.config.extract_css = !Rails.env.development?
+      end
+
+      config.to_prepare do
+        {load_entries: 'webpack-assets.json', load_static_files: 'static.json'}.each do |load_method, filename|
+          path = Rails.root.join(filename)
+          if File.exist?(path)
+            data = JSON.parse(File.read(path))
+          else
+            data = {}
+          end
+          Webpack.public_send(load_method, data)
+        end
+      end
+    end
+  end
+end

data/lib/webpack/view_helpers.rb

@@ -0,0 +1,64 @@
+module Webpack
+  module ViewHelpers
+    def webpack_context
+      Context.new(self)
+    end
+
+    # @param name [String]
+    def webpack_js_tag(name)
+      javascript_include_tag(webpack_entry_url(name, :js))
+    end
+
+    # @param name [String]
+    def webpack_css_tag(name)
+      stylesheet_link_tag(webpack_entry_url(name, :css)) if Webpack.config.extract_css
+    end
+
+    # @param name [String]
+    # @param ext [String]
+    # @return [String]
+    def webpack_entry_url(name, ext)
+      webpack_context.entry_url(name, ext)
+    end
+
+    # @param path [String]
+    # @return [String]
+    def webpack_static_file_url(path)
+      webpack_context.static_file_url(path)
+    end
+
+    class Context
+      attr_reader :view_context
+
+      def initialize(view_context)
+        @view_context = view_context
+      end
+
+      def entry_url(name, ext)
+        if Webpack.config.use_server
+          server_url("#{name}.#{ext}")
+        else
+          Webpack.fetch_entry(name.to_s, ext.to_s)
+        end
+      end
+
+      def static_file_url(path)
+        if Webpack.config.use_server
+          server_url(path)
+        else
+          Webpack.fetch_static_file("#{Webpack.config.static_path}/#{path}")
+        end
+      end
+
+      private
+
+      def server_url(path)
+        "//#{server_host}#{Webpack.config.public_path}/#{path}"
+      end
+
+      def server_host
+        Webpack.config.host || "#{view_context.request.host}:#{Webpack.config.port}"
+      end
+    end
+  end
+end

data/webpack-assets.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webpack/assets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'webpack-assets'
+  spec.version       = Webpack::Assets::VERSION
+  spec.authors       = ['Sergey Nartimov']
+  spec.email         = ['sergey.nartimov@toptal.com']
+
+  spec.summary       = 'Webpack Assets for Rails.'
+  spec.homepage      = 'https://github.com/toptal/webpack-assets'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'actionpack', '>= 4.2.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: webpack-assets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Nartimov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: 
+email:
+- sergey.nartimov@toptal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webpack.rb
+- lib/webpack/assets.rb
+- lib/webpack/assets/version.rb
+- lib/webpack/configuration.rb
+- lib/webpack/rails.rb
+- lib/webpack/view_helpers.rb
+- webpack-assets.gemspec
+homepage: https://github.com/toptal/webpack-assets
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Webpack Assets for Rails.
+test_files: []