quince 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b96b6d822903711930bf3baf921a25c7132761cbc339ff290ee1923aba16f4a6
-  data.tar.gz: 9ea1dd9174b8e4f7aa100a83fb29aef865b4426d0889cc41e31b1d13c83cacd6
+  metadata.gz: f42655bc57603a51bd5231388dc7be387a51a8e912549f6a504fbaeb0e1dbb3e
+  data.tar.gz: ed87a57062ce7343b08409fd8126034a7dbf46e094b1741829fc63fdb9ab1f7d
 SHA512:
-  metadata.gz: 59599fdd6fb5b40d606bcc2f70d636f0f214f10e14c424cd95d3b7c1dddef4341368d8569fff5ad5d5ebc77fcd0b865e274229d66b19665bb48ec54c62fca5f7
-  data.tar.gz: b6ecdd02de862f7659ac94a3c588687fd2b265e7ceb2ed3cae8893587e5d4e37454a7d9015398baf1e67c82cde6141ec32383093a7799db466c438b3bd52e241
+  metadata.gz: 7c5358907ee716710a7c0f53c277ede1301ee16c31ab2304a63d33cdd91dff9f80a282f2832637d7b5ad14d4103d65a5f9ce16c4ed02cda14f9a148145263ee5
+  data.tar.gz: 0dc9bad86700382b48810bf70a2c0b0258c7e3383a4b73a37ea84fc46bf8ca174f2e20404c5070723512ffd2c1f0b1a61447bd9ce3da9eec6275e2dc8a003309

data/Gemfile.lock

@@ -1,15 +1,26 @@
 PATH
   remote: .
   specs:
-    quince (0.5.1)
+    quince (0.6.0)
       oj (~> 3.13)
+      rack-contrib (~> 2.3)
+      sinatra (~> 2.1)
+      sinatra-contrib (~> 2.1)
       typed_struct (>= 0.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.4.4)
+    multi_json (1.15.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     oj (3.13.9)
+    rack (2.2.3)
+    rack-contrib (2.3.0)
+      rack (~> 2.0)
+    rack-protection (2.1.0)
+      rack
     rake (13.0.6)
     rbs (1.6.2)
     rspec (3.10.0)
@@ -25,6 +36,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    sinatra-contrib (2.1.0)
+      multi_json
+      mustermann (~> 1.0)
+      rack-protection (= 2.1.0)
+      sinatra (= 2.1.0)
+      tilt (~> 2.0)
+    tilt (2.0.10)
     typed_struct (0.1.4)
       rbs (~> 1.0)
 

data/README.md

@@ -10,7 +10,8 @@ React, Turbo, Hotwire amongst others
 
 ### Current status
 
-Proof of concept, but [working in production](https://quince-rb.herokuapp.com/), and with decent performance despite few optimisations at this stage
+Early, but [working in production](https://quince-rb.herokuapp.com/). Expect more features and
+optimisations to come, but also potential for big changes between versions in the early stages.
 
 ### How it works
 
@@ -22,7 +23,7 @@ Proof of concept, but [working in production](https://quince-rb.herokuapp.com/),
 
 ```ruby
 # app.rb
-require "quince_sinatra"
+require "quince"
 
 class App < Quince::Component
     def render
@@ -46,7 +47,7 @@ ruby app.rb
 ## More complex example
 
 ```ruby
-require 'quince_sinatra'
+require 'quince'
 
 class App < Quince::Component
     def render
@@ -114,49 +115,23 @@ expose App, at: "/"
 
 ### Why?
 
-- Lightweight 🪶
-    - Very few dependencies
-    - Just a couple hundred lines of core logic
-    - Fewer than 30 lines (unminified) of JavaScript in the front end
-- Plug and play into multiple back ends 🔌
 - Components > templates 🧩
-    - Write html-like elements, but with strong typo resistence
-    - no special syntax or compilation required
+- Lightweight 🪶
 - Shallow learning curve if you are already familiar with React 📈
-- Just worry about your core business logic and how the app looks 🧪
-    - No need to worry about
-        - routes
-        - controllers
-        - front end -> back end communication/APIs/Data transfer
-        - front end -> back end code sharing
-    - Quince handles these for you
-- No node_modules 📦
-    - No yarn/npm
-    - Minimise bundle size concerns
-    - Manage your dependencies just using bundler & rubygems
-    - Make use of other pre-built Quince components via rubygems
+- Focus on your core business logic, not routes/APIs/data transfer/code sharing 🧪
+- No compilation/node_modules/yarn/js bundle size concerns - just bundler 📦
 - Get full use of Ruby's rich and comprehensive standard library 💎
 - Take advantage of Ruby's ability to wrap native libraries (eg. gems using C) ⚡️
-- Fully server-rendered responses 📡
-    - Single source of truth for your app's code (no code-sharing needed)
-    - Better SEO out the box
-    - Know exactly what your user is seeing
-        - Tracking a user's activity on the front end has become a big deal, especially in heavily front-end driven apps/SPAs, in order to be able to see how a user is actually using the app (ie. to track how the state has been changing on the front end)
-        - This normally requires cookies and a premium third party service
-        - But if everything a user sees is generated server-side, it would be easy to reconstruct a user's journey and their state changes
+- Fully server-rendered responses - single source of truth 📡
+- Easy to recreate/rehydrate a pages state (almost nothing is stored in memory from JavaScript - all
+  the state is stored with the HTML document's markup)
 
 ## Installation
 
-Quince itself is framework agnostic, so you should use an adaptor which plugs it into an existing framework for handling basic server needs
-
-### Install it via adapters
-
-- [Sinatra](https://github.com/johansenja/quince_sinatra)
-
-Pick one, and add it to your application's Gemfile, eg:
+Add this to your application's Gemfile:
 
 ```ruby
-gem 'quince_sinatra'
+gem 'quince'
 ```
 
 And then execute:
@@ -165,7 +140,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install quince_sinatra
+    $ gem install quince
 
 
 ## Usage notes

data/lib/quince/attributes_by_element.rb

@@ -16,7 +16,7 @@ module Quince
 
     ATTRIBUTES_BY_ELEMENT = {
       "A" => {
-        # download: t::Any,
+        download: opt_string_sym,
         href: opt_string_sym,
         hreflang: opt_string_sym,
         media: opt_string_sym,
@@ -337,7 +337,7 @@ module Quince
       "Area" => {
         alt: opt_string_sym,
         coords: opt_string_sym,
-        # download: t::Any,
+        download: opt_string_sym,
         href: opt_string_sym,
         hreflang: opt_string_sym,
         media: opt_string_sym,

data/lib/quince/callback.rb

@@ -12,6 +12,7 @@ module Quince
         rerender: nil,
         push_params_state: nil,
         handle_errors: true,
+        download: false,
       }.freeze
 
       def callback(method_name, **opts)
@@ -29,7 +30,7 @@ module Quince
       attr_reader(
         :receiver,
         :method_name,
-        *ComponentHelpers::DEFAULT_CALLBACK_OPTIONS.keys,
+              *ComponentHelpers::DEFAULT_CALLBACK_OPTIONS.keys,
       )
     end
 

data/lib/quince/component.rb

@@ -1,3 +1,4 @@
+require "forwardable"
 require_relative "callback"
 
 module Quince
@@ -24,18 +25,20 @@ module Quince
         @exposed_actions ||= Set.new
         @exposed_actions.add action
         route = "/api/#{self.name}/#{action}"
-        Quince.middleware.create_route_handler(
+        Quince::SinatraApp.create_route_handler(
           verb: method,
           route: route,
-        ) do |params|
+        ) do |bind|
+          Thread.current[:request_binding] = bind
+          params = bind.receiver.params
+          Thread.current[:params] = params[:params] || {}
           instance = Quince::Serialiser.deserialise(CGI.unescapeHTML(params[:component]))
-          Quince::Component.class_variable_set :@@params, params[:params]
-          render_with = if params[:rerender]
-              instance.instance_variable_set :@state_container, params[:stateContainer]
-              params[:rerender][:method].to_sym
-            else
-              :render
-            end
+          if params[:rerender]
+            instance.instance_variable_set :@state_container, params[:stateContainer]
+            render_with = params[:rerender][:method].to_sym
+          else
+            render_with = :render
+          end
           instance.instance_variable_set :@render_with, render_with
           instance.instance_variable_set :@callback_event, params[:event]
           if @exposed_actions.member? action
@@ -73,11 +76,9 @@ module Quince
       end
     end
 
+    extend Forwardable
     include Callback::ComponentHelpers
 
-    # set default
-    @@params = {}
-
     attr_reader :props, :state, :children
 
     def render
@@ -91,9 +92,15 @@ module Quince
     end
 
     def params
-      @@params
+      Thread.current[:params]
     end
 
+    def request_context
+      Thread.current[:request_binding].receiver
+    end
+
+    def_delegators :request_context, :attachment, :request, :response, :redirect, :halt
+
     private
 
     attr_reader :__id

data/lib/quince/sinatra.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+ENV["RACK_ENV"] ||= "development"
+
+require "sinatra/base"
+require "sinatra/reloader" if ENV["RACK_ENV"] == "development"
+require "rack/contrib"
+
+module Quince
+  class SinatraApp < Sinatra::Base
+    configure :development do
+      if Object.const_defined? "Sinatra::Reloader"
+        register Sinatra::Reloader
+        dont_reload __FILE__
+        also_reload $0
+      end
+    end
+    use Rack::JSONBodyParser
+    use Rack::Deflater
+    set :public_folder, File.join(File.dirname(File.expand_path($0)), "public")
+
+    class << self
+      def create_route_handler(verb:, route:, &blck)
+        meth = case verb
+          when :POST, :post
+            :post
+          when :GET, :get
+            :get
+          else
+            raise "invalid verb"
+          end
+
+        public_send meth, route do
+          Quince.to_html(blck.call(binding))
+        ensure
+          Thread.current[:request_binding] = nil
+          Thread.current[:params] = nil
+        end
+      end
+    end
+  end
+end
+
+def expose(component, at:)
+  Quince::SinatraApp.get(at) do
+    Thread.current[:request_binding] = binding
+    Thread.current[:params] = binding.receiver.params
+    comp = component.instance_of?(Class) ? component.create : component
+    comp.instance_variable_set :@render_with, :render
+    Quince.to_html(comp)
+  ensure
+    Thread.current[:request_binding] = nil
+    Thread.current[:params] = nil
+  end
+end
+
+at_exit do
+  if $!.nil? || ($!.is_a?(SystemExit) && $!.success?)
+    if Object.const_defined? "Sinatra::Reloader"
+      app_dir = Pathname(File.expand_path($0)).dirname.to_s
+      $LOADED_FEATURES.each do |f|
+        next unless f.start_with? app_dir
+
+        Quince::SinatraApp.also_reload f
+      end
+    end
+
+    Quince::SinatraApp.run!
+  end
+end

data/lib/quince/singleton_methods.rb

@@ -1,28 +1,5 @@
 module Quince
   class << self
-    attr_reader :middleware
-    attr_accessor :underlying_app
-
-    def optional_string
-      @optional_string ||= Rbs("String?")
-    end
-
-    def middleware=(middleware)
-      @middleware = middleware
-      Object.define_method(:expose) do |component, at:|
-        Quince.middleware.create_route_handler(
-          verb: :GET,
-          route: at,
-        ) do |params|
-          component = component.create if component.instance_of? Class
-          Quince::Component.class_variable_set :@@params, params
-          component.instance_variable_set :@render_with, :render
-          component
-        end
-      end
-      Object.send :private, :expose
-    end
-
     def define_constructor(const, constructor_name = nil)
       if const.name
         parts = const.name.split("::")

data/lib/quince/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Quince
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/lib/quince.rb

@@ -5,3 +5,4 @@ require_relative "quince/singleton_methods"
 require_relative "quince/component"
 require_relative "quince/html_tag_components"
 require_relative "quince/version"
+require_relative "quince/sinatra"

data/quince.gemspec

@@ -29,6 +29,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
+  spec.add_dependency "sinatra", "~> 2.1"
+  spec.add_dependency "sinatra-contrib", "~> 2.1"
+  spec.add_dependency "rack-contrib", "~> 2.3"
   spec.add_dependency "typed_struct", ">= 0.1.4"
   spec.add_dependency "oj", "~> 3.13"
 

data/scripts.js

@@ -11,7 +11,12 @@ const Q = {
       }
     ).then(resp => {
       if (resp.status <= 299) {
-        return resp.text()
+        const cd = resp.headers.get("Content-Disposition");
+        if (cd && cd.trim().startsWith("attachment")) {
+         return resp.blob(); 
+        } else {
+          return resp.text();
+        }
       } else if (resp.status >= 500) {
         throw Q.em["500"];
       } else {
@@ -21,45 +26,46 @@ const Q = {
         
         throw msg;
       }
-    }).then(html => {
-      const element = document.querySelector(selector);
-      if (!element) {
-        throw `element not found for ${selector}`;
-      }
-
-      switch (mode) {
-        case "append_diff":
-          const tmpElem = document.createElement(element.nodeName);
-          tmpElem.innerHTML = html;
-          const newNodes = Array.from(tmpElem.childNodes);
-          const script = newNodes.pop();
-          const existingChildren = element.childNodes;
-          // This comparison doesn't currently work because of each node's unique id (data-quid).
-          // maybe it would be possible to use regex replace to on the raw html, but it could also
-          // be overkill
-          // let c = 0;
-          // for (; c < existingChildren.length; c++) {
-          //   if (existingChildren[c].isEqualNode(newNodes[c]))
-          //     continue;
-          //   else
-          //     break;
-          // }
-          // for the time being, we can just assume that we can just take the extra items
-          let c = existingChildren.length;
-          for (const node of newNodes.slice(c)) {
-            element.appendChild(node);
+    }).then(data => {
+      switch (true) {
+        case data instanceof Blob:
+          const url = URL.createObjectURL(data);
+          const a = document.createElement('a');
+          a.href = url;
+          a.download = "download";
+          document.body.appendChild(a);
+          a.click();
+          a.remove();
+          break;
+        default: // html
+          const element = document.querySelector(selector);
+          if (!element) {
+            throw `element not found for ${selector}`;
           }
 
-          const newScript = document.createElement("script");
-          newScript.dataset.quid = script.dataset.quid;
-          newScript.innerHTML = script.innerHTML;
-          document.head.appendChild(newScript);
-          break;
-        case "replace": 
-          element.outerHTML = html;
-          break;
-        default:
-          throw `mode ${mode} is not valid`;
+          switch (mode) {
+            case "append_diff":
+              const tmpElem = document.createElement(element.nodeName);
+              tmpElem.innerHTML = data;
+              const newNodes = Array.from(tmpElem.childNodes);
+              const script = newNodes.pop();
+              const existingChildren = element.childNodes;
+              let c = existingChildren.length;
+              for (const node of newNodes.slice(c)) {
+                element.appendChild(node);
+              }
+
+              const newScript = document.createElement("script");
+              newScript.dataset.quid = script.dataset.quid;
+              newScript.innerHTML = script.innerHTML;
+              document.head.appendChild(newScript);
+              break;
+            case "replace": 
+              element.outerHTML = data;
+              break;
+            default:
+              throw `mode ${mode} is not valid`;
+          }
       }
     }).catch(err => {
       if (!handleErrors) throw err;

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: quince
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Joseph Johansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: typed_struct
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +104,7 @@ files:
 - lib/quince/component.rb
 - lib/quince/html_tag_components.rb
 - lib/quince/serialiser.rb
+- lib/quince/sinatra.rb
 - lib/quince/singleton_methods.rb
 - lib/quince/types.rb
 - lib/quince/version.rb