startback-web 0.19.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a3f5b453cd2fba385b573997a7ffbbc176fee1c9d5e7d41ec94c7f94cef46e7
-  data.tar.gz: 28ed0bb7dac353782cfe9c5bd9730b82d8a0acd64caefb58824e84acca96290b
+  metadata.gz: 9865e5f094493dfbbd8a6c4c15e03a17c71ffaa9280367389db9afba31eb6255
+  data.tar.gz: 2d4ae874f78dd724f7566dde79dd8b6562a7b4978d84f9a57fa5d26cb4ad7789
 SHA512:
-  metadata.gz: b336df5e884f52e88885bdda039872e218d278c6fe73b5b05233365ba17938e94dd390b16a2cba8c8d27c7567dcf518a5e9f5b52bdb151b21f181161f67eb1d5
-  data.tar.gz: dfb7d19b289d01a68ae26590a92427650569e0dc79dc727957e8bf1a95e6409c958daf2609140cece7554ab789d27acb5d3f4dffda5b2d2123e7df3369f3cabd
+  metadata.gz: 51e3d15af5479b12dc9bea38aaa399744ac2c6fa5ce33b0bfdfc74d4650abe602dbe9e52fb2f225cc89afc5bf047196a3d8a5a84fc5d0673c350659ef2e0e7e8
+  data.tar.gz: 73f8cdfc98570ce81091079435479bf0be9616196a73cf98359d99e963d890567380266191a154a164efece2434482df65f15d112ddc81ac8da65a7f5aa9f05f

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+gemspec
+
+gem 'startback', path: '../..'

data/Rakefile

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+def shell(*cmds)
+  cmd = cmds.join("\n")
+  puts cmd
+  system cmd
+end
+
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+Dir["tasks/*.rake"].each do |taskfile|
+  load taskfile
+end
+
+task :default => :test

data/lib/startback/web/magic_assets/ng_html_transformer.rb

@@ -0,0 +1,80 @@
+module Startback
+  module Web
+    class MagicAssets
+      #
+      # Plugin for MagicAssets that compiles .html angular templates in the
+      # assets structure to javascript files filling angular's template cache.
+      #
+      # Heavily inspired, yet over-simplified version, of angular-rails-templates
+      # See https://github.com/pitr/angular-rails-templates, licensed under MIT
+      #
+      # Example:
+      #
+      #   use Startback::Web::MagicAssets, {
+      #     plugins: [Startback::Web::MagicAssets::NgHtmlTransfomer.new]
+      #   }
+      #
+      class NgHtmlTransformer
+
+        DEFAULT_OPTIONS = {
+          :path       => '/assets',
+          :ng_module  => 'templates',
+          :mime_type  => 'text/ng-html',
+          :extensions => [".html"]
+        }
+
+        def initialize(options = {})
+          @options = DEFAULT_OPTIONS.merge(options)
+        end
+        attr_reader :options
+
+        def install(sprockets)
+          sprockets.register_mime_type options[:mime_type], extensions: options[:extensions]
+          sprockets.register_transformer options[:mime_type], 'application/javascript', self
+        end
+
+TPL = <<-EOF
+angular.module("<%= ng_module %>").run(["$templateCache", function($templateCache) {
+  $templateCache.put("<%= angular_template_name %>", <%= html %>)
+}]);
+EOF
+
+        # inspired by Rails' action_view/helpers/javascript_helper.rb
+        JS_ESCAPE_MAP = {
+          '\\'    => '\\\\',
+          "\r\n"  => '\n',
+          "\n"    => '\n',
+          "\r"    => '\n',
+          '"'     => '\\"',
+          "'"     => "\\'"
+        }
+
+        # We want to deliver the shortist valid javascript escaped string
+        # Count the number of " vs '
+        # If more ', escape "
+        # If more ", escape '
+        # If equal, prefer to escape "
+
+        def escape_javascript(raw)
+          if raw
+            quote = raw.count(%{'}) >= raw.count(%{"}) ? %{"} : %{'}
+            escaped = raw.gsub(/(\\|\r\n|[\n\r#{quote}])/u) {|match| JS_ESCAPE_MAP[match] }
+            "#{quote}#{escaped}#{quote}"
+          else
+            '""'
+          end
+        end
+
+        def call(input)
+          file_path = input[:filename]
+          angular_template_name = "#{options[:path]}/#{input[:name]}.html"
+          source_file = file_path
+          ng_module = options[:ng_module]
+          html = escape_javascript(input[:data].chomp)
+          ERB.new(TPL).result(binding)
+        end
+
+      end # class NgHtmlTransformer
+    end # class MagicAssets
+  end # module Web
+end # module Startback

data/lib/startback/web/magic_assets/rake_tasks.rb

@@ -0,0 +1,64 @@
+module Startback
+  module Web
+    class MagicAssets
+      class RakeTasks
+
+        DEFAULT_OPTIONS = {
+          :namespace => :assets
+        }
+
+        def initialize(rake, options)
+          @rake = rake
+          @options = DEFAULT_OPTIONS.merge(options)
+          install
+        end
+        attr_reader :rake, :options
+
+      private
+
+        def install
+          require 'securerandom'
+
+          ns = options[:namespace]
+          target_folder = options[:target]
+          assets = options[:assets]
+          assets = MagicAssets.new(assets) if assets.is_a?(Hash)
+          version = SecureRandom.urlsafe_base64
+
+          rake.instance_exec do
+            namespace(ns) do
+
+              desc 'Cleans generated assets'
+              task :clean do
+                FileUtils.rm_rf target_folder
+              end
+
+              task :prepare do
+                FileUtils.mkdir_p target_folder
+                (target_folder/"VERSION").write(version)
+              end
+
+              desc 'compile javascript assets'
+              task :compile_js do
+                assets['vendor.js'].write_to(target_folder/"vendor-#{version}.min.js")
+                assets['app.js'].write_to(target_folder/"app-#{version}.min.js")
+                puts "successfully compiled js assets"
+              end
+
+              desc 'compile css assets'
+              task :compile_css do
+                assets['vendor.css'].write_to(target_folder/"vendor-#{version}.min.css")
+                assets['app.css'].write_to(target_folder/"app-#{version}.min.css")
+                puts "successfully compiled css assets"
+              end
+
+              desc 'compile assets'
+              task :compile => [:clean, :prepare, :compile_js, :compile_css]
+            end
+          end
+        end
+
+      end
+    end # class MagicAssets
+  end # module Web
+end # module Startback

data/lib/startback/web/magic_assets.rb

@@ -0,0 +1,98 @@
+require 'sprockets'
+module Startback
+  module Web
+    #
+    # Rack application & middleware that can be used to simplify javascript
+    # and css assets management, using Sprockets.
+    #
+    # Example:
+    #
+    #     # Used as rack app, typically under a path
+    #     Rack::Builder.new do
+    #       map '/assets' do
+    #         run Startback::Web::MagicAssets.new({
+    #           folder: "/path/to/assets/src"
+    #         })
+    #       end
+    #       run MyApp
+    #     end
+    #
+    #     # Used as a rack middleware, e.g. in a Sinatra application
+    #     use Startback::Web::MagicAssets, {
+    #       folder: "/path/to/assets/src",
+    #       path: "/assets"
+    #     }
+    #
+    # Sprocket configuration can be done through the `:sprocket` option:
+    #
+    #     use Startback::Web::MagicAssets, {
+    #       sprockets: {
+    #         :css_compressor => :scss
+    #       }
+    #     }
+    #
+    class MagicAssets
+
+      DEFAULT_OPTIONS = {
+        sprockets: {},
+        plugins: {}
+      }
+
+      def initialize(app, options = {})
+        app, options = nil, app if app.is_a?(Hash)
+        @app = app
+        @options = DEFAULT_OPTIONS.merge(options)
+        @sprockets = build_sprockets
+      end
+      attr_reader :sprockets
+
+      def call(env)
+        if new_env = is_match?(env)
+          @sprockets.call(new_env)
+        else
+          @app.call(env)
+        end
+      end
+
+      def [](*args, &bl)
+        @sprockets.[](*args, &bl)
+      end
+
+    private
+
+      def path
+        @options[:path]
+      end
+
+      def is_match?(env)
+        if @app.nil?
+          # Not used as a middleware, use this env and match
+          env
+        elsif env['PATH_INFO'].start_with?(path)
+          # Used as a middleware, and PATH_INFO starts with the
+          # assets path => strip it for sprockets
+          env.merge("PATH_INFO" => env["PATH_INFO"].sub(path, ""))
+        else
+          # No match, let @app execute with the untouched environment
+          nil
+        end
+      end
+
+      def build_sprockets
+        Sprockets::Environment.new.tap{|s|
+          Array(@options[:folder]).each do |folder|
+            s.append_path(folder)
+          end
+          @options[:sprockets].each_pair do |k,v|
+            s.public_send(:"#{k}=", v)
+          end
+          @options[:plugins].each do |p|
+            p.install(s)
+          end
+        }
+      end
+
+    end # class MagicAssets
+  end # module Web
+end # module Startback
+require_relative 'magic_assets/rake_tasks'

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'startback'
+require 'startback/web/magic_assets'
+require 'rack/test'
+
+module SpecHelpers
+end

data/spec/unit/web/fixtures/assets/app/hello.es6

@@ -0,0 +1,4 @@
+let test = (x) => {
+  console.log("Hello " + x)
+}
+test("world")

data/spec/unit/web/fixtures/assets/app/hello.html

@@ -0,0 +1 @@
+<p>Hello {{who}}</p>

data/spec/unit/web/fixtures/assets/index.es6

@@ -0,0 +1 @@
+//= require_tree ./app

data/spec/unit/web/test_magic_assets.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+require 'startback/web/magic_assets'
+require 'startback/web/magic_assets/ng_html_transformer'
+
+module Startback
+  module Web
+    describe MagicAssets do
+      include Rack::Test::Methods
+
+      context 'when used as an app' do
+        let(:app){
+          MagicAssets.new({
+            folder: Path.dir/"fixtures/assets"
+          })
+        }
+
+        it 'works as expected' do
+          get "/index.js"
+          expect(last_response.status).to eql(200)
+          expect(last_response.body).to match(/function test/)
+        end
+
+        it 'delegates a [] call to sprockets' do
+          result = app['index.js']
+          expect(result.to_s).to match(/function test/)
+        end
+
+        it 'returns a 404 on unknown' do
+          get '/nosuchone.js'
+          expect(last_response.status).to eql(404)
+        end
+      end
+
+      context 'when used as a middleware' do
+        let(:app){
+          Rack::Builder.new do
+            use MagicAssets, {
+              folder: Path.dir/"fixtures/assets",
+              path: "/my-assets"
+            }
+            run ->(t){
+              [200, {}, ["Hello world"]]
+            }
+          end
+        }
+
+        it 'lets unrelated things pass' do
+          get "/hello"
+          expect(last_response.status).to eql(200)
+          expect(last_response.body).to eql("Hello world")
+        end
+
+        it 'serves the assets under the chosen path' do
+          get "/my-assets/index.js"
+          expect(last_response.status).to eql(200)
+          expect(last_response.body).to match(/function test/)
+        end
+      end
+
+      context 'when registering the NgHtmlTransformer' do
+        let(:app){
+          plugin = MagicAssets::NgHtmlTransformer.new({
+            ng_module: "test.templates"
+          })
+          MagicAssets.new({
+            folder: Path.dir/"fixtures/assets",
+            plugins: [plugin]
+          })
+        }
+
+        it 'works as expected' do
+          get "/index.js"
+          expect(last_response.status).to eql(200)
+          expect(last_response.body).to match(/function test/)
+          expect(last_response.body).to match(/Hello \{\{who\}\}/)
+          expect(last_response.body).to match(/angular.module\("test.templates"\)/)
+        end
+      end
+
+    end
+  end
+end

data/tasks/test.rake

@@ -0,0 +1,13 @@
+require 'rspec/core/rake_task'
+
+namespace :test do
+
+  desc "Run RSpec unit tests"
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = "spec/unit/**/test_*.rb"
+    t.rspec_opts = %{-Ilib -Ispec --color --backtrace --format progress --format RspecJunitFormatter --out spec/rspec-unit.xml}
+  end
+
+  task :all => [:unit]
+end
+task :test => :'test:all'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: startback-web
 version: !ruby/object:Gem::Version
-  version: 0.19.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -36,40 +36,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: webspicy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.26.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.25'
+        version: '0.27'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.26.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.25'
+        version: '0.27'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,20 +84,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: startback
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
@@ -192,12 +206,23 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Web variant of startback
+description: Startback for website
 email: blambeau@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Gemfile
+- Rakefile
+- lib/startback/web/magic_assets.rb
+- lib/startback/web/magic_assets/ng_html_transformer.rb
+- lib/startback/web/magic_assets/rake_tasks.rb
+- spec/spec_helper.rb
+- spec/unit/web/fixtures/assets/app/hello.es6
+- spec/unit/web/fixtures/assets/app/hello.html
+- spec/unit/web/fixtures/assets/index.es6
+- spec/unit/web/test_magic_assets.rb
+- tasks/test.rake
 homepage: https://www.enspirit.be
 licenses:
 - MIT
@@ -220,5 +245,5 @@ requirements: []
 rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
-summary: Got Your Ruby Back
+summary: Startback for website
 test_files: []