svelte-on-rails 0.0.34 → 0.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fdbb3868bbac50f65971957df0748db4c578fc317bab77065e64155b5d9c2d9
-  data.tar.gz: b30194ddee3daf2742d1d21e3d63ca835ff60123f6514dade9c5b6d930e0bc82
+  metadata.gz: 40380d23e1e5115506e76b3a03f7024ffe7817d28ef2ea807c555ef565547cb2
+  data.tar.gz: 8e20a2c5620788b190b43c5f0d072af21c0d96573dce9e5d15217d7027f65598
 SHA512:
-  metadata.gz: dbf57486fba0f80bb50077243d7781b3d4ea3e21adf8c98dd54a6df7e71c416db846072e515c85296652db815d8b0423c528491ec5560edd998bdd614d28ad76
-  data.tar.gz: 9db84e5d1ad4f60cc0a9bb1e5c69c81f40a1c2466fc67f4f27faa8a53148f66f2cfe5636884960573db1e8f99d8d4e8223fe3534f1083d0297732970b4172df1
+  metadata.gz: a0f10a0d977358a4a709882ae662ea9b53d0892ec89c2068b37aecd5648b534f759f9ea5279103bd736bc297dac8988441eee4739ce81d7386c58db046a73208
+  data.tar.gz: 62c4f47cd06a2d7ce3172b5829468847b328a7381f81db5219ddc24389f17660a49f4b026cdd8fcff46a608e36aa1e74f27ee97be7239476302c5d52da913173

data/README.md

@@ -72,7 +72,14 @@ The `--full` contains:
 - `--hello-world` 
   - adds a hello world component
 
-You can also use the options you want instead of using `--full`
+You can also use the options you want instead of using `--full`.
+And there is the option `--force` that would not ask you whether it should overwrite existing files, for automated processes like testing.
+
+This means, if you want all, except haml, you can run:
+
+```bash
+rails g svelte_on_rails:install --vite --turbo --svelte --hello-world --force
+```
 
 The installer is written carefully: It does not overwrite a file without asking.
 It tells you all what he is doing.
@@ -90,13 +97,7 @@ and start coding.
 
 ## Minimal Installation
 
-within the app folder
-
-```bash
-bundle add svelte-on-rails
-```
-
-Run the installer
+For example, within a existing app, add the gem and run the installer without any options
 
 ```bash
 rails g svelte_on_rails:install
@@ -230,11 +231,14 @@ rails svelte_on_rails:add_hello_world
 rails svelte_on_rails:remove_hello_world
 ```
 
-```bash
-rails svelte_on_rails:toggle_hello_world_svg
-```
+[//]: # (```bash)
+
+[//]: # (rails svelte_on_rails:toggle_hello_world_svg)
+
+[//]: # (```)
 
-toggles the svg nested to the hello world component for check if thee svg is refreshed when imported image changes
+[//]: # ()
+[//]: # (toggles the svg nested to the hello world component for check if thee svg is refreshed when imported image changes)
 
 ```bash
 rails svelte_on_rails:reset_and_compile_all
@@ -257,53 +261,37 @@ Example from the rails console for a medium complex component
   - => subsequent calls
 - Completed 200 OK in 521ms (Views: 520.2ms | ActiveRecord: 0.0ms (0 queries, 0 cached) | GC: 0.3ms)
 
-## Testing
+## Developers Guide
 
-Testings are within the gem by `rspec`. Mainly there are 2 types of tests:
+Tests are based on the included templates, like the `hello world template` and on the installer.
 
-**compiler tests**
+On the gem folder you can put a file `generated_test_app_path`, and put the path for a existing
+folder where the tests generate a test rails app.
 
-The folder `spec/rails_vite_test_app` holds a package.json 
-with the `@csedl/svelte-on-rails` package, mainly because of the 
-peer dependencies necessary for ssr tests, and some example components.
-This is mainly for testing the compiler.
+**Installer tests** starting with completely destroy the rails app within the `generated_test_app_path`,
+generating a new rails app and running the installer and test by `playwright` if the components are working.
 
-**Fully complete tests**
- 
-The folder `spec/installer_tests`, mainly, is emptied
-before test. Tests there are starting by `rails new` followed
-by running the installer.
+**component tests** only checking if a rails server is alive, and if not, install and run a rails app. 
+For this is the testing helper `start_rails_server_unless_ping`. This step may only be slow on the 
+first run, then it is fast. And on every repeating the test it always overwrites the components
+with the components from the template by the testing helper `install_hello_world(
+      ['rails_vite_hello_world'],
+      app_root: generated_rails_app_root,
+      force: true,
+      silent: true
+      )`. At the end of the test it leaves the rails server running.
 
+On that way a developer can just edit the templates and run a test and see always the refreshed 
+content on the browser and on the app within the `generated_test_app_path`.
+  
 NOTE: Theese tests are dependend on your environment, including the running ruby version!
-I am woring on `rvm` If you work on a different environment, tests may have to be adopted.
+I am working on rvm. If you work on a different environment, some (not many) changes may be necessary.
+Thats your part :)
 
 The current test cases including (among others):
 
-- create a completely new rails app, running the full installer and check if a `hello World` component is visible and javascript is working.
-- run `assets:precompile` within a rails app and check if the gem does its precompiling too.
-
-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.
-
-As a rule of thumb, for **component tests**, before each test, templates are copied onto the tests-app, and be tested by playwright and the rails server should remain running at the end of each component test. 
-On that way the templates easily can be developped and tested, the end user has maximum function stability and the developer always see the latest changes.
-
-Idea is to have all working examples within the template and included in the testing scope as in the hello world component.
-
-... for having a 100% WYSIWYG and a easy maintainable package so that contributors are motivated to come into my project. 
+create a completely new rails app, running the full installer and check if a hello World component is visible and javascript is working.
+run assets:precompile within a rails app and check if the gem does its precompiling too.
 
 ## Licence
 

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

@@ -5,6 +5,7 @@ module SvelteOnRails
     class InstallGenerator < Rails::Generators::Base
 
       class_option :full, type: :boolean, default: false, desc: "Run full installation with additional setup"
+      class_option :force, type: :boolean, default: false, desc: "Do not ask for overwriting files"
       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"
@@ -20,24 +21,24 @@ module SvelteOnRails
         validate_raw_options!(args)
         puts '-' * 80
         puts 'STARTING SVELTE-ON-RAILS INSTALLATION'
+        puts "FORCED (option --force was given)" if options[:force]
       end
 
       def vite
         return unless options[:full] || options[:vite]
+        puts '-' * 80
+        puts '• INSTALLING VITE-RAILS'
         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
+        puts '-' * 80
+        puts ' ▶︎▶︎▶︎ INSTALLING SVELTE-ON-RAILS GEM'
+
         utils = SvelteOnRails::Installer::Utils
         npm_i = SvelteOnRails::Installer::Npm
-        utils.write_templates(['svelte_on_rails_vite_base'])
+        utils.write_templates(['svelte_on_rails_vite_base'], ask_for_overwrite: !options[:force])
         npm_i.install_or_update_package('@csedl/svelte-on-rails')
         # insert_initializer
         uts = SvelteOnRails::Installer::Utils
@@ -50,6 +51,8 @@ module SvelteOnRails
       def turbo
         return unless options[:full] || options[:turbo]
 
+        puts '-' * 80
+        puts ' ▶︎▶︎▶︎ INSTALLING @hotwired/turbo-rails'
         puts '-' * 80
         npm_i = SvelteOnRails::Installer::Npm
         tr_pkg = '@hotwired/turbo-rails'
@@ -62,6 +65,9 @@ module SvelteOnRails
       def svelte
         return unless options[:svelte] || options[:full]
 
+        puts '-' * 80
+        puts ' ▶︎▶︎▶︎ INSTALLING svelte (npm package)'
+
         puts '-' * 80
         svelte_i = SvelteOnRails::Installer::Svelte
         svelte_i.install_svelte
@@ -70,15 +76,28 @@ module SvelteOnRails
       def hello_world
         return unless options[:hello_world] || options[:full]
 
+        puts '-' * 80
+        puts ' ▶︎▶︎▶︎︎ INSTALLING Hello World component'
         puts '-' * 80
 
         hw_i = SvelteOnRails::Installer::HelloWorld
         @hello_world_path = hw_i.install_hello_world(['rails_vite_hello_world'], app_root: nil, force: true, silent: true)
       end
 
+      def haml_and_convert
+        return unless options[:full] || options[:haml]
+
+        puts '-' * 80
+        puts ' ▶︎▶︎▶︎ INSTALLING Haml and converting existing .erb files to .haml'
+
+        haml_i = SvelteOnRails::Installer::Haml
+        haml_i.install_haml_and_convert(force: options[:force])
+        #haml_i.empty_test_methode
+      end
+
       def finish
         puts '-' * 80
-        puts 'FINISHED SVELTE INSTALLATION'
+        puts ' 👍 FINISHED SVELTE INSTALLATION 👍'
         puts '-' * 80
 
         puts "SvelteOnRails installed successfully!"

data/lib/svelte-on-rails.rb

@@ -37,14 +37,4 @@ module SvelteOnRails
     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/installer/haml.rb

@@ -1,7 +1,9 @@
 module SvelteOnRails
   module Installer
-    module Haml
-      def self.install_haml_and_convert
+
+    class Haml
+
+      def self.install_haml_and_convert(force: false)
 
         # install haml-rails
 
@@ -36,17 +38,19 @@ module SvelteOnRails
 
         # ask if haml already exist
 
-        if existing_haml_files.any?
-          puts '-' * 80
-          begin
-            puts "Theare are already .haml files:"
-            puts existing_haml_files
-            puts "Would you like to continue? (y/n)"
-            continue = STDIN.gets.chomp.downcase[0]
-          end until ['y', 'n'].include?(continue)
-          if continue == 'n'
-            puts 'skipping convert to haml'
-            return
+        unless force
+          if existing_haml_files.any?
+            puts '-' * 80
+            begin
+              puts "Theare are already .haml files:"
+              puts existing_haml_files
+              puts "Would you like to continue? (y/n)"
+              continue = STDIN.gets.chomp.downcase[0]
+            end until ['y', 'n'].include?(continue)
+            if continue == 'n'
+              puts 'skipping convert to haml'
+              return
+            end
           end
         end
 
@@ -104,6 +108,8 @@ module SvelteOnRails
         end
 
       end
+
     end
+
   end
 end

data/lib/svelte_on_rails/installer/hello_world.rb

@@ -41,8 +41,7 @@ module SvelteOnRails
 
         existing_files = files.dup.select { |f| File.exist?(f[2]) }
 
-        return unless existing_files.any?
-        if ask
+        if ask && existing_files.any?
           question = "Remove Hello World component?\nThe following files will be removed:\n#{existing_files.map { |f| f[1] }.join("\n")}"
           return unless utils.ask_yn(question)
         end
@@ -51,6 +50,13 @@ module SvelteOnRails
           File.delete(f[2])
         end
         puts "Removed Hello World component files."
+
+        utils.remove_line_from_file(
+          utils.app_root_path(app_root).join('config/routes.rb'),
+          "svelte_on_rails_hello_world",
+          force: !ask,
+        )
+
       end
 
     end

data/lib/svelte_on_rails/installer/svelte.rb

@@ -2,7 +2,7 @@ module SvelteOnRails
   module Installer
     module Svelte
 
-      def self.install_svelte
+      def self.install_svelte(force: false)
         puts '-' * 80
 
         # check npm package version

data/lib/svelte_on_rails/installer/utils.rb

@@ -173,13 +173,10 @@ module SvelteOnRails
 
       def self.write_templates(templates, ask_for_overwrite: true, app_root: nil, silent: false)
 
-
         paths = template_paths(templates, app_root: app_root)
 
-
         existing = paths.dup.select { |p| File.exist?(p[2]) }
 
-
         if existing.present? && ask_for_overwrite
           begin
             puts "#{'File'.pluralize(existing.length)} already exists:\n#{existing.map { |p| p[1] }.join("\n")}.\nOverwrite? (y/n)"
@@ -318,7 +315,7 @@ module SvelteOnRails
         end
       end
 
-      def self.remove_line_from_file(file_path, string_to_find)
+      def self.remove_line_from_file(file_path, string_to_find, force: false)
 
         # Read the file content
         content = File.read(file_path)
@@ -337,7 +334,10 @@ module SvelteOnRails
         end
 
         utils = SvelteOnRails::Installer::Utils
-        if found_lines.present? && utils.ask_yn("Remove lines\n  • #{found_lines.join("\n  • ")}\n from #{file_path}?")
+
+        if found_lines.present?
+          return if !force && 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"))

data/lib/svelte_on_rails/installer/vite.rb

@@ -48,7 +48,7 @@ module SvelteOnRails
 
       end
 
-      def self.configure_for_svelte
+      def self.configure_for_svelte(force: false)
 
         # add import statement
 

data/lib/tasks/svelte_on_rails_tasks.rake

@@ -20,8 +20,7 @@ namespace :svelte_on_rails do
   task :remove_hello_world do
 
     hw_i = SvelteOnRails::Installer::HelloWorld
-    f = hello_world_files + toggle_hello_world_files
-    hw_i.remove_hello_world(f.uniq)
+    hw_i.remove_hello_world(['rails_vite_hello_world'])
 
   end
 
@@ -30,7 +29,7 @@ namespace :svelte_on_rails do
 
     puts '-' * 80
     hw_i = SvelteOnRails::Installer::HelloWorld
-    hello_world_path = hw_i.install_hello_world(hello_world_files)
+    hello_world_path = hw_i.install_hello_world(['rails_vite_hello_world'])
     puts "You can now see the Hello World component on: #{hello_world_path}."
 
   end
@@ -72,33 +71,4 @@ namespace :svelte_on_rails do
     SvelteOnRails::Compiler.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svelte-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.37
 platform: ruby
 authors:
 - Christian Sedlmair