roda-sprockets 1.1.0 → 2.0.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c5624471b78bed45e3ad30586950ddd71710008d5f2b7831d418d08eea65390
-  data.tar.gz: d231ec5e75c74f884cfef8cb37f565480b982bb6a3cd7249269b4e2a81618425
+  metadata.gz: 508fedb44f1daee79f32b2ef1746fb5a266aa771465dc44b42a9d2de03787d6a
+  data.tar.gz: 15678eedb2c7d2aa7d5e8c1136dd2b16c77d4336514e689875488a7ec593e934
 SHA512:
-  metadata.gz: 49f8d649e83eca62de5464f7be4ce388284204fb9a1664ed44efdb9e91f7b97185cfc590369e0cc9e8aaa3a7056bc6c0439754303511f206e0db75821ab95d66
-  data.tar.gz: 4fd782e737b76b53aa090c6d5ade85028d83c662a420ed201f4ab0a81bed75ac64186af9f7ce62af9ea0d92cdb8f6454fee4cde25cce5b167646be54f3a3e936
+  metadata.gz: eac697f7e01b05019e19a48704088910ceb1451ad2d6e40dccfc3ee8d8c67ef3b301d61876ca6089b4ce8454f19a1b02afbe3065abd812fdd804017188ddd838
+  data.tar.gz: c25b68ac51d50b091f398a5d98780f15987c20643535e289ed034d60929229ca0af556545dd6268981c83921dd763080c1a572306e5ef009161c37c20b57716c

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+v2.0.0
+
+- :debug argument now defaults to true, if RACK_ENV is development, false
+  otherwise - also false in rake tasks (#10)
+- add sprockets_env class method, so you can shorten code like
+  `App.sprockets_options[:sprockets]` to just `App.sprockets_env` (#11)
+
 v1.1.0
 
 - Fix the Rack::Lint issue (#1)

data/README.md

@@ -23,12 +23,11 @@ And then execute:
 class App < Roda
    plugin :sprockets, precompile: %w(site.js site.css),
                       opal: true,
-                      debug: true
    plugin :public
 
    route do |r|
      r.public
-     r.sprockets
+     r.sprockets if ENV['RACK_ENV'] == 'development'
    end
 end
 ```
@@ -53,11 +52,13 @@ end
   plugin takes files + `path_prefix`)
 * `path_prefix` - a Roda prefix of your assets directory. By default: `/assets`
 * `protocol` - either :http (default) or :https.
-* `css_compressor`, `js_compressor` - pick a compressor of your choice.
+* `css_compressor`, `js_compressor` - pick a compressor of your choice (respected
+  only if `debug` is false)
 * `host` - for hosting your assets on a different server
 * `digest` (bool) - digest your assets for unique filenames, default: true
 * `opal` (bool) - Opal support, default: false
-* `debug` (bool) - debug mode, default: false
+* `debug` (bool) - debug mode, default: true if RACK_ENV is development,
+  false otherwise (in rake tasks it's false too)
 * `cache` - a `Sprockets::Cache` instance, default: nil (no cache)
 
 ### Templates:
@@ -142,6 +143,27 @@ Roda::RodaPlugins::Sprockets::Task.define!(App)
 
 And launch: `rake assets:precompile` or `rake assets:clean`
 
+### Sprockets extended configuration:
+
+You can configure your environment directly by accessing a method `sprockets_env`
+(which is a `Sprockets::Environment`) on your `App` class.
+
+For instance, to enable Brotli with [sprockets-exporters_pack](https://github.com/hansottowirtz/sprockets-exporters_pack)
+you will need to either add this code inside your `App` class:
+
+```ruby
+sprockets_env.register_exporter %w(text/css application/javascript image/svg+xml), Sprockets::ExportersPack::BrotliExporter
+```
+
+Or at some other point:
+
+```ruby
+App.sprockets_env.register_exporter %w(text/css application/javascript image/svg+xml), Sprockets::ExportersPack::BrotliExporter
+```
+
+Do note, that some extensions, like for example [opal-optimizer](https://github.com/hmdne/opal-optimizer)
+won't need any configuration at all beside `require "opal/optimizer/sprockets"`.
+
 ## Contributing
 
 1. Fork it ( https://github.com/hmdne/roda-sprockets/fork )

data/examples/opal-doc/app.rb

@@ -3,13 +3,12 @@ require 'roda'
 class App < Roda
    plugin :sprockets, precompile: %w(application.js),
                       prefix: %w(app/),
-                      opal: true,
-                      debug: ENV['RACK_ENV'] != 'production'
+                      opal: true
    plugin :public
 
    route do |r|
      r.public
-     r.sprockets if ENV['RACK_ENV'] != 'production'
+     r.sprockets if ENV['RACK_ENV'] == 'development'
 
      r.root do
        <<~END

data/examples/opal-exception/Gemfile

@@ -1,7 +1,8 @@
 source "https://rubygems.org"
 
 gem "roda-sprockets", path: "../.."
-gem "opal", github: "opal/opal"
+gem "opal"
 gem "opal-sprockets"
 gem "puma"
 gem "rake"
+gem "uglifier"

data/examples/opal-exception/app.rb

@@ -3,13 +3,13 @@ require 'roda'
 class App < Roda
    plugin :sprockets, precompile: %w(application.js),
                       prefix: %w(app/),
-                      opal: true,
-                      debug: ENV['RACK_ENV'] != 'production'
+                      js_compressor: :uglify,
+                      opal: true
    plugin :public
 
    route do |r|
      r.public
-     r.sprockets if ENV['RACK_ENV'] != 'production'
+     r.sprockets if ENV['RACK_ENV'] == 'development'
 
      r.root do
        <<~END

data/examples/sass/app.rb

@@ -1,13 +1,12 @@
 require 'roda'
 
 class App < Roda
-   plugin :sprockets, precompile: %w(application.css),
-                      debug: ENV['RACK_ENV'] != 'production'
+   plugin :sprockets, precompile: %w(application.css)
    plugin :public
 
    route do |r|
      r.public
-     r.sprockets if ENV['RACK_ENV'] != 'production'
+     r.sprockets if ENV['RACK_ENV'] == 'development'
 
      r.root do
        <<~END

data/lib/roda/plugins/sprockets.rb

@@ -18,7 +18,7 @@ class Roda
         host:           nil,
         digest:         true,
         opal:           false,
-        debug:          false,
+        debug:          nil,
         cache:          nil,
       }.freeze
 
@@ -35,6 +35,14 @@ class Roda
           options[:root] = app.opts[:root] || Dir.pwd
         end
 
+        if options[:debug].nil?
+          if ENV['RACK_ENV'] == 'development'
+            options[:debug] = true
+          else
+            options[:debug] = false
+          end
+        end
+
         # opal-sprockets registers engines when required, but if we create Sprockets::Environment before
         # requiring that, they don't get registered
         require 'opal/sprockets' if options[:opal]
@@ -81,7 +89,7 @@ class Roda
 
         unless options[:debug]
           options[:sprockets].css_compressor = options[:css_compressor] unless options[:css_compressor].nil?
-          options[:sprockets].js_compressor  = options[:js_compressor] unless options[:js_compressor].nil?
+          options[:sprockets].js_compressor  = options[:js_compressor] unless options[:js_compressor].nil?  
 
           options[:sprockets_helpers].manifest   = ::Sprockets::Manifest.new(options[:sprockets], options[:public_path])
           options[:sprockets_helpers].protocol   = options[:protocol]
@@ -94,6 +102,10 @@ class Roda
           opts[:sprockets]
         end
 
+        def sprockets_env
+          sprockets_options[:sprockets]
+        end
+
         def sprockets_regexp
           %r{#{sprockets_options[:sprockets_helpers].prefix[1..-1]}/(.*)}
         end

data/lib/roda/plugins/sprockets_task.rb

@@ -26,11 +26,7 @@ class Roda
         end
 
         def sprockets_options
-          @opts ||= begin
-            opts = @app_klass.sprockets_options.dup
-            opts[:debug] = false
-            opts
-          end
+          @app_klass.sprockets_options
         end
 
         def define

data/roda-sprockets.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "roda-sprockets"
-  spec.version       = '1.1.0'
+  spec.version       = '2.0.0rc1'
   spec.authors       = ["cj", "hmdne"]
   spec.email         = ["cjlazell@gmail.com"]
   spec.summary       = %q{Use sprockets to serve assets in roda.}

data/spec/examples_spec.rb

@@ -38,9 +38,18 @@ RSpec.describe "Example" do
       when "opal-exception"
         error.should_not be_nil
         functions = error.stack_trace["callFrames"].map { |i| i["functionName"] }
-        functions.should include "$$a"
-        functions.should include "$$b"
-        functions.should include "$$c"
+        if debug
+          functions.should include "$$a"
+          functions.should include "$$b"
+          functions.should include "$$c"
+        else
+          # We minify this example, so functions should be mangled
+          functions.should_not include "$$a"
+          functions.should_not include "$$b"
+          functions.should_not include "$$c"
+        end
+        # Nevertheless, "Opal.modules.application" should stay unmangled.
+        functions.should include "Opal.modules.application"
         # How can we now test that source maps work? The browser doesn't help us...
       when "sass"
         browser.evaluate("window.getComputedStyle(document.body).backgroundColor").should be == "rgb(0, 128, 0)"
@@ -75,7 +84,7 @@ RSpec.describe "Example" do
               rescue Ferrum::JavaScriptError => e
                 instance_exec(browser, true, e, &example_specific)
               ensure
-                browser.quit
+                browser.quit if browser
               end
             ensure
               sigterm(pid)
@@ -87,8 +96,6 @@ RSpec.describe "Example" do
       it "works in production mode" do
         Dir.chdir example do
           Bundler.with_unbundled_env do
-            ENV['RACK_ENV'] = 'production'
-
             if ENV.key? 'CI'
               system("bundle config --local path #{__dir__+"/../vendor/bundle"}")
             end
@@ -100,6 +107,8 @@ RSpec.describe "Example" do
             system("bundle exec rake assets:precompile").should be true
             Dir.children(example + "/public/assets").length.should be == 3
 
+            ENV['RACK_ENV'] = 'production'
+
             begin
               port = free_port
               pid = spawn("bundle exec rackup -p#{port}")
@@ -112,9 +121,9 @@ RSpec.describe "Example" do
 
                 instance_exec(browser, false, nil, &example_specific)
               rescue Ferrum::JavaScriptError => e
-                instance_exec(browser, true, e, &example_specific)
+                instance_exec(browser, false, e, &example_specific)
               ensure
-                browser.quit
+                browser.quit if browser
               end
             ensure
               system("bundle exec rake assets:clean").should be true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roda-sprockets
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0rc1
 platform: ruby
 authors:
 - cj
@@ -144,9 +144,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.22
 signing_key: