hotwire_native_rails 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db9feb69df016d6781d12df5d095422b9984afe20e0128add4ec5db096bc9232
-  data.tar.gz: ae82da4ac986d04d552d47207b7c93dc75fea6cde2e38944f8b9926997d89b3e
+  metadata.gz: 84432c1688ed077b1d915d0db3a714598008c8811ed3d1147b2e4e38f668a1ea
+  data.tar.gz: 8ca34b0820ce17f62fd23bc7dd17df3035b8a644831f1f3dcdaf6fb8dff3bcfa
 SHA512:
-  metadata.gz: 18302cf1e8af968d95a23685db7d7020375060bc7a22b628b146d3596791fcdd18409f818d04456594b030d2ab40bc98f90b4d6c1d08fd3108448929155c16f8
-  data.tar.gz: 1385c781224c90744b7eeea4b7fa5690524768cd5fc21db85085ac1725b42ae0f901bc433a80082771ba88e1ca04f1a1c8918dbbcf692e87f82d015cc48a9bfb
+  metadata.gz: f403700954894cda1a7ecb3f4e3011d103523fb0959734e0bd12c499bcc02c877bf60d9ac8f610551f56bef255328bfe50632820609711c8f58688dd53547a4e
+  data.tar.gz: 23765b7fd268eb314bbbab24c23088380225b3be6f6c6ce41aae76e8e071fadb6a8b8b1904114ead1e37cca090e0e458d020706d7373a6a14c306d77ed705b37

data/README.md

@@ -18,15 +18,17 @@ rails g hotwire_native
 
 ## Usage
 
+Recommended to use with [my fork of iOS Hotwire Native starter app](https://github.com/yshmarov/hotwire-native-ios/tree/superails-extensions-2/Demo).
+
 #### Helpers
 - `viewport_meta_tag` - forbid zooming on mobile/native
 - use `data: { turbo_action: replace_if_native }` to submit authentication forms & forms in modals
 - `:mobile` request variant. `index.html+mobile.erb`
 - override link_to to not open internal links in in-app browser on native app
-- conditionally override page title for native apps
+- conditionally override page `<title>` for native apps
 
 #### CSS
-- `turbo-native:` css variant (works with CSS and Tailwind)
+- `hotwire-native:` css variant (works with CSS and Tailwind)
 
 #### Bridge Components
 - install Hotwire Native Bridge (works with Importmaps and Node)
@@ -39,6 +41,12 @@ rails g hotwire_native
 
 ## Development
 
+Run the local version of the gem:
+
+```ruby
+gem 'hotwire_native_rails', path: '/Users/yaroslavshmarov/Documents/GitHub.nosync/hotwire_native_rails'
+```
+
 Make a release to rubygems:
 
 ```sh

data/hotwire_native_rails.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) || f.end_with?('.gem') }
   end
 end

data/lib/generators/hotwire_native/hotwire_native_generator.rb

@@ -9,11 +9,13 @@ class HotwireNativeGenerator < Rails::Generators::Base
     # helpers
     copy_file "helpers/hotwire_native_helper.rb", "app/helpers/hotwire_native_helper.rb"
     copy_file "test_unit/hotwire_native_helper_test.rb", "test/helpers/hotwire_native_helper_test.rb"
+    copy_file "test_unit/hotwire_native_controller_test.rb", "test/controllers/hotwire_native_controller_test.rb"
 
     # routes
     copy_file "routes/hotwire_native.rb", "config/routes/hotwire_native.rb"
-    copy_file "controllers/hotwire_native/v1/android/path_configuration_controller.rb", "app/controllers/hotwire_native/v1/android/path_configuration_controller.rb"
-    copy_file "controllers/hotwire_native/v1/ios/path_configuration_controller.rb", "app/controllers/hotwire_native/v1/ios/path_configuration_controller.rb"
+    copy_file "controllers/hotwire_native/v1/android/path_configurations_controller.rb", "app/controllers/hotwire_native/v1/android/path_configurations_controller.rb"
+    copy_file "controllers/hotwire_native/v1/ios/path_configurations_controller.rb", "app/controllers/hotwire_native/v1/ios/path_configurations_controller.rb"
+    copy_file "test_unit/path_configurations_controller_test.rb", "test/controllers/path_configurations_controller_test.rb"
 
     # :native request variant
     copy_file "controllers/concerns/device_format.rb", "app/controllers/concerns/device_format.rb"
@@ -21,7 +23,7 @@ class HotwireNativeGenerator < Rails::Generators::Base
 
   def add_detect_device_to_application_controller
     inject_into_file "app/controllers/application_controller.rb", after: "class ApplicationController < ActionController::Base\n" do
-      "  include DetectDevice\n"
+      "  include DeviceFormat\n"
     end
   end
 
@@ -48,7 +50,7 @@ class HotwireNativeGenerator < Rails::Generators::Base
   def add_css_variants
     return add_tailwind_css_variants if tailwind?
 
-    add_turbo_native_css
+    add_hotwire_native_css
   end
 
   def add_platform_identifier
@@ -73,8 +75,8 @@ class HotwireNativeGenerator < Rails::Generators::Base
     Rails.root.join("config/tailwind.config.js").exist?
   end
 
-  # class="turbo-native:hidden"
-  # class="non-turbo-native:hidden"
+  # class="hotwire-native:hidden"
+  # class="non-hotwire-native:hidden"
   def add_tailwind_css_variants
     prepend_to_file "config/tailwind.config.js", "const plugin = require('tailwindcss/plugin')\n"
 
@@ -82,21 +84,21 @@ class HotwireNativeGenerator < Rails::Generators::Base
       <<-JS
 
   plugin(function({ addVariant }) {
-    addVariant("turbo-native", "html[data-turbo-native] &"),
-    addVariant("non-turbo-native", "html:not([data-turbo-native]) &")
+    addVariant("hotwire-native", "html[data-hotwire-native] &"),
+    addVariant("non-hotwire-native", "html:not([data-hotwire-native]) &")
   }),
       JS
     end
   end
 
-  # class="turbo-native:hidden"
-  def add_turbo_native_css
-    gsub_file "app/views/layouts/application.html.erb", "<body>", "<body class=\"<%= \"turbo-native\" if turbo_native_app? %>\">"
+  # class="hotwire-native:hidden"
+  def add_hotwire_native_css
+    gsub_file "app/views/layouts/application.html.erb", "<body>", "<body class=\"<%= \"hotwire-native\" if turbo_native_app? %>\">"
 
     append_to_file "app/assets/stylesheets/application.css" do
       <<-CSS
 
-body.turbo-native .turbo-native:hidden {
+body.hotwire-native .hotwire-native:hidden {
   display: none;
 }
       CSS

data/lib/generators/hotwire_native/templates/controllers/concerns/device_format.rb

@@ -8,6 +8,6 @@ module DeviceFormat
   private
 
   def set_variant
-    return request.variant = :mobile if turbo_native_app? || browser.device.mobile?
+    request.variant = :mobile if turbo_native_app? || browser.device.mobile?
   end
 end

data/lib/generators/hotwire_native/templates/helpers/hotwire_native_helper.rb

@@ -6,11 +6,11 @@ module HotwireNativeHelper
   # after
   # <title><%= page_title %></title>
   # usage
-  # <% content_for :turbo_native_title, "Sign in" %>
+  # <% content_for :hotwire_native_title, "Sign in" %>
   # <% content_for :title, "Sign in | My App" %>
   def page_title
     if turbo_native_app?
-      content_for(:turbo_native_title) || content_for(:title) || Rails.application.class.module_parent.name
+      content_for(:hotwire_native_title) || content_for(:title) || Rails.application.class.module_parent.name
     else
       content_for(:title) || Rails.application.class.module_parent.name
     end
@@ -25,7 +25,7 @@ module HotwireNativeHelper
 
   # set on <html> tag
   def platform_identifier
-    'data-turbo-native' if turbo_native_app?
+    'data-hotwire-native' if turbo_native_app?
   end
 
   # link_to 'Next', next_path, data: { turbo_action: replace_if_native }
@@ -37,37 +37,37 @@ module HotwireNativeHelper
   end
 
   # override link_to to not open internal links in in-app browser on native app
-  def link_to(name = nil, options = nil, html_options = {}, &block)
+  def link_to(name = nil, options = nil, html_options = {}, &)
     html_options[:target] = '' if turbo_native_app? && internal_url?(url_for(options))
-    super(name, options, html_options, &block)
+    super
   end
 
   # https://github.com/joemasilotti/daily-log/blob/main/rails/app/helpers/form_helper.rb
   class BridgeFormBuilder < ActionView::Helpers::FormBuilder
     def submit(value = nil, options = {})
       options[:data] ||= {}
-      options["data-bridge--form-target"] = "submit"
-      options[:class] = [options[:class], "turbo-native:hidden"].compact
-      super(value, options)
+      options['data-bridge--form-target'] = 'submit'
+      options[:class] = [options[:class], 'hotwire-native:hidden'].compact
+      super
     end
   end
 
-  def bridge_form_with(*, **options, &block)
+  def bridge_form_with(*, **options, &)
     options[:html] ||= {}
     options[:html][:data] ||= {}
     options[:html][:data] = options[:html][:data].merge(bridge_form_data)
 
     options[:builder] = BridgeFormBuilder
 
-    form_with(*, **options, &block)
+    form_with(*, **options, &)
   end
 
   private
 
   def bridge_form_data
     {
-      controller: "bridge--form",
-      action: "turbo:submit-start->bridge--form#submitStart turbo:submit-end->bridge--form#submitEnd"
+      controller: 'bridge--form',
+      action: 'turbo:submit-start->bridge--form#submitStart turbo:submit-end->bridge--form#submitEnd'
     }
   end
 

data/lib/generators/hotwire_native/templates/test_unit/hotwire_native_controller_test.rb

@@ -0,0 +1,15 @@
+require "test_helper"
+
+class HotwireNativeTest < ActionDispatch::IntegrationTest
+  test 'zoom is disabled for native' do
+    get root_path, headers: { HTTP_USER_AGENT: 'Hotwire Native' }
+    assert_response :success
+    assert_match(/user-scalable=0/, response.body)
+  end
+
+  test 'zoom is enabled for web' do
+    get root_path
+    assert_response :success
+    assert_no_match(/user-scalable=0/, response.body)
+  end
+end

data/lib/generators/hotwire_native/templates/test_unit/hotwire_native_helper_test.rb

@@ -1,54 +1,53 @@
 require 'test_helper'
 
 class HotwireNativeHelperTest < ActionView::TestCase
-  # add more tests
   setup do
     def root_url
-      "http://test.host/"
-    end    
+      'http://test.host/'
+    end
   end
 
-  test "link_to removes target for internal links in turbo native app" do
+  test 'link_to removes target for internal links in turbo native app' do
     def turbo_native_app?
       true
     end
 
-    result = link_to("Home", "/foo/bar", target: "_blank")
-    assert_no_match /target="_blank"/, result
+    result = link_to('Home', '/foo/bar', target: '_blank', rel: 'noopener')
+    assert_no_match(/target="_blank"/, result)
   end
 
-  test "link_to keeps target for external links in turbo native app" do
+  test 'link_to keeps target for external links in turbo native app' do
     def turbo_native_app?
       true
     end
-    
-    result = link_to("External", "http://external.com", target: "_blank")
-    assert_match /target="_blank"/, result
+
+    result = link_to('External', 'http://external.com', target: '_blank', rel: 'noopener')
+    assert_match(/target="_blank"/, result)
   end
 
-  test "link_to keeps target for internal links when not in turbo native app" do
+  test 'link_to keeps target for internal links when not in turbo native app' do
     def turbo_native_app?
       false
     end
-    
-    result = link_to("Home", root_url, target: "_blank")
-    assert_match /target="_blank"/, result
+
+    result = link_to('Home', root_url, target: '_blank', rel: 'noopener')
+    assert_match(/target="_blank"/, result)
   end
 
-  test "link_to keeps target for external links when not in turbo native app" do
+  test 'link_to keeps target for external links when not in turbo native app' do
     def turbo_native_app?
       false
     end
 
-    result = link_to("External", "http://external.com", target: "_blank")
-    assert_match /target="_blank"/, result
+    result = link_to('External', 'http://external.com', target: '_blank', rel: 'noopener')
+    assert_match(/target="_blank"/, result)
   end
 
-  test "internal_url? returns true for internal links" do
-    assert internal_url?("http://test.host/some_path")
+  test 'internal_url? returns true for internal links' do
+    assert internal_url?('http://test.host/some_path')
   end
 
-  test "internal_url? returns false for external links" do
-    assert_not internal_url?("http://external.com")
+  test 'internal_url? returns false for external links' do
+    assert_not internal_url?('http://external.com')
   end
-end
+end

data/lib/generators/hotwire_native/templates/test_unit/path_configurations_controller_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+class PathConfigurationsControllerTest < ActionDispatch::IntegrationTest
+  test 'android' do
+    get '/hotwire_native/v1/android/path_configuration'
+    assert_response :success
+  end
+
+  test 'ios' do
+    get '/hotwire_native/v1/ios/path_configuration'
+    assert_response :success
+  end
+end

data/lib/hotwire_native_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HotwireNativeRails
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire_native_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Yaro Shm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-30 00:00:00.000000000 Z
+date: 2024-12-15 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -29,8 +29,8 @@ files:
 - hotwire_native_rails.gemspec
 - lib/generators/hotwire_native/hotwire_native_generator.rb
 - lib/generators/hotwire_native/templates/controllers/concerns/device_format.rb
-- lib/generators/hotwire_native/templates/controllers/hotwire_native/v1/android/path_configuration_controller.rb
-- lib/generators/hotwire_native/templates/controllers/hotwire_native/v1/ios/path_configuration_controller.rb
+- lib/generators/hotwire_native/templates/controllers/hotwire_native/v1/android/path_configurations_controller.rb
+- lib/generators/hotwire_native/templates/controllers/hotwire_native/v1/ios/path_configurations_controller.rb
 - lib/generators/hotwire_native/templates/helpers/hotwire_native_helper.rb
 - lib/generators/hotwire_native/templates/javascript/controllers/bridge/button_controller.js
 - lib/generators/hotwire_native/templates/javascript/controllers/bridge/form_controller.js
@@ -39,7 +39,9 @@ files:
 - lib/generators/hotwire_native/templates/javascript/controllers/bridge/overflow_menu_controller.js
 - lib/generators/hotwire_native/templates/javascript/controllers/bridge/review_prompt_controller.js
 - lib/generators/hotwire_native/templates/routes/hotwire_native.rb
+- lib/generators/hotwire_native/templates/test_unit/hotwire_native_controller_test.rb
 - lib/generators/hotwire_native/templates/test_unit/hotwire_native_helper_test.rb
+- lib/generators/hotwire_native/templates/test_unit/path_configurations_controller_test.rb
 - lib/hotwire_native_rails.rb
 - lib/hotwire_native_rails/version.rb
 homepage: https://github.com/yshmarov/hotwire_native_rails