svelte-rack 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f75e6f882ad966f7162d1ede2d54554f0b6a5b11
-  data.tar.gz: 4727209786305ec228b836ac29ee455128e43df2
+  metadata.gz: 8b117fbcf00b33dae587fac2181a2c5df32fac42
+  data.tar.gz: d22cba61869370da7124a9ef8a51fcd7e729600e
 SHA512:
-  metadata.gz: 475d21f50ae1f1cea105c0e199b149c6c33560528ba45b936951f2706dd61d1e95e8f77b2cdb12702d332aff7691418b7619798899d133ef0db2e14bafe9ee65
-  data.tar.gz: 1b615152a3937a0e6258efb23587133a8590dc5c24dcbacbf2b6c92e1cb7e98dbd6b471c79244011a5d265ef01f9ffadfcf2468ee41b1833ce8071acd316b147
+  metadata.gz: 3709f09d2684c31f543ed9186394d86305c22bb03e22ae3658483497d55797820bc08ba4075c8d35ae19ef31c3ab77033fbe4a86acd96e0ab11fcf2120d3805d
+  data.tar.gz: 31a8b04b7f2eb30dd02267791e019e0917b1b53e7d1f2c9c1a12767a0561d1902c3faae597c5242c55f5046dca99b2c4e4073e549ada066af63433e712bec974

data/README.md

@@ -3,32 +3,44 @@
 Rack middleware for compiling [Svelte components] to Javascript
 
   [Svelte components]: https://svelte.technology
+  
+[![Gem Version](https://badge.fury.io/rb/svelte-rack.svg)](https://badge.fury.io/rb/svelte-rack)
 
 
 ## Usage
 
 ```
-# Within a rackup file (or with Rack::Builder):
+# @example Within a rackup file (or with Rack::Builder)
 #   require 'rack/svelte'
 #   use Rack::Svelte,
-#     #:app_root_dir         => ::File.expand_path('..', __FILE__),
-#     :app_root_dir         => Rack::Directory.new('').root,
-#     :components_dir_in    => '/app/components',
-#     :components_dir_out   => '/public/app/js',
-#     :format               => 'iife'
+#     #app_root_dir:              Rack::Directory.new('').root,
+#     app_root_dir:               ::File.expand_path(File.dirname(__FILE__)),
+#     components_dir_in:          '/app/components',
+#     components_dir_out:         '/public/app/js',
+#     default_dir_out_overwrite:  false,
+#     default_dir_out_clear:      false,
+#     format:                     'iife'
 #   run app
 #
-# Rails example:
+# @example Rails example
 #   # above Rails::Initializer block
 #   require 'rack/svelte'
 #
 #   # inside Rails::Initializer block
 #   config.middleware.use Rack::Svelte,
-#     #:app_root_dir         => Rails.root.to_s,
-#     :components_dir_in    => '/app/components',
-#     :components_dir_out   => '/public/app/js',
-#     :format               => 'iife'
-
+#     app_root_dir:               Rails.root.to_s,
+#     components_dir_in:          '/app/components',
+#     components_dir_out:         '/public/app/js',
+#     default_dir_out_overwrite:  false,
+#     default_dir_out_clear:      false,
+#     format:                     'iife'
+#
+# Default svelte-rack options are:
+#   default_root:               '/'
+#   default_components_in:      '/app/components'
+#   default_components_out:     '/public/app/js'
+#   default_dir_out_overwrite:  false
+#   default_dir_out_clear:      false
 ```
 
 ## Installation

data/lib/rack/svelte.rb

@@ -2,35 +2,58 @@ require 'rack'
 require 'svelte'
 require 'FileUtils' unless Object.const_defined?('FileUtils')
 
-# Svelte for Rack w/ Cogs
+# Svelte for Rack w/ Cogs(tm)
 #
-# Within a rackup file (or with Rack::Builder):
+# @example Within a rackup file (or with Rack::Builder)
 #   require 'rack/svelte'
 #   use Rack::Svelte,
-#     #:app_root_dir         => ::File.expand_path('..', __FILE__),
-#     #:app_root_dir         => Rack::Directory.new('').root,
-#     :components_dir_in    => '/app/components',
-#     :components_dir_out   => '/public/app/js',
-#     :format               => 'iife'
+#     #app_root_dir:              Rack::Directory.new('').root,
+#     app_root_dir:               ::File.expand_path(File.dirname(__FILE__)),
+#     components_dir_in:          '/app/components',
+#     components_dir_out:         '/public/app/js',
+#     default_dir_out_overwrite:  false,
+#     default_dir_out_clear:      false,
+#     format:                     'iife'
 #   run app
 #
-# Rails example:
+# @example Rails example
 #   # above Rails::Initializer block
 #   require 'rack/svelte'
 #
 #   # inside Rails::Initializer block
 #   config.middleware.use Rack::Svelte,
-#     :app_root_dir         => Rails.root.to_s,
-#     :components_dir_in    => '/app/components',
-#     :components_dir_out   => '/public/app/js',
-#     :format               => 'iife'
+#     app_root_dir:               Rails.root.to_s,
+#     components_dir_in:          '/app/components',
+#     components_dir_out:         '/public/app/js',
+#     default_dir_out_overwrite:  false,
+#     default_dir_out_clear:      false,
+#     format:                     'iife'
+#
 module Rack::Svelte
   autoload :Cogs, 'rack/svelte/cogs'
 
   # Create a new Rack::Svelte middleware component that builds Svelte components
-  # using the svelte-ruby gem. The +options+ Hash can include any Svelte compiler
-  # options AND components_dir_in, components_dir_in
+  #   using the svelte-ruby gem. The +options+ Hash can include any Svelte compiler
+  #   options AND components_dir_in, components_dir_in
+  #
   # @see Svelte on Github for options: https://github.com/sveltejs/svelte#options
+  #
+  # @param  backend [#rack_object] set implicitly by Rack, use the var: `backend`
+  # @param          [Hash]    options for processing and svelte compiler
+  # @option options [String]  :app_root_dir        app's root dir (path expanded)
+  # @option options [String]  :components_dir_in   where svelte-rack look for components (path begins at app's root dir)
+  # @option options [String]  :components_dir_out  where svelte-rack writes compiled js (path begins at app's root dir)
+  # @option options [Boolean] :dir_out_overwrite   overwrite any files with matching name in the components_dir_out dir
+  # @option options [Boolean] :dir_out_clear       clear entire components_dir_out dir before writing new files 
+  # @return [void]
+  #
+  # Default svelte-rack options are:
+  #   default_root:               '/'
+  #   default_components_in:      '/app/components'
+  #   default_components_out:     '/public/app/js'
+  #   default_dir_out_overwrite:  false
+  #   default_dir_out_clear:      false
+  # 
   def self.new(backend, options = {})
     Cogs.new(backend, options)
   end

data/lib/rack/svelte/cogs.rb

@@ -12,60 +12,48 @@ module Rack::Svelte
     DEFAULT_COMPONENTS_OUT    = '/public/app/js'
     DEFAULT_DIR_OUT_OVERWRITE = false
     DEFAULT_DIR_OUT_CLEAR     = false
-
-    # svelte-ruby gem options, see https://github.com/sveltejs/svelte#options
-    attr_accessor :svelte_options
-
-    # options for Rack::Svelte processing
-    attr_accessor :app_root_dir
-    attr_accessor :components_dir_in
-    attr_accessor :components_dir_out
-    attr_accessor :dir_out_overwrite
-    attr_accessor :dir_out_clear
+    SVELTE_RACK_ATTRS         = [:app_root_dir, :components_dir_in, :components_dir_out, :dir_out_overwrite, :dir_out_clear]
 
     def initialize(app, options = {})
       @app                      = app
       symbolize_keys!(options)
-      self.app_root_dir         = options.delete(:app_root_dir)       || DEFAULT_ROOT
-      self.components_dir_in    = options.delete(:components_dir_in)  || DEFAULT_COMPONENTS_IN
-      self.components_dir_out   = options.delete(:components_dir_out) || DEFAULT_COMPONENTS_OUT
-      self.dir_out_overwrite    = options.delete(:dir_out_overwrite)  || DEFAULT_DIR_OUT_OVERWRITE
-      self.dir_out_clear        = options.delete(:dir_out_clear)      || DEFAULT_DIR_OUT_CLEAR
-      self.svelte_options       = DEFAULT_SVELTE_OPTS.merge(options)
+      @app_root_dir         = options.fetch(:app_root_dir,        DEFAULT_ROOT)
+      @components_dir_in    = options.fetch(:components_dir_in,   DEFAULT_COMPONENTS_IN)
+      @components_dir_out   = options.fetch(:components_dir_out,  DEFAULT_COMPONENTS_OUT)
+      @dir_out_overwrite    = options.fetch(:dir_out_overwrite,   DEFAULT_DIR_OUT_OVERWRITE)
+      @dir_out_clear        = options.fetch(:dir_out_clear,       DEFAULT_DIR_OUT_CLEAR)
+      @svelte_options       = DEFAULT_SVELTE_OPTS.merge(options.reject {|x| SVELTE_RACK_ATTRS.include?(x)})
     end
 
-    # method required by Rack interface
     def call(env)
-      call! env
-    end
-
-    # thread safe version using shallow copy of env
-    def call!(env)
-      dir_in  = File.join(self.app_root_dir, self.components_dir_in)
-      dir_out = File.join(self.app_root_dir, self.components_dir_out)
+      dir_in  = File.join(@app_root_dir, @components_dir_in)
+      dir_out = File.join(@app_root_dir, @components_dir_out)
 
       raise "ERROR: Dir In cannot be found: #{dir_in}" unless Dir.exist? dir_in
       raise "ERROR: Dir Out cannot be found: #{dir_out}" unless Dir.exist? dir_out
 
-      FileUtils.rm File.join(dir_out, '*') if self.dir_out_clear
+      FileUtils.rm File.join(dir_out, '*') if @dir_out_clear
 
       Dir.glob(File.join(dir_in, '**/*')).each do |filename_in|
         # only html components
         next unless filename_in =~ /.\.html$/i
 
         # create output filename
-        fn_in           = filename_in[dir_in.length..-1]  # remove input dir
-        fn_out_basename = File.basename(fn_in).split('.')[0] + '.js'
-        fn_out_dir      = File.dirname(fn_in)
-        fn_out          = File.join(dir_out, fn_out_dir, fn_out_basename) # Kenny Powers
+        fn_in               = filename_in[dir_in.length..-1]  # remove input dir
+        fn_out_basename     = File.basename(fn_in, '.html')
+        fn_out_basename_js  = File.basename(fn_in, '.html') + '.js'
+        fn_out_dir          = File.dirname(fn_in)
+        fn_out              = File.join(dir_out, fn_out_dir, fn_out_basename + '.js') # Kenny Powers
 
         # ensure output dir
         FileUtils.mkdir_p(fn_out_dir) unless Dir.exist?(fn_out_dir)
 
         # compile
-        sv_hash = ::Svelte.exec_method('svelte.compile', filename_in, *self.svelte_options)
+        comp_opts = @svelte_options.dup
+        comp_opts.merge!(name: fn_out_basename) unless comp_opts.key?(:name)
+        sv_hash = ::Svelte.exec_method('svelte.compile', filename_in, nil, comp_opts)
 
-        unless self.dir_out_overwrite
+        unless @dir_out_overwrite
           raise "Error: file exists: #{fn_out}\n  use option: 'dir_out_overwrite: true'" if File.exist?(fn_out)
         end
 
@@ -73,10 +61,7 @@ module Rack::Svelte
         IO.write(fn_out, sv_hash['code'])
       end
 
-      ##
-      # TODO: research thread safety (the following is adopted)
-      @env = env.dup
-      @app.call(@env)
+      @app.call(env)
     end
 
     private

data/lib/rack/svelte/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Svelte
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/test/files/hello_world_output.txt

@@ -27,7 +27,7 @@ function renderMainFragment ( root, component ) {
 	};
 }
 
-function SvelteComponent ( options ) {
+function hello_world ( options ) {
 	options = options || {};
 	this._state = options.data || {};
 	
@@ -47,14 +47,14 @@ function SvelteComponent ( options ) {
 	if ( options.target ) this._fragment.mount( options.target, null );
 }
 
-SvelteComponent.prototype.get = get;
-SvelteComponent.prototype.fire = fire;
-SvelteComponent.prototype.observe = observe;
-SvelteComponent.prototype.on = on;
-SvelteComponent.prototype.set = set;
-SvelteComponent.prototype._flush = _flush;
+hello_world.prototype.get = get;
+hello_world.prototype.fire = fire;
+hello_world.prototype.observe = observe;
+hello_world.prototype.on = on;
+hello_world.prototype.set = set;
+hello_world.prototype._flush = _flush;
 
-SvelteComponent.prototype._set = function _set ( newState ) {
+hello_world.prototype._set = function _set ( newState ) {
 	var oldState = this._state;
 	this._state = Object.assign( {}, oldState, newState );
 	
@@ -63,7 +63,7 @@ SvelteComponent.prototype._set = function _set ( newState ) {
 	dispatchObservers( this, this._observers.post, newState, oldState );
 };
 
-SvelteComponent.prototype.teardown = SvelteComponent.prototype.destroy = function destroy ( detach ) {
+hello_world.prototype.teardown = hello_world.prototype.destroy = function destroy ( detach ) {
 	this.fire( 'destroy' );
 
 	this._fragment.teardown( detach !== false );
@@ -176,4 +176,4 @@ function _flush() {
 	}
 }
 
-export default SvelteComponent;
+export default hello_world;

data/test/files/hello_world_output_iife.txt

@@ -1,4 +1,4 @@
-var SvelteComponent = (function () { 'use strict';
+var hello_world = (function () { 'use strict';
 
 function renderMainFragment ( root, component ) {
 	var h1 = createElement( 'h1' );
@@ -29,7 +29,7 @@ function renderMainFragment ( root, component ) {
 	};
 }
 
-function SvelteComponent ( options ) {
+function hello_world ( options ) {
 	options = options || {};
 	this._state = options.data || {};
 	
@@ -49,14 +49,14 @@ function SvelteComponent ( options ) {
 	if ( options.target ) this._fragment.mount( options.target, null );
 }
 
-SvelteComponent.prototype.get = get;
-SvelteComponent.prototype.fire = fire;
-SvelteComponent.prototype.observe = observe;
-SvelteComponent.prototype.on = on;
-SvelteComponent.prototype.set = set;
-SvelteComponent.prototype._flush = _flush;
+hello_world.prototype.get = get;
+hello_world.prototype.fire = fire;
+hello_world.prototype.observe = observe;
+hello_world.prototype.on = on;
+hello_world.prototype.set = set;
+hello_world.prototype._flush = _flush;
 
-SvelteComponent.prototype._set = function _set ( newState ) {
+hello_world.prototype._set = function _set ( newState ) {
 	var oldState = this._state;
 	this._state = Object.assign( {}, oldState, newState );
 	
@@ -65,7 +65,7 @@ SvelteComponent.prototype._set = function _set ( newState ) {
 	dispatchObservers( this, this._observers.post, newState, oldState );
 };
 
-SvelteComponent.prototype.teardown = SvelteComponent.prototype.destroy = function destroy ( detach ) {
+hello_world.prototype.teardown = hello_world.prototype.destroy = function destroy ( detach ) {
 	this.fire( 'destroy' );
 
 	this._fragment.teardown( detach !== false );
@@ -178,6 +178,6 @@ function _flush() {
 	}
 }
 
-return SvelteComponent;
+return hello_world;
 
-}());
+}());

data/test/rack_svelte_test.rb

@@ -34,6 +34,18 @@ describe "Rack::Svelte" do
       act = IO.read(@hello_world_test_js)
       assert_equal exp, act
     end
+
+    it "should compile with iife" do
+      assert File.exist?(@hello_world_test_html)
+      refute File.exist?(@hello_world_test_js)
+
+      get_response('/', '<!--BODY-->', 'text/html', @options.merge(format: 'iife'))
+      assert File.exist? @hello_world_test_js
+
+      exp = @hello_world_output_iife
+      act = IO.read(@hello_world_test_js)
+      assert_equal exp, act
+    end
   end
 
   after do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svelte-rack
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - So Awesome Man