isorun 0.1.0.pre

data/lib/isorun/config/option.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Isorun
+  class Config
+    # Isorun configuration option DSL
+    module Option
+      # Defines configuration option
+      #
+      # When you call option, it defines two methods. One method will take place
+      # in the +Config+ class and the other method will take place in the
+      # +Builder+ class.
+      #
+      # The +name+ parameter will set both builder method and config attribute.
+      # If the +:as+ option is defined, the builder method will be the specified
+      # option while the config attribute will be the +name+ parameter.
+      #
+      # If you want to introduce another level of config DSL you can
+      # define +builder_class+ parameter.
+      # Builder should take a block as the initializer parameter and respond to function +build+
+      # that returns the value of the config attribute.
+      #
+      # ==== Options
+      #
+      # * [:+as+] Set the builder method that goes inside +configure+ block
+      # * [+:default+] The default value in case no option was set
+      # * [+:builder_class+] Configuration option builder class
+      #
+      # ==== Examples
+      #
+      #    option :name
+      #    option :name, as: :set_name
+      #    option :name, default: 'My Name'
+      #    option :scopes builder_class: ScopesBuilder
+      #
+      def option(name, options = {})
+        attribute = options[:as] || name
+        attribute_builder = options[:builder_class]
+
+        builder_class.instance_eval do
+          if method_defined?(name)
+            Kernel.warn "[ISORUN] Option #{name} already defined and will be overridden"
+            remove_method name
+          end
+
+          define_method name do |*args, &block|
+            if (deprecation_opts = options[:deprecated])
+              warning = "[ISORUN] #{name} has been deprecated and will soon be removed"
+              warning = "#{warning}\n#{deprecation_opts.fetch(:message)}" if deprecation_opts.is_a?(Hash)
+
+              Kernel.warn(warning)
+            end
+
+            value = if attribute_builder
+                      attribute_builder.new(&block).build
+                    else
+                      block || args.first
+                    end
+
+            @config.instance_variable_set(:"@#{attribute}", value)
+          end
+        end
+
+        define_method attribute do |*_args|
+          if instance_variable_defined?(:"@#{attribute}")
+            instance_variable_get(:"@#{attribute}")
+          else
+            options[:default]
+          end
+        end
+
+        public attribute
+      end
+
+      def self.extended(base)
+        return if base.respond_to?(:builder_class)
+
+        raise Isorun::MissingConfigurationBuilderClass, "Define `self.builder_class` method " \
+                                                        "for #{base} that returns your custom Builder class to use options DSL!"
+      end
+    end
+  end
+end

data/lib/isorun/config/validations.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Isorun
+  class Config
+    # Isorun configuration validator.
+    #
+    module Validations
+      # Validates configuration options to be set properly.
+      def validate!; end
+    end
+  end
+end

data/lib/isorun/config.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "isorun/config/abstract_builder"
+require "isorun/config/option"
+require "isorun/config/validations"
+require "isorun/resolver"
+
+# taken from https://github.com/doorkeeper-gem/doorkeeper/blob/main/lib/doorkeeper/config.rb
+module Isorun
+  class MissingConfiguration < StandardError
+    def initialize
+      super("Configuration for isorun is missing. Do you have a isorun initializer?")
+    end
+  end
+
+  class MissingConfigurationBuilderClass < StandardError; end
+
+  class << self
+    def configure(&block)
+      @config = Config::Builder.new(&block).build
+    end
+
+    def configuration
+      @config || (raise MissingConfiguration)
+    end
+
+    alias config configuration
+  end
+
+  class Config
+    class Builder < AbstractBuilder
+    end
+
+    # Replace with `default: Builder` when we drop support of Rails < 5.2
+    mattr_reader(:builder_class) { Builder }
+
+    extend Option
+    include Validations
+
+    option :module_resolver, default: Isorun::Resolver::SSR_APP_RESOLVER
+    option :receiver, default: ->(*_args, **_kwargs) {}
+  end
+end

data/lib/isorun/context.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Isorun
+  class Context
+    class Import
+      attr_reader :context, :export_names
+
+      def initialize(context, export_names)
+        @context = context
+        @export_names = export_names
+      end
+
+      def from(module_path)
+        mod = load(module_path)
+        imports = export_names.map { |export_name| mod.import(export_name) }
+        return imports.first if imports.size == 1
+
+        imports
+      end
+
+      private
+
+      CACHE_KEY = "isorun_module_path_mtime"
+      private_constant :CACHE_KEY
+
+      def load(module_path)
+        return context.load(module_path) if Rails.env.production?
+
+        key = module_path.parameterize
+
+        file = File.open(module_path)
+        mtime = file.mtime.to_i
+
+        cache_miss = false
+
+        prev_mtime = Rails.cache.fetch("#{CACHE_KEY}:#{key}") do
+          cache_miss = true
+          mtime
+        end
+
+        # map to URI scheme to allow adding a timestamp to bust module cache
+        module_path = "file://#{module_path}?t=#{mtime}"
+
+        return context.load(module_path) if cache_miss
+
+        Rails.cache.write("#{CACHE_KEY}:#{key}", mtime) if prev_mtime < mtime
+
+        context.load(module_path)
+      end
+    end
+
+    private_constant :Import
+
+    class << self
+      def create(&block)
+        raise "[Isorun::Context] block missing when creating context" unless block
+
+        context = Isorun::Context.new
+        yield(context)
+      end
+
+      # @!method new()
+      # @return [Isorun::Context] the newly created context
+
+      private
+
+      def default_options
+        {
+          receiver: Isorun.configuration.receiver
+        }
+      end
+    end
+
+    def import(*export_names)
+      export_names = [*export_names].map(&:to_s)
+      export_names = [:default.to_s] if export_names.empty?
+      Import.new(self, export_names)
+    end
+  end
+
+  # @!method receiver=(receiver)
+  # @param receiver [Proc]
+  # @return [Isorun::Context] the newly created context
+end

data/lib/isorun/engine.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+
+module Isorun
+  class Engine < Rails::Engine
+    isolate_namespace Isorun
+    config.eager_load_namespaces << Isorun
+    config.autoload_once_paths = %W[
+      #{root}/app/helpers
+    ]
+
+    initializer "isorun.helpers", before: :load_config_initializers do
+      ActiveSupport.on_load(:action_controller_base) do
+        Rails.logger.debug Isorun::Engine.helpers
+        helper Isorun::Engine.helpers
+      end
+    end
+  end
+end

data/lib/isorun/function.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Isorun
+  class Function # rubocop:disable Lint/EmptyClass
+  end
+end

data/lib/isorun/module.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Isorun
+  class Module # rubocop:disable Lint/EmptyClass
+  end
+end

data/lib/isorun/resolver.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Isorun
+  module Resolver
+    SSR_APP_RESOLVER = lambda { |bundle_id|
+      if Rails.env.development?
+        Rails.root.join("app", "assets", "builds", "#{bundle_id}-server.js").to_s
+      else
+        javascript_path("#{bundle_id}-server")
+      end
+    }
+
+    SIMPLE_RESOLVER = lambda { |bundle_id|
+      if Rails.env.development?
+        Rails.root.join("app", "assets", "builds", "#{bundle_id}.js").to_s
+      else
+        javascript_path(bundle_id)
+      end
+    }
+  end
+end

data/lib/isorun/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Isorun
+  VERSION = "0.1.0.pre"
+end

data/lib/isorun.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# load native extension
+begin
+  ruby_version = /(\d+\.\d+)/.match(::RUBY_VERSION)
+  require "isorun/#{ruby_version}/isorun"
+rescue LoadError
+  require "isorun/isorun"
+end
+
+require "isorun/config"
+require "isorun/context"
+require "isorun/engine"
+require "isorun/function"
+require "isorun/module"
+require "isorun/version"
+
+module Isorun
+  extend ActiveSupport::Autoload
+
+  class Error < StandardError; end
+
+  def self.with_receiver(receiver)
+    self.receiver = receiver
+    result = yield
+    self.receiver = nil
+    result
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: isorun
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Hannes Moser
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.46
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.46
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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: rake-compiler-dock
+  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: rspec-rails
+  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'
+description: "Import ECMAScript modules into Ruby and use values and functions like
+  \nJavaScript is part of Ruby. Enables easy to set up server-side rendering for\nmodern
+  frontend stacks.\n\nIsorun embeds v8 into Ruby via a native extension built with
+  Rust and\ndeno_core.\n"
+email:
+- box@hannesmoser.at
+executables: []
+extensions:
+- ext/isorun/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/helpers/isorun/app_helper.rb
+- ext/isorun/Cargo.lock
+- ext/isorun/Cargo.toml
+- ext/isorun/extconf.rb
+- ext/isorun/src/call.js
+- ext/isorun/src/isorun/configure.rs
+- ext/isorun/src/isorun/context.rs
+- ext/isorun/src/isorun/function.rs
+- ext/isorun/src/isorun/mod.rs
+- ext/isorun/src/isorun/module.rs
+- ext/isorun/src/isorun/utils.rs
+- ext/isorun/src/js/mod.rs
+- ext/isorun/src/js/module.rs
+- ext/isorun/src/js/module_item.rs
+- ext/isorun/src/js/worker.rs
+- ext/isorun/src/lib.rs
+- lib/isorun.rb
+- lib/isorun/config.rb
+- lib/isorun/config/abstract_builder.rb
+- lib/isorun/config/option.rb
+- lib/isorun/config/validations.rb
+- lib/isorun/context.rb
+- lib/isorun/engine.rb
+- lib/isorun/function.rb
+- lib/isorun/module.rb
+- lib/isorun/resolver.rb
+- lib/isorun/version.rb
+homepage: https://github.com/eliias/isorun
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/eliias/isorun
+  source_code_uri: https://github.com/eliias/isorun
+  changelog_uri: https://github.com/eliias/isorun
+  documentation_uri: https://eliias.github.io/isorun
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.22
+signing_key:
+specification_version: 4
+summary: Run JavaScript applications in your Rails application.
+test_files: []