gems_assets_webpack_bridge 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f98d4f84753185927415394d7491fa3d9fb4c2ff
+  data.tar.gz: 1b3ff95a1fa7e58e6624f6a568a2240136b917e4
+SHA512:
+  metadata.gz: ca13a74a68fcfe29826c59c76867304dda07cbe3737ed66c6c3ee36ed886785f9dd8072308a6b3cadc71b9319ba76c334e898a0ab05c75149eafa1579ddd9f6b
+  data.tar.gz: c1290e9d3175edff7abad38ce27c7471e25243a8edda746c7aaf06a377043f8d69234c4e977848f0e79924d7505c26e2a8db486a7f389493f7cf7f4f82bfecec

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+gems_assets_webpack_bridge-*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gems_assets_webpack_bridge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ilya N. Zykin
+
+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,143 @@
+# GemsAssetsWebpackBridge
+
+This Rails gem helps to create a bridge between assets in your ruby gems and [Webpack](https://webpack.js.org/).
+
+![pexels-photo-208684](https://user-images.githubusercontent.com/496713/36936816-18261a9c-1f1b-11e8-9c46-6b6d830fed2c.jpeg)
+
+## The Problem
+
+1. I had a classic monolith Rails application with Sprockets.
+2. I've split my Rails app into a few Rails gems and moved my assets into gems.
+3. I started migration from Sprockets to Webpack.
+4. Webpack didn't know how to find my assets in Rails gems.
+
+## The Solution
+
+This gem helps to collect paths to assets' folders in gems and adds some [aliases](https://webpack.js.org/configuration/resolve/#resolve-alias) for Webpack to help it to find assets in classic Rails gems.
+
+## Installation
+
+**Gemfile**
+
+```ruby
+gem 'gems_assets_webpack_bridge'
+```
+
+```
+$ bundle
+```
+
+## Usage
+
+Create a bridge between Rails gems and Webpack:
+
+```ruby
+rake gems_asstes_webpack_bridge:create
+```
+
+### What is The Bridge?
+
+* The Bridge is a JSON file with paths to assets in your gems.
+* The Bridge provides additional [aliases](https://webpack.js.org/configuration/resolve/#resolve-alias) for Webpack to help it to find assets' folders in ruby gems.
+* Every alias has the following naming: `@[UNDERSCORED_GEM_NAME]-[ASSET_TYPE]`.
+* Default asset types are: `images`, `scripts`, `styles`.
+* By default the file has name `gems-assets-webpack-bridge.json` and looks like that:
+
+```json
+{
+  "@crop_tool-scripts": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/crop_tool/app/assets/javascripts",
+  "@crop_tool-styles": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/crop_tool/app/assets/stylesheets",
+  "@jquery_ui_rails-images": "/Users/@username/.rvm/gems/ruby-2.3.3@open-cook.ru/gems/jquery-ui-rails-5.0.0/app/assets/images",
+  "@jquery_ui_rails-scripts": "/Users/@username/.rvm/gems/ruby-2.3.3@open-cook.ru/gems/jquery-ui-rails-5.0.0/app/assets/javascripts",
+  "@jquery_ui_rails-styles": "/Users/@username/.rvm/gems/ruby-2.3.3@open-cook.ru/gems/jquery-ui-rails-5.0.0/app/assets/stylesheets",
+  "@log_js-scripts": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/log_js/app/assets/javascripts",
+  "@notifications-scripts": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/notifications/app/assets/javascripts",
+  "@notifications-styles": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/notifications/app/assets/stylesheets",
+}
+```
+
+### How to use The Bridge?
+
+Now, when you the bridge file, you can use it in Webpack like this:
+
+**webpack.config.js**
+
+```javascript
+// This helper-function reads the bridge file and
+// adds some additional aliases in `WebPackConfig.resolve.alias`
+function addGemsAssetsWebpackBridge (WebPackConfig) {
+  const alias = WebPackConfig.resolve.alias
+  const bridgeFile = `${rootPath}/gems-assets-webpack-bridge.json`
+
+  var bridgeAlias = JSON.parse(fs.readFileSync(bridgeFile, 'utf8'))
+  return Object.assign(alias, bridgeAlias)
+}
+
+let WebpackConfig = {
+  entry: {
+    ...
+  },
+
+  output: {
+    ...
+  },
+
+  resolve : {
+    alias: {
+      '@vendors': `${rootPath}/assets/vendors`
+    }
+  }
+}
+
+WebPackConfig.resolve.alias = addGemsAssetsWebpackBridge(WebPackConfig)
+module.exports = WebPackConfig
+```
+
+After you added the aliases you can use them in your Webpack entries like this:
+
+```javascript
+require('@log_js-scripts/log_js')
+require('@notifications-scripts/notifications')
+require('@the_comments-scripts/the_comments')
+
+require('@notifications-styles/notifications')
+require('@the_comments-styles/the_comments')
+```
+
+### How can I configure this gem?
+
+You can create a new initializer in your Rails app change options:
+
+**config/initializers/gems_assets_webpack_bridge.rb**
+
+```ruby
+GemsAssetsWebpackBridge.configure do |config|
+  # From a root of your Rails app
+  config.bridge_path = '/configs/gems-webpack-bridge.json'
+
+  #  From a root of every Rails gem
+  config.assets_types = {
+    # Default values
+    images: 'app/assets/images',
+    scripts: 'app/assets/javascripts',
+    styles: 'app/assets/stylesheets',
+
+    # Your custom values
+    vendor_select2_images: 'vendors/select2/images',
+  }
+end
+```
+
+### Should I add the bridge file in my VCS?
+
+No. Paths will be different for different users. Just add `gems-assets-webpack-bridge.json` in your `.gitignore` and run `rake gems_asstes_webpack_bridge:create` when you need it.
+
+### Should I change my deployment process?
+
+You have to run `rake gems_asstes_webpack_bridge:create` before every Webpack compilation during deployment. Otherwise Webpack will know nothing about aliases and a compilation won't work.
+
+### License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Bridge image @ pexels.com](https://www.pexels.com/photo/architecture-autumn-blue-blue-sky-208684/)

data/README.ru.md

@@ -0,0 +1,143 @@
+# GemsAssetsWebpackBridge
+
+Рельсовый гем, который помогает построить мост между ассетами в руби гемах и [Вебпаком](https://webpack.js.org/).
+
+![pexels-photo-208684](https://user-images.githubusercontent.com/496713/36936816-18261a9c-1f1b-11e8-9c46-6b6d830fed2c.jpeg)
+
+## Проблема
+
+1. У меня было классическое монолитное рельсовое приложение со Sprockets.
+2. Я разделил приложение на несколько рельсовых гемов и перенес в них ассеты.
+3. Я начал миграцию со Sprockets на Webpack.
+4. Webpack ничего не знал о путях к ассетах в моих рельсовых гемах.
+
+## Решение
+
+Этот гем помогает собрать пути к ассетам в руби гемах и сделать [ссылки (алиасы)](https://webpack.js.org/configuration/resolve/#resolve-alias) для Вебпака, чтобы он мог найти ассеты в руби гемах.
+
+## Установка
+
+**Gemfile**
+
+```ruby
+gem 'gems_assets_webpack_bridge'
+```
+
+```
+$ bundle
+```
+
+## Использование
+
+Создать мост между рельсовыми гемами и Вебпаком:
+
+```ruby
+rake gems_asstes_webpack_bridge:create
+```
+
+### Что такое Мост?
+
+* Мост это JSON файл с путями к папкам ассетов в ваших руби гемах.
+* Мост формирует [ссылки (алиасы)](https://webpack.js.org/configuration/resolve/#resolve-alias) для Вебпака, чтобы помочь ему найти ваши ассеты.
+* Каждая ссылка имеет следующий формат: `@[UNDERSCORED_GEM_NAME]-[ASSET_TYPE]`.
+* Типы ассетов по умолачнию: `images`, `scripts`, `styles`.
+* Имя файла-моста по-умолчанию `gems-assets-webpack-bridge.json` и выглядит он примерно так:
+
+```json
+{
+  "@crop_tool-scripts": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/crop_tool/app/assets/javascripts",
+  "@crop_tool-styles": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/crop_tool/app/assets/stylesheets",
+  "@jquery_ui_rails-images": "/Users/@username/.rvm/gems/ruby-2.3.3@open-cook.ru/gems/jquery-ui-rails-5.0.0/app/assets/images",
+  "@jquery_ui_rails-scripts": "/Users/@username/.rvm/gems/ruby-2.3.3@open-cook.ru/gems/jquery-ui-rails-5.0.0/app/assets/javascripts",
+  "@jquery_ui_rails-styles": "/Users/@username/.rvm/gems/ruby-2.3.3@open-cook.ru/gems/jquery-ui-rails-5.0.0/app/assets/stylesheets",
+  "@log_js-scripts": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/log_js/app/assets/javascripts",
+  "@notifications-scripts": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/notifications/app/assets/javascripts",
+  "@notifications-styles": "/Users/@username/.rvm/gems/ruby-2.4.2/gems/notifications/app/assets/stylesheets",
+}
+```
+
+### Как использовать Мост?
+
+Теперь, когда у вас есть файл-мост, вы можете использовать его в конфиге Вебпака:
+
+**webpack.config.js**
+
+```javascript
+// Эта функция читает файл-мост
+// И добавляет ссылки в `WebPackConfig.resolve.alias`
+function addGemsAssetsWebpackBridge (WebPackConfig) {
+  const alias = WebPackConfig.resolve.alias
+  const bridgeFile = `${rootPath}/gems-assets-webpack-bridge.json`
+
+  var bridgeAlias = JSON.parse(fs.readFileSync(bridgeFile, 'utf8'))
+  return Object.assign(alias, bridgeAlias)
+}
+
+let WebpackConfig = {
+  entry: {
+    ...
+  },
+
+  output: {
+    ...
+  },
+
+  resolve : {
+    alias: {
+      '@vendors': `${rootPath}/assets/vendors`
+    }
+  }
+}
+
+WebPackConfig.resolve.alias = addGemsAssetsWebpackBridge(WebPackConfig)
+module.exports = WebPackConfig
+```
+
+После того, как вы добавили ссылки в Вебпак, вы можете использовать их в энтри-поинтах:
+
+```javascript
+require('@log_js-scripts/log_js')
+require('@notifications-scripts/notifications')
+require('@the_comments-scripts/the_comments')
+
+require('@notifications-styles/notifications')
+require('@the_comments-styles/the_comments')
+```
+
+### Как я могу сконфигурировать этот гем?
+
+ Создайте инициализатор в приложении и вы сможете настроить следующие значения:
+
+**config/initializers/gems_assets_webpack_bridge.rb**
+
+```ruby
+GemsAssetsWebpackBridge.configure do |config|
+  # От корня рельсового приложения
+  config.bridge_path = '/configs/gems-webpack-bridge.json'
+
+  # От корня любого гема
+  config.assets_types = {
+    # Значения по-умолчанию
+    images: 'app/assets/images',
+    scripts: 'app/assets/javascripts',
+    styles: 'app/assets/stylesheets',
+
+    # Ваши кастомные пути
+    vendor_select2_images: 'vendors/select2/images',
+  }
+end
+```
+
+### Нужно ли мне добавлять файл-мост в мою систему контроля версий?
+
+Нет. Пути будут у всех разные. Просто добавьте `gems-assets-webpack-bridge.json` в ваш  `.gitignre` и запускайте `rake gems_asstes_webpack_bridge:create` когда вам это потребуется.
+
+### Нужно ли мне поменять процесс деплоя?
+
+Вам нужно запускать `rake gems_asstes_webpack_bridge:create` перед каждой компиляцией Вебпака во время деплоя. Иначе Вебпак не будет ничего знать о дополнительных ссылках и компиляция не будет работать.
+
+### License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Bridge image @ pexels.com](https://www.pexels.com/photo/architecture-autumn-blue-blue-sky-208684/)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/gems_assets_webpack_bridge.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "./version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gems_assets_webpack_bridge"
+  spec.version       = GemsAssetsWebpackBridge::VERSION
+  spec.authors       = ["Ilya N. Zykin"]
+  spec.email         = ["zykin-ilya@ya.ru"]
+
+  spec.summary       = %q{The Bridge between Rails gems and Webpack}
+  spec.description   = %q{Helps to make visible Rails gems's assets in Webpack}
+  spec.homepage      = "https://github.com/the-teacher"
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/config.rb

@@ -0,0 +1,25 @@
+module GemsAssetsWebpackBridge
+  def self.configure(&block)
+    yield @config ||= GemsAssetsWebpackBridge::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :assets_types, :bridge_path
+  end
+
+  configure do |config|
+    config.assets_types = {
+      images: 'app/assets/images',
+      scripts: 'app/assets/javascripts',
+      styles: 'app/assets/stylesheets'
+    }
+
+    config.bridge_path = 'gems-assets-webpack-bridge.json'
+  end
+end

data/lib/gems_assets_webpack_bridge.rb

@@ -0,0 +1,6 @@
+require_relative "../version"
+require_relative "./config"
+
+module GemsAssetsWebpackBridge
+  class Engine < Rails::Engine; end
+end

data/lib/tasks/gems_assets_webpack_bridge.rake

@@ -0,0 +1,30 @@
+require 'json'
+
+# rake gems_assets_webpack_bridge:create
+namespace :gems_assets_webpack_bridge do
+  task create: :environment do
+    assets_types = GemsAssetsWebpackBridge.config.assets_types
+    bridge_path = GemsAssetsWebpackBridge.config.bridge_path
+
+    bridge = Bundler.load.specs.inject({}) do |bridge, gem|
+      assets_types.each do |type_name, type_path|
+        assets_path = "#{gem.full_gem_path}/#{type_path}"
+
+        if Dir.exist?(assets_path)
+          path_name = "@#{gem.name.underscore}-#{type_name}"
+          bridge[path_name] = assets_path
+        end
+      end
+
+      bridge
+    end
+
+    bridge_file = "#{Rails.root}/#{bridge_path}"
+    File.open(bridge_file, 'w') do |file|
+      file.write JSON.pretty_generate(bridge)
+    end
+
+    puts "GemsAssetsWebpackBridge"
+    puts "The bridge-file is created: #{bridge_file}"
+  end
+end

data/version.rb

@@ -0,0 +1,3 @@
+module GemsAssetsWebpackBridge
+  VERSION = "0.9.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: gems_assets_webpack_bridge
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Ilya N. Zykin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: Helps to make visible Rails gems's assets in Webpack
+email:
+- zykin-ilya@ya.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.ru.md
+- Rakefile
+- gems_assets_webpack_bridge.gemspec
+- lib/config.rb
+- lib/gems_assets_webpack_bridge.rb
+- lib/tasks/gems_assets_webpack_bridge.rake
+- version.rb
+homepage: https://github.com/the-teacher
+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.14
+signing_key: 
+specification_version: 4
+summary: The Bridge between Rails gems and Webpack
+test_files: []