parceler 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e700061babf3bf7e9cba67f790aeb10bac52207bf3f3287eabe6cbed05654125
+  data.tar.gz: ef8a0f5c4060d2b7058931afa7fa2d5bf85e886ce4b308baac0f422c07967112
+SHA512:
+  metadata.gz: 596cca5043df26bf6850deaa0d8756a7008d3d8d080a2fd5011eb467698a665047545ab221e08f89a907824e6d8baaee33945cc42dd9e41f4fd2ad34622315a9
+  data.tar.gz: cad3edcdc595c5525a0b1b44fcf6734729403165405e7e97cc59838b47f74e32c890f73e013c1306540930991156f7e749c1cd264e8d041dd234502a9ac079cf

data/.gitignore

@@ -0,0 +1,2 @@
+/node_modules
+*.gem

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Elias Gabriel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,59 @@
+# Parceler
+[![version](https://img.shields.io/gem/v/parceler.svg?label=version&style=flat-square)
+![downloads](https://img.shields.io/gem/dt/parceler.svg?style=flat-square)](https://rubygems.org/gems/parceler)
+[![license](https://img.shields.io/github/license/thearchitectoR/parceler.svg?style=flat-square)](/LICENSE)
+
+Parceler attempts to be an alternative asset compiler and manager for [Ruby on Rails](https://rubyonrails.org/). It provides functionality similar to Rails' own [Webpacker gem](https://github.com/rails/webpacker) but is powered by [Parcel](https://parceljs.org/) instead of [Webpack](https://webpack.js.org/). As a result and at the cost of some more advanced features, it requires significantly less out-of-the-box configuration. While meant for Rails, nothing inhibits using this gem outside of a Rails context.
+
+## Installation
+You can install this gem by adding it to your application's `Gemfile` via:
+
+```ruby
+  gem 'parceler', group: :development
+```
+
+This gem also requires a Node.js environment set up with Yarn. You can install Node.js at https://nodejs.org/en/download/ and Yarn at https://yarnpkg.com/en/docs/install.
+
+To install the required Node packages, run the rake task `parceler:install`:
+
+```sh
+  $ bundle exec rake parceler:install
+```
+
+### Configuration
+Before this gem can bundle your app's assets, it must be configured. To do so, you must run `Parceler.configure` with a provided configuration block _before_ starting your app's server. The default configuration block that is packaged with this gem looks something like this:
+
+```rb
+# Configuration options defined here have direct relations to those defined in the official documentation.
+# https://parceljs.org/cli.html
+Parceler.configure do |c|
+    c.entry_point = "app/javascript/application.js"
+    c.destination = "public/parcels"
+    c.cache = nil
+    c.source_maps = false
+    c.autoresolve = false
+
+    # The following options only have an effect in production builds. You can parcel
+    # your assets for production with rake tasks `parceler:build` or `assets:precompile`.
+    c.minify = true
+    c.content_hashing = true
+    c.tree_shaking = false
+end
+```
+
+If you do not want to customize your app, you may simply copy this block and everythig should work fine. _However_, it is very likely that you will need to customize it to your particular needs.
+
+#### Configuration on Rails
+While the above steps are not explicitly required, it is _highly_ recommended that you create a config file so you can customize this gem to align with your own app. You can generate the default configuration initializer by running
+
+```sh
+  $ rails g parceler
+```
+
+, which will place a new file at `config/initializers/parceler.rb`.
+
+## Origin Story
+I built this gem while working on the MAIS™ business managment and information system developed by [sdbase](sdbase.com). At the time of development, we were looking at upgrading the entire stack from EOLed versions of Ruby and Rails. Throughout the process, I realized that the new asset management system (`webpacker`) was overly complicated for many of our applications. As a result, it provided a reasonably steep learning curve to many of the burgeoning developers with which we were working. To mitigate those problems and to simplify the engineering learning process, I built Parceler to require very little out-of-the-box configuration while maintaining very transparent functionality.
+
+## License
+This gem is released and published under the [3-Clause BSD License](https://opensource.org/licenses/BSD-3-Clause) by Elias Gabriel (@thearchitector).

data/lib/generators/parceler_generator.rb

@@ -0,0 +1,7 @@
+class ParcelerGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_initializer_file
+        copy_file "config.rb", "config/initializers/parceler.rb"
+    end
+end

data/lib/generators/templates/config.rb

@@ -0,0 +1,14 @@
+# Configuration options defined here have direct relations to those defined in the official documentation.
+# https://parceljs.org/cli.html
+Parceler.configure do |c|
+    c.entry_point = "app/javascript/application.js"
+    c.destination = "public/parcels"
+    c.cache = nil
+    c.source_maps = false
+    c.autoresolve = false
+
+    # The following options only have an effect in production builds. You can parcel
+    # your assets for production with rake tasks `parceler:build` or `assets:precompile`.
+    c.minify = true
+    c.content_hashing = true
+end

data/lib/parceler/engine.rb

@@ -0,0 +1,20 @@
+module Parceler
+    class Engine
+        def initialize(config)
+            @args = [config.entry_point, "--out-dir", config.destination]
+            @args.append("--cache-dir") if config.cache.present?
+            @args.append("--no-source-maps") if !config.source_maps
+            @args.append("--no-content-hash") if !config.content_hashing
+            @args.append("--no-autoinstall") if !config.autoresolve
+            @args.append("--no-minify") if !config.minify
+        end
+
+        def getcmd(cmd = '')
+            return "yarn run parcel #{cmd} #{@args.join(' ')}"
+        end
+
+        def execute(cmd = '')
+            exec(self.getcmd(cmd))
+        end
+    end
+end

data/lib/parceler/railtie.rb

@@ -0,0 +1,41 @@
+require 'posix/spawn'
+
+module Parceler
+	class Railtie < ::Rails::Railtie
+		railtie_name :parceler
+
+		rake_tasks do
+			load 'parceler/tasks.rake'
+		end
+
+		# Parcel's HMR server should only be used in development mode, so we restrict it
+		if Rails.env.development? && defined?(Rails::Server)
+			initializer "parceler.start_hmr" do |app|
+				app.config.after_initialize do
+					puts "\033[36m~~~ Launching a Parcel server for hot compliation ~~~\033[0m"
+
+					if Parceler.engine.nil?
+						Parceler.configure do |c|
+							puts "\033[31m -> No configuration found. Falling back to defaults...\033[0m"
+						end
+					end
+
+					pid = POSIX::Spawn::spawn(Parceler.engine.getcmd(:watch))
+
+					# Wait for the parent (Rails server) to die, and then kill the child process
+					#
+					# NOTE: We cannot use Signal.trap here because it does not automatically respect
+					# previously defined handlers, and thus Rails does not pass the event onto Parceler.
+					at_exit do
+						puts "\033[1m~~~ Gracefully stopping the Parcel watch server ~~~\033[0m"
+						Process.kill("SIGKILL", pid)
+						Process.waitpid(pid)
+						puts "=== parceler shutdown: #{Time.now.strftime("%Y-%m-%d %H:%M:%S %z")} ==="
+						puts "\033[36mAu revoir!\033[0m"
+						exit
+					end
+				end
+			end
+		end
+	end
+end

data/lib/parceler/tasks.rake

@@ -0,0 +1,24 @@
+namespace :parceler do
+    desc 'Installs the Parcel dependency with Yarn'
+    task install: :environment do
+        exec("yarn add parcel-bundler --dev")
+    end
+
+    desc 'Launches a Parcel process for proactive compilation'
+    task watch: :environment do
+        Parceler.engine.execute(:watch)
+    end
+
+    desc 'Builds a production-ready asset package using Parcel'
+    task build: :environment do
+        Parceler.engine.execute(:build)
+    end
+end
+
+Rake::Task['assets:precompile'].enhance do
+    Rake::Task['parceler:compile'].invoke
+end
+
+Rake::Task['assets:clobber'].enhance do
+    Rake::Task['parceler:clobber'].invoke
+end

data/lib/parceler.rb

@@ -0,0 +1,32 @@
+require "parceler/engine"
+require "parceler/railtie" if defined?(Rails)
+
+module Parceler
+	class Error < StandardError; end
+	class << self
+		attr_accessor :configuration
+		attr_accessor :engine
+	end
+
+	def self.configure
+		self.configuration ||= Configuration.new
+		yield(configuration)
+		self.engine = Parceler::Engine.new(self.configuration)
+	end
+
+	# Configuration options defined here have direct relations to those defined in the official documentation
+	# https://parceljs.org/cli.html
+	class Configuration
+		attr_accessor :entry_point, :destination, :cache, :source_maps, :minify, :content_hashing, :autoresolve
+
+		def initialize
+			@entry_point = "app/javascript/application.js"
+			@destination = "public/parcels"
+			@cache = nil
+			@source_maps = false
+			@minify = true
+			@content_hashing = true
+			@autoresolve = false
+		end
+	end
+end

data/package.json

@@ -0,0 +1,9 @@
+{
+  "private": true,
+  "name": "parceler",
+  "version": "1.0.3",
+  "description": "A Parcel-based asset manager",
+  "devDependencies": {
+    "parcel-bundler": "^1.12.3"
+  }
+}

data/parceler.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+	spec.name          = "parceler"
+	spec.version       = "1.0.3"
+	spec.platform      = Gem::Platform::RUBY
+	spec.author        = "Elias Gabriel"
+	spec.email         = "me@eliasfgabriel.com"
+	spec.summary       = "A Parcel-based asset manager"
+	spec.description   = "An alternative Parcel-powered asset manager and compiler, meant for Rails but built for Ruby."
+	spec.homepage      = "https://github.com/thearchitector/parceler"
+	spec.license       = "BSD-3-Clause"
+
+	spec.metadata["allowed_push_host"] = "https://rubygems.org"
+	spec.metadata["homepage_uri"] = spec.metadata["source_code_uri"] = spec.homepage
+	spec.extra_rdoc_files = ["README.md"]
+
+	spec.requirements = ["Node.js", "Yarn"]
+
+	spec.require_paths = ["lib"]
+	spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+		`git ls-files -z`.split("\x0")
+	end
+
+	spec.required_ruby_version = '>= 1.9'
+
+	spec.add_runtime_dependency "posix-spawn", '~> 0.3'
+	spec.add_development_dependency "bundler", '~> 2.0'
+	spec.add_development_dependency "rake", '~> 10.0'
+end