proscenium 0.1.0.alpha1-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e3e07ba3e379ca73169149eecf63a25c49a6a8410200bd6d552fdff4d8e58f8
+  data.tar.gz: 51abd6eecf71b9a1a1c74b6b6576765710ab6d3b273daee8e3a1f02ba9e7ecbf
+SHA512:
+  metadata.gz: c05bc284df4b0ae4a84eef3a93dfdb83dbdaed624ae699fdff54cfae02d9be1d1aeb01ed4879e5b80b83ac794968fda301e83848929cfc9bdb18c880080e41be
+  data.tar.gz: 635bb7478afa4a130266ca7e1abfed8c3faa2da07b96cdb4a28bcaab6819d53a095b468b26d4a75ec9034bcf9943692359263a8239a4a4cc7209c3aa7be7fed2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at joel@developwithstyle.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -0,0 +1,91 @@
+# Proscenium
+
+- Serve assets from anywhere within the Rails root. (eg. `/app/views/layouts/application.css`, `/lib/utils/time.js`)
+- Side loaded JS/CSS for your layouts and views.
+- JS imports
+- Dynamic imports
+- Real-time bundling of JS, JSX and CSS.
+- Import CSS and other static assets (images, fonts, etc.)
+
+## WANT
+
+- Nested CSS
+- Import CSS Modules
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'proscenium'
+```
+
+## Usage
+
+### Side Loading
+
+Proscenium has built in support for automatically side loading JS and CSS with your views and layouts.
+
+Just create a JS and/or CSS file with the same name as any view or layout, and make sure your layouts include `<%= yield :side_loaded_js %>` and `<%= yield :side_loaded_css %>`. Something like this:
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Hello World</title>
+    <%= yield :side_loaded_css %>
+  </head>
+  <body>
+    <%= yield %> <%= yield :side_loaded_js %>
+  </body>
+</html>
+```
+
+On each page request, Proscenium will check if your layout and view has a JS/CSS file of the same name, and include them into your layout HTML.
+
+### Importing in JS with `import`
+
+Imports that do not begin with a `./` or `/` are bare imports, and will import a package using your local Node resolution algorithm.
+
+`import 'react'`
+`import React as * from 'react'`
+`import { useState } from 'react'`
+
+Absolute and relative import paths are supported (`/*`, `./*`), and will behave as you would expect.
+
+Imports are assumed to be JS files, so there is no need to specify the file extesnion in such cases. But you can if you like. All other file types must be specified using their fill file name and extension.
+
+### CSS
+
+Direct access to CSS files are parsed through @parcel/css.
+
+Importing a CSS file from JS will append the CSS file to the document's head. The results of the import will be an object of CSS modules.
+
+## How It Works
+
+Proscenium provides a Rails middleware that proxies requests for your frontend code. By default, it will simply search for a file of the same name in your Rails root. For example, a request for '/app/views/layouts/application.js' or '/lib/hooks.js' will return that exact file relative to your Rails root.
+
+This allows your frontend code to become first class citizens of you Rails application.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Compile the compilers
+
+`deno compile --no-config -o bin/compilers/esbuild --import-map import_map.json -A lib/proscenium/compilers/esbuild.js`
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/proscenium. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/proscenium/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Proscenium project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joelmoss/proscenium/blob/master/CODE_OF_CONDUCT.md).

data/lib/proscenium/cli/argument_error.js

@@ -0,0 +1,24 @@
+export default class CliArgumentError extends Error {
+  static MESSAGES = {
+    cwdRequired: 'Current working directory is required as first argument.',
+    entrypointRequired: 'An entry point is required as second argument.',
+    builderRequired: 'The builder is required as third and final argument.',
+
+    cwdUnknown: ({ cwd }) => `A valid working directory is required - received ${cwd}`,
+    entrypointUnknown: ({ entrypoint }) =>
+      `A valid entrypoint is required - received ${entrypoint}`,
+    builderUnknown: ({ builder }) => `Unknown builder '${builder}'`
+  }
+
+  constructor(reason, options) {
+    let message = CliArgumentError.MESSAGES[reason]
+    if (typeof message === 'function') {
+      message = message(options)
+    }
+
+    super(message, options)
+
+    this.reason = reason
+    this.message = message
+  }
+}

data/lib/proscenium/cli/builders/index.js

@@ -0,0 +1 @@
+export const builderNames = ['javascript', 'react', 'solid']

data/lib/proscenium/cli/builders/javascript.js

@@ -0,0 +1,45 @@
+import { build, stop } from 'esbuild'
+
+import envPlugin from '../esbuild/env_plugin.js'
+import resolvePlugin from '../esbuild/resolve_plugin.js'
+
+export default async (cwd, entrypoint) => {
+  const railsEnv = Deno.env.get('RAILS_ENV')
+  const isProd = railsEnv === 'production'
+
+  let entrypointIsSourcemap = false
+  if (/\.js\.map$/.test(entrypoint)) {
+    entrypoint = entrypoint.replace(/\.map$/, '')
+    entrypointIsSourcemap = true
+  }
+
+  const params = {
+    entryPoints: [entrypoint],
+    absWorkingDir: cwd,
+    logLevel: 'error',
+    sourcemap: !entrypointIsSourcemap ? false : 'linked',
+    outdir: 'public',
+    outbase: './',
+    write: false,
+    format: 'esm',
+    minify: isProd,
+    bundle: true,
+    plugins: [envPlugin(), resolvePlugin({ debug: false })]
+  }
+
+  try {
+    const result = await build(params)
+
+    if (params.sourcemap === 'linked') {
+      if (entrypointIsSourcemap) {
+        return result.outputFiles[0].contents
+      } else {
+        return result.outputFiles[1].contents
+      }
+    } else {
+      return result.outputFiles[0].contents
+    }
+  } finally {
+    stop()
+  }
+}

data/lib/proscenium/cli/builders/react.js

@@ -0,0 +1,60 @@
+import { build, stop } from 'esbuild'
+import { join } from 'std/path/mod.ts'
+
+import envPlugin from '../esbuild/env_plugin.js'
+import resolvePlugin from '../esbuild/resolve_plugin.js'
+
+export default async (cwd, entrypoint) => {
+  const railsEnv = Deno.env.get('RAILS_ENV')
+  const isProd = railsEnv === 'production'
+
+  let entrypointIsSourcemap = false
+  if (/\.jsx\.map$/.test(entrypoint)) {
+    entrypoint = entrypoint.replace(/\.map$/, '')
+    entrypointIsSourcemap = true
+  }
+
+  const params = {
+    entryPoints: [entrypoint],
+    absWorkingDir: cwd,
+    logLevel: 'error',
+    sourcemap: !entrypointIsSourcemap ? false : 'linked',
+    outdir: 'public',
+    outbase: './',
+    write: false,
+    format: 'esm',
+    minify: isProd,
+    bundle: true,
+    // jsxFactory: 'createElement',
+    // jsxFragment: 'Fragment',
+    plugins: [envPlugin(), resolvePlugin({ debug: false })]
+  }
+
+  if (entrypoint.endsWith('.jsx')) {
+    try {
+      const stat = Deno.lstatSync(join(cwd, 'lib/react_shim.js'))
+      if (stat.isFile) {
+        params.inject = ['./lib/react_shim.js']
+      }
+    } catch {
+      // Safe to swallow as this should only throw if file does not exist.
+      // TODO: print warning to user
+    }
+  }
+
+  try {
+    const result = await build(params)
+
+    if (params.sourcemap === 'linked') {
+      if (entrypointIsSourcemap) {
+        return result.outputFiles[0].contents
+      } else {
+        return result.outputFiles[1].contents
+      }
+    } else {
+      return result.outputFiles[0].contents
+    }
+  } finally {
+    stop()
+  }
+}

data/lib/proscenium/cli/builders/solid.js

@@ -0,0 +1,46 @@
+import { build, stop } from 'esbuild'
+
+import envPlugin from '../esbuild/env_plugin.js'
+import resolvePlugin from '../esbuild/resolve_plugin.js'
+import solidjsPlugin from '../esbuild/solidjs_plugin.js'
+
+export default async (cwd, entrypoint) => {
+  const railsEnv = Deno.env.get('RAILS_ENV')
+  const isProd = railsEnv === 'production'
+
+  let entrypointIsSourcemap = false
+  if (/\.jsx\.map$/.test(entrypoint)) {
+    entrypoint = entrypoint.replace(/\.map$/, '')
+    entrypointIsSourcemap = true
+  }
+
+  const params = {
+    entryPoints: [entrypoint],
+    absWorkingDir: cwd,
+    logLevel: 'error',
+    sourcemap: !entrypointIsSourcemap ? false : 'linked',
+    outdir: 'public',
+    outbase: './',
+    write: false,
+    format: 'esm',
+    minify: isProd,
+    bundle: true,
+    plugins: [envPlugin(), resolvePlugin({ debug: false }), solidjsPlugin({ debug: false })]
+  }
+
+  try {
+    const result = await build(params)
+
+    if (params.sourcemap === 'linked') {
+      if (entrypointIsSourcemap) {
+        return result.outputFiles[0].contents
+      } else {
+        return result.outputFiles[1].contents
+      }
+    } else {
+      return result.outputFiles[0].contents
+    }
+  } finally {
+    stop()
+  }
+}

data/lib/proscenium/cli/esbuild/env_plugin.js

@@ -0,0 +1,21 @@
+import { setup } from '../utils.js'
+
+export default setup('env', () => {
+  return {
+    onResolve: {
+      filter: /^env$/,
+      callback({ path }) {
+        return { path, namespace: 'env' }
+      }
+    },
+
+    onLoad: {
+      filter: /.*/,
+      namespace: 'env',
+      callback() {
+        const env = Deno.env.toObject()
+        return { loader: 'json', contents: JSON.stringify(env) }
+      }
+    }
+  }
+})

data/lib/proscenium/cli/esbuild/resolve_plugin.js

@@ -0,0 +1,136 @@
+import { join, resolve } from 'std/path/mod.ts'
+import {
+  parseFromString as parseImportMap,
+  resolve as resolveFromImportMap
+} from 'import-maps/resolve'
+
+import { setup } from '../utils.js'
+
+const baseURL = new URL('file://')
+const importKinds = ['import-statement', 'dynamic-import', 'require-call']
+
+export default setup('resolve', build => {
+  const cwd = build.initialOptions.absWorkingDir
+  const importMap = readImportMap()
+
+  return {
+    onResolve: {
+      filter: /.*/,
+      async callback(args) {
+        // Remote modules
+        if (args.path.startsWith('http://') || args.path.startsWith('https://')) {
+          return { external: true }
+        }
+
+        // Proscenium runtime
+        if (args.path.startsWith('/proscenium-runtime')) {
+          return { external: true }
+        }
+
+        // Everything else is unbundled.
+        if (importKinds.includes(args.kind)) {
+          return await unbundleImport(args)
+        }
+      }
+    },
+
+    onLoad: {
+      filter: /.*/,
+      namespace: 'importStylesheet',
+      callback(args) {
+        const result = {
+          resolveDir: cwd,
+          loader: 'js'
+        }
+
+        if (args.path.endsWith('.module.css')) {
+          result.contents = `
+              import { importCssModule } from '/proscenium-runtime/import_css.js'
+              export default await importCssModule('${args.path}')
+            `
+        } else {
+          result.contents = `
+            import { appendStylesheet } from '/proscenium-runtime/import_css.js'
+            appendStylesheet('${args.path}')
+          `
+        }
+
+        return result
+      }
+    }
+  }
+
+  // Resolve the given `params.path` to a path relative to the Rails root.
+  //
+  // Examples:
+  //  'react' -> '/.../node_modules/react/index.js'
+  //  './my_module' -> '/.../app/my_module.js'
+  //  '/app/my_module' -> '/.../app/my_module.js'
+  async function unbundleImport(params) {
+    const result = { path: params.path }
+
+    if (importMap) {
+      const { matched, resolvedImport } = resolveFromImportMap(params.path, importMap, baseURL)
+      if (matched) {
+        if (resolvedImport.protocol === 'file:') {
+          params.path = resolvedImport.pathname
+        } else {
+          return { path: resolvedImport.href, external: true }
+        }
+      }
+    }
+
+    // Absolute path - append to current working dir.
+    if (params.path.startsWith('/')) {
+      result.path = resolve(cwd, params.path.slice(1))
+    }
+
+    // Resolve the path using esbuild's internal resolution. This allows us to import node packages
+    // and extension-less paths without custom code, as esbuild with resolve them for us.
+    const resolveResult = await build.resolve(result.path, {
+      resolveDir: params.resolveDir,
+      pluginData: {
+        // We use this property later on, as we should ignore this resolution call.
+        isResolvingPath: true
+      }
+    })
+
+    if (resolveResult.errors.length > 0) {
+      // throw `${resolveResult.errors[0].text} (resolveDir: ${cwd})`
+    }
+
+    result.path = resolveResult.path.slice(cwd.length)
+    result.sideEffects = resolveResult.sideEffects
+
+    if (
+      params.path.endsWith('.css') &&
+      params.kind === 'import-statement' &&
+      /\.jsx?$/.test(params.importer)
+    ) {
+      // We're importing a CSS file from JS(X).
+      result.namespace = 'importStylesheet'
+    } else {
+      // Requested path is a bare module.
+      result.external = true
+    }
+
+    return result
+  }
+
+  function readImportMap() {
+    const file = join(cwd, 'config', 'import_map.json')
+    let source
+
+    try {
+      source = Deno.readTextFileSync(file)
+    } catch {
+      return null
+    }
+
+    return parseImportMap(source, baseURL)
+  }
+})
+
+function isBareModule(path) {
+  return !path.startsWith('.') && !path.startsWith('/')
+}

data/lib/proscenium/cli/esbuild/solidjs_plugin.js

@@ -0,0 +1,23 @@
+import { basename } from 'std/path/mod.ts'
+import { transformAsync } from '@babel/core'
+import solid from 'babel-preset-solid'
+
+import { setup } from '../utils.js'
+
+export default setup('solidjs', () => {
+  return {
+    onLoad: {
+      filter: /\.jsx$/,
+      async callback(args) {
+        const source = await Deno.readTextFile(args.path)
+
+        const { code } = await transformAsync(source, {
+          presets: [solid],
+          filename: basename(args.path)
+        })
+
+        return { contents: code, loader: 'js' }
+      }
+    }
+  }
+})