darkroom 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 518b5ff3d82631d41125029a7292c2bfdd8942990a7e92e2be08f99217fe8d02
-  data.tar.gz: 388cf8db580df8de6d85a9d196786ef7400a97a096dfbbb316de4b0dbca8e295
+  metadata.gz: 1a77051a57dc9a5b32fe1ea1e96c831884183729058f1336139e15142d55a43f
+  data.tar.gz: 11ee7f486da94bf7c5dadf9af8e14fd9c1ab41a9620cc72c604885d9474d9150
 SHA512:
-  metadata.gz: 439b783c5d7afcb20c6a5bde715f686e42236bd70251af909938784f3c4e855f3e22b8fa779b1de19478e64e17462dc4fe37d28f043c0a62f95d13cc8e40829a
-  data.tar.gz: 3bb350472717b4a656e71ef3c7c1b8c200b88c7414c3f7feecfee46b19327e7d7bb5bb061878474d584c65afa84777cdf784fe76fd0cada86cecfbb20485fd13
+  metadata.gz: c4a4bb0e7cb9845154951aa703197be875b7777bba1f824d0bbba6ccfed609cebc9460a3c32db60ca846e819a0ac4b4a9c4024ba2b882a498108ef83230757d8
+  data.tar.gz: 83a14e41099925ae3ea44c23a18a044c1db1b1ca8fc10c15dabecf725270c32ec559165ef6e596852f5c7b22f2354ab92a0cdfadd654c1c8d22a6d9d2f5ae9f1

data/README.md

@@ -6,6 +6,23 @@ performed for upload to a CDN or proxy server in production environments); this
 simple and performant in development. Darkroom also supports asset bundling for CSS and JavaScript using
 each language's native import statement syntax.
 
+The following file types are supported out of the box, though support for others can be added (see the
+[Extending](#extending) section):
+
+| Name       | Content Type           | Exension(s) |
+| ---------- |----------------------- |-------------|
+| CSS        | text/css               | .css        |
+| JavaScript | application/javascript | .js         |
+| HTML       | text/html              | .htm, .html |
+| HTX        | application/javascript | .htx        |
+| ICO        | image/x-icon           | .ico        |
+| JPEG       | image/jpeg             | .jpg, .jpeg |
+| PNG        | image/png              | .png        |
+| SVG        | image/svg+xml          | .svg        |
+| Text       | text/plain             | .txt        |
+| WOFF       | font/woff              | .woff       |
+| WOFF2      | font/woff2             | .woff2      |
+
 ## Installation
 
 Add this line to your Gemfile:
@@ -36,7 +53,7 @@ darkroom = Darkroom.new('app/assets', 'vendor/assets', '...',
   min_process_interval: 1,             # Minimum time that must elapse between process calls
 )
 
-# Refreshe any assets that have been modified (in development, this should be called at the
+# Refresh any assets that have been modified (in development, this should be called at the
 # beginning of each web request).
 darkroom.process
 
@@ -48,7 +65,7 @@ darkroom.dump('output/dir',
 )                         # /favicon.ico or /robots.txt should be left out)
 ```
 
-Note that assets paths across all load path directories must be globally unique (e.g. the existance of both
+Note that assets paths across all load path directories must be globally unique (e.g. the existence of both
 `app/assets/app.js` and `vendor/assets/app.js` will result in an error).
 
 To work with assets:
@@ -129,6 +146,23 @@ Imports can even be cyclical. If `asset-a.css` imports `asset-b.css` and vice-ve
 contain the content of both of those assets (though order will be different as an asset's own content always
 comes after any imported assets' contents).
 
+## Extending
+
+Darkroom is extensible. Support for arbitrary file types can be added as follows (all named parameters are
+optional):
+
+```ruby
+Darkroom::Asset.add_spec('.extension1', 'extension2', '...', 'content/type',
+  dependency_regex: /import (?<path>.*)/, # Regex for identifying dependencies for bundling;
+                                          # must include `path` named capture group
+  compile_lib: 'some-compile-lib',        # Name of library required for compilation
+  compile: -> (path, content) { '...' },  # Proc that returns compiled content
+  minify_lib: 'some-minify-lib',          # Name of library required for minification
+  minify: -> (content) { '...' },         # Proc that returns minified content
+)
+
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/npickens/darkroom.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/darkroom.rb

@@ -11,13 +11,13 @@ require('darkroom/errors/processing_error')
 require('darkroom/errors/spec_not_defined_error')
 
 Darkroom::Asset.add_spec('.css', 'text/css',
-  dependency_regex: /^ *@import +(?<quote>['"]) *(?<path>.*) *\g<quote> *; *$/,
-  minify: -> (content) { CSSminify.compress(content) },
-  minify_lib: 'cssminify',
+  dependency_regex: /^ *@import +#{Darkroom::Asset::IMPORT_PATH_REGEX} *; *$/,
+  minify: -> (content) { SassC::Engine.new(content, style: :compressed).render },
+  minify_lib: 'sassc',
 )
 
 Darkroom::Asset.add_spec('.js', 'application/javascript',
-  dependency_regex: /^ *import +(?<quote>['"])(?<path>.*)\g<quote> *;? *$/,
+  dependency_regex: /^ *import +#{Darkroom::Asset::IMPORT_PATH_REGEX} *;? *$/,
   minify: -> (content) { Uglifier.compile(content, harmony: true) },
   minify_lib: 'uglifier',
 )
@@ -29,7 +29,7 @@ Darkroom::Asset.add_spec('.htx', 'application/javascript',
   minify_lib: Darkroom::Asset.spec('.js').minify_lib,
 )
 
-Darkroom::Asset.add_spec('.html', '.html', 'text/html')
+Darkroom::Asset.add_spec('.htm', '.html', 'text/html')
 Darkroom::Asset.add_spec('.ico', 'image/x-icon')
 Darkroom::Asset.add_spec('.jpg', '.jpeg', 'image/jpeg')
 Darkroom::Asset.add_spec('.png', 'image/png')

data/lib/darkroom/asset.rb

@@ -11,6 +11,13 @@ class Darkroom
     DEPENDENCY_JOINER = "\n"
     EXTENSION_REGEX = /(?=\.\w+)/.freeze
 
+    OPEN_QUOTE = '(?<quote>[\'"])'
+    BODY = '((?!\k<quote>).|(?<!\\\\)\\\\(\\\\\\\\)*\k<quote>)*'
+    BODY_END = '(?<!\\\\)(\\\\\\\\)*'
+    CLOSE_QUOTE = '\k<quote>'
+
+    IMPORT_PATH_REGEX = /#{OPEN_QUOTE}(?<path>#{BODY}#{BODY_END})#{CLOSE_QUOTE}/.freeze
+
     @@specs = {}
 
     attr_reader(:content, :error, :errors, :path, :path_unversioned, :path_versioned)

data/lib/darkroom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Darkroom
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darkroom
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nate Pickens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,8 +44,10 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 6.0.0
-description: Darkroom provides simple web asset management complete with dependency
-  bundling based on import statements, compilation, and minification.
+description: Darkroom provides web asset compilation, bundling, and minification without
+  any external tools, manifest files, or special comment syntax. CSS and JavaScript
+  bundles are automatically generated based on import statements native to each language.
+  Darkroom is also extensible, allowing support to be added for arbitrary file types.
 email:
 executables: []
 extensions: []