ruflet_rails 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d142d63121dae012354a763ef756504d64534adbc4b2c11eaf0dc51b514c6b32
-  data.tar.gz: d3d1e6cbf9af94c81d5514b71325484e547b40ba34afe3d8601a111f08e4af6a
+  metadata.gz: dc30304299f6e6c539c8fcc838c7f843b54b2d106e6219c657ac8c856c69f9cf
+  data.tar.gz: 52ec66b70428d3d1d4ff2d3d7ac4cf6bae34b497addd74e6ba39f8f9c3cc5d3f
 SHA512:
-  metadata.gz: daf5bf66b258ece12da18cbb4c455d2f9f5dd141faa3638c2ef0ec9a64d85be9b25d94add15ae0374a96c6694f6e393ee015290df62368bd1d9cd6920a3185f3
-  data.tar.gz: 075def7cfb22688619559ba1ca55ede0d4c152c403c95a2273c1fa322a2862b20aafe7bda0507bf73bb4a8e8f40e03eb6c87b9505900fb31aa3ac08098dbf88b
+  metadata.gz: 976c713a63c7a6f3663fbd2541474008e010947a81c6d205cb43f318d6e6fbdaae59c71564f145f34311570518c1910ead0f0278173e270f9ce6bbda3bd4d659
+  data.tar.gz: 88d2668bd895b3e817bae881f65ab8fa395ec54377b850a9f7aef163bcf1caa96982656103fdeb8b6034a40271ae1c4dfe80ae43a7f987fd0cf816e56f28cb2d

data/README.md

@@ -2,17 +2,18 @@
 
 `ruflet_rails` is the Rails-first integration package for Ruflet.
 
-Internal Rails transport/protocol code is bundled inside this gem as `Ruflet::Rails::Protocol`.
-No separate protocol gem is required.
+It mounts Ruby-driven Ruflet interfaces in a Rails application, makes Rails
+models available to Ruflet components, and connects web, mobile, and desktop
+clients to the same application entrypoint.
 
-## Usage
+## Add The Gem
 
 ```ruby
 # Gemfile
-gem "ruflet_rails", ">= 0.0.5"
+gem "ruflet_rails"
 ```
 
-## Install into Rails
+## Install Into Rails
 
 ```bash
 bin/rails generate ruflet:install
@@ -119,13 +120,16 @@ bundle exec rake ruflet:install[DEVICE_ID]
 
 ## Ruflet resource scaffolds
 
-Generate a mountable Ruflet CRUD component for an existing Rails model:
+The standard Rails scaffold command also generates a mountable Ruflet CRUD
+component:
 
 ```bash
-bin/rails generate ruflet:scaffold Post
+bin/rails generate scaffold Post title:string body:text published:boolean
 ```
 
-The scaffold creates generated app code the Rails developer can own and edit:
+The Rails model attributes are passed to the Ruflet component generator. The
+scaffold creates generated application code the Rails developer can own and
+edit:
 
 ```ruby
 # app/views/ruflet/components/posts/post_component.rb
@@ -147,6 +151,9 @@ The generated component contains the developer-owned UI and persistence calls.
 helpers. Component files under `app/views/ruflet/components` are loaded by the
 Railtie so both web mounts and `main.rb` can reference them.
 
+Use `--skip-ruflet` when a Rails scaffold should not generate a Ruflet
+component.
+
 ## Ruflet model forms
 
 Generate only a reusable Ruflet form for an existing Rails model:

data/lib/ruflet/rails/generator_hooks.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Ruflet
+  module Rails
+    module GeneratorHooks
+      module_function
+
+      def install!
+        require "active_support/core_ext/string/filters"
+        require "rails/generators/rails/scaffold/scaffold_generator"
+        require "generators/ruflet/scaffold/scaffold_generator"
+
+        generator = ::Rails::Generators::ScaffoldGenerator
+        return if generator.class_options.key?(:ruflet)
+
+        generator.hook_for(
+          :ruflet,
+          type: :boolean,
+          default: true,
+          desc: "Generate a Ruflet resource component"
+        )
+      end
+    end
+  end
+end

data/lib/ruflet/rails/native_app.rb

@@ -4,7 +4,7 @@ require "uri"
 
 module Ruflet
   module Rails
-    # Hotwire Native-style driver for ruflet_rails.
+    # Managed webview navigation driver for ruflet_rails.
     #
     # Your existing web app is the body, rendered in a WebView. Navigation works
     # out of the box: a tiny JS bridge injected into each page intercepts link
@@ -122,6 +122,7 @@ module Ruflet
         Ruflet::UI::ControlFactory.build(
           :webview,
           url: screen.url,
+          method: "get",
           expand: true,
           on_page_ended: ->(_event) { inject_bridge(screen) },
           on_console_message: ->(event) { handle_message(screen, message_of(event)) }
@@ -190,7 +191,7 @@ module Ruflet
       # --- Modal (bottom sheet of web content) -------------------------------
 
       def present_modal(url)
-        sheet_webview = Ruflet::UI::ControlFactory.build(:webview, url: url.to_s, expand: true)
+        sheet_webview = Ruflet::UI::ControlFactory.build(:webview, url: url.to_s, method: "get", expand: true)
         @modal_sheet = Ruflet::UI::ControlFactory.build(
           :bottomsheet,
           open: true,
@@ -245,7 +246,7 @@ module Ruflet
 
     module_function
 
-    # Start a Hotwire Native-style app. See NativeApp.
+    # Start a managed webview app. See NativeApp.
     def native_app(page, **opts)
       NativeApp.new(page, **opts).start
     end

data/lib/ruflet/rails/railtie.rb

@@ -3,6 +3,11 @@
 module Ruflet
   module Rails
     class Railtie < ::Rails::Railtie
+      generators do
+        require "ruflet/rails/generator_hooks"
+        Ruflet::Rails::GeneratorHooks.install!
+      end
+
       # Make ruflet_frame and friends available in every .erb template.
       initializer "ruflet_rails.view_helpers" do
         ActiveSupport.on_load(:action_view) do

data/lib/ruflet/rails/resource_component.rb

@@ -12,7 +12,7 @@ module Ruflet
     # The generated subclass owns the explicit CRUD UI (render, show, the
     # create/edit form) AND the database calls (record.update, record.destroy!,
     # model_class.new) — so a developer can read and change anything. This base
-    # provides only reusable, non-DB helpers: model resolution, record loading,
+    # provides reusable helpers: model resolution, record loading,
     # field inference (resource_fields/display_fields/display_value), navigation
     # (render_index/render_show/refresh), dialog management, snackbars, and the
     # date/time picker value helpers.
@@ -88,9 +88,8 @@ module Ruflet
         model_class.respond_to?(:model_name) ? model_class.model_name.human.titleize : self.class.singular_title
       end
 
-      # Fields rendered on the detail (show) screen. The generated subclass
-      # overrides this with the scaffolded attributes; the default falls back to
-      # the model's own attribute names.
+      # Fields rendered on the detail (show) screen. The default uses the
+      # model's own attribute names; subclasses can override it.
       def resource_fields
         default_resource_fields
       end
@@ -105,7 +104,7 @@ module Ruflet
         record.public_send(field).to_s
       end
 
-      # --- Record loading & persistence --------------------------------------
+      # --- Record loading & navigation ---------------------------------------
 
       def records
         scope = model_class.respond_to?(:limit) ? model_class.limit(50) : model_class.all

data/lib/ruflet/rails/webview_app.rb

@@ -33,7 +33,7 @@ module Ruflet
     def webview_app(url:, appbar: nil, navigation_bar: nil, bottom_appbar: nil,
                     route: "/", prevent_links: nil, on_navigate: nil,
                     on_page_started: nil, on_page_ended: nil, **webview_props)
-      webview_args = { url: url, expand: true }
+      webview_args = { url: url, method: "get", expand: true }
       webview_args[:prevent_links] = prevent_links unless prevent_links.nil?
       webview_args[:on_url_change] = ->(event) { on_navigate.call(event.data) } if on_navigate
       webview_args[:on_page_started] = on_page_started if on_page_started

data/lib/ruflet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ruflet
-  VERSION = "0.0.12" unless const_defined?(:VERSION)
+  VERSION = "0.0.13" unless const_defined?(:VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruflet_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Adam Moussa Ali
@@ -29,42 +29,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.15
+        version: 0.0.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.15
+        version: 0.0.16
 - !ruby/object:Gem::Dependency
   name: ruflet_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.15
+        version: 0.0.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.15
+        version: 0.0.16
 - !ruby/object:Gem::Dependency
   name: ruflet_server
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.15
+        version: 0.0.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.15
+        version: 0.0.16
 description: Build cross-platform mobile and desktop apps with Ruby on Rails using
   Ruflet.
 email:
@@ -82,6 +82,7 @@ files:
 - lib/ruflet/rails/configuration.rb
 - lib/ruflet/rails/desktop_launcher.rb
 - lib/ruflet/rails/form_helpers.rb
+- lib/ruflet/rails/generator_hooks.rb
 - lib/ruflet/rails/install_support.rb
 - lib/ruflet/rails/native_app.rb
 - lib/ruflet/rails/protocol.rb
@@ -102,7 +103,8 @@ files:
 - lib/ruflet/version.rb
 - lib/ruflet_rails.rb
 homepage: https://github.com/AdamMusa/ruflet/tree/main/packages/ruflet_rails
-licenses: []
+licenses:
+- MIT
 metadata: {}
 rdoc_options: []
 require_paths: