porous 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87cf02a737a26d181f89e3ee42f73574a30473e490b4ce045d76960e3dbc6fa5
-  data.tar.gz: 679a28921b7fc66630d2ec21b75543cd7dc4906d3f77230a052ff9fb08ab1281
+  metadata.gz: 87c6a954ddaf691739b880123048bf3345ece37389404d7a1c7163b27119c0ac
+  data.tar.gz: d13c2be795c751e8eb6095e0642560065e4815ff04ac17ffd7605e1092d775ba
 SHA512:
-  metadata.gz: 7e25b7156a1e9d10c8d66ea198be3ddb3da0a87aa904519b6fbe0c71006e13d33f5840c051114c7a8e8506ce73f033492fb1bc4089506534759b8bc1a86d18e6
-  data.tar.gz: 8da9145c152a0d93d0a2d182f3ade0da334dc9bb898a75483675173f341a3ea42e5fcd1bc8e16b5e949e92b283fc1f845f7772c3fd19e193283d5338a8acd557
+  metadata.gz: 84e53a85958c58e66417eeadc77fd35332ac0f30b7b59eaef49e39ebeb1cc83d8f3dc906d848c40eb1f4ca08604e36d06efc6b72de0427911a185f705278ce95
+  data.tar.gz: 7e42e43664d2329d25f47999bddf7e0c28cbd2ccd36c69ce81e4e94a4e6894a5c905bc5f9ddce41b0ce6770f5f116c369b48c6d2622135e8b2e32221e7d1a6d5

data/CHANGELOG.md

@@ -1,6 +1,5 @@
 ## [Planned]
 
-- Production mode
 - Data Abstraction Layer / Object Relational Model
 - Event Model
 - Plugin / Extension system
@@ -13,6 +12,20 @@
 	- Disk (file)
 	- Databases (SQLite, PostgreSQL)
 
+## [Unreleased]
+
+## [0.3.1] - 24 February 2024
+
+- Production Mode
+	- `porous build production`
+	- `porous server`
+	- Needs `ssl/cert.pem` and `ssl/key.pem`
+	- Binds on :80 and :443
+- Development Mode
+	- `porous dev`
+	- Binds on :9292
+- Serves favicon from `static/favicon.svg`
+
 ## [0.3.0] - 22 February 2024
 
 - WebSockets support

data/README.md

@@ -42,21 +42,21 @@ Porous is not a framework. You don't build an application with it as a dependenc
 
 ## Usage
 
-Porous is still pre-alpha and so is not ready for usage yet, but the general idea is that you would define your application's entities, pages, components and events in Ruby scripts structured in a specific way. Then you would simply run `porous` while pointing it to that folder and it will spin up a Rack-compatible web server for you to use.
+Porous is still pre-alpha and so is not ready for usage yet, but the general idea is that you would define your application's entities, pages, components and events in Ruby scripts structured in a specific way. Then you would simply run `porous server` while pointing it to that folder and it will spin up a Rack-compatible web server for you to use.
 
 > ⚠️ Expect any and all APIs to change radically until version 1.0! Hence why it won't be documented or properly tested until things settle to a more stable state.
 
-To start a new Porous project simply `gem install porous` using whichever Ruby environment you want to use (Ruby 3.0+). Then change to that directory and run:
+To start a new Porous project simply `gem install porous` using whichever Ruby environment you want to use (Ruby 3.0+) and then `porous new` with your project name. Then change to that directory and run:
 
-    $ porous server
+    $ porous dev
 
-By default Porous will run at `localhost:9292`. Now you can edit `pages/home.rb` or add more pages. Files you modify will be hot-reloaded so you can simply open the page in your browser and edit the file. Hot-reloading will be improved once WebSockets support is implemented.
+By default Porous will run at `localhost:9292`. Now you can edit `pages/home.rb` or add more pages. Files you modify will be hot-reloaded, so you can simply open the page in your browser and edit the file.
 
 ### Running examples
 
-To test out some example "apps" using Porous you can navigate to the examples folder and in any folder run:
+To test out an example application using Porous you can clone the [Porous website](https://github.com/exastencil/porous.dev) and in that directory:
 
-    $ porous server
+    $ porous dev
 
 ## Development
 

data/lib/porous/application.rb

@@ -20,6 +20,7 @@ module Porous
 
           script src: '/static/dist/application.js', id: 'application'
           script src: 'https://cdn.tailwindcss.com'
+          link rel: 'icon', href: '/static/favicon.svg'
         end
 
         body class: 'bg-gray-50 dark:bg-gray-900' do

data/lib/porous/cli/build.rb

@@ -12,10 +12,10 @@ module Porous
       true
     end
 
-    desc 'build', 'Build static assets'
-    def build
+    desc 'build ENV', 'Build static assets for environment (default: development)'
+    def build(env = :development)
       empty_directory 'static/dist', verbose: false, force: options[:force]
-      Porous::Server::Builder.new.build
+      Porous::Server::Builder.new(env.to_sym).build
     end
   end
 end

data/lib/porous/cli/dev.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Porous
+  class CLI < Thor
+    check_unknown_options!
+
+    namespace :dev
+
+    desc 'dev', 'Starts a Porous development server'
+    def dev # rubocop:todo Metrics/MethodLength, Metrics/AbcSize
+      empty_directory 'static/dist', verbose: false, force: options[:force]
+
+      Agoo::Log.configure(
+        dir: '',
+        console: true,
+        classic: true,
+        colorize: true,
+        states: {
+          INFO: true,
+          DEBUG: false,
+          connect: false,
+          request: false,
+          response: false,
+          eval: true,
+          push: true
+        }
+      )
+
+      Agoo::Server.init 9292, Dir.pwd, thread_count: 1
+      Agoo::Server.use Rack::ContentLength
+      Agoo::Server.use Rack::Static, urls: ['/static']
+      Agoo::Server.use Rack::ShowExceptions
+
+      # Socket Communication
+      $socket ||= Porous::Server::Socket.new
+      Agoo::Server.handle nil, '/connect', Porous::Server::Connect.new
+      # Server-Side Rendering
+      Agoo::Server.handle nil, '**', Porous::Server::Application.new
+      Agoo::Server.start
+      # Live Reload Builder
+      Server::Builder.new.build.start
+    end
+  end
+end

data/lib/porous/cli/server.rb

@@ -6,19 +6,7 @@ module Porous
 
     namespace :server
 
-    desc 'server [OPTIONS]', 'Starts Porous server'
-    method_option :port,
-                  aliases: :p,
-                  type: :numeric,
-                  default: 9292,
-                  desc: 'The port Porous will listen on'
-
-    method_option :host,
-                  aliases: :h,
-                  type: :string,
-                  default: 'localhost',
-                  desc: 'The host address Porous will bind to'
-
+    desc 'server [OPTIONS]', 'Starts Porous server in production mode'
     def server # rubocop:todo Metrics/MethodLength
       Agoo::Log.configure(dir: '',
                           console: true,
@@ -27,26 +15,33 @@ module Porous
                           states: {
                             INFO: true,
                             DEBUG: false,
-                            connect: false,
-                            request: false,
+                            connect: true,
+                            request: true,
                             response: false,
-                            eval: true,
-                            push: true
+                            eval: false,
+                            push: false
                           })
 
-      Agoo::Server.init 9292, Dir.pwd, thread_count: 1
+      Agoo::Server.init(
+        80, '.',
+        thread_count: 0,
+        ssl_cert: 'ssl/cert.pem',
+        ssl_key: 'ssl/key.pem',
+        bind: [
+          'http://127.0.0.1:80',
+          'https://127.0.0.1:443'
+        ]
+      )
       Agoo::Server.use Rack::ContentLength
       Agoo::Server.use Rack::Static, urls: ['/static']
-      Agoo::Server.use Rack::ShowExceptions
 
       # Socket Communication
       $socket ||= Porous::Server::Socket.new
       Agoo::Server.handle nil, '/connect', Porous::Server::Connect.new
       # Server-Side Rendering
       Agoo::Server.handle nil, '**', Porous::Server::Application.new
+
       Agoo::Server.start
-      # Live Reload Builder
-      Server::Builder.new.build.start
     end
   end
 end

data/lib/porous/cli/template/.gitignore.tt

@@ -1 +1,2 @@
 static/dist
+ssl

data/lib/porous/cli/template/README.md.tt

@@ -1,7 +1,21 @@
 # <%= config[:project_name] %>
 
+## Development
+
 ```sh
-$ porous run
+$ porous dev
 ```
 
-Go to [http://localhost:8080/](http://localhost:8080/)
+Go to [http://localhost:9292/](http://localhost:9292/)
+
+## Production
+
+Place your SSL certificate in `ssl`:
+
+- `ssl/cert.pem`
+- `ssl/key.pem`
+
+```sh
+$ porous build production
+$ porous server
+```

data/lib/porous/cli/template/pages/home.rb

@@ -32,11 +32,7 @@ class Home
             end
             a href: 'https://github.com/exastencil/porous', target: '_blank', rel: 'noopener',
               class: 'flex items-center space-x-2 text-gray-500 dark:text-gray-400' do
-              svg role: 'img', width: '24', height: '24', class: 'w-5 h-5', viewBox: '0 0 24 24', fill: 'currentColor',
-                  xmlns: 'http://www.w3.org/2000/svg' do
-                title 'GitHub'
-                path d: 'M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'
-              end
+              img class: 'w-8 h-8 text-gray-500', src: '/static/github.svg'
               span 'View on GitHub'
             end
           end

data/lib/porous/cli/template/static/github.svg

@@ -0,0 +1,4 @@
+<svg role="img" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+	<title>GitHub logo</title>
+	<path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"></path>
+</svg>

data/lib/porous/cli.rb

@@ -12,5 +12,6 @@ require 'rack'
 require 'rackup/server'
 
 require 'porous/cli/build'
+require 'porous/cli/dev'
 require 'porous/cli/new'
 require 'porous/cli/server'

data/lib/porous/server/builder.rb

@@ -5,7 +5,8 @@ require 'opal/builder_scheduler/sequential'
 module Porous
   module Server
     class Builder
-      def initialize
+      def initialize(environment = :development)
+        @environment = environment
         @build_queue = Queue.new
         @last_build = nil
         @latest_change = Dir.glob(File.join('**', '*.rb')).map { |f| File.mtime f }.max
@@ -17,7 +18,8 @@ module Porous
           @latest_change = modified if modified > @latest_change
           "require '#{relative_path}'"
         end
-        build_string = "require 'porous'; #{components.join ";"}".gsub '.rb', ''
+        build_string = "require 'porous'; #{components.join ";"}; ".gsub '.rb', ''
+        build_string << inject_socket_connection
         builder = Opal::Builder.new scheduler: Opal::BuilderScheduler::Sequential, cache: false
         builder.build_str build_string, '(inline)'
         File.binwrite "#{Dir.pwd}/static/dist/application.js", builder.to_s
@@ -42,11 +44,16 @@ module Porous
           Thread.new { build }.join
 
           # Notify clients
-          $socket.public 'build', @last_build.inspect
+          $socket&.public 'build', @last_build.inspect
           @build_queue.clear
         end
       end
       # rubocop:enable Metrics/AbcSize
+
+      def inject_socket_connection
+        uri = @environment == :production ? 'wss://localhost/connect' : 'ws://localhost:9292/connect'
+        "$connection = '#{uri}'; "
+      end
     end
   end
 end

data/lib/porous/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Porous
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/opal/porous.rb

@@ -29,7 +29,7 @@ end
 
 $document.ready do
   Porous::Application.mount_to($document.body)
-  Browser::Socket.new 'ws://localhost:9292/connect' do
+  Browser::Socket.new $connection do
     on :open do |_e|
       $console.info 'Connected to server!'
     end
@@ -38,14 +38,9 @@ $document.ready do
       channel, content = e.data.split '|'
       case channel
       when 'build'
-        if content == 'started'
-          $console.log 'New build started…'
-        else
-          $console.log 'Reloading scripts…'
-          $document.location.reload
-        end
+        $document.location.reload unless content == 'started'
       else
-        $console.log "Received #{e.data}"
+        $console.log e.data
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: porous
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Exa Stencil
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: agoo
@@ -102,11 +102,13 @@ files:
 - lib/porous/application.rb
 - lib/porous/cli.rb
 - lib/porous/cli/build.rb
+- lib/porous/cli/dev.rb
 - lib/porous/cli/new.rb
 - lib/porous/cli/server.rb
 - lib/porous/cli/template/.gitignore.tt
 - lib/porous/cli/template/README.md.tt
 - lib/porous/cli/template/pages/home.rb
+- lib/porous/cli/template/static/github.svg
 - lib/porous/cli/template/static/hero.png
 - lib/porous/component.rb
 - lib/porous/component/class_methods.rb