snowpacker 0.0.4.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7421458a983b96881cc1a1e1c5897faa2dc9e45525f98fc8a7b221ac508c0f2b
+  data.tar.gz: 63825a9988c73a052c8473d3faaf5b6a5c94d1b2d2fdf93dc7aa5e930b7036f5
+SHA512:
+  metadata.gz: 31acb49ccdaa05c9fb530bc5b6146eb80fa1e9b789bcd548077e4c0ac68110dbde33cc69164a546467e57a6e08c982e6c8f70689ba16ff66ff888e10bd72b358
+  data.tar.gz: ec162ec7488a1fa0e9e2049a2901e4ddc72c7a3b25c683d3252b1401199a1042de61c39e103bb102a684c8fb4103595ff8caeb3e5d91eccad47e3f424750b656

data/.codeclimate.yml

@@ -0,0 +1,3 @@
+exclude_patterns:
+  - "examples/"
+  - "lib/snowpacker/templates/babel.config.js"

data/.dockerignore

@@ -0,0 +1,22 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+public/
+.cache/
+
+log/
+
+node_modules/
+
+.vscode/
+/tags
+.gitignore

data/.github/workflows/build.yml

@@ -0,0 +1,20 @@
+name: Run tests and linter
+
+on:
+  push:
+    branches: [ $default-branch ]
+  pull_request:
+    branches: [ $default-branch ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build the Docker image
+      run: |
+        source docker.env
+        docker-compose up --build --exit-code-from web
+    - name: Run StandardRB
+      run: docker-compose run --rm web bundle exec standardrb --format progress

data/.gitignore

@@ -0,0 +1,65 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+public/
+.cache/
+
+log/
+
+*node_modules*
+
+.vscode/
+tags
+
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+.bundle
+
+# Ignore the default SQLite database.
+examples/*/db/*.sqlite3
+examples/*/db/*.sqlite3-journal
+examples/*/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+examples/*/log/*
+examples/*/tmp/*
+!examples/*/log/.keep
+!examples/*/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+examples/*/tmp/pids/*
+!examples/*/tmp/pids/
+!examples/*/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+examples/*/storage/*
+!examples/*/storage/.keep
+
+examples/*/public/assets
+examples/*/.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+examples/*/config/master.key
+
+examples/*/public/packs
+examples/*/public/snowpacks
+examples/*/public/packs-test
+examples/*/node_modules
+examples/*/yarn-error.log
+examples/*/yarn-debug.log*
+examples/*/.yarn-integrity
+examples/*/snowpacks

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+<a name="2020-07-24"></a>
+### 2020-07-24
+
+
+#### Features
+
+* add an example of using stylesheet link tags	 ([889f241](/../../commit/889f241))
+* add a mount directory configuration	 ([c8556d7](/../../commit/c8556d7))
+* add a compile rake task	 ([607ef29](/../../commit/607ef29))
+* updating templates	 ([e126948](/../../commit/e126948))
+* rewrite snowpack.config to js format	 ([e6f89aa](/../../commit/e6f89aa))
+* allow users to define a hostname and port	 ([95ff03b](/../../commit/95ff03b))
+* add rack-proxy for proxy requests	 ([8635324](/../../commit/8635324))
+* add snowpacks to example directory	 ([bb3f1e9](/../../commit/bb3f1e9))
+* have the runner specify a node_env	 ([5f97e9a](/../../commit/5f97e9a))
+* modify generators and update readme	 ([a305177](/../../commit/a305177))
+* Add a prior-to-install directory	 ([fbca36d](/../../commit/fbca36d))
+* add docker	 ([945d27b](/../../commit/945d27b))
+
+#### Bug Fixes
+
+* gitignore to ignore node_modules	 ([e1ee78d](/../../commit/e1ee78d))
+* remove parcel-bundler, remove .travis.yml	 ([08ecb2a](/../../commit/08ecb2a))
+
+* **gitignore**
+  * ignore tags	 ([890ce35](/../../commit/890ce35))
+
+

data/Dockerfile

@@ -0,0 +1,38 @@
+FROM ruby:2.6-alpine3.11 as builder
+
+# Install system dependencies & clean them up
+RUN apk add --no-cache --virtual \
+   nodejs-dev yarn bash \
+   tzdata build-base libffi-dev \
+   curl git vim \
+   libnotify-dev
+
+FROM builder as bridgetownrb-app
+
+# This is to fix an issue on Linux with permissions issues
+ARG USER_ID=${USER_ID:-1000}
+ARG GROUP_ID=${GROUP_ID:-1000}
+ARG DOCKER_USER=${DOCKER_USER:-user}
+ARG APP_DIR=${APP_DIR:-/home/user/snowpacker}
+
+# Create a non-root user
+RUN addgroup -g $GROUP_ID -S $GROUP_ID
+RUN adduser --disabled-password -G $GROUP_ID --uid $USER_ID -S $DOCKER_USER
+
+# Create and then own the directory to fix permissions issues
+RUN mkdir -p $APP_DIR
+RUN chown -R $USER_ID:$GROUP_ID $APP_DIR
+
+# Define the user running the container
+USER $USER_ID:$GROUP_ID
+
+# . now == $APP_DIR
+WORKDIR $APP_DIR
+
+# COPY is run as a root user, not as the USER defined above, so we must chown it
+COPY --chown=$USER_ID:$GROUP_ID Gemfile* $APP_DIR/
+COPY --chown=$USER_ID:$GROUP_ID *.gemspec $APP_DIR/
+RUN gem install bundler
+RUN bundle install
+
+CMD ["bundle", "exec", "rake", "test"]

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,199 @@
+PATH
+  remote: .
+  specs:
+    snowpacker (0.0.4.alpha1)
+      rack-proxy (~> 0.6.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    conventional-changelog (1.3.0)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rack-proxy (0.6.5)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    standard (0.4.7)
+      rubocop (~> 0.85.0)
+      rubocop-performance (~> 1.6.0)
+    standardrb (1.0.0)
+      standard
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    yard (0.9.25)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2)
+  conventional-changelog (~> 1.2)
+  minitest (~> 5.14)
+  pry (~> 0.12)
+  rails (~> 6)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  snowpacker!
+  standardrb
+  yard
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michał Darda
+
+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,156 @@
+# Snowpacker
+
+## WORK IN PROGRESS
+
+Progress can be seen on the `development` branch.
+
+[![Gem Version](https://badge.fury.io/rb/snowpacker.svg)](https://badge.fury.io/rb/snowpacker)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/b88ac1a56d868d4f23d5/maintainability)](https://codeclimate.com/github/ParamagicDev/snowpacker/maintainability)
+
+This gem integrates the [snowpack](https://snowpack.dev/) JS module bundler into
+your Rails application. It is inspired by gems such as
+[breakfast](https://github.com/devlocker/breakfast) /
+[webpacker](https://github.com/rails/webpacker) started as a fork of
+[parcel-rails](https://github.com/michaldarda/parcel-rails)
+
+This is not meant to be a 1:1 replacement of Webpacker.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snowpacker'
+```
+
+Then run
+
+```bash
+bin/rails g snowpacker
+```
+
+## Usage
+
+### Tasks
+
+```bash
+rails snowpacker:dev # starts a dev server
+rails snowpacker:build # builds for production
+
+rails assets:precompile # will build snowpacker and asset pipeline
+```
+
+### Caveats
+
+Currently `snowpacker` is not integrated with `rails s` so you need a process manager like [foreman](https://github.com/ddollar/foreman) to run both `rails s` and `snowpack`.
+
+Create `Procfile.dev`, with the following content:
+
+```bash
+web: bin/rails s
+snowpacker: bin/rails snowpacker:dev
+```
+
+Then run `foreman start -f Procfile.dev`
+
+Alternatively, you can run:
+
+```
+rails server
+rails snowpacker:dev
+```
+
+in 2 different terminals.
+
+## File Structure
+
+Given the below file structure and a default configuration:
+
+```yaml
+app:
+├── javascript:
+│   ├── channels:
+│   ├── packs:
+│   └── stylesheets:
+```
+
+It will output to the following location:
+
+```yaml
+├── public:
+│   └── snowpacks:
+│       ├── channels:
+│       ├── packs:
+│       ├── __snowpack__:
+│       ├── stylesheets:
+│       └── web_modules:
+```
+
+## Including in views
+
+Use Rails generic helpers to include assets in your views
+
+```ruby
+<%= stylesheet_link_tag '/snowpacks/stylesheets/index', media: 'all',
+'data-turbolinks-track': 'reload' %>
+
+<%= javascript_include_tag '/snowpacks/packs/application',
+'data-turbolinks-track': 'reload', type: "module" %>
+```
+
+This assumes you are using the default configuration.
+
+Make sure to use `type: "module"` for all javascript scripts, otherwise,
+snowpack will not work properly.
+
+## Configuration
+
+After running generator, the configuration file can be found in
+`config/initializers/snowpacker.rb`
+
+In addition, all related `snowpack.config.js`, `babel.config.js`, and `postcss.config.js` can all be found in the
+`config/snowpacker` directory.
+
+## Production
+
+Gem hooks up to the `rails assets:precompile` and `rails
+assets:clobber`, so no special setup is required.
+
+You can start snowpacker's compilation process manually by running
+
+```bash
+rails snowpacker:compile
+
+# OR
+
+rails snowpacker:build
+```
+
+
+## Examples
+
+Examples can be found in the [/examples](/examples) directory.
+
+## Converting from Webpack to Snowpack
+
+- Snowpack (as far as I'm aware) does not support the `require.context()`
+so you will have to manually `register` your Stimulus Controllers and
+your Websocket Channels.
+
+- Any require statements should be rewritten to import statements.
+Alternatively, you could add a polyfill-plugin to snowpack to fix this
+issue as well.
+
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/ParamagicDev/snowpacker/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ParamagicDev/snowpacker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).