svelte-on-rails 0.0.41 → 0.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 683e0e4881fc72969224d9792ba06ff4049c19adbcf55bc8e0ba817ba4be48d4
-  data.tar.gz: 6a9ed00119ddbdb2b9a095458b010150ecd938d751e9112b26629343bc782656
+  metadata.gz: c46f6cb43c90617bc4798072b58a35e81a311886a858c379224216fc63c03d3e
+  data.tar.gz: 2bd3286eac9420225ac3f641d1cf783a84f48f575d69c0bce53a9b1da9d9d262
 SHA512:
-  metadata.gz: a166ff91777a7969f50874feb855c522aeac968dae0c6f1659b92ced9ac461683cbac34eee6f3999b961db6669732dbcbea41d3f659f621a3c198fc6b3204e76
-  data.tar.gz: dd7c49785a50f484c936fbac6f5a8000fc46d6fc7165113c55a7e437b4b2ac20a05a1da4d9311b24d8757d307fa14061c35b2fdf607614502bd6ff24aa0ee948
+  metadata.gz: 9e4ae887620aaabd737fc30864bed6eea15dcc9bb47e6ef9db4ab1e38f0ea96a1643b2f12cd81aeadf2c636e6e1575920da2efca62886e877a71dbe25b2818a2
+  data.tar.gz: 821084886d515faf8e68440a001bc4a3fd5d310c6068efbb1578ca558774f0ad731e5cf13f142b3223db7e5a2b380775319de9ce3e75a54e597ff59ba1a505cc

data/README.md

@@ -263,10 +263,20 @@ Example from the rails console for a medium complex component
 
 ## Contributors Guide
 
-Tests are based on the included templates, like the `hello world template` and on the installer.
+Contributors welcome!
+
+After downloaded the gem, please run the task
+
+```bash 
+rake svelte_on_rails:create_contributor_configs_file
+```
+and define a `generated_test_app_folder_path` (required) for apps, generated for the testings.
 
-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.
+For development of the **npm package @csedl/svelte-on-rails** you can set the
+`local_npm_package_path` (optional) and insert the path to the npm package on your local machine.
+This will cause the installer, to install the npm package from a local path instead from the npm registry.
+
+Tests are based on the included templates, like the `hello world template` and on the installer.
 
 **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.
@@ -293,13 +303,6 @@ 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.
 
-For development of the **npm package @csedl/svelte-on-rails** you can add the file
-`local_npm_package_path` and insert the path to the npm package on your local machine.
-This will cause the installer, not to install the npm package from npm, but to use the local one.
-
-‼️ **ATTENTION:** Please do never commit the file `local_npm_package_path` to the repo! This is only for developers!
-Otherwise a user would, on running the installer, get an error, because the npm package is not found.
-
 ## Licence
 
 License is MIT

data/lib/svelte_on_rails/installer/npm.rb

@@ -68,7 +68,7 @@ module SvelteOnRails
         if pkg
           {
             type: pkg.match(/^.*?(?=\/[^\/]*$)/).to_s,
-            version: version.split('.').map(&:to_i)
+            version: version&.split('.')&.map(&:to_i)
           }
         end
 

data/lib/svelte_on_rails/lib/development_utils.rb

@@ -2,18 +2,15 @@ module SvelteOnRails
   class DevelopmentUtils
 
     def self.local_npm_package_url
-      config_file = gem_folder.join('local_npm_package_path')
-      if !File.exist?(config_file)
-        return nil
+      str = contributor_config('local_npm_package_path', required: false)
+      if !str.present?
+        nil
+      elsif !Dir.exist?(str)
+        raise "Invalid path given on local_npm_package_path: «#{str}»"
+      elsif !File.exist?(Pathname.new(str).join('package.json'))
+        raise "Given local_npm_package_path does not seem to be a valid npm package as it does not contain a package.json"
       else
-        str = File.read(config_file).strip
-        if !Dir.exist?(str)
-          raise "Invalid path given on local_npm_package_path: «#{str}»"
-        elsif !File.exist?(Pathname.new(str).join('package.json'))
-          raise "Given local_npm_package_path does not seem to be a valid npm package as it does not contain a package.json"
-        else
-          return Pathname.new(str)
-        end
+        return Pathname.new(str)
       end
     end
 
@@ -21,5 +18,21 @@ module SvelteOnRails
       Pathname.new(File.expand_path('../../..', __dir__))
     end
 
+    def self.contributor_config(key, required: true)
+      config_file = File.expand_path('../svelte_on_rails_contributor_configs.yml', gem_folder)
+      if !File.exist?(config_file)
+        if required
+          raise "Missing configuration file, searched at: «#{config_file}»"
+        end
+      else
+        yml = YAML.load_file(config_file)
+        value = yml[key.to_s]
+        if required && !value.present?
+          raise "Missing value «#{key}» in configuration file: «#{config_file}»"
+        end
+        value
+      end
+    end
+
   end
 end

data/lib/tasks/svelte_on_rails_tasks.rake

@@ -71,4 +71,31 @@ namespace :svelte_on_rails do
     SvelteOnRails::Compiler.reset_and_compile_all
   end
 
+  desc "For contributors to this gem: writes a config file for developing options."
+  task :create_contributor_configs_file do
+    path = File.expand_path('../../../svelte_on_rails_contributor_configs.yml', __dir__)
+
+    if File.exist?(path)
+      puts "Config file for Contributors already exists: file://#{path}"
+      puts 'nothing done.'
+      exit
+    end
+
+    content = <<-END
+#local_npm_package_path: /path/to/my/local/csedl-svelte-on-rails-main
+
+# optional
+# If you want to develop the @csedl/svelte-on-rails package
+# add full path like /path/to/csedl-svelte-on-rails-main
+# Then, on running the generator, it installs this package from your local root folder
+
+generated_test_app_folder_path: /destination/folder/for/generated/test/app
+
+# required!
+# When you run tests, a rails app will be generated into this folder
+    END
+    File.write(path, content)
+    puts "Config file for Contributors created at: #{path}"
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svelte-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.41
+  version: 0.0.42
 platform: ruby
 authors:
 - Christian Sedlmair