railspacker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c24630dcc6c82027087d8970696856e24fb6bd652db7a18546e96e3d42f017e9
+  data.tar.gz: eb89e2d01b53f91700902992b8a03bd59b0bdf7ff7235f7c9b683e16319b474b
+SHA512:
+  metadata.gz: 52d2ff5c65e364b98feca23f5df11bb32ca7f279f041faaaba8d0eff2fba9cff99e848ce224edf2a2b3e969a01e3d606198177f29e7eff02e95638383ceff659
+  data.tar.gz: 4cd86153360a79885a9a5ffeaca6668fe2a7d70d28a5d8a22cf62244f8b63a131ee925a618bb5346e578a6c842061e9287a6156de549280c352ce4df60d621f6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Alexandre Magro
+
+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,54 @@
+# Railspacker
+Railspacker is a alternative to Webpacker. The motivation is to give more control over the webpack to the developer, avoiding wrapping it in ruby, opting for the configuration.
+
+## Status
+
+This is an early version, if you liked the design concept, and intend to use it, let me know. Consider contributing, knowledge with testing for rails plugins will be welcome.
+
+## Prerequisites
+
+- Ruby 5.1 (+ Yarn);
+- WebpackManifestPlugin on;
+
+## Getting started
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'railspacker'
+```
+
+Then run `bundle install`
+
+Next, you need to run the generator:
+```bash
+$ rails generate railspacker:install
+```
+
+Add script in application template via `pack_path`
+```html
+<%= javascript_include_tag pack_path('pack_name.js') %>
+```
+
+Railspacker has created the necessary files and a preconfiguration for you to begin development. Read the next session to understand how to proceed.
+
+## Usage
+
+### Development
+
+Start WebpackDevServer in separated process to serve live code reloading assets:
+```bash
+$ yarn run serve
+```
+
+**NOTE:** The devServer already comes preconfigured, if you want to change the configuration, be sure to look at the railspacker configuration in `config/initializers/railspacker.rb`
+
+### Test
+
+System test approach is: compile packs before tests. For this, Railspacker installer added command `Railspacker.run 'build-test'` to your ApplicationSystemTestCase. So, when you run System Tests, yarn will run package script named `'build-test'`. The output `public/packs-test` will be created, and ignored to git via `.gitignore`
+
+### Production
+
+To production environment, Railspacker enhance the task `rails assets:precompile`. Thus, the packages will be compiled soon after the assets `task:precompile`.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Railspacker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/lib/generators/railspacker/install_generator.rb

@@ -0,0 +1,27 @@
+module Railspacker
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def create_initializer_file
+        copy_file 'package.json', './package.json'
+        copy_file 'webpack.config.js', './webpack.config.js'
+        copy_file 'config/initializers/railspacker.rb', 'config/initializers/railspacker.rb'
+        empty_directory './app/webpack'
+
+        append_to_file '.gitignore' do
+          <<~TEXT
+
+            # Ignore precompiled javascript packs
+            /public/packs
+            /public/packs-test
+          TEXT
+        end
+
+        inject_into_class 'test/application_system_test_case.rb', 'ApplicationSystemTestCase' do
+          "  Railspacker.run 'build-test'\n\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/config/initializers/railspacker.rb

@@ -0,0 +1,11 @@
+# `build` script will run before the `assets:precompile` task
+# Railspacker.before_assets_precompile_script = 'build'
+
+Railspacker.manifest = case Rails.env
+when 'development'
+  Railspacker::Manifest::DevServer.new(url: 'http://localhost:3001')
+when 'test'
+  Railspacker::Manifest::Build.new(public_path: 'packs-test')
+when 'production'
+  Railspacker::Manifest::Build.new(public_path: 'packs')
+end

data/lib/generators/templates/package.json

@@ -0,0 +1,9 @@
+{
+  "private": true,
+  "scripts": {
+    "build": "webpack --env=production",
+    "build-test": "webpack --env=test",
+    "serve": "webpack-dev-server --env=development",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

data/lib/generators/templates/webpack.config.js

@@ -0,0 +1,47 @@
+// Add dependencies
+// 
+// `yarn add webpack clean-webpack-plugin webpack-manifest-plugin`
+
+const path               = require('path');
+const CleanWebpackPlugin = require('clean-webpack-plugin');
+const ManifestPlugin     = require('webpack-manifest-plugin');
+const webpack            = require('webpack');
+
+module.exports = (env) => {
+  const config = {};
+  const outputPath = (env == 'test') ? 'public/packs-test' : 'public/packs';
+
+  config.entry = {
+    app: './app/webpack/index.js'
+  };
+  config.plugins = [
+    // Generate a manifest.json to output. Is requred to Railspacker.
+    new ManifestPlugin(),
+
+    // Clean output directory before builds
+    new CleanWebpackPlugin([outputPath]),
+
+    // Enables Hot Module Replacement, otherwise known as HMR.
+    new webpack.HotModuleReplacementPlugin()
+  ];
+  config.output = {
+    filename: '[name].js',
+    path: path.resolve(__dirname, outputPath)
+  };
+
+  if (env === 'development' || env === 'test') {
+    config.mode = 'development'
+    config.devtool = 'inline-source-map'
+    config.devServer = {
+      contentBase: path.resolve(__dirname, 'app/webpack'),
+      port: 3001,
+      hot: true
+    }
+  };
+
+  if (env === 'production') {
+    config.mode = 'production'
+  };
+
+  return config;
+};

data/lib/railspacker/helper.rb

@@ -0,0 +1,15 @@
+module Railspacker::Helper
+  def pack_path(name)
+    manifest = Railspacker.manifest.load
+
+    if manifest.nil?
+      raise "manifest.json not found."
+    end
+
+    if !manifest.key?(name)
+      raise "Pack not found in manifest.json: #{name}"
+    end
+    
+    [Railspacker.manifest.path_to, manifest[name]].join('/')
+  end
+end

data/lib/railspacker/manifest/build.rb

@@ -0,0 +1,13 @@
+module Railspacker::Manifest
+  class Build < Struct.new(:public_path, keyword_init: true)
+    def load
+      file = Rails.public_path.join(public_path).join('manifest.json')
+
+      JSON.parse File.read(file)
+    end
+
+    def path_to
+      Pathname.new('/').join(public_path)
+    end
+  end
+end

data/lib/railspacker/manifest/dev_server.rb

@@ -0,0 +1,15 @@
+require 'net/http'
+
+module Railspacker::Manifest
+  class DevServer < Struct.new(:url, keyword_init: true)
+    def load
+      uri = URI("#{url}/manifest.json")
+
+      JSON.parse Net::HTTP.get(uri)
+    end
+
+    def path_to
+      url
+    end
+  end
+end

data/lib/railspacker/railtie.rb

@@ -0,0 +1,19 @@
+require "railspacker/helper"
+
+module Railspacker
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'tasks/railspacker_tasks.rake'
+    end
+
+    initializer 'railspacker.helper' do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.helper Railspacker::Helper
+      end
+
+      ActiveSupport.on_load :action_view do
+        include Railspacker::Helper
+      end
+    end
+  end
+end

data/lib/railspacker/version.rb

@@ -0,0 +1,3 @@
+module Railspacker
+  VERSION = '0.1.0'
+end

data/lib/railspacker.rb

@@ -0,0 +1,12 @@
+require "railspacker/railtie"
+require "railspacker/manifest/build"
+require "railspacker/manifest/dev_server"
+
+module Railspacker
+  mattr_accessor :manifest
+  mattr_accessor :before_assets_precompile_script, default: 'build'
+
+  def self.run(name)
+    system("yarn run #{name}")
+  end
+end

data/lib/tasks/railspacker_tasks.rake

@@ -0,0 +1,9 @@
+if Rake::Task.task_defined?("assets:precompile")
+  Rake::Task['assets:precompile'].enhance do
+    Railspacker.run Railspacker.before_assets_precompile_script
+  end
+else
+  Rake::Task.define_task("assets:precompile") do
+    Railspacker.run Railspacker.before_assets_precompile_script
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: railspacker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandre Magro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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:
+- alexandremagro@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/test
+- lib/generators/railspacker/install_generator.rb
+- lib/generators/templates/config/initializers/railspacker.rb
+- lib/generators/templates/package.json
+- lib/generators/templates/webpack.config.js
+- lib/railspacker.rb
+- lib/railspacker/helper.rb
+- lib/railspacker/manifest/build.rb
+- lib/railspacker/manifest/dev_server.rb
+- lib/railspacker/railtie.rb
+- lib/railspacker/version.rb
+- lib/tasks/railspacker_tasks.rake
+homepage: https://github.com/alexandremagro/railspacker
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Railspacker is an alternative to Webpacker
+test_files: []