static-rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a555d5b5ad757f03beff3a2b8e25b4abebdb3e9446d6089017c02b11450bc4a
-  data.tar.gz: 4b48dff937b530a8d407d312091b80649dbc0a4522457dc022eba8ebb8926af7
+  metadata.gz: 59b735436f8beadbe02b488f6d9ba385beb4527cc3b1da082e4e07f2a4645dc9
+  data.tar.gz: 5c40b3b20ea44e52dabef6d8660aaf59784f198759baac9e909ba9283916a9f8
 SHA512:
-  metadata.gz: c789c382631f82888708250d75cbf7a541bb344a46706699903fe267e957ced8f20b5bf4ff24e27171eaf2c6fb3d2ef82e81cb7ce0044a5fc7abb99f92b960f8
-  data.tar.gz: 41dcfb55228d18933242c3c2aef24cbbcccd6cd0508ce10a97f2c0a3849db03aa81d099efd43f571fd57bd77220aabd6fc176ab8c7188f29ad9eafcb1b6642fd
+  metadata.gz: 2d222bec9bcc9c02e3c52adadcd8426290dccbd18aaff465723ed4b152147d42c4980bf34284669cbd58ec2b9794aaf02b3e719bb1b76324ffceb24547b6afbc
+  data.tar.gz: c42139bb13e835326dd49c37f569c816689eff8a490befba9f6b37491e0113992dcaf4f5395fb24aaea20143c7abeacd5db8b0276932748ae7fc1476566263e3

data/.circleci/config.yml

@@ -8,12 +8,10 @@ jobs:
     steps:
       - checkout
 
-      - run:
-        name: Add fake blog to the host
-        command: echo 127.0.0.1 blog.localhost | sudo tee -a /etc/hosts
+      - run: echo 127.0.0.1 blog.localhost | sudo tee -a /etc/hosts
 
       # One of the apps needs hugo
-      - run: apt-get update && apt-get install -y --no-install-recommends hugo
+      - run: sudo apt-get update && sudo apt-get install -y --no-install-recommends hugo
 
       # Bundle install dependencies
       - type: cache-restore
@@ -57,7 +55,36 @@ jobs:
             - ~/.cache
           key: v2-yarn-{{ checksum "example/yarn.lock" }}
 
-      - run: bin/rake standard:fix
+      # Bundle install dependencies for jekyll app
+      - type: cache-restore
+        key: v1-jekyll-{{ checksum "example/static/docs/Gemfile.lock" }}
+
+      - run: |
+          cd example/static/docs
+          bundle install --path vendor/bundle
+
+      - type: cache-save
+        key: v1-jekyll-{{ checksum "example/static/docs/Gemfile.lock" }}
+        paths:
+          - example/static/docs/vendor/bundle
+
+      # Npm install for Eleventy app
+      - restore_cache:
+          keys:
+            - v1-eleventy-{{ checksum "example/static/blog-docs/package-lock.json" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-eleventy-
+
       - run: |
-        cd example
-        ./script/test
+          cd example/static/blog-docs
+          npm install
+
+      - save_cache:
+          paths:
+            - example/static/blog-docs/node_modules
+          key: v1-eleventy-{{ checksum "example/static/blog-docs/package-lock.json" }}
+
+      - run: bundle exec rake standard:fix
+      - run: |
+          cd example
+          ./script/test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    static-rails (0.0.1)
+    static-rails (0.0.2)
       rack-proxy (~> 0.6)
       railties (>= 5.0.0)
 

data/README.md

@@ -1,44 +1,71 @@
 # static-rails
 
-A gem to support integrating one or more static sites with your Rails
-application.
+[![CircleCI](https://circleci.com/gh/testdouble/static-rails.svg?style=svg)](https://circleci.com/gh/testdouble/static-rails)
+
+## What is this thing?
+
+**tl;dr in development, static-rails runs your static site generators &
+proxies requests; in production, it compiles and serves the final assets**
+
+Static site generators are hot right now. Maybe you're hip with "the
+[Jamstack](https://jamstack.org)", or maybe your API documentation is generated
+by [Hugo](https://gohugo.io), or maybe your marketing folks use
+[Jekyll](https://jekyllrb.com) for the company blog.
+
+Up until now, compiling static assets with any degree of sophistication beyond
+dumping them in your app's `public/` directory represented a significant
+deviation from the "Rails Way". But the alternative—keeping your static sites
+wholly separate from your Rails app—raises myriad operational challenges, from
+tracking multiple git repositories, to managing multiple server configurations,
+to figuring out a way to share common JavaScript and CSS assets between them
+all.
+
+No longer! static-rails lets you use your static asset generators of choice
+without forcing you to abandon your monolithic Rails architecture.
+
+Here's what it does:
+
+* In `development` and `test` environments, the gem will run launch each site's
+  `serve_command` and proxy to them any requests that match their configured
+  `url_subdomain` and `url_root_path` properties
+
+* When running `rake assets:precompile` (typically performed during a deploy),
+  the `compile_command` you've configured will be executed for each of your
+  sites
+
+* In `production`, the gem will host each of your sites' assets out of your
+  configured `compile_dir` using the same middleware code that Rails uses to
+  host assets out of `public/`. (Putting a performant CDN in front of everything
+  remains an exercise for the reader.)
 
 ## Install
 
-Add this to the Gemfile of your Rails app:
+Add this to your Gemfile:
 
 ```
 gem "static-rails"
 ```
 
-And run this to generate an initializer in which to configure your static sites:
+Then run this generator to create a configuration file 
+`config/initializers/static.rb`:
 
 ```
 $ rails g static_rails:initializer
 ```
 
-This will create an documented configuration file in
-`config/initializers/static.rb`
-
-Once installed, any `config.sites` you specify will be handled by static-rails
-in the following way, by default:
-
-* In `development` and `test`, static-rails will start each site's
-  `serve_command` and proxy any requests to the Rails server that match the
-  `url_subdomain` and `url_root_path` to that server
-
-* When running `rake assets:precompile` (typically performed during a deploy),
-  static-rails will run the `compile_command` for each configured site
+You can check out the configuration options in the [generated file's
+comments](/lib/generators/templates/static.rb).
 
-* In `production`, static-rails will use `Rack::Static` to map any requests to
-  the Rails server that match the site's `url_subdomain` and `url_root_path`
-  settings (note that this is the opposite default for Rails'
-  `config.public_file_server.enabled` setting, which is disabled by default)
-
-For examples on how to configure your static site, read on!
+Want an example of setting things up? You're in luck, there's an [example
+app](/example) right in this repo!
 
 ## Configuring your static site generators
 
+Assuming you won't be mounting your static site to your app's root `/` path,
+you'll probably need to configure its base URL path somehow. Here are
+some tips (and if your tool of choice isn't listed, we'd love a [pull
+request](https://github.com/testdouble/static-rails/edit/master/README.md)!):
+
 ### Using Jekyll
 
 If you have a Jekyll app that you plan on serving from a non-root path (say,
@@ -77,8 +104,8 @@ To mitigate this, there are a few things you can do:
   base path with `{{ "/" | relURL }}` (given the above `baseURL`, this will
   render `"/marketing/"`)
 
-Also, because Hugo will serve `/livereload.js` from the root, it probably won't
-work in development when running through the static-rails proxy in development.
+Also, because Hugo will serve `/livereload.js` from the root, live-reloading probably 
+won't work in development when running through the static-rails proxy.
 You might consider disabling it with `--disableLiveReload`.
 
 A static-rails config for a Hugo configuration in `sites` might look like:
@@ -125,10 +152,10 @@ A static-rails config for an Eleventy configuration in `sites` might look like:
 
 ### Using Gatsby
 
-** ⚠️ Gatsby is unlikely to work in development mode, due to [this
+<strong> ⚠️ Gatsby is unlikely to work in development mode, due to [this
 issue](https://github.com/gatsbyjs/gatsby/issues/18143), wherein all the assets
 are actually served over a socket.io WebSocket channel and not able to be
-proxied effectively. ⚠️  **
+proxied effectively. ⚠️  </strong>
 
 If you're mounting a [Gatsby](https://www.gatsbyjs.org) site to a non-root path
 (e.g. in static-rails, you've configured its `url_root_path` to, say,
@@ -160,3 +187,12 @@ A static-rails config for a Gatsby configuration in `sites` might look like:
     compile_dir: "static/docs/public"
   },
 ```
+
+## Code of Conduct
+
+This project follows Test Double's [code of
+conduct](https://testdouble.com/code-of-conduct) for all community interactions,
+including (but not limited to) one-on-one communications, public posts/comments,
+code reviews, pull requests, and GitHub issues. If violations occur, Test Double
+will take any action they deem appropriate for the infraction, up to and
+including blocking a user from the organization's repositories.

data/lib/generators/templates/static.rb

@@ -21,7 +21,8 @@ StaticRails.config do |config|
     #   # File path to the static app relative to Rails root path
     #   source_dir: "static/blog",
     #
-    #   # Constrain static app to the following subdomain (omit or leave nil if you aren't hosting the site on a subdomain)
+    #   # Constrain static app to the following subdomain (omit or leave nil
+    #   #   if you aren't hosting the site on a subdomain)
     #   url_subdomain: "blog",
     #
     #   # Mount the static site web hosting to a certain sub-path (e.g. "/docs")
@@ -30,10 +31,16 @@ StaticRails.config do |config|
     #   # Whether to run the local development/test server or not
     #   start_server: !Rails.env.production?,
     #
-    #   # If start_server is true, wait to proxy requests to the server until it can connect to server_host over TCP on server_port
+    #   # If start_server is true, wait to proxy requests to the server until it
+    #   #   can connect to server_host over TCP on server_port
     #   ping_server: true
     #
-    #   # The command to execute when running the static app in local development/test environments
+    #   # Any environment variables you need to pass to the server & compile
+    #   #   commands as a hash (e.g. `env: {"BUNDLE_PATH" => "vendor/bundle"}`)
+    #   env: {},
+    #
+    #   # The command to execute when running the static app in local
+    #   #   development/test environments
     #   server_command: "hugo server",
     #
     #   # The host the local development/test server should be reached on
@@ -42,13 +49,14 @@ StaticRails.config do |config|
     #   # The port the local development/test server should be reached on
     #   server_port: "1313",
     #
-    #   # The root path on the local development/test server to which requests should be forwarded
+    #   # The root path on the local development/test server to which requests
+    #   #   should be forwarded
     #   server_path: "/",
     #
     #   # The command to execute when building the static app for production
     #   compile_command: "hugo",
     #
-    #   # The destination of the production-compiled assets, relative to Rails root
+    #   # The destination of production-compiled assets, relative to Rails root
     #   compile_dir: "static/blog/dist"
     # },
   ]

data/lib/static-rails/compile.rb

@@ -9,7 +9,7 @@ module StaticRails
         Dir.chdir(config.app.root.join(site.source_dir)) do
           Bundler.with_unbundled_env do
             puts "=> Compiling static site \"#{site.name}\" to #{site.compile_dir}"
-            result = system site.compile_command
+            result = system(site.env, site.compile_command)
             unless result == true
               raise Error.new("Compilation of static site \"#{site.name}\" failed (in directory \"#{site.source_dir}\" with command: `#{site.compile_command}`)")
             end

data/lib/static-rails/server.rb

@@ -46,7 +46,7 @@ module StaticRails
 
       Rails.logger.info "=> Starting #{@site.name} static server"
       Bundler.with_unbundled_env do
-        Process.spawn(ENV, @site.server_command, options).tap do |pid|
+        Process.spawn(@site.env, @site.server_command, options).tap do |pid|
           Process.detach(pid)
         end
       end

data/lib/static-rails/site.rb

@@ -6,6 +6,7 @@ module StaticRails
     :source_dir,
     :start_server,
     :ping_server,
+    :env,
     :server_command,
     :server_host,
     :server_port,
@@ -19,11 +20,13 @@ module StaticRails
       url_root_path: "/",
       start_server: !Rails.env.production?,
       ping_server: true,
+      env: {},
       server_host: "localhost",
       server_path: "/",
       **other_kwargs
     )
       @start_server = start_server
+      @env = env
       @server_host = server_host
       @server_path = server_path
       @ping_server = ping_server

data/lib/static-rails/version.rb

@@ -1,3 +1,3 @@
 module StaticRails
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/static-rails/waits_for_connection.rb

@@ -8,7 +8,7 @@ module StaticRails
       loop do
         Socket.tcp(site.server_host, site.server_port, connect_timeout: 5)
         break
-      rescue Errno::ECONNREFUSED
+      rescue Errno::ECONNREFUSED, Errno::EADDRNOTAVAIL
         elapsed = Time.new - start
         if elapsed > timeout
           raise Error.new("Static site server \"#{site.name}\" failed to start within #{timeout} seconds. You can change the timeout with `StaticRails.config.ping_server_timeout = 42`")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: static-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2020-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties