startback 0.19.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c48ad9ab9ddaa6733cce35a924c08e57c68f6dae5151a9084f0cf50fe6584cf5
-  data.tar.gz: 6739fe6b17c7e044b3e714fa7abf4cf2f9df4bde01e90068a186f9e72178da03
+  metadata.gz: 85db266a4c72694e948fc85a4bd7e4923f0ecce7afeb9976a1d6033d120a8191
+  data.tar.gz: fb68dc41bc6acc1bd6dda521146d5f0f444f81c6824137d64dd1393d78db0199
 SHA512:
-  metadata.gz: db0259e7543727285bac8dc2251f3a95a5b37f48233c290dffc7c7cbe3a15d56ab4af629d91bea05482af30c5259591f5444e3541772416806cc68cf2985e061
-  data.tar.gz: bb4c89e15a9e7fdfed688f73c29f28e24a30e15f486c33f702f89cca4041b099827fc819ec428b1b3e2429584deca834b99d3fcaa99b7d79ebdd25222f0f9cf5
+  metadata.gz: a56a2fc06d115226421684fc78441ee22b111fd3fd8a2d1ab18cf5a44ab5f699df7b43e5eebb6be2ac5e968c157f4c6c20e1e74f5b44faabc7130965099c9c59
+  data.tar.gz: 0c75bea563030c189613f45d29f61fed3869777f4987f8e6bc6af1b169fbf3184e4f561d2c655d3efdadfd250cfe44d397cff03d40e8048c6f80a0d597a31d5a

data/README.md

@@ -11,3 +11,13 @@ Currently,
 1. is handled using extra support on top of Sinatra
 2. is handled using Startback specific classes
 3. is handled using Bmg
+
+## Public API
+
+This gem uses semantics versioning and has reached it's 1.0 version. The public
+API is defined as follows:
+
+* All ruby classes, require path, constructor arguments, and public methods.
+
+* The `enspirit/startback:api` and `enspirit/startback:web` docker images and
+  main `CMD`.

data/lib/startback/version.rb

@@ -1,8 +1,8 @@
 module Startback
   module Version
-    MAJOR = 0
-    MINOR = 19
-    TINY  = 4
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: startback
 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
@@ -170,20 +170,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
@@ -290,20 +290,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: tzinfo-data
   requirement: !ruby/object:Gem::Requirement
@@ -441,9 +441,6 @@ files:
 - lib/startback/web/catch_all.rb
 - lib/startback/web/cors_headers.rb
 - lib/startback/web/health_check.rb
-- lib/startback/web/magic_assets.rb
-- lib/startback/web/magic_assets/ng_html_transformer.rb
-- lib/startback/web/magic_assets/rake_tasks.rb
 - lib/startback/web/middleware.rb
 - lib/startback/web/prometheus.rb
 - lib/startback/web/shield.rb
@@ -476,15 +473,11 @@ files:
 - spec/unit/test_event.rb
 - spec/unit/test_operation.rb
 - spec/unit/test_support.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_api.rb
 - spec/unit/web/test_auto_caching.rb
 - spec/unit/web/test_catch_all.rb
 - spec/unit/web/test_cors_headers.rb
 - spec/unit/web/test_healthcheck.rb
-- spec/unit/web/test_magic_assets.rb
 - tasks/test.rake
 homepage: https://www.enspirit.be
 licenses:

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

@@ -1,80 +0,0 @@
-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

@@ -1,64 +0,0 @@
-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

@@ -1,98 +0,0 @@
-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/unit/web/fixtures/assets/app/hello.es6

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

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

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

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

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

data/spec/unit/web/test_magic_assets.rb

@@ -1,82 +0,0 @@
-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