archipelago-rails 0.1.0

data/test/generators/react_install_generator_test.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+require "rails/generators/test_case"
+require "generators/archipelago/install/react_generator"
+require "json"
+
+class ReactInstallGeneratorTest < Rails::Generators::TestCase
+  tests Archipelago::Generators::Install::ReactGenerator
+  destination File.expand_path("../../tmp", __dir__)
+
+  setup :prepare_destination
+
+  def setup
+    super
+    FileUtils.mkdir_p(File.join(destination_root, "app/javascript"))
+    File.write(File.join(destination_root, "app/javascript/application.js"), "// entry\n")
+    File.write(File.join(destination_root, "Gemfile"), "gem \"jsbundling-rails\"\n")
+    File.write(
+      File.join(destination_root, "package.json"),
+      <<~JSON
+        {
+          "name": "dummy",
+          "scripts": {
+            "build": "esbuild app/javascript/*.* --bundle --outdir=app/assets/builds",
+            "build:watch": "esbuild app/javascript/*.* --bundle --outdir=app/assets/builds --watch"
+          }
+        }
+      JSON
+    )
+  end
+
+  def test_generates_entry_and_wires_application_import
+    run_generator %w[--interactive=false]
+
+    assert_file "app/javascript/archipelago/entry.jsx", /import registry from "\.\/registry\.generated"/
+    assert_file "app/javascript/application.js", /import "\.\/archipelago\/entry"/
+    assert_file "app/javascript/archipelago/generate_registry.mjs", /registry\.generated\.js/
+    assert_file "app/javascript/archipelago/registry.generated.js", /const registry = \{\}/
+
+    package_json = JSON.parse(File.read(File.join(destination_root, "package.json")))
+    assert_equal "node app/javascript/archipelago/generate_registry.mjs", package_json.dig("scripts", "archipelago:registry")
+    assert_match(/^node app\/javascript\/archipelago\/generate_registry\.mjs && /, package_json.dig("scripts", "build"))
+  end
+
+  def test_generates_typescript_entry_when_requested
+    run_generator %w[--interactive=false --typescript=true]
+
+    assert_file "app/javascript/archipelago/entry.tsx", /import registry from "\.\/registry\.generated"/
+    assert_file "app/javascript/archipelago/registry.generated.ts", /const registry: IslandRegistry = \{\}/
+  end
+
+  def test_auto_detects_typescript_when_tsconfig_present
+    File.write(File.join(destination_root, "tsconfig.json"), "{\n}\n")
+
+    run_generator %w[--interactive=false]
+
+    assert_file "app/javascript/archipelago/entry.tsx", /bootArchipelagoIslands/
+  end
+
+  def test_can_disable_auto_registry
+    run_generator %w[--interactive=false --auto_registry=false]
+
+    assert_file "app/javascript/archipelago/entry.jsx", /const registry = \{/
+    refute File.exist?(File.join(destination_root, "app/javascript/archipelago/generate_registry.mjs"))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+ENV["RAILS_ENV"] ||= "test"
+
+require "minitest/autorun"
+require "active_support"
+require "active_support/testing/time_helpers"
+require "action_view"
+begin
+  require "action_controller/template_assertions"
+rescue LoadError
+  # Loaded in full Rails app contexts.
+end
+begin
+  require "action_cable/engine"
+rescue LoadError
+  # Streaming tests require actioncable; core tests can still run without it.
+end
+require "archipelago"
+
+if defined?(ActionController::Base)
+  ActionController::Base.allow_forgery_protection = false
+end
+
+class ArchipelagoTestCase < Minitest::Test
+  include ActiveSupport::Testing::TimeHelpers
+
+  def setup
+    super
+    Archipelago.reset_configuration!
+    Archipelago.registry.clear!
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: archipelago-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Archipelago
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Inertia-style server-driven props for embedded React islands
+email:
+- dev@archipelago.local
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Appraisals
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/archipelago/application_controller.rb
+- app/controllers/archipelago/islands_controller.rb
+- config/database.yml
+- config/routes.rb
+- lib/archipelago-rails.rb
+- lib/archipelago.rb
+- lib/archipelago/action.rb
+- lib/archipelago/broadcasts.rb
+- lib/archipelago/channel.rb
+- lib/archipelago/configuration.rb
+- lib/archipelago/context.rb
+- lib/archipelago/engine.rb
+- lib/archipelago/params_dsl.rb
+- lib/archipelago/registry.rb
+- lib/archipelago/resolver.rb
+- lib/archipelago/response.rb
+- lib/archipelago/security/origin_validator.rb
+- lib/archipelago/security/redirect_validator.rb
+- lib/archipelago/test_helpers.rb
+- lib/archipelago/view_helper.rb
+- lib/generators/archipelago/install/install_generator.rb
+- lib/generators/archipelago/install/react/react_generator.rb
+- lib/generators/archipelago/install/react/templates/entry.js.tt
+- lib/generators/archipelago/install/react/templates/generate_registry.mjs.tt
+- lib/generators/archipelago/install/react_generator.rb
+- lib/generators/archipelago/install_generator.rb
+- lib/generators/archipelago/island/island_generator.rb
+- lib/generators/archipelago/island/templates/action.rb.tt
+- lib/generators/archipelago/island/templates/component.tsx.tt
+- lib/generators/archipelago/island_generator.rb
+- test/archipelago/action_test.rb
+- test/archipelago/broadcasts_test.rb
+- test/archipelago/channel_test.rb
+- test/archipelago/notifications_test.rb
+- test/archipelago/origin_validator_test.rb
+- test/archipelago/params_dsl_test.rb
+- test/archipelago/redirect_validator_test.rb
+- test/archipelago/resolver_test.rb
+- test/archipelago/response_test.rb
+- test/archipelago/view_helper_test.rb
+- test/controllers/islands_controller_test.rb
+- test/generators/install_generator_test.rb
+- test/generators/island_generator_test.rb
+- test/generators/react_install_generator_test.rb
+- test/test_helper.rb
+homepage: https://github.com/robrace/archipelago/tree/main/archipelago-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/robrace/archipelago/tree/main/archipelago-rails
+  source_code_uri: https://github.com/robrace/archipelago
+  changelog_uri: https://github.com/robrace/archipelago/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Server-driven React islands for Rails
+test_files: []