svelte-on-rails 0.0.31 → 0.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2633f5ce568d2efa0e237ca750a61817a65824bd98ecc743c00b76230daf6c5c
-  data.tar.gz: 343f34a87f81e9a1e054993b8d4264acd3eb707c482ef74e1b86fab2ffe83282
+  metadata.gz: b437bee130ee620c17fd1874e37032e316f02e14bb6c90863534c9c3131776e3
+  data.tar.gz: bbfe5547994bfbd95b7e886c998aa233eb7c850114449bf0e34659e0c3bf2652
 SHA512:
-  metadata.gz: 53977d6319e3801b37bc89dcac688d9a2bbf59b3bd26c856b06eb187863ff5fa13920e8aa514949f00b17154df055d582ce6531b0688a1d3668bcd2509cb4c2d
-  data.tar.gz: b06e2417074271fd531a5d1b44e72522173c03ff90a43e3c3ffd0c21a50c80bb8aee524d70b3aa4fee279783c23b25cb5877121cba0f44ab42236f177ae157ed
+  metadata.gz: 52bb2bd60cf155cab50966649643c675c4584367b8a7de2c6179bd0355e48952a05f10e6a5c67d5bd4f151d303bbea69b26937c36d10dff28e6364c434f7ba9d
+  data.tar.gz: ab731d288b0b4e91c7d4df6f8935505e5c3e38799909112d5f3cc380924fa20e2f31787744c453111c7946b061d0499e7e0dee74411568f406aa475ee1005319

data/README.md

@@ -45,21 +45,40 @@ If you want to start from a new rails app, follow theese tutorials
 rails new my-test-app --skip-javascript
 ```
 
-within the app path do
+within the app add the gem
 
 ```bash
 bundle add svelte-on-rails
 ```
 
-and run the fat installer
+and run the installer
 
 ```bash
-rails svelte_on_rails:install_haml_vite
+rails g svelte_on_rails:install --full
 ```
 
-this installer guides you through and if you answer all with yes, 
-at the end, you just have to (re-) start your server
-and you will see a Svelte component!
+The `--full` contains:
+
+- `--vite` 
+  - adds vite_rails gem and running the installer
+- `--haml` 
+  - adds the gem and converts existing views
+- `svelte_on_rails` 
+  - This is not a option, this is always done: Adds a config file and installs `@csedl/svelte-on-rails` by npm
+- `--turbo` 
+  - installs `@hotwired/turbo-rails` and adds import statement to application.js
+- `--svelte` 
+  - adds or updates `svelte`
+- `--hello-world` 
+  - adds a hello world component
+
+You can also use the options you want instead of using `--full`
+
+The installer is written carefully: It does not overwrite a file without asking.
+It tells you all what he is doing.
+
+At the end, you just have to (re-) start your server
+and you will see a Svelte component.
 
 ## Minimal Installation
 
@@ -68,19 +87,11 @@ within the app folder
 ```bash
 bundle add svelte-on-rails
 ```
-```bash
-rails svelte_on_rails:install
-```
-
-This will create a little config file, installs the npm package,
-creates a initializer file and adds the import statement on `appplication.js` entrypoint file
 
-#### Minimal installer
-
-There is also a minimal installer:
+Run the installer
 
 ```bash
-rails svelte_on_rails:install
+rails g svelte_on_rails:install
 ```
 
 that does:
@@ -237,10 +248,26 @@ The folder `spec/installer_tests` is for testing the installer: This folder, mai
 before test. Tests there are starting by `rails new` followed
 by running the installer.
 
-NOTE: Theese tests rely on rvm and fixed to specific ruby versions, which 
-must be installed on your machine.
-If you are on a different ruby version manager and you want to contribute,
-PR are welcome.
+NOTE: Theese tests are running within your current ruby environment. If you want
+to test if a installer with a specific ruby version is running you must switch
+this by your development environment. And theese tests are killing all puma processes
+before and after run.
+
+Development helpers:
+
+```bash
+rake svelte_on_rails:create_test_app
+```
+
+This creates a new rails app within `spec/installer_tests` and runs the installer with `--full`.
+On the last line it shows you the path to the test app.
+Now you can cd into this folder and run `rails s`.
+
+```bash
+rake svelte_on_rails:replace_test_app_hello_world
+```
+
+Overwrites the hello world files within this test app from template.
 
 ## Licence
 

data/lib/generators/svelte_on_rails/install/install_generator.rb

@@ -0,0 +1,135 @@
+require "rails/generators"
+
+module SvelteOnRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :full, type: :boolean, default: false, desc: "Run full installation with additional setup"
+      class_option :vite, type: :boolean, default: false, desc: "Use Vite"
+      class_option :haml, type: :boolean, default: false, desc: "Use Haml"
+      class_option :turbo, type: :boolean, default: false, desc: "Use @hotwired/turbo-rails"
+      class_option :svelte, type: :boolean, default: false, desc: "Install Svelte"
+      class_option :hello_world, type: :boolean, default: false, desc: "Create Hello World component"
+
+      require 'svelte_on_rails/installer/utils'
+      require 'svelte_on_rails/installer/haml'
+      require_relative '../../../../spec/test_helpers'
+
+      def initialize(*args)
+        super
+        validate_raw_options!(args)
+        puts '-' * 80
+        puts 'STARTING SVELTE-ON-RAILS INSTALLATION'
+      end
+
+      def vite
+        return unless options[:full] || options[:vite]
+        vite_i = SvelteOnRails::Installer::Vite
+        vite_i.install_vite
+      end
+
+      def haml
+        return unless options[:full] || options[:haml]
+        haml_i = SvelteOnRails::Installer::Haml
+        haml_i.install_haml_and_convert
+      end
+
+      def svelte_on_rails
+        utils = SvelteOnRails::Installer::Utils
+        npm_i = SvelteOnRails::Installer::Npm
+        utils.write_templates(['config/svelte_on_rails.yml'])
+        npm_i.install_or_update_package('@csedl/svelte-on-rails')
+        # insert_initializer
+        uts = SvelteOnRails::Installer::Utils
+        uts.write_templates(['app/frontend/initializers/svelte.js'])
+        # add import statements
+        js_i = SvelteOnRails::Installer::Javascript
+        init_stat = '../initializers/svelte.js'
+        js_i.append_import_statement(application_js_path, init_stat, "import '#{init_stat}';")
+      end
+
+      def turbo
+        return unless options[:full] || options[:turbo]
+
+        puts '-' * 80
+        npm_i = SvelteOnRails::Installer::Npm
+        tr_pkg = '@hotwired/turbo-rails'
+        npm_i.install_or_update_package(tr_pkg)
+        js_i = SvelteOnRails::Installer::Javascript
+        js_i.append_import_statement(application_js_path, tr_pkg, "import '#{tr_pkg}';")
+
+      end
+
+      def svelte
+        return unless options[:svelte] || options[:full]
+
+        puts '-' * 80
+        svelte_i = SvelteOnRails::Installer::Svelte
+        svelte_i.install_svelte
+      end
+
+      def hello_world
+        return unless options[:hello_world] || options[:full]
+
+        puts '-' * 80
+
+        hw_i = SvelteOnRails::Installer::HelloWorld
+        @hello_world_path = hw_i.install_hello_world(HELLO_WORLD_FILES)
+      end
+
+      def finish
+        puts '-' * 80
+        puts 'FINISHED SVELTE INSTALLATION'
+        puts '-' * 80
+
+        puts "SvelteOnRails installed successfully!"
+        puts "Restart the server and check if it all works."
+        if @hello_world_path
+          puts "You can now access the Hello World component on: http://localhost:your-port-number#{@hello_world_path}."
+        end
+        puts "Happy coding!"
+      end
+
+      HELLO_WORLD_FILES = %w[
+          app/controllers/svelte_on_rails_hello_world_controller.rb
+          app/views/svelte_on_rails_hello_world/index.haml
+          app/frontend/javascript/components/SvelteOnRailsHelloWorld.svelte
+          app/frontend/javascript/components/Pug.svelte
+          app/frontend/javascript/components/sub/NestedComponent.svelte
+          app/frontend/javascript/nestedJavascript.js
+          app/frontend/javascript/nestedJavascriptToggled.js
+          app/frontend/javascript/components/sub/NestedComponent.svelte
+          app/frontend/images/svg.svg
+          app/frontend/images/check-circle-green.png
+      ]
+
+      private
+
+      def toggle_hello_world_files
+        %w[
+          app/frontend/images/svg.svg
+          app/frontend/images/atom.svg
+          app/frontend/javascript/nestedJavascript.js
+          app/frontend/javascript/nestedJavascriptToggled.js
+        ]
+      end
+
+      def validate_raw_options!(args)
+        # Get option names from class_options, excluding inherited Thor/Rails options
+        valid_options = self.class.class_options.keys.map { |opt| "--#{opt.to_s.tr('_', '-')}" }
+        rails_internal_options = %w[--skip-namespace --skip-collision-check --pretend --quiet --force]
+        options_array = args.find { |arg| arg.is_a?(Array) && arg.any? { |a| a.start_with?('--') } } || []
+        passed_options = options_array.select { |arg| arg.start_with?('--') }
+        unknown_options = passed_options - valid_options - rails_internal_options
+        unless unknown_options.empty?
+          valid_display = valid_options.map { |opt| opt.gsub(/^--/, '') }.join(', ')
+          raise Thor::Error, "Unknown options: #{unknown_options.join(', ')}. Valid options are: #{valid_display}\nNothing done."
+        end
+      end
+
+      def application_js_path
+        Rails.root.join("app", "frontend", "entrypoints", "application.js")
+      end
+    end
+  end
+end

data/lib/svelte-on-rails.rb

@@ -16,6 +16,8 @@ require 'svelte_on_rails/installer/npm'
 require 'svelte_on_rails/installer/javascript'
 require 'svelte_on_rails/installer/hello_world'
 
+require 'generators/svelte_on_rails/install/install_generator'
+
 module SvelteOnRails
   class << self
     def configuration
@@ -23,4 +25,26 @@ module SvelteOnRails
     end
 
   end
+
+  def self.run_install_task
+    # Ensure Rake tasks are loaded
+    Rake::Task.define_task(:environment) # Define a dummy environment task (if needed)
+    load File.expand_path('../rakefile', __FILE__) # Load the gem's Rakefile
+
+    # Invoke the task
+    Rake::Task['svelte_on_rails:create_test_app'].invoke
+  rescue StandardError => e
+    puts "Error running create_test_app task: #{e.message}"
+  end
+
+  def self.run_replace_hello_world_task
+    # Ensure Rake tasks are loaded
+    Rake::Task.define_task(:environment) # Define a dummy environment task (if needed)
+    load File.expand_path('../rakefile', __FILE__) # Load the gem's Rakefile
+
+    # Invoke the task
+    Rake::Task['svelte_on_rails:replace_test_app_hello_world'].invoke
+  rescue StandardError => e
+    puts "Error running replace_test_app_hello_world task: #{e.message}"
+  end
 end

data/lib/svelte_on_rails/compiler/compiler.rb

@@ -101,17 +101,17 @@ module SvelteOnRails
     end
 
     def self.reset_and_compile_all
-      SvelteOnRails::RenderServerSide.reset_dist
+      reset_dist
       cnf = SvelteOnRails::Configuration.instance
       frontend_folder = cnf.frontend_folder_full
-      sveltes = Dir.glob(cnf.frontend_folder_full.join('**/*.svelte'))
-      sveltes.each_with_index do |file, ind|
+      files = Dir.glob(cnf.frontend_folder_full.join('**/*.svelte'))
+      files.each_with_index do |file, ind|
         comp_name = file.to_s[(cnf.frontend_folder_full.to_s.length + 1)..-1]
 
-        n = SvelteOnRails::RenderServerSide.new(comp_name, base_path: frontend_folder)
+        n = SvelteOnRails::Compiler.new(comp_name, base_path: frontend_folder)
         n.compile
 
-        puts "compiled #{ind + 1}/#{sveltes.length}: #{comp_name}"
+        puts "compiled #{ind + 1}/#{files.length}: #{comp_name}"
 
       end
     end

data/lib/svelte_on_rails/configuration.rb

@@ -29,8 +29,8 @@ module SvelteOnRails
       end
     end
 
-    def rails_root
-      Rails.root
+    def rails_root(root_url = nil)
+      root_url || Rails.root
     end
 
     def frontend_folder
@@ -58,8 +58,8 @@ module SvelteOnRails
       end
     end
 
-    def dist_folder
-      rails_root.join('public', 'svelteDist')
+    def dist_folder(app_root = nil)
+      rails_root(app_root).join('public', 'svelteDist')
     end
 
     def system_type
@@ -69,8 +69,12 @@ module SvelteOnRails
     private
 
     def load_yaml_config
-      config_path = Rails.root.join("config", "svelte_on_rails.yml")
-      return unless File.exist?(config_path)
+      begin
+        config_path = Rails.root.join("config", "svelte_on_rails.yml")
+        return unless File.exist?(config_path)
+      rescue
+        return
+      end
 
       config_data = YAML.load_file(config_path)
 

data/lib/svelte_on_rails/installer/hello_world.rb

@@ -2,20 +2,20 @@ module SvelteOnRails
   module Installer
     module HelloWorld
 
-      def self.install_hello_world(files)
+      def self.install_hello_world(files, force: false, app_root: nil)
 
         utils_i = SvelteOnRails::Installer::Utils
 
         # write templates
 
 
-        utils_i.write_templates(files)
+        utils_i.write_templates(files, ask_for_overwrite: !force, app_root: app_root)
 
 
         # route
 
         route = 'svelte_on_rails_hello_world#index'
-        rr = utils_i.which_root_route
+        rr = utils_i.which_root_route(app_root)
         root_url = "/"
         url = root_url + route.sub('#', '/')
 

data/lib/svelte_on_rails/installer/utils.rb

@@ -171,10 +171,11 @@ module SvelteOnRails
         end
       end
 
-      def self.write_templates(template_paths, ask_for_overwrite: true)
+      def self.write_templates(template_paths, ask_for_overwrite: true, app_root: nil)
 
-        existing = template_paths.select { |p| File.exist?(p) }
-        verb = 'Created'
+        a_root = app_root_path(app_root)
+
+        existing = template_paths.select { |p| File.exist?(a_root.join(p)) }
 
         if existing.present? && ask_for_overwrite
           begin
@@ -185,16 +186,20 @@ module SvelteOnRails
             puts "Skipping write #{'template'.pluralize(template_paths.length)}."
             return
           end
-          verb = 'Overwrote'
         end
 
         template_paths.each do |p|
           source_path = File.expand_path('rails_template', __dir__) + '/' + p
-          FileUtils.mkdir_p(File.dirname(p))
-          FileUtils.cp(source_path, p)
+
+          dest_path = a_root.join(p)
+          v = (File.exist?(dest_path) ? 'replaced' : 'created')
+
+          FileUtils.mkdir_p(File.dirname(a_root.join(p)))
+          FileUtils.cp(source_path, a_root.join(p))
+
+          puts "#{v}: #{p}"
         end
 
-        puts "#{verb} #{'file'.pluralize(template_paths.length)}:\n#{template_paths.join("\n")}"
       end
 
       def self.ask_yn(question)
@@ -205,11 +210,11 @@ module SvelteOnRails
         continue == 'y'
       end
 
-      def self.which_root_route
+      def self.which_root_route(app_root = nil)
 
         # Check if the root route is active (uncommented) or commented out
 
-        routes = File.read(Rails.root.join('config', 'routes.rb'))
+        routes = File.read(app_root_path(app_root).join('config', 'routes.rb'))
         m = routes.match(/^\s*root\s+['"]([^'"]+)['"]/m)
         if m
           m.to_s.match(/^\s*root\s*['"]([^'"]*)['"]/)[1]
@@ -311,18 +316,31 @@ module SvelteOnRails
         if found_lines.present? && utils.ask_yn("Remove lines\n  • #{found_lines.join("\n  • ")}\n from #{file_path}?")
           # Write the modified content back to the file
           begin
-            File.write(file_path, modified_content.map{|l|l.gsub(/\n/, '')}.join("\n"))
+            File.write(file_path, modified_content.map { |l| l.gsub(/\n/, '') }.join("\n"))
             puts "Successfully removed #{found_lines.length} #{'line'.pluralize(found_lines.length)}."
           rescue => e
             raise "Error writing to #{file_path} => «#{e.message}»"
           end
         else
 
-
         end
 
       end
 
+      def self.app_root_path(app_root = nil)
+        if app_root
+          raise "ERROR: app_root must be class Pathname" unless app_root.is_a?(Pathname)
+          app_root
+        else
+          begin
+            Dir.exist?(Rails.root.join('app'))
+            Rails.root
+          rescue => e
+            raise "ERROR: Could not find Rails.root => #{e}"
+          end
+        end
+      end
+
     end
   end
 end

data/lib/tasks/svelte_on_rails_tasks.rake

@@ -1,107 +1,20 @@
-Rake::Task["assets:precompile"].enhance do
-  SvelteOnRails::RenderServerSide.reset_and_compile_all
-  puts "Mount Svelte: Reset dist and compile-all executed"
+if defined?(Rails)
+  Rake::Task["assets:precompile"].enhance do
+    puts '-'*80
+    SvelteOnRails::Compiler.reset_and_compile_all
+    puts "Svelte on Rails: Reset dist and compile-all executed"
+    puts '-'*80
+  end
 end
 
-require 'svelte_on_rails/installer/utils'
-require 'svelte_on_rails/installer/haml'
-utils = SvelteOnRails::Installer::Utils
-npm_i = SvelteOnRails::Installer::Npm
-application_js_path = Rails.root.join("app", "frontend", "entrypoints", "application.js")
-toggle_hello_world_files = %w[
-          app/frontend/images/svg.svg
-          app/frontend/images/atom.svg
-          app/frontend/javascript/nestedJavascript.js
-          app/frontend/javascript/nestedJavascriptToggled.js
-        ]
-hello_world_files = %w[
-          app/controllers/svelte_on_rails_hello_world_controller.rb
-          app/views/svelte_on_rails_hello_world/index.haml
-          app/frontend/javascript/components/SvelteOnRailsHelloWorld.svelte
-          app/frontend/javascript/components/Pug.svelte
-          app/frontend/javascript/components/sub/NestedComponent.svelte
-          app/frontend/javascript/nestedJavascript.js
-          app/frontend/javascript/nestedJavascriptToggled.js
-          app/frontend/javascript/components/sub/NestedComponent.svelte
-          app/frontend/images/svg.svg
-          app/frontend/images/check-circle-green.png
-        ]
-
-namespace :svelte_on_rails do
-
-  desc "Installs SvelteOnRails for usage together with vite_rails, haml and @hotwired/turbo-rails"
-  task :install_haml_vite => :environment do
-
-    puts '-' * 80
-    puts 'STARTING SVELTE-ON-RAILS INSTALLATION'
-
-    # vite
-
-    vite_i = SvelteOnRails::Installer::Vite
-    vite_i.install_vite
-
-    # haml
-
-    haml_i = SvelteOnRails::Installer::Haml
-    haml_i.install_haml_and_convert
 
-    # svelte_on_rails
+require_relative '../../spec/test_helpers'
+require_relative '../../lib/svelte_on_rails/installer/hello_world'
+require_relative '../../lib/generators/svelte_on_rails/install/install_generator'
 
-    utils.write_templates(['config/svelte_on_rails.yml'])
-    npm_i.install_or_update_package('@csedl/svelte-on-rails')
-    # insert_initializer
-    uts = SvelteOnRails::Installer::Utils
-    uts.write_templates(['app/frontend/initializers/svelte.js'])
-    # add import statements
-    js_i = SvelteOnRails::Installer::Javascript
-    init_stat = '../initializers/svelte.js'
-    js_i.append_import_statement(application_js_path, init_stat, "import '#{init_stat}';")
 
-    # turbo
 
-    tr_pkg = '@hotwired/turbo-rails'
-
-    npm_i.install_or_update_package(tr_pkg)
-
-    js_i = SvelteOnRails::Installer::Javascript
-    js_i.append_import_statement(application_js_path, tr_pkg, "import '#{tr_pkg}';")
-
-    # svelte
-
-    svelte_i = SvelteOnRails::Installer::Svelte
-    svelte_i.install_svelte
-
-    # Hello World
-
-    puts '-' * 80
-
-    hw_i = SvelteOnRails::Installer::HelloWorld
-    hello_world_path = hw_i.install_hello_world(hello_world_files)
-
-    # finish
-
-    puts '-' * 80
-    puts 'FINISHED SVELTE INSTALLATION'
-    puts '-' * 80
-
-    puts "SvelteOnRails installed successfully!"
-    puts "Restart the server and check if it all works."
-    if hello_world_path
-      puts "You can now access the Hello World component on: http://localhost:your-port-number#{hello_world_path}."
-    end
-    puts "Happy coding!"
-
-  end
-
-  desc "Installs SvelteOnRails YAML configuration into your Rails application"
-  task :install do
-
-    # svelte_on_rails
-
-    utils.write_templates(['config/svelte_on_rails.yml'])
-    npm_i.install_or_update_package('@csedl/svelte-on-rails')
-
-  end
+namespace :svelte_on_rails do
 
   desc "Removes the Hello World component"
   task :remove_hello_world do
@@ -156,7 +69,36 @@ namespace :svelte_on_rails do
 
   desc "Compile all Svelte components"
   task :reset_and_compile_all do
-    SvelteOnRails::RenderServerSide.reset_and_compile_all
+    #SvelteOnRails::RenderServerSide.reset_and_compile_all
+  end
+
+  desc "Build test app within spec/installer_tests"
+  task :create_test_app do
+    TestHelpers.cleanup_rails_app
+    TestHelpers.create_rails_app
+    TestHelpers.gem_setup("rails g svelte_on_rails:install --full")
+    puts '-'*80
+    puts "Built test app successfully!"
+    puts "You can now run the server by:"
+    puts "$ cd #{TestHelpers.installer_test_app_path} && rails s"
+  end
+
+  desc "Build test app within spec/installer_tests"
+  task :replace_test_app_hello_world do
+    #require_relative '../../lib/svelte_on_rails/lib/utils'
+    require_relative '../../spec/test_helpers'
+    th = TestHelpers
+    puts '-'*80
+    hw_i = SvelteOnRails::Installer::HelloWorld
+    #utils = SvelteOnRails::Lib::Utils
+    @hello_world_path = hw_i.install_hello_world(
+      SvelteOnRails::Generators::InstallGenerator::HELLO_WORLD_FILES,
+      app_root: th.installer_test_app_path,
+      force: true,
+    )
+
+    puts '-'*80
+    puts "replaced Hello World component with new one"
   end
 
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: svelte-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.31
+  version: 0.0.32
 platform: ruby
 authors:
 - Christian Sedlmair
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,13 +23,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-description:
 email: christian@sedlmair.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/generators/svelte_on_rails/install/install_generator.rb
 - lib/svelte-on-rails.rb
 - lib/svelte_on_rails/compiler/compile.js
 - lib/svelte_on_rails/compiler/compiler.rb
@@ -72,7 +71,6 @@ metadata:
   source_code_uri: https://gitlab.com/sedl/svelte-on-rails
   changelog_uri: https://gitlab.com/sedl/svelte-on-rails
   post_install: ruby -r svelte_on_rails/install -e 'SvelteOnRails::Install.run'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Seamlessly integrate Svelte Components into Rails views.
 test_files: []