funicular 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d778a4d72fce90ad8e8403f40a32293431da06b47908e927a587ad725afa192
-  data.tar.gz: 1ded05e84560d65c99119e6e8603c04a8f130e40949ca476d6ec1419ba19cc82
+  metadata.gz: 42012485f28870d0316fa30ba1fbebd4699c07cb8e61e5d201874d2eafd50d04
+  data.tar.gz: ab7f7e473a32d0a00b8bca5b0c67fc7e7b91a9a7860724e53631ea7d08dbcc41
 SHA512:
-  metadata.gz: 843a50c979823f2a307107958dab03e4414ebf37978bb968857336c6ba4436f48ab47322f3bf7b37ce27f2bd8030696d668c20c3adc52df7b01eb7c443c01d6d
-  data.tar.gz: 51f945d515798ee9804b4e11359f7ff7579024a8db8e392ef96c4bfa36867a0a6a52cedb8da8542abc7161be1fe256b3076ba345e39803407683e3523fbeef6f
+  metadata.gz: 5488c967e48dd01768dc05acba5a350e07fb2fb5fc9ede01f5e06dd1274c1c4ee1fd7f0f4e76a2c616b74b8eff10260f5a14108d83798a34e25c3f785c4be7c7
+  data.tar.gz: 653010659b471071850c77dd459ff17984b906485cfcc9b396c3ecf1558686c353ca2ec65cc3940dad4497c79318515b833ff4219f7f9e301e93a041abbfbb30

data/CHANGELOG.md

@@ -1,5 +1,84 @@
 ## [Unreleased]
 
+### Added
+
+- **Funicular::Store DSL**: Declarative client-side stores backed by
+  IndexedDB. Subclass `Funicular::Store::Singleton` (one value per scope)
+  or `Funicular::Store::Collection` (ordered list per scope) and use
+  class-level DSL (`database`, `scope`, `limit`, `key`, `expires_in`,
+  `cleared_on`, `subscribes_to`) to wire up persistence, TTL, event-based
+  clearing, and ActionCable integration.
+- `Funicular::Store.dispatch(:event)` for coordinated store clearing
+  (e.g., logout wipes all stores registered with `cleared_on :logout`)
+- `subscribes_to` DSL for embedding Cable message handling directly in
+  store classes; scopes gain `subscribe!` / `unsubscribe!` / `subscribed?`
+- Lazy KVS initialization: stores open IndexedDB on first access, removing
+  the need for explicit `init!` calls in application initializers
+- `Funicular::Store::Scope#on_change` / `off_change` for reactive UI
+  updates when store data changes
+
+### Changed
+
+- `Funicular::Cable::Consumer` now automatically resubscribes all active
+  subscriptions after WebSocket reconnect (`resubscribe_all`)
+
+## [0.1.0] - 2026-04-20
+
+### Added
+
+- Consolidated with picoruby-funicular: merged the full PicoRuby frontend
+  framework into this gem, including Component, Cable, VDOM, Router,
+  FormBuilder, Model, HTTP, FileUpload, ErrorBoundary, Styles, Differ,
+  Patcher, Debug, and EnvironmentInquirer, along with RBS signatures and
+  comprehensive test suite
+- Bundle PicoRuby.wasm and picorbc WASM artifacts into the gem via a
+  `rake copy_wasm` task; artifacts are vendored at build time so no
+  runtime npm lookup is required
+- `Funicular::Configuration` with per-environment PicoRuby.wasm source
+  selection (`:local_debug`, `:local_dist`, `:cdn`) and optional
+  `cdn_version` override
+- `picoruby_include_tag` view helper (auto-registered via Railtie) that
+  serves the appropriate PicoRuby.wasm build per environment
+- `funicular:install:wasm` rake sub-task to copy dist/debug WASM builds
+  into `public/picoruby/`
+- Rails Asset Pipeline integration: Rack middleware, compiler, and
+  `funicular:compile` / `funicular:install` rake tasks
+- `funicular routes` CLI command and `Funicular::RouteParser` to inspect
+  Rails routes from the command line
+- Component Debug Highlighter: CSS/JS assets (`funicular_debug.css`,
+  `funicular_debug.js`) that highlight the selected component in the
+  browser
+- `ENV['FUNICULAR_ENV']` is now set from `Rails.env` in generated
+  `application.rb`
+
+### Changed
+
+- picorbc is now resolved from a vendored WASM artifact; removed
+  npm-based picorbc lookup and all `PICORBC_VERSION` environment variable
+  logic
+- Upgraded picorbc to the latest version
+- Switched test framework from test/unit to minitest
+
+### Fixed
+
+- Asset pipeline: middleware now detects whether `app.mrb` has actually
+  changed before recompiling, preventing unnecessary rebuilds
+- XSS vulnerabilities in VDOM attribute handling: expanded
+  `URL_ATTRIBUTES` constant, applied case-insensitive `javascript:` URI
+  blocking, and added the same URL validation to `Patcher#update_props`
+  and `Patcher#create_element`
+- XSS vulnerability in Debug module: replaced manual JSON string
+  concatenation with `JSON.generate` to eliminate escaping gaps
+- `funicular:compile` rake task
+- `funicular:install` rake task
+- Rack middleware
+- RBS type signatures
+
+### Removed
+
+- Debugger Chrome extension (`debugger/` directory)
+- `.ruby-version` file
+
 ## [0.0.1] - 2025-11-27
 
 - Initial release

data/README.md

@@ -1,43 +1,89 @@
 # Funicular
 
-TODO: Delete this and the text below, and describe your gem
+> 🎵Funicu-lì, Funicu-là!🚊🚊🚊
+>
+> 🎵Funicu-lì, Funicu-là!🚞🚞🚞
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/funicular`. To experiment with that code, run `bin/console` for an interactive prompt.
+**Funicular** is a single-page application (SPA) framework powered by PicoRuby.wasm.
 
-## Installation
+## Features
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+- Write client-side code in Ruby instead of JavaScript
+- Seamless Rails integration
 
-Install the gem and add to the application's Gemfile by executing:
+## Combined Gem
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+This repository consists of three relevant projects:
+
+- PicoGem "picoruby-funicular" ... Core implementation
+- CRubyGem "funicular" ... Rails integration
+- Chrome extension "PicoRuby Debugger"
+
+### PicoGem "picoruby-funicular"
+
+```console
+.
+├── mrbgem.rake
+├── mrblib/
+└── test/
+```
+
+### CRubyGem "funicular"
+
+```console
+.
+├── bin/
+├── exe/
+├── funicular.gemspec
+├── Gemfile
+├── Gemfile.lock
+├── lib/
+├── minitest/
+└── Rakefile
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### Chrome extention "PicoRuby.wasm debugger"
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```console
+.
+└── debugger/
 ```
 
-## Usage
+----
+
+The others are common resources.
+
+## Documentation
+
+User documentation is hosted on **picoruby.org**:
 
-TODO: Write usage instructions here
+- [Getting Started with Funicular](https://picoruby.org/funicular-getting-started) — a standalone, no-Rails tutorial
+- [Funicular on Rails](https://picoruby.org/funicular-on-rails) — installation, the asset pipeline, and a feature-by-feature tutorial plus reference (components, routing, forms, data fetching, stores, realtime, SSR, styling, debugging)
+
+For contributors working on the gem itself, see [docs/architecture.md](docs/architecture.md).
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+This repository is a submodule of [picoruby/picoruby](https://github.com/picoruby/picoruby).
+Do not check it out standalone. Instead, clone the parent repository and work from there:
 
-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).
+```console
+git clone --recurse-submodules https://github.com/picoruby/picoruby.git
+cd picoruby/mrbgems/picoruby-funicular
+```
 
-## Contributing
+The CRubyGem side (`lib/`, `funicular.gemspec`, etc.) can be developed and tested independently inside that directory, but `rake copy_wasm` — which vendorsthe PicoRuby.wasm and picorbc wasm artifacts into the gem — relies on sibling directories within the picoruby repository (`mrbgems/picoruby-wasm/npm/`).
+Running it from a standalone checkout will fail.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/funicular. 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/[USERNAME]/funicular/blob/master/CODE_OF_CONDUCT.md).
+## Testing
 
-## License
+- CRubygem (Rails integration) test: `rake test` in this repository
+- PicoGem Funicular test: `rake test:gems:picoruby[picoruby-funicular]` in picoruby where mrbgems/picoruby-funicular exists as a submodule
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/picoruby/funicular.
 
-## Code of Conduct
+## License
 
-Everyone interacting in the Funicular project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/funicular/blob/master/CODE_OF_CONDUCT.md).
+Copyright © 2025- HASUMI Hitoshi. See MIT-LICENSE for further details.

data/Rakefile

@@ -4,9 +4,110 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
+  t.libs << "minitest"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["minitest/**/*_test.rb"]
 end
 
 task default: :test
+
+desc "Copy picoruby and picorbc wasm artifacts from picoruby-wasm into the gem"
+task :copy_wasm do
+  require "fileutils"
+  require "json"
+
+  vendor_root = File.expand_path("lib/funicular/vendor", __dir__)
+
+  # PICORUBY_WASM_NPM_DIR overrides the default search path.
+  # Default: picoruby-wasm is a sibling of picoruby-funicular under mrbgems/.
+  npm_root = ENV["PICORUBY_WASM_NPM_DIR"] ||
+             File.expand_path("../picoruby-wasm/npm", __dir__)
+
+  unless Dir.exist?(npm_root)
+    abort "picoruby-wasm npm directory not found: #{npm_root}\n" \
+          "Set PICORUBY_WASM_NPM_DIR to override, and ensure picoruby-wasm has been built."
+  end
+
+  # ------------------------------------------------------------------
+  # 1) PicoRuby runtime (browser): dist + debug
+  # ------------------------------------------------------------------
+  picoruby_src  = File.join(npm_root, "picoruby")
+  picoruby_dest = File.join(vendor_root, "picoruby")
+  abort "Missing #{picoruby_src}" unless Dir.exist?(picoruby_src)
+
+  picoruby_version = JSON.parse(File.read(File.join(picoruby_src, "package.json"))).fetch("version")
+  picoruby_files = %w[picoruby.wasm picoruby.js init.iife.js]
+
+  %w[dist debug].each do |variant|
+    src = File.join(picoruby_src, variant)
+    dst = File.join(picoruby_dest, variant)
+    abort "Missing source variant: #{src}" unless Dir.exist?(src)
+
+    FileUtils.rm_rf(dst)
+    FileUtils.mkdir_p(dst)
+    picoruby_files.each do |fname|
+      src_file = File.join(src, fname)
+      abort "Missing file: #{src_file}" unless File.exist?(src_file)
+      # FileUtils.copy_file follows symlinks, so debug/init.iife.js
+      # (a symlink to ../dist/init.iife.js) is materialized.
+      FileUtils.copy_file(src_file, File.join(dst, fname))
+    end
+    puts "  copied picoruby/#{variant}"
+  end
+
+  File.write(File.join(picoruby_dest, "VERSION"), "#{picoruby_version}\n")
+  puts "  wrote picoruby/VERSION (#{picoruby_version})"
+
+  # ------------------------------------------------------------------
+  # 2) picorbc compiler (node CLI, run by Funicular::Compiler)
+  # ------------------------------------------------------------------
+  picorbc_src  = File.join(npm_root, "picorbc", "debug")
+  picorbc_dest = File.join(vendor_root, "picorbc")
+  abort "Missing #{picorbc_src}" unless Dir.exist?(picorbc_src)
+
+  picorbc_version = JSON.parse(File.read(File.join(npm_root, "picorbc", "package.json"))).fetch("version")
+  picorbc_files = %w[picorbc.js picorbc.wasm]
+
+  FileUtils.rm_rf(picorbc_dest)
+  FileUtils.mkdir_p(picorbc_dest)
+  picorbc_files.each do |fname|
+    src_file = File.join(picorbc_src, fname)
+    abort "Missing file: #{src_file}" unless File.exist?(src_file)
+    FileUtils.copy_file(src_file, File.join(picorbc_dest, fname))
+  end
+  File.chmod(0755, File.join(picorbc_dest, "picorbc.js"))
+  File.write(File.join(picorbc_dest, "VERSION"), "#{picorbc_version}\n")
+  puts "  copied picorbc (#{picorbc_version})"
+
+  # ------------------------------------------------------------------
+  # 3) PicoRuby runtime for DOM-backed Node.js tests
+  # ------------------------------------------------------------------
+  test_runtime_src = ENV["PICORUBY_WASM_TEST_DIR"] ||
+                     File.expand_path("../../build/picoruby-wasm-test/bin", __dir__)
+  test_runtime_dest = File.join(vendor_root, "picoruby-test-node")
+  test_runtime_files = %w[picoruby.js picoruby.wasm]
+  optional_test_runtime_files = %w[picoruby.wasm.map]
+
+  unless Dir.exist?(test_runtime_src)
+    abort "PicoRuby WASM test runtime not found: #{test_runtime_src}\n" \
+          "Run `MRUBY_CONFIG=picoruby-wasm-test rake all` from the picoruby checkout, " \
+          "or set PICORUBY_WASM_TEST_DIR to the directory containing picoruby.js."
+  end
+
+  FileUtils.rm_rf(test_runtime_dest)
+  FileUtils.mkdir_p(test_runtime_dest)
+  test_runtime_files.each do |fname|
+    src_file = File.join(test_runtime_src, fname)
+    abort "Missing file: #{src_file}" unless File.exist?(src_file)
+    FileUtils.copy_file(src_file, File.join(test_runtime_dest, fname))
+  end
+  optional_test_runtime_files.each do |fname|
+    src_file = File.join(test_runtime_src, fname)
+    FileUtils.copy_file(src_file, File.join(test_runtime_dest, fname)) if File.exist?(src_file)
+  end
+  File.write(File.join(test_runtime_dest, "VERSION"), "#{picoruby_version}\n")
+  puts "  copied picoruby-test-node (#{picoruby_version})"
+end
+
+# Make sure the wasm artifacts are refreshed before the gem is packaged for release.
+Rake::Task["build"].enhance([:copy_wasm])