porous 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 764d087181654089e95897a26692efd6bf2b3302f36a1917695c9e5e7ba3c088
+  data.tar.gz: 7eb52c0975ce2611e1e0b57591cd0da848c639a0873785a3e6023e3506852a18
+SHA512:
+  metadata.gz: 5ca6f72a3d234ca0e368da80f7c4c839fd6d80b5577ef3eca7df9f2c0788bbb3891a099bb62568eaa3357f3940c8e6c6cd65f5dfd42d25713cb85ea812696df7
+  data.tar.gz: e16772a071f6cf91395774bac8b01374173624f5fff38e97539fbe3b72c6586538b2f716a851093cb46ee9aaa583ef1e713ed2baae042f305812ff14afd067ab

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.0

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## [Planned]
+
+- Server-side hot reloading
+- Dynamic page metadata
+- Client-side component rendering
+- Client-side routing
+- Websockets support
+- Client-side hot reloading
+
+## [0.1.0] - 15 February 2024
+
+- `porous server` to run apps
+- Only server-side HTML rendering
+- Component-based server-side routing
+- No Entity support
+- No Event support
+- No persistence
+- No client-side (transpiled) components

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at git@exastencil.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Exa Stencil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# Porous
+
+Porous is a web engine that uses isomorphic Ruby components to build a Progressive Web App. Its use is analogous to a web framework, but the approach is entirely different.
+
+This project is a work-in-progress and is not yet even in the Proof of Concept phase. However, if you are interested in a full-stack, everything included solution, that only requires you to use one language (that is arguably easy and enjoyable to write) then feel free to follow this project.
+
+The closest thing to this I could find was [Volt](https://github.com/voltrb/volt) or [Silica](https://github.com/youchan/silica), neither of which are active or match the overall development flow I'm looking for.
+
+## Design
+
+Applications are composed of `Page`s which are in turn composed of `Component`s. Data is persisted as `Entity`s in configurable store options (memory, disk, database). Client-server communication occurs as `Event`s over WebSockets.
+
+### Page
+
+A page is conceptually similar to what would be rendered when visiting a specific URL. So `www.example.com/blog/45` might render a `Blog` page, while `www.example.com/login` might render a `Login` page. Generally, code contained in pages are not reused.
+
+### Components
+
+A component is any composable unit of code responsible for rendering markup, potentially based on some state. This is somewhat equivalent to Web Components, in that it can also have some behaviour attached. But it can also simply be based to remove code duplication. Essentially any markup that has behaviour attached or would otherwise create code duplication should probably be in a Components.
+
+### Entities
+
+Data in a Porous application is stored as entities. An `Entity` is a agglomeration of virtual attributes constructed from `Datom`s – pieces of information we know to be true about that entity at a point in time. In this way, full history of an entity is automatically maintained. `Datom`s are immutable, allowing for simpler synchronisation between client and server.
+
+### Events
+
+Every user maintains one open channel (WebSocket) to the server which can be used to send and receive `Event`s. This is the sole communication mechanism and is used for "database queries", push notifications, presence, analytics, etc.
+
+## Installation
+
+Porous is not a framework. You don't build an application with it as a dependency, you run it with your application configuration as input. As such you can easily install the gem globally to use it:
+
+    $ gem install porous
+
+## 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.
+
+To start a new Porous project simply `gem install porous` using whichever Ruby environment you want to use (Ruby 3.0 minimum). Then change to that directory and run:
+
+    $ porous server
+
+By default Porous will run at `loclahost:9292`. Now you can edit `pages/home.rb` or add more pages. Finally restart the server and refresh the page. Hot-reloading will be coming later.
+
+### Running examples
+
+To test out some example "apps" using Porous you can navigate to the examples folder and in any folder run:
+
+    $ porous server
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/exastencil/porous. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/exastencil/porous/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Porous project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/exastencil/porous/blob/master/CODE_OF_CONDUCT.md).
+
+## Acknowledgements
+
+The work done by Michał Kalbarczyk ([fazibear](https://github.com/fazibear)) on [Inesita](https://github.com/inesita-rb/inesita) and his [VirtualDOM wrapper](https://github.com/fazibear/opal-virtual-dom) which served as the starting point for my implementation of Porous.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/porous

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'porous/cli'
+
+Porous::CLI.start ARGV

data/lib/porous/cli/build.rb

@@ -0,0 +1,22 @@
+module Porous
+  class CLI < Thor
+    include Thor::Actions
+
+    check_unknown_options!
+
+    namespace :build
+
+    desc 'build', 'Build static assets'
+
+    def build
+      empty_directory 'static/dist', force: options[:force]
+      transpile
+    end
+
+    no_commands do
+      def transpile
+        # TODO: Use Opal::Builder to generate pages, components and entities into static/dist
+      end
+    end
+  end
+end

data/lib/porous/cli/new.rb

@@ -0,0 +1,29 @@
+module Porous
+  class CLI < Thor
+    include Thor::Actions
+
+    check_unknown_options!
+
+    namespace :new
+
+    desc 'new PROJECT_NAME', 'Create Porous app'
+
+    method_option :force,
+                  aliases: :f,
+                  type: :boolean,
+                  default: false,
+                  desc: 'Force overwriting files'
+
+    def new(project_dir)
+      directory('template', project_dir, project_name: project_dir)
+
+      inside project_dir do
+        # run 'bundle install'
+      end
+    end
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+  end
+end

data/lib/porous/cli/server.rb

@@ -0,0 +1,26 @@
+module Porous
+  class CLI < Thor
+    check_unknown_options!
+
+    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: '127.0.0.1',
+                  desc: 'The host address Porous will bind to'
+
+    def server
+      Rackup::Server.start environment: 'development', builder: <<-BUILDER
+        run Porous::Server.new
+      BUILDER
+    end
+  end
+end

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

@@ -0,0 +1 @@
+static/dist

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

@@ -0,0 +1,7 @@
+# <%= config[:project_name] %>
+
+```sh
+$ porous run
+```
+
+Go to [http://localhost:8080/](http://localhost:8080/)

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

@@ -0,0 +1,48 @@
+class Home
+  include Porous::Page
+  include Porous::Component
+
+  def route = '/'
+
+  def render
+    div class: 'container p-8 mx-auto lg:h-full xl:px-0 flex flex-wrap' do
+      div class: 'flex items-center w-full lg:w-1/2' do
+        div class: 'max-w-2xl mb-8' do
+          h1 class: 'text-4xl font-bold leading-snug tracking-tight text-gray-800 lg:text-4xl lg:leading-tight xl:text-6xl xl:leading-tight dark:text-white' do
+            span class: "bg-gradient-to-br from-pink-500 to-violet-500 bg-clip-text text-transparent box-decoration-clone" do
+              text 'Welcome to Porous!'
+            end
+          end
+          p class: 'py-5 text-xl leading-normal text-gray-500 lg:text-xl xl:text-2xl dark:text-gray-300' do
+            text 'Porous is an all-in-one application engine for building applications with Web technologies.'
+          end
+
+          div class: 'flex flex-col items-start space-y-3 sm:space-x-4 sm:space-y-0 sm:items-center sm:flex-row' do
+            a href: 'https://github.com/exastencil/porous', target: '_blank', rel: 'noopener',
+              class: "group relative inline-flex h-12 items-center justify-center overflow-hidden rounded-md bg-indigo-600 px-6 font-medium text-neutral-200 transition hover:scale-110" do
+              span 'Get Started'
+              div class: "absolute inset-0 flex h-full w-full justify-center [transform:skew(-12deg)_translateX(-100%)] group-hover:duration-1000 group-hover:[transform:skew(-12deg)_translateX(100%)]" do
+                div class: "relative h-full w-8 bg-white/20"
+              end
+            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
+              span 'View on GitHub'
+            end
+          end
+        end
+      end
+
+      div class: 'flex items-center justify-center w-full lg:w-1/2' do
+        div do
+          img src: '/static/hero.png', width: '616', height: '617', class: 'object-cover', alt: 'Hero Illustration'
+        end
+      end
+    end
+  end
+end

data/lib/porous/cli.rb

@@ -0,0 +1,10 @@
+require 'thor'
+
+require 'porous'
+
+require 'rack'
+require 'rackup/server'
+
+require 'porous/cli/build'
+require 'porous/cli/new'
+require 'porous/cli/server'

data/lib/porous/component/class_methods.rb

@@ -0,0 +1,15 @@
+module Porous
+  module Component
+    module ClassMethods
+      def inject(clazz, opts = {})
+        method_name = opts[:as] || clazz.to_s.downcase
+        @injections ||= {}
+        @injections[method_name] = clazz
+      end
+
+      def injections
+        @injections || {}
+      end
+    end
+  end
+end

data/lib/porous/component/render.rb

@@ -0,0 +1,19 @@
+module Porous
+  module Component
+    module Render
+      def render
+        raise Error, "Implement #render in #{self.class} component"
+      end
+
+      def before_render
+      end
+
+      def render_virtual_dom
+        before_render
+        @__virtual_nodes__ = []
+        render
+        to_vnode
+      end
+    end
+  end
+end

data/lib/porous/component/virtual.rb

@@ -0,0 +1,18 @@
+module Porous
+  module Component
+    module Virtual
+      # Used to render nested components (no caching on server)
+      def component(comp, opts = {})
+        raise Error, "Component is nil in #{self.class} class" if comp.nil?
+
+        @__virtual_nodes__ ||= []
+        comp = (comp.is_a?(Class) ? comp.new(opts[:props] || {}) : comp)
+               .with_root_component(@root_component)
+               .inject
+        comp.init
+        @__virtual_nodes__ << comp.render_virtual_dom
+        self
+      end
+    end
+  end
+end

data/lib/porous/component.rb

@@ -0,0 +1,34 @@
+module Porous
+  module Component
+    include VirtualDOM::DOM
+    include Virtual
+    include Render
+    include Injection
+
+    def self.included(base)
+      base.extend Porous::Component::ClassMethods
+    end
+
+    def initialize(props = {})
+      @props = props
+      @root_component = self
+      init_injections
+      inject
+      @virtual_dom = render_virtual_dom
+      self
+    end
+
+    def props
+      @props || {}
+    end
+
+    def with_props(props)
+      @props = props
+      self
+    end
+
+    def to_s
+      @virtual_dom.to_s
+    end
+  end
+end

data/lib/porous/injection.rb

@@ -0,0 +1,38 @@
+module Porous
+  module Injection
+    def init; end
+
+    def with_root_component(component)
+      @root_component = component
+      self
+    end
+
+    def inject
+      @root_component.injections.each do |name, instance|
+        define_singleton_method(name) do
+          instance
+        end
+      end
+      self
+    end
+
+    attr_reader :injections
+
+    def init_injections
+      @injections ||= {}
+      self.class.injections.each do |name, clazz|
+        if clazz.included_modules.include?(Porous::Injection)
+          @injections[name] = clazz
+                              .new
+                              .with_root_component(@root_component)
+        else
+          raise Error, "Invalid #{clazz} class, should mixin Porous::Injection"
+        end
+      end
+      @injections.each do |key, instance|
+        instance.inject
+        instance.init
+      end
+    end
+  end
+end

data/lib/porous/page.rb

@@ -0,0 +1,11 @@
+module Porous
+  module Page
+    # Define the route according to the Router::Routes rules
+    def route!
+      path = route
+      @routes ||= Routes.new.tap do |routes|
+        routes.route path, to: self.class
+      end
+    end
+  end
+end

data/lib/porous/router.rb

@@ -0,0 +1,113 @@
+module Porous
+  module Router
+    include Porous::Component
+
+    attr_reader :params
+
+    def initialize(props = {})
+      @props = props
+      @routes = Routes.new
+
+      # Extract the routes from all Pages
+      ObjectSpace.each_object(Class).select { |c| c.included_modules.include? Porous::Page }.each do |klass|
+        # TODO: Figure out where these classes are coming from
+        # puts "#{klass}: #{klass.ancestors.first} (#{klass.respond_to? :new})"
+        next if klass.to_s.start_with? '#<Class:' # skip singleton classes
+
+        @routes.combine klass.new.route!
+      end
+
+      raise Error, 'No Porous::Page components found!' if @routes.routes.empty?
+
+      find_route
+      parse_url_params
+    end
+
+    def self.included(base)
+      base.extend(Porous::Component::ClassMethods)
+    end
+
+    def find_route
+      @routes.routes.each do |route|
+        next unless path.match(route[:regex])
+        return go_to(url_for(route[:redirect_to])) if route[:redirect_to]
+
+        return @route = route
+      end
+      raise Error, "Can't find route for url"
+    end
+
+    def find_component(route)
+      call_on_enter_callback(route)
+      @component_props = route[:component_props]
+      route[:component]
+    end
+
+    def render
+      component find_component(@route), props: @component_props if @route
+    end
+
+    def call_on_enter_callback(route)
+      return unless route[:on_enter]
+
+      if route[:on_enter].respond_to?(:call)
+        route[:on_enter].call
+      end
+    end
+
+    def go_to(path)
+      # Figure out how to change path
+      @props[:path] = path
+      find_route
+      parse_url_params
+      render!
+      false
+    end
+
+    def parse_url_params
+      @params = component_url_params
+      query[1..-1].split('&').each do |param|
+        key, value = param.split('=')
+        @params[key] = value
+      end unless query.empty?
+    end
+
+    def component_url_params
+      Hash[@route[:params].zip(path.match(@route[:regex])[1..-1])]
+    end
+
+    def url_for(name, params = nil)
+      route = @routes.routes.find do |r|
+        case name
+        when String
+          r[:name] == name || r[:path] == name
+        when Object
+          r[:component] == name
+        else
+          false
+        end
+      end
+      route ? url_with_params(route, params) : raise(Error, "Route '#{name}' not found.")
+    end
+
+    def query
+      @props ? @props[:query] : '' # Browser.query
+    end
+
+    def path
+      @props ? @props[:path] : '/' # @props[:path] # Browser.path
+    end
+
+    def current_url?(name)
+      path == url_for(name, params)
+    end
+
+    def url_with_params(route, params)
+      path = route[:path]
+      params.each do |key, value|
+        path = path.gsub(":#{key}", "#{value}")
+      end if params
+      path
+    end
+  end
+end