middleman-importmap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa6a34d5c0c79ece0369c0dabbc30bf59493a998a9e353a9b6609d5f46797ae8
+  data.tar.gz: a1dc98ff572e075939f0eefe0707a3e84230bef30d0bcd179946bf5f46468616
+SHA512:
+  metadata.gz: 67fb7f8e7eb827bc60d497b8a232f5b6f707c7140bf1498c081d568840831d16d7b1ac1a6fffa67f3aae365b7faa868e54689b3bc80848d5f6516da066726c15
+  data.tar.gz: d0f1899ee1eac2caa92600d4960d5cb85957562fc3649217390df583513bca3a4167b1b009f8cef5c5479e05e9455a5d20149fcf6ba0b158ca72a9f7e1e6cf8f

data/.gitignore

@@ -0,0 +1,61 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-importmap.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Daniel Vinciguerra
+
+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,26 @@
+
+# middleman-importmap
+
+An Importmap extension for Middleman.
+
+
+## Install
+
+**Add gem to `Gemfile`**
+
+`gem 'middleman-importmap'`
+
+**Create the `importmap.yml` file at middleman root path**
+
+`cd middleman_project && touch importmap.yml`
+
+The importmap.yml file keep the same structure of importmap in HTML
+
+
+## License
+
+See `./LICENSE` file for more details.
+
+## Author
+
+Daniel Vinciguerra

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "cucumber/rake/task"
+
+Cucumber::Rake::Task.new(:cucumber, "Run features that should pass") do |t|
+  t.cucumber_opts = "--color --tags not @wip --strict"
+end
+
+require "rake/clean"
+
+task test: ["cucumber"]
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-importmap')

data/lib/middleman-importmap/extension.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "middleman-core"
+require "moddleman-importmap/helpers"
+
+module Middleman
+  class ImportmapExtension < Extension
+    option :entrypoint, "site", "define js entrypoint file"
+    option :use_shim, true, "use importmapdefine js entrypoint file"
+
+    def initialize(app, options_hash = {}, &block)
+      super
+    end
+
+    def after_configuration; end
+
+    helpers do
+      include ::Middleman::Importmap::Helpers
+    end
+  end
+end

data/lib/middleman-importmap/helpers.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "erb"
+require "yaml"
+
+module Middleman
+  module Importmap
+    module Helpers
+      def javascript_importmap_tags(entrypoint = "site", shim: true)
+        [
+          javascript_importmap_shim_tag,
+          javascript_inline_importmap_tag,
+          javascript_inline_module_tag(entrypoint),
+        ].join
+      end
+
+      def javascript_importmap_shim_tag
+        template = File.join(File.dirname(__FILE__), "views/javascript_impotmap_shim_tag.html.erb")
+        erb = ERB.new(File.read(template))
+        erb.result
+      end
+
+      def javascript_inline_importmap_tag(importmap = "importmap.yml")
+        template = File.join(File.dirname(__FILE__), "views/javascript_inline_impotmap_tag.html.erb")
+        importmap_config = YAML.load_file(File.join(app.root_path, importmap), symbolize_names: true)
+
+        erb = ERB.new(File.read(template))
+        erb.result_with_hash(importmap: importmap_config)
+      end
+
+      def javascript_inline_module_tag(entrypoint)
+        template = File.join(File.dirname(__FILE__), "views/javascript_inline_module_tag.html.erb")
+        erb = ERB.new(File.read(template))
+        erb.result_with_hash(entrypoint: entrypoint)
+      end
+    end
+  end
+end

data/lib/middleman-importmap/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Middleman
+  module Importmap
+    VERSION = "0.1.0"
+  end
+end

data/lib/middleman-importmap/views/javascript_impotmap_shim_tag.html.erb

@@ -0,0 +1,6 @@
+
+<script
+  async
+  data-turbo-track="reload"
+  src="https://ga.jspm.io/npm:es-module-shims@1.4.6/dist/es-module-shims.js"
+></script>

data/lib/middleman-importmap/views/javascript_inline_impotmap_tag.html.erb

@@ -0,0 +1,3 @@
+<script type="importmap-shim">
+  <%= JSON.pretty_generate(importmap) %>
+</script>

data/lib/middleman-importmap/views/javascript_inline_module_tag.html.erb

@@ -0,0 +1,4 @@
+<script
+  type="module-shim"
+  src="/javascripts/<%= entrypoint %>.js"
+></script>'

data/lib/middleman-importmap.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "middleman-core"
+
+Middleman::Extensions.register(:importmap) do
+  require "middleman-importmap/extension"
+  ::Middleman::ImportmapExtension
+end

data/lib/middleman_extension.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "middleman-importmap"

data/middleman-importmap.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+$LOAD_PATH.push(File.expand_path("../lib", __FILE__))
+
+require "middleman-importmap/version"
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-importmap"
+  s.version     = Middleman::Importmap::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daniel Vinciguerra"]
+  s.email       = ["daniel.vinciguerra@bivee.com.br"]
+  s.homepage    = "https://github.com/dvinciguerra/middleman-importmap"
+  s.summary     = "Middleman Importmap extension"
+  s.description = "An extension to port importmap assets to Middleman"
+
+  s.files         = %x(git ls-files).split("\n")
+  s.test_files    = %x(git ls-files -- {test,spec,features}/*).split("\n")
+  s.executables   = %x(git ls-files -- bin/*).split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 4.4.2"])
+
+  # Additional dependencies
+  # s.add_runtime_dependency("gem-name", "gem-version")
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: middleman-importmap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Vinciguerra
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.2
+description: An extension to port importmap assets to Middleman
+email:
+- daniel.vinciguerra@bivee.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-importmap.rb
+- lib/middleman-importmap/extension.rb
+- lib/middleman-importmap/helpers.rb
+- lib/middleman-importmap/version.rb
+- lib/middleman-importmap/views/javascript_impotmap_shim_tag.html.erb
+- lib/middleman-importmap/views/javascript_inline_impotmap_tag.html.erb
+- lib/middleman-importmap/views/javascript_inline_module_tag.html.erb
+- lib/middleman_extension.rb
+- middleman-importmap.gemspec
+homepage: https://github.com/dvinciguerra/middleman-importmap
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Middleman Importmap extension
+test_files:
+- features/support/env.rb