importmap-package-manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a110fb59f6923d5c6e6b3d646b6b20936dd41785a04a194f4db90c6bff70745
+  data.tar.gz: 557158037bd82ba4c6480074fab6ddb4e38061754723ed1ef6ca89ae0620a804
+SHA512:
+  metadata.gz: 85a2d44db07e38b2170b2459c8eefdd63d6d9c76aef699347c5fd03b5e44f39a0848e57a9d0e9d77b0e5600e79939dfbc7af060fb8f0942ed8bb5eaef096a971
+  data.tar.gz: '0968ac3a5bce98c409b740b19f9337640d4605e68972f278617217a1f168d015ea5922294edf0aa8431bf005e55f67262eb5fa2cdd24519c2ffbbd82472b3f27'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Quimbee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# importmap-package-manager
+
+`importmap-package-manager` adds package version management to [importmap-rails](https://github.com/rails/importmap-rails) via version ranges, similar to how version ranges can be specified in `Gemfile` (eg `~> 4.0`).
+
+This is for managing third-party libraries. For your own first-party code, that will still be managed in the normal ways via `importmap-rails`.
+
+## Installation
+
+First, you'll need to have [importmap-rails](https://github.com/rails/importmap-rails) set up and configured properly for your application.
+
+Once that's done, add this line to your application's Gemfile:
+
+```ruby
+gem "importmap-package-manager"
+```
+
+And then execute:
+
+    $ bundle install
+
+Finally, run this gem's installer:
+
+    $ bundle exec rails importmap_package_manager:install
+
+## Usage
+
+1. Add packages to `config/importmap_packages.yml` under the `imports` key. See [#package-options] for more details. You'll also want to delete these from `config/importmap.rb`.
+2. Run `bundle exec rails importmap_package_manager:update` to update `config/importmap-packages-lock.rb`
+3. That's it! From here, your packages will automatically be available in the importmap and ready to be used.
+
+### Package options
+
+Each import should be specified as a key/value pair. In the most simple case, the key is the package name and the value is the version constraint. For example:
+
+```yml
+imports:
+  lodash: "~> 4.0"
+```
+
+In this case, `importmap-package-manager` will install the latest 4.0 version of lodash.
+
+Packages can also be broken out into more detail, to provide more options:
+
+```yml
+imports:
+  lodash/merge:
+    package: "lodash"
+    version: "~> 4.0.0"
+    subpath: "./merge"
+```
+
+This would produce something like the following in your importmap: `{ "lodash/merge": "https://ga.jspm.io/npm:lodash@4.17.21/merge.js" }`
+
+In this case, the key is just a unique identifier. It isn't used at all.
+
+The options that can be passed for each import are:
+
+|| Option || Description ||
+| package | Package name, as listed in npmjs.com |
+| version | Version number constraint, using [ruby syntax](https://guides.rubygems.org/patterns/#pessimistic-version-constraint) |
+| subpath | A subpath within the package to pin. This will be used in both the import name, and the path. |
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/quimbee/importmap-package-manager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/quimbee/importmap-package-manager/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+importmap-package-manager is released under the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Importmap::Version::Manager project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/quimbee/importmap-package-manager/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/importmap-package-manager/manager.rb

@@ -0,0 +1,99 @@
+require "yaml"
+
+module ImportmapPackageManager
+  class Manager
+    HTTPError = Class.new(StandardError)
+
+    class << self
+      def update!(config: nil, lockfile: nil)
+        unless config
+          config_file = Rails.root.join("config/importmap_packages.yml")
+          config = YAML.load_file(config_file)
+        end
+
+        import_map = build_import_map(config)
+        update_lockfile!(import_map, lockfile)
+      end
+
+      private
+
+      def build_import_map(config)
+        imports = config["imports"]
+
+        if imports == nil
+          raise "No imports defined. Add import definitions to `config/importmap_packages.yml`"
+        end
+
+        import_definitions =
+          imports.map do |import, import_config|
+            if import_config.is_a?(String) || import_config.is_a?(Array)
+              import_config = { "version" => import_config }
+            end
+
+            package = import_config["package"] || import
+            version_requirement = Gem::Requirement.new(import_config["version"])
+
+            exact_version = resolve_package_version(package, version_requirement)
+
+            target = "#{package}@#{exact_version}"
+
+            import_definition = { target: target }
+
+            if import_config["subpath"]
+              import_definition[:subpath] = import_config["subpath"]
+            end
+            import_definition
+          end
+        resolve_import_urls(import_definitions)
+      end
+
+      def resolve_package_version(package, version_requirement)
+        # Step 1: Query NPM registry for all versions
+        response = Net::HTTP.get(URI("https://registry.npmjs.org/#{package}"))
+        versions = JSON.parse(response)["versions"].keys.map { |version_string| Gem::Version.new(version_string) }
+
+        # Step 2: Find latest version that matches version_requirement
+        versions.sort.reverse.find { |version| version_requirement.satisfied_by?(version) && !version.prerelease? }
+      rescue StandardError => e
+        raise HTTPError, "Unexpected transport error (#{e.class}: #{e.message})"
+      end
+
+      def resolve_import_urls(import_definitions)
+        response = Net::HTTP.post(
+          URI("https://api.jspm.io/generate"),
+          {
+            install: import_definitions,
+            flattenScope: true,
+            env: %w[browser module production],
+            defaultProvider: "jspm"
+          }.to_json,
+          "Content-Type" => "application/json"
+        )
+
+        json_response = JSON.parse(response.body)
+
+        if response.code != "200"
+          raise "Error resolving imports: #{json_response['error']}"
+        end
+
+        # Note: ideally, we would also want to pull "scopes" out of the response, to support
+        # incompatible subdependencies. However, importmap-rails does not support subdependencies
+        # yet: https://github.com/rails/importmap-rails/issues/148
+        json_response.dig("map", "imports").sort.to_h
+      end
+
+      def update_lockfile!(import_map, lockfile)
+        lockfile ||= Rails.root.join("config/importmap-packages-lock.rb")
+
+        File.open(lockfile, "w") do |f|
+          f << "# NOTE: this file is managed by importmap-package-manager.\n"
+          f << "# DO NOT edit this file directly! Instead, edit `config/importmap_packages.yml` and run `rake importmap_package_manager:update`\n"
+
+          import_map.each do |import, url|
+            f << %(pin "#{import}", to: "#{url}"\n)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/importmap-package-manager/railtie.rb

@@ -0,0 +1,13 @@
+require "importmap-package-manager"
+require "rails"
+
+module ImportmapPackageManager
+  class Railtie < Rails::Railtie
+    railtie_name :importmap_package_manager
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/importmap-package-manager/tasks/install.rake

@@ -0,0 +1,24 @@
+namespace :importmap_package_manager do
+  desc "Install importmap-package-manager"
+  task install: :environment do
+    File.open(Rails.root.join("config/importmap_packages.yml"), "w") do |f|
+      f << %(imports:\n)
+      f << %(  # For example:\n)
+      f << %(  # lodash: "~> 4.0"\n)
+    end
+
+    File.open(Rails.root.join("config/initializers/importmap-package-manager.rb"), "w") do |f|
+      f << %(Rails.application.configure do\n)
+      f << %(  config.importmap.paths << Rails.root.join\("config/importmap-packages-lock.rb"\)\n)
+      f << %(end\n)
+    end
+
+    File.open(Rails.root.join("config/importmap.rb"), "a") do |f|
+      f << %(\n)
+      f << %(# Note: package imports are managed by importmap-package-manager.\n)
+      f << %(# To add or update packages, make changes in `config/importmap_packages.yml`,\n)
+      f << %(# then run `importmap_package_manager:update` to update `config/importmap-packages-lock.rb`.\n)
+      f << %(# That file is included into the importmap via `config/initializers/importmap-package-manager.rb`\n)
+    end
+  end
+end

data/lib/importmap-package-manager/tasks/update.rake

@@ -0,0 +1,6 @@
+namespace :importmap_package_manager do
+  desc "Update importmap packages via importmap-package-manager"
+  task update: :environment do
+    ImportmapPackageManager::Manager.update!
+  end
+end

data/lib/importmap-package-manager/version.rb

@@ -0,0 +1,3 @@
+module ImportmapPackageManager
+  VERSION = "0.1.0".freeze
+end

data/lib/importmap-package-manager.rb

@@ -0,0 +1,6 @@
+require "importmap-package-manager/version"
+require "importmap-package-manager/manager"
+
+module ImportmapPackageManager
+  require "importmap-package-manager/railtie" if defined?(Rails)
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: importmap-package-manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derek Kniffin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-25 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- derek@quimbee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/importmap-package-manager.rb
+- lib/importmap-package-manager/manager.rb
+- lib/importmap-package-manager/railtie.rb
+- lib/importmap-package-manager/tasks/install.rake
+- lib/importmap-package-manager/tasks/update.rake
+- lib/importmap-package-manager/version.rb
+homepage: https://github.com/Quimbee/importmap-package-manager
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Quimbee/importmap-package-manager
+  source_code_uri: https://github.com/Quimbee/importmap-package-manager
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Manages importmap package versions using ruby-like version constraints
+test_files: []