practical-pig 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65939a635abedfb99cbe01747fdf1c04d8ab6cb0c774b49b2749d9d35ffc763b
+  data.tar.gz: 813c4cc9234e4819e10984645e51d8b9d12f53980817376d1f325ed152b4c44f
+SHA512:
+  metadata.gz: 3c7c147073f21a667ade272446ef0c4b6dfd125072b1d4aca85240e89cbd1a55b14a48030f6ab22ccb05dea932c069a93ba9b5f334e7971c3c185636ec887d17
+  data.tar.gz: 1db1a0657bedd4ff3f0ff48ab0db7f39ef8408370ab95f3bbd5ad0d6e84ae89f454eb32c480f91b15045fa1a67396029ba6e447004d024c166b15b9e663a7a64

data/.gitignore

@@ -0,0 +1,12 @@
+/tmp/
+**/log
+**/*.log
+
+Gemfile.lock
+**/pnpm-lock.yaml
+
+**/*.gem
+gemfiles/vendor
+.bundle
+
+/test

data/.rubocop.yml

@@ -0,0 +1,24 @@
+#
+# RuboCop is a Ruby static code analyzer and code formatter that tries to enforce many of
+# the guidelines outlined in the community Ruby and Rails
+# style guides.
+#
+# https://docs.rubocop.org/en/latest/
+# https://rubystyle.guide/
+# https://rails.rubystyle.guide/
+inherit_from: rubocop-base.yaml
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+    - IgnoredMethods
+    - AllowedMethods
+
+AllCops:
+  Exclude:
+    - "test/**/*"
+
+Metrics/AbcSize:
+  IgnoredMethods:
+    - new
+    - generate

data/.travis.yml

@@ -0,0 +1,47 @@
+language: ruby
+dist: bionic
+os:
+  - linux
+  - osx
+
+cache:
+  bundler: true
+  npm: true
+  directories:
+    - "~/.pnpm-store"
+rvm:
+  - 2.4.10
+  - 2.5.5
+  - 2.6.5
+  - 2.7.0
+  - ruby-head
+gemfile:
+  - gemfiles/Gemfile-rails.5.2.x
+  - gemfiles/Gemfile-rails.6.0.x
+
+addons:
+  homebrew:
+    packages:
+    - postgresql
+
+before_install:
+  - gem install rubygems-update && update_rubygems
+  - yes | rvm @global do gem install bundler -v 2.1.4 || true
+  - nvm install --lts
+  - curl -L https://raw.githubusercontent.com/pnpm/self-installer/master/install.js | node
+  - pnpm config set store-dir ~/.pnpm-store
+  - bundle config set path 'vendor/bundle'
+install:
+  - bundle install --jobs 3 --retry 3
+  - pnpm install --frozen-lockfile
+script:
+  - bundle exec rubocop
+  - bundle exec ruby ./bin/pig new test/test_app
+
+jobs:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+  exclude:
+    - rvm: 2.4.10
+      gemfile: gemfiles/Gemfile-rails.6.0.x

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog (<https://keepachangelog.com/en/1.0.0/>). This project adheres to Semantic Versioning (<https://semver.org/spec/v2.0.0.html>).
+
+## [v1.0.0] - 2020-05-23
+
+### Added
+
+- Gem specifications and foundational files, generated by Bundler v2.1.4, for defining a Ruby gem.
+- `pig` command for invoking `PracticalPig::CLI` methods.
+- `new` CLI command for generating Practical Pig-based Rails applications, based on `rails new`.
+- Sparse application template with pre-configured gem and Webpacker environments (using `webpacker-pnpm`).
+- Exposed RuboCop config for use in dependent gems.
+- Travis config for CLI and environment testing.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+install_if -> { Gem.win_platform? } do
+  gem "tzinfo-data"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Elias Gabriel
+
+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,62 @@
+# practical-pig
+
+[![version](https://img.shields.io/gem/v/practical-pig?label=version&style=flat-square)](https://rubygems.org/gems/practical-pig)
+[![status](https://img.shields.io/travis/thearchitector/practical-pig?style=flat-square)](https://travis-ci.org/github/thearchitector/practical-pig)
+[![downloads](https://img.shields.io/gem/dt/practical-pig?style=flat-square)](https://rubygems.org/gems/practical-pig)
+[![license](https://img.shields.io/badge/license-MIT-green?style=flat-square)](./LICENSE)
+
+Practical Pig is an opinionated Ruby on Rails template that makes use of webpacker-pnpm, RuboCop, and Prettier to provide a simple yet robust foundation for any web application.
+
+## Features
+
+- Opinionated so you don't have to deal with the nitty-gritty
+- Provides production-ready application templates
+- Agnostic of underlying Rails version
+
+## Installation and Usage
+
+Assuming you have `pnpm` installed, simply download the gem to your system and then create a new repository as you would using `rails`.
+
+```sh
+$ gem install practical-pig
+$ pig new APP_PATH
+```
+
+To view the help dialog, you may run `pig help new`, which will yield the following output:
+
+```plaintext
+Usage:
+  pig new APP_PATH
+
+Options:
+  -q, [--quiet], [--no-quiet]        # Suppress status output
+      [--with-hmr], [--no-with-hmr]  # Install Webpack HMR development server
+
+Description:
+  `pig new` will generate a new Ruby on Rails application and modify it to adhere
+  to Practical Pig's application design guidelines.
+
+  The APP_PATH you provide will be used as the path of the application during
+  creation, with its name being the basename (last part of the path). In every
+  case, the new application will be generated relative to the current working
+  directory (where you execute this command).
+
+  By design, your application name must start and end with an alphanumeric
+  character.
+
+  This command makes use of `rails new` under the hood but does not accept any
+  generator options.
+```
+
+## License
+
+MIT License
+
+Copyright (c) 2020 Elias Gabriel
+
+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 conditions outlined in [LICENSE](./LICENSE).

data/bin/pig

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+git_path = File.expand_path("../.git", __dir__)
+
+if File.exist?(git_path)
+  railties_path = File.expand_path("../lib", __dir__)
+  $:.unshift(railties_path)
+end
+
+require "practical/pig/cli"
+PracticalPig::CLI.start(ARGV)

data/gemfiles/Gemfile-rails.5.2.x

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 5.2.0"
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/gemfiles/Gemfile-rails.6.0.x

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 6.0.0.rc2"
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/lib/practical/pig.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "pig/version"
+require_relative "pig/cli"

data/lib/practical/pig/cli.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "thor"
+require "rails/gem_version"
+require "active_support/core_ext/string/filters"
+require "active_support/core_ext/string/inflections"
+
+require "etc"
+require "bundler"
+
+module PracticalPig
+  class CLI < Thor
+    include Thor::Actions
+
+    NAME_PATTERN = /^[a-z].*[a-z0-9]$/i.freeze
+    private_constant :NAME_PATTERN
+
+    attr_accessor :app_name
+
+    desc "new APP_PATH", "Generates a Practical Pig Rails application template."
+    long_desc <<~HEREDOC
+      `pig new` will generate a new Ruby on Rails application and modify it
+      to adhere to Practical Pig's application design guidelines.
+
+      The APP_PATH you provide will be used as the path of the application during
+      creation, with its name being the basename (last part of the path). In every
+      case, the new application will be generated relative to the current working
+      directory (where you execute this command).
+
+      By design, your application name must start and end with an alphanumeric character.
+
+      This command makes use of `rails new` under the hood but does not accept
+      any generator options.
+    HEREDOC
+    option :quiet, type: :boolean, aliases: "-q", desc: "Suppress status output"
+    option :with_hmr, type: :boolean, desc: "Install Webpack HMR development server"
+    def new(app_path)
+      # ensure that applications are not requests for help, or that their names follow the
+      # appropriate format
+      if Thor::HELP_MAPPINGS.include?(app_path) || (flag = !app_path.match?(NAME_PATTERN))
+        if flag
+          say <<~MSG.squish
+            \e[31mBy design, your application name must start and end with an alphanumeric
+            character.\e[0m
+          MSG
+          say
+        end
+
+        help("new")
+        return
+      end
+
+      # generate a Rails application, omitting many things
+      run(
+        <<~CMD.squish
+          rails new #{app_path} -GMPCSJB --database=postgresql --skip-gemfile --skip-keeps
+          #{" --quiet" if options[:quiet]} --skip-action-mailbox --skip-system-test
+          --skip-action-text --skip-active-storage --skip-turbolinks
+        CMD
+      )
+
+      app_root = File.join(Dir.pwd, app_path)
+      @app_name = File.basename(app_root)
+
+      generate(app_root)
+    end
+
+    def self.source_root
+      File.join(__dir__, "../../template")
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    private
+
+    def generate(app_root)
+      # copy all files from PP's template app, evaluating ERBs and forcing
+      # file overwrites
+      directory(".", app_root, force: true)
+
+      inside(app_root) do
+        remove_file("app/assets/config")
+        remove_file("app/assets/stylesheets/application.css")
+        remove_file("app/views/layouts/application.html.erb")
+
+        # concurrently install all JS dependencies using pnpm
+        run("pnpm i --child-concurrency=#{Etc.nprocessors}", capture: options[:quiet])
+        run("pnpm add webpack-dev-server --save-dev") if options[:with_hmr]
+
+        # get the system-wide Bundler gem and, within the local environment (application),
+        # concurrently install all Ruby gems. we do it in a separate bundler environment
+        # because we don't want cross-talk between pig and app dependencies
+        cmd = "#{Gem.ruby} #{Gem.bin_path("bundler", "bundle")}"
+        Bundler.with_unbundled_env do
+          run("#{cmd} install --jobs=#{Etc.nprocessors}", capture: options[:quiet])
+
+          # install Webpacker's binstubs
+          run("#{cmd} exec rake webpacker:binstubs", capture: options[:quiet])
+          remove_file("bin/webpack-dev-server") unless options[:with_hmr]
+        end
+      end
+
+      print_output
+    end
+
+    def print_output
+      # say a nice thing
+      if options[:quiet]
+        say <<~MSG.squish
+          \e[90mYour Practical Pig application (#{app_name}) was generated successfully
+          (and quietly)!\e[0m 🤫
+        MSG
+      else
+        say
+        say
+        say <<~MSG.squish
+          \e[32mHooray! Your Practical Pig application (#{app_name}) was generated
+          successfully!\e[0m 🥳
+        MSG
+        # because PP copies a static package.json and pnpm, it is possible that new
+        # applications will have an outdated version in their dependency list. to
+        # help mitigate that, output a message making users aware of the possibility
+        say <<~MSG
+          \e[90m> Your application's dependencies might be out of date.\e[0m
+          \e[90m> To safely update, run `bundle update --conservative` and `pnpm up`.\e[0m
+          \e[90m> To forcefully update, run `bundle update` and `pnpm up -L`.\e[0m
+        MSG
+        say
+      end
+    end
+
+    # https://github.com/rails/rails/blob/master/railties/lib/rails/generators/app_base.rb#L300-L311
+    def rails_version_specifier(gem_version = Rails.gem_version)
+      if gem_version.segments.size == 3 || gem_version.release.segments.size == 3
+        "~> #{gem_version}"
+      else
+        patch = gem_version.segments[0, 3].join(".")
+        "~> #{patch}\", \">= #{gem_version}"
+      end
+    end
+  end
+end

data/lib/practical/pig/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PracticalPig
+  VERSION = "1.0.0"
+
+  public_constant :VERSION
+end

data/lib/template/.npmrc

@@ -0,0 +1,2 @@
+shamefully-hoist=true
+resolution-strategy=fewer-dependencies

data/lib/template/.rubocop.yml

@@ -0,0 +1,25 @@
+#
+# RuboCop is a Ruby static code analyzer and code formatter that tries to enforce many of
+# the guidelines outlined in the community Ruby and Rails
+# style guides.
+#
+# https://docs.rubocop.org/en/latest/
+# https://rubystyle.guide/
+# https://rails.rubystyle.guide/
+inherit_gem:
+  practical-pig: rubocop-base.yaml
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+    - IgnoredMethods
+    - AllowedMethods
+
+# cop-specific excludes are not inherited for some reason (likely a bug in RuboCop) so we
+# need to manually re-omit the intended files and directories.
+Layout/LineLength:
+  Exclude:
+    - "**/config/initializers/**/*"
+Style/MethodCallWithArgsParentheses:
+  Exclude:
+    - "**/Gemfile"

data/lib/template/Gemfile.tt

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby "<%= RUBY_VERSION %>"
+
+gem "bootsnap", require: false # Speeds up loading of individual source files
+gem "puma"
+gem "rails", "<%= rails_version_specifier %>"
+gem "slim-rails" # Replaces ERB templates with Slim templates
+gem "webpacker"
+gem "webpacker-pnpm" # Replaces Yarn with pnpm
+
+install_if -> { Gem.win_platform? } do
+  gem "tzinfo-data" # Ensures the use of the latest timezone data
+  gem "wdm" # Enables the use of a better Windows file update monitor
+end
+
+require "rbconfig"
+install_if -> { RbConfig::CONFIG["target_os"] =~ /bsd|dragonfly/i } do
+  gem "rb-kqueue" # Wraps BSD's notification interface to manage runtime processes
+end
+
+group :development, :test do
+  gem "dotenv-rails" # Allows loading ENV values from .env files
+  gem "practical-pig", require: false
+  gem "rubocop", "~> 0.83.0", require: false # Enables code analysis and linting
+  gem "rubocop-minitest", require: false
+  gem "rubocop-performance", require: false
+  gem "rubocop-rails", require: false
+  gem "spring" # Loads a pre-booted Rails process
+end
+
+group :development do
+  gem "annotate" # Annotates ActiveModel records with DB schemata
+  gem "listen"
+  gem "pry-rails" # Replaces IRB with pry in the rails console
+  gem "spring-watcher-listen" # Enables Spring to use Listen rather than fs polling
+end
+
+##
+## App-specific Dependencies
+## (add all your application-specific gems below)
+##
+
+# gem "devise"
+gem "pg"
+# gem "rack-cors"

data/lib/template/app/assets/packs/application.js.tt

@@ -0,0 +1,17 @@
+// This file is automatically compiled by Webpack, along with any other files
+// present in this directory. You're encouraged to place your actual application
+// logic in a relevant structure within app/javascript and only use these pack
+// files to reference that code so it'll be compiled.
+
+// import 'core-js/stable'
+// import 'regenerator-runtime/runtime'
+
+// Uncomment to copy all static images under ../images to the output folder
+// and reference them with the image_pack_tag helper in views or the
+// `imagePath` JavaScript helper below.
+//
+// const images = require.context('../images', true)
+// const imagePath = (name) => images(name, true)
+
+import "../javascript/<%= app_name %>";
+import "../stylesheets/<%= app_name %>";

data/lib/template/app/views/layouts/application.html.slim.tt

@@ -0,0 +1,12 @@
+doctype html
+html lang="en"
+  head
+    title <%= app_name.titleize %>
+    = csrf_meta_tags
+    = csp_meta_tag
+
+    = stylesheet_pack_tag 'application', media: 'all'
+    = javascript_pack_tag 'application', defer: true
+
+  body
+    = yield

data/lib/template/bin/format

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n\e[31m== Command #{args} failed ==\e[0m")
+end
+
+Dir.chdir(APP_ROOT) do
+  puts "\e[36m\n== Running RuboCop static code formatter ==\e[0m"
+  system!("bundle exec rubocop -a")
+
+  puts "\e[36m\n== Running Prettier style formatter ==\e[0m"
+  system!("pnpm run format")
+end

data/lib/template/bin/test

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n\e[31m== Command #{args} failed ==\e[0m")
+end
+
+Dir.chdir(APP_ROOT) do
+  puts "\e[36m\n== Running RuboCop static code analysis ==\e[0m"
+  system!("bundle exec rubocop -P")
+
+  puts "\e[36m\n== Running Prettier style check ==\e[0m"
+  system!("pnpm run lint")
+end

data/lib/template/config/initializers/content_security_policy.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Define an application-wide content security policy.
+#
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy.
+Rails.application.config.content_security_policy do |policy|
+  policy.default_src(:none)
+  policy.connect_src(:self, :https)
+  policy.script_src(:self, :https)
+  policy.style_src(:self, Rails.env.development? ? :unsafe_inline : :https)
+  policy.form_action(:self, :https)
+end
+
+# If you are using UJS then enable automatic nonce generation
+Rails.application.config.content_security_policy_nonce_generator = proc do
+  SecureRandom.base64(16)
+end

data/lib/template/config/initializers/generators.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Rails.application.config.generators do |g|
+  # Disable creation of default generators
+  g.stylesheets(false)
+  g.javascripts(false)
+  g.scaffold_stylesheet(false)
+
+  # Specify Slim as the templating engine
+  g.template_engine(:slim)
+end

data/lib/template/config/webpack/development.js

@@ -0,0 +1,9 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
+const environment = require('./environment')
+const webpack = require('webpack')
+
+// enable automatic prefetching to speed incremental built times
+environment.plugins.prepend('AutomaticPrefetch', new webpack.AutomaticPrefetchPlugin())
+
+module.exports = environment.toWebpackConfig()

data/lib/template/config/webpack/environment.js

@@ -0,0 +1,13 @@
+const { environment } = require('@rails/webpacker')
+const webpack = require('webpack')
+
+// ensure that we expose global variables
+// environment.plugins.prepend('Provide', new webpack.ProvidePlugin({
+// 	$: 'jquery',
+// 	jQuery: 'jquery',
+// }))
+
+// disable source map emission
+environment.config.merge({ devtool: 'none' })
+
+module.exports = environment

data/lib/template/config/webpack/production.js

@@ -0,0 +1,78 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'production'
+
+const environment = require('./environment')
+const CompressionPlugin = require('compression-webpack-plugin');
+const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin');
+const TerserPlugin = require('terser-webpack-plugin');
+
+// delete default webpacker optimization plugins since we want to
+// replace them entirely not append to them
+environment.plugins.delete('Compression')
+environment.plugins.delete('Compression Brotli')
+environment.plugins.delete('OptimizeCSSAssets')
+
+// enable asset compression using brotli
+environment.plugins.prepend('Compression', new CompressionPlugin({
+	filename: '[path].br[query]',
+  algorithm: 'brotliCompress',
+  cache: true,
+	test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/,
+	compressionOptions: { level: 11 },
+	threshold: 0,
+	minRatio: 1,
+	deleteOriginalAssets: false
+}))
+
+// enable advanced css minification
+environment.plugins.prepend('OptimizeCssAssets', new OptimizeCssAssetsPlugin({
+  cssProcessor: require('cssnano'),
+  cssProcessorPluginOptions: {
+    preset: ['advanced']
+  },
+  canPrint: false
+}))
+
+// enable js optimization and minification
+environment.config.optimization = {
+  minimize: true,
+  minimizer: [
+    new TerserPlugin({
+      parallel: true,
+      cache: true,
+      sourceMap: false,
+      terserOptions: {
+        parse: { ecma: 8 },
+        compress: {
+          ecma: 6,
+          passes: 2,
+          drop_console: true,
+          arguments: true,
+          booleans_as_integers: true,
+          keep_fargs: false,
+          // enable "unsafe" optimizations - this is really only "unsafe" is your
+          // JS is written poorly  making use of flawed logic and/or syntactical
+          // loopholes). if that's the case, its probably best that it not work
+          // anyway...
+          unsafe: true,
+          unsafe_arrows: true,
+          unsafe_comps: true,
+          unsafe_Function: true,
+          unsafe_math: true,
+          unsafe_symbols: true,
+          unsafe_methods: true,
+          unsafe_proto: true,
+          unsafe_regexp: true,
+          unsafe_undefined: true
+        },
+        output: {
+          ecma: 6,
+          comments: false,
+          ascii_only: true,
+          beautify: false
+        }
+      }
+    })
+  ]
+}
+
+module.exports = environment.toWebpackConfig()

data/lib/template/config/webpacker.yml

@@ -0,0 +1,92 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/assets
+  source_entry_path: packs
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/cache/webpacker
+  webpack_compile_output: true
+
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths: []
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  # Extract and emit a css file
+  extract_css: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+    - .eot
+    - .otf
+    - .ttf
+    - .woff
+    - .woff2
+
+  extensions:
+    - .mjs
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .svg
+    - .gif
+    - .jpeg
+    - .jpg
+
+development:
+  <<: *default
+  compile: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    # Inline should be set to true if using HMR
+    inline: true
+    overlay: true
+    compress: true
+    disable_host_check: true
+    use_local_ip: false
+    quiet: false
+    pretty: false
+    headers:
+      'Access-Control-Allow-Origin': '*'
+    watch_options:
+      ignored: '**/node_modules/**'
+
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Extract and emit a css file
+  extract_css: true
+
+  # Cache manifest.json for performance
+  cache_manifest: true

data/lib/template/package.json.tt

@@ -0,0 +1,24 @@
+{
+  "name": "<%= app_name %>",
+  "version": "0.1.0",
+  "dependencies": {
+    "@rails/webpacker": "^5.1.1",
+    "compression-webpack-plugin": "^4.0.0",
+    "cssnano": "^4.1.10",
+    "cssnano-preset-advanced": "^4.0.7",
+    "optimize-css-assets-webpack-plugin": "^5.0.3",
+    "postcss-fail-on-warn": "^0.1.0",
+    "terser-webpack-plugin": "^3.0.1",
+    "webpack": "^4.43.0"
+  },
+  "devDependencies": {
+    "prettier": "^2.0.5"
+  },
+  "browserslist": [
+    "defaults"
+  ],
+  "scripts": {
+    "lint": "prettier --check app/assets/**/*",
+    "format": "prettier --check --write app/assets/**/*"
+  }
+}

data/lib/template/postcss.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+	plugins: [
+		require('postcss-import'),
+		require('postcss-flexbugs-fixes'),
+		require('autoprefixer'),
+    require('postcss-fail-on-warn')
+	]
+}

data/practical-pig.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "practical/pig/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "practical-pig"
+  spec.version     = PracticalPig::VERSION
+  spec.author      = "Elias Gabriel"
+  spec.email       = "me@eliasfgabriel.com"
+  spec.homepage    = "https://github.com/thearchitector/practical-pig"
+  spec.license     = "MIT"
+
+  spec.summary     = <<~HEREDOC.gsub(/[[:space:]]+/, " ").strip
+    An opinionated and robust Ruby on Rails application template using RuboCop and pnpm.
+  HEREDOC
+  spec.description = <<~HEREDOC.gsub(/[[:space:]]+/, " ").strip
+    Practical Pig is an opinionated Ruby on Rails template that makes use of webpacker-pnpm, RuboCop, and Prettier to provide a simple yet robust foundation for any web application.
+  HEREDOC
+
+  spec.metadata    = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "#{spec.homepage}/tree/v#{spec.version}",
+    "changelog_uri" => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md",
+    "bug_tracker_uri" => "#{spec.homepage}/issues"
+  }
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.add_dependency "rails", ">= 5.2"
+  spec.add_dependency "thor", "~> 1.0"
+
+  spec.add_development_dependency "rubocop", "~> 0.83.0"
+  spec.add_development_dependency "rubocop-minitest", "~> 0.9"
+  spec.add_development_dependency "rubocop-performance", "~> 1.3"
+  spec.add_development_dependency "rubocop-rails", "~> 2.5"
+
+  spec.bindir      = "bin"
+  spec.executables = ["pig"]
+
+  spec.files = `git ls-files`.split("\n")
+end

data/rubocop-base.yaml

@@ -0,0 +1,206 @@
+#
+# RuboCop is a Ruby static code analyzer and code formatter that tries to enforce many of
+# the guidelines outlined in the community Ruby and Rails
+# style guides.
+#
+# https://docs.rubocop.org/en/latest/
+# https://rubystyle.guide/
+# https://rails.rubystyle.guide/
+require:
+  - rubocop-rails
+  - rubocop-performance
+  - rubocop-minitest
+AllCops:
+  Exclude:
+    - "**/node_modules/**/*"
+    - "**/db/schema.rb"
+    - "**/bin/**/*"
+    - "**/vendor/**/*"
+
+# force length length checking and auto-correction. this is here to enforce
+# standardization; however, it is good practice keep lines <= 90 columns when
+# programming so they remain readable. omit conifg initializers from line-length
+# checking as they are often auto-generated and thus result in tons of comment
+# length conflicts.
+Layout/LineLength:
+  Enabled: true
+  AutoCorrect: true
+  Max: 90
+  Exclude:
+    - "**/config/initializers/**/*"
+
+# when Layout/LineLength triggers, ensure that the output remains human-readable.
+# arguments to methods, pairs in hashes, and array elements should reside on
+# separate lines from the constructor.
+Layout/FirstArgumentIndentation:
+  Enabled: true
+  EnforcedStyle: special_for_inner_method_call
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+# case statements should be indended one level from the block to mitigate
+# confusion and make clear possible execution branches
+Layout/CaseIndentation:
+  IndentOneStep: true
+
+# consistent class structure is important when defining data models and handlers.
+# while it does not affect functionality, consistent organizational patterns make
+# understanding functions and behaviors easier across an entire application.
+#
+# https://docs.rubocop.org/en/latest/cops_layout/#layoutclassstructure
+Layout/ClassStructure:
+  Enabled: true
+
+# separating variables from their assignments when dealing with multiline expressions
+# disconnects them from their values. to prevent confusion and lack of behavioral
+# clarity, value expressions should always begin (and preferebly end) on the line
+# of assignment.
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+  EnforcedStyle: same_line
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+# this simply doesn't work in a cross-platform development environment. Bit
+# flags across UNIX and Windows platforms are volatile, and thus there is no
+# way to ensure this passes besides explicitly granting execute permissions
+# in CI config (which would defeat the purpose).
+Lint/ScriptPermission:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+# functionalization is important, but the Rails' idiom for returning key-value
+# maps can raise a false alarm with the max line number (10). increase the value
+# to something more reasonable given the circumstances.
+Metrics/MethodLength:
+  Enabled: true
+  Max: 20
+
+# omit rake tasks, Gemfiles, and gemspecs from block length checks, as they
+# can be fairly complex and are not subject to segmentation.
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - "**/*.rake"
+    - "**/*.gemspec"
+    - "**/Gemfile"
+
+# flags methods that violate the an ABC magnitude of >16. The ABC metric
+# quantizes the size of a method, and is calculated based on the number of
+# assignment operations, possible execution branches, and number of conditionals.
+#
+# https://en.wikipedia.org/wiki/ABC_Software_Metric
+Metrics/AbcSize:
+  Enabled: true
+  Max: 16
+
+# disable documentation checking. many classes do not require top-level comments,
+# and their inclusion can actually obscure their function.
+Style/Documentation:
+  Enabled: false
+
+# flag potential memory leaks, like when opening a file.
+Style/AutoResourceCleanup:
+  Enabled: true
+
+# single quotes are meant for single characters. double quotes are meant for
+# strings, which are arrays of multiple characters. there are a whole host of
+# other differences and functions; if you're creating a string, you nearly always
+# should use double quotes.
+#
+# https://en.wikipedia.org/wiki/Delimiter#Bracket_delimiters
+# Schwartz, Randal (2005). Learning Perl. ISBN 978-0-596-10105-3.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# by default Ruby makes all defined constants public, which litters the
+# public API of the class or module. Explicitly declaring a visibility makes intent
+# more clear and prevents outside actors from touching private states.
+Style/ConstantVisibility:
+  Enabled: true
+
+# the bracket idiom [:hi, :bye] is clearer when compared to the percent
+# idiom %i[hi bye] as it does not obfuscate the data structure (an array of symbols).
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# the bracket idiom ["hi", "bye"] is clearer when compared to the percent
+# idiom %w[hi bye] as it does not obfuscate the data structure (an array of strings).
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# in Ruby, methods don't have to be called with parantheses. however their omission
+# can cause confusion about which expressions are being passed to the caller,
+# especialy if that method is being called from within an array or hash. force
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  IgnoredMethods:
+    - require
+    - require_relative
+    - puts
+    - raise
+    - say
+  Exclude:
+    - "**/Gemfile"
+    - "**/*.gemspec"
+
+# method signatures should never span multiple lines as that obfuscates the data
+# on which method might depend/function.
+Style/MultilineMethodSignature:
+  Enabled: true
+
+# by definition, constants should not be mutable. ensure that the constant expression
+# is frozen so that any future modifications raise a runtime exception.
+Style/MutableConstant:
+  Enabled: true
+  EnforcedStyle: strict
+
+# parentheses should be used in situations with complex ternary assignments, as they
+# help distinguish between conditional and expression.
+Style/TernaryParentheses:
+  Enabled: true
+  EnforcedStyle: require_parentheses_when_complex
+
+# methods that manipulate and return multiple values are allowed, as it tends to
+# yield clearer and more concise code and methods.
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: practical-pig
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Elias Gabriel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.83.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.83.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: Practical Pig is an opinionated Ruby on Rails template that makes use
+  of webpacker-pnpm, RuboCop, and Prettier to provide a simple yet robust foundation
+  for any web application.
+email: me@eliasfgabriel.com
+executables:
+- pig
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- bin/pig
+- gemfiles/Gemfile-rails.5.2.x
+- gemfiles/Gemfile-rails.6.0.x
+- lib/practical/pig.rb
+- lib/practical/pig/cli.rb
+- lib/practical/pig/version.rb
+- lib/template/.npmrc
+- lib/template/.rubocop.yml
+- lib/template/Gemfile.tt
+- lib/template/app/assets/javascript/%app_name%.js
+- lib/template/app/assets/packs/application.js.tt
+- lib/template/app/assets/stylesheets/%app_name%.scss
+- lib/template/app/views/layouts/application.html.slim.tt
+- lib/template/bin/format
+- lib/template/bin/test
+- lib/template/config/initializers/content_security_policy.rb
+- lib/template/config/initializers/generators.rb
+- lib/template/config/webpack/development.js
+- lib/template/config/webpack/environment.js
+- lib/template/config/webpack/production.js
+- lib/template/config/webpacker.yml
+- lib/template/package.json.tt
+- lib/template/postcss.config.js
+- practical-pig.gemspec
+- rubocop-base.yaml
+homepage: https://github.com/thearchitector/practical-pig
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thearchitector/practical-pig
+  source_code_uri: https://github.com/thearchitector/practical-pig/tree/v1.0.0
+  changelog_uri: https://github.com/thearchitector/practical-pig/blob/v1.0.0/CHANGELOG.md
+  bug_tracker_uri: https://github.com/thearchitector/practical-pig/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: An opinionated and robust Ruby on Rails application template using RuboCop
+  and pnpm.
+test_files: []