vite_hanami 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8bed5de3195c146f3e7826478b064fdcc2356e76b37ae4f828592babc50a5e79
+  data.tar.gz: 1ad190f5198116cfdc4227221f07ee948d6651a069c68c3c377108aee2fa60be
+SHA512:
+  metadata.gz: b522acfcb73ec7206b497d57ab2dd999e8ad7034bdcc963dbb21b8f2ef72c9e23f5b87ff6fa04fc1735d1b61b90ab2460e432c23d9b289e9850aef1d4c30a1d5
+  data.tar.gz: 2660390dbef9a773ce0cc566663a22178d197fb33c5fa3073ee28f7a81850f16acd4cb9fb04655a14cb229a721ab61ed94ad0bb94a71d6eda764fea409dedaac

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Vite Hanami 1.0.0 (2020-02-09)
+
+- Initial release, includes installation samples and tag helpers.

data/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+## Setting Up a Development Environment
+
+1. Install [Yarn](https://yarnpkg.com/)
+
+2. Run the following commands to set up the development environment.
+
+```
+bundle install
+```
+
+## Making sure your changes pass all tests
+There are a number of automated checks which run on GitHub Actions when a pull request is created.
+You can run those checks on your own locally to make sure that your changes would not break the CI build.
+
+### 1. Check the code for JavaScript style violations
+```
+yarn lint
+```
+
+### 2. Check the code for Ruby style violations
+```
+bundle exec rubocop
+```
+
+### 3. Run the JavaScript test suite
+```
+yarn test
+```
+
+### 4. Run the Ruby test suite
+```
+bundle exec rake test
+```

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Maximo Mussini
+
+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,108 @@
+<h1 align="center">
+  <a href="https://vite-rails.netlify.app/">
+    <img src="https://raw.githubusercontent.com/ElMassimo/vite_rails/main/docs/public/logo.svg" width="120px"/>
+  </a>
+
+  <br>
+
+  <a href="https://vite-rails.netlify.app/">
+    Vite Hanami
+  </a>
+
+  <br>
+
+  <p align="center">
+    <a href="https://github.com/ElMassimo/vite_rails/actions">
+      <img alt="Build Status" src="https://github.com/ElMassimo/vite_rails/workflows/build/badge.svg"/>
+    </a>
+    <a href="https://codeclimate.com/github/ElMassimo/vite_rails">
+      <img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/vite_rails/badges/gpa.svg"/>
+    </a>
+    <a href="https://codeclimate.com/github/ElMassimo/vite_rails">
+      <img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/vite_rails/badges/coverage.svg"/>
+    </a>
+    <a href="https://rubygems.org/gems/vite_hanami">
+      <img alt="Gem Version" src="https://img.shields.io/gem/v/vite_hanami.svg?colorB=e9573f"/>
+    </a>
+    <a href="https://github.com/ElMassimo/vite_rails/blob/master/LICENSE.txt">
+      <img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/>
+    </a>
+  </p>
+</h1>
+
+[website]: https://vite-rails.netlify.app/
+[configuration reference]: https://vite-rails.netlify.app/config/
+[features]: https://vite-rails.netlify.app/guide/introduction.html
+[guides]: https://vite-rails.netlify.app/guide/
+[config]: https://vite-rails.netlify.app/config/
+[vite_rails]: https://github.com/ElMassimo/vite_rails
+[webpacker]: https://github.com/rails/webpacker
+[vite]: http://vitejs.dev/
+[config file]: https://github.com/ElMassimo/vite_rails/blob/main/vite-plugin-ruby/default.vite.json
+[example app]: https://github.com/ElMassimo/pingcrm-vite
+[heroku]: https://pingcrm-vite.herokuapp.com/
+[Issues]: https://github.com/ElMassimo/vite_rails/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
+[Discussions]: https://github.com/ElMassimo/vite_rails/discussions
+[vite_rails]: https://github.com/ElMassimo/vite_rails/tree/main/vite_rails
+[vite_ruby]: https://github.com/ElMassimo/vite_rails/tree/main/vite_ruby
+[vite_hanami]: https://github.com/ElMassimo/vite_rails/tree/main/vite_hanami
+
+
+[Vite] is to frontend tooling as Ruby to programming, pure joy! 😍
+
+This library provides specific installation scripts for Hanami, as well as idiomatic tag helpers.
+
+## Features ⚡️
+
+- 💡 Instant server start
+- ⚡️ Blazing fast hot reload
+- 🚀 Zero-config deployments
+- 🤝 Integrated with <kbd>assets:precompile</kbd>
+- [And more!][features]
+
+## Documentation 📖
+
+Visit the [documentation website][website] to check out the [guides] and searchable [configuration reference].
+
+## Installation 💿
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vite_hanami'
+```
+
+Then, run:
+
+```bash
+bundle install
+bundle exec vite install
+```
+
+This will generate configuration files and a sample setup.
+
+Additional installation instructions are available in the [documentation website][website].
+
+## Getting Started 💻
+
+Restart your Hanami web server, and then run <kbd>bin/vite dev</kbd> to start the Vite development server.
+
+Visit any page and you should see a printed console output: `Vite ⚡️ Ruby`.
+
+For more [guides] and a full [configuration reference], check the [documentation website][website].
+
+## Contact ✉️
+
+Please use [Issues] to report bugs you find, and [Discussions] to make feature requests or get help.
+
+Don't hesitate to _⭐️ star the project_ if you find it useful!
+
+
+## Special Thanks 🙏
+
+- [webpacker]
+- [vite]
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/vite_hanami.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'vite_ruby'
+require 'vite_hanami/version'
+require 'vite_hanami/tag_helpers'

data/lib/vite_hanami/installation.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'vite_hanami'
+
+# Internal: Extends the base installation script from Vite Ruby to work for a
+# typical Hanami app.
+module ViteHanami::Installation
+  HANAMI_TEMPLATES = Pathname.new(File.expand_path('../../templates', __dir__))
+
+  # Override: Setup a typical apps/web Hanami app to use Vite.
+  def setup_app_files
+    cp HANAMI_TEMPLATES.join('config/hanami-vite.json'), config.config_path
+    inject_line_after root.join('config/environment.rb'), 'environment :development do', '    middleware.use(ViteRuby::DevServerProxy, ssl_verify_none: true) if ViteRuby.run_proxy?'
+    inject_line_after_last root.join('apps/web/application.rb'), 'include Web::Assets::Helpers', '        include ViteHanami::TagHelpers'
+    inject_line_after root.join('apps/web/application.rb'), 'configure :development do', <<-CSP
+      # Allow @vite/client to hot reload changes in development
+      security.content_security_policy(
+        security.content_security_policy
+          .sub('script-src', "script-src 'unsafe-eval'")
+          .sub('connect-src', "connect-src ws://\#{ ViteRuby.config.host_with_port }")
+      )
+    CSP
+  end
+
+  # Override: Inject the vite client and sample script to the default HTML template.
+  def install_sample_files
+    super
+    inject_line_before root.join('apps/web/templates/application.html.erb'), '</head>', <<-HTML
+    <%= vite_client %>
+    <%= vite_javascript 'application' %>
+    HTML
+  end
+end
+
+ViteRuby::CLI::Install.prepend(ViteHanami::Installation)

data/lib/vite_hanami/tag_helpers.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Public: Allows to render HTML tags for scripts and styles processed by Vite.
+module ViteHanami::TagHelpers
+  # Public: Renders a script tag for vite/client to enable HMR in development.
+  def vite_client
+    return unless src = vite_manifest.vite_client_src
+
+    html.script(src: src, type: 'module')
+  end
+
+  # Public: Resolves the path for the specified Vite asset.
+  #
+  # Example:
+  #   <%= vite_asset_path 'calendar.css' %> # => "/vite/assets/calendar-1016838bab065ae1e122.css"
+  def vite_asset_path(name, **options)
+    asset_path vite_manifest.path_for(name, **options)
+  end
+
+  # Public: Renders a <script> tag for the specified Vite entrypoints.
+  def vite_javascript(*names,
+                      type: 'module',
+                      asset_type: :javascript,
+                      skip_preload_tags: false,
+                      skip_style_tags: false,
+                      crossorigin: 'anonymous',
+                      **options)
+    entries = vite_manifest.resolve_entries(*names, type: asset_type)
+    tags = javascript(*entries.fetch(:scripts), crossorigin: crossorigin, type: type, **options)
+    tags << vite_modulepreload(*entries.fetch(:imports), crossorigin: crossorigin) unless skip_preload_tags
+    tags << stylesheet(*entries.fetch(:stylesheets)) unless skip_style_tags
+    ::Hanami::Utils::Escape::SafeString.new(tags)
+  end
+
+  # Public: Renders a <script> tag for the specified Vite entrypoints.
+  def vite_typescript(*names, **options)
+    vite_javascript(*names, asset_type: :typescript, **options)
+  end
+
+  # Public: Renders a <link> tag for the specified Vite entrypoints.
+  def vite_stylesheet(*names, **options)
+    style_paths = names.map { |name| vite_asset_path(name, type: :stylesheet) }
+    stylesheet(*style_paths, **options)
+  end
+
+private
+
+  # Internal: Returns the current manifest loaded by Vite Ruby.
+  def vite_manifest
+    ViteRuby.instance.manifest
+  end
+
+  # Internal: The leading path to every Vite asset.
+  def vite_assets_prefix
+    "/#{ ViteRuby.instance.config.public_output_dir }"
+  end
+
+  # Internal: Renders a modulepreload link tag.
+  def vite_modulepreload(*sources, crossorigin:)
+    _safe_tags(*sources) { |source|
+      href = asset_path(source)
+      _push_promise(href, as: :script)
+      html.link(rel: 'modulepreload', href: href, as: :script, crossorigin: crossorigin)
+    }
+  end
+
+  # Override: Hanami doesn't play nice with non-managed assets, it will always
+  # prefix them and there's no configuration option to avoid it.
+  def _relative_url(source)
+    if self.class.assets_configuration.cdn || !source.to_s.start_with?(vite_assets_prefix)
+      self.class.assets_configuration.asset_path(source)
+    else
+      Hanami::Utils::PathPrefix.new('/').join(source).to_s
+    end
+  end
+end

data/lib/vite_hanami/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ViteHanami
+  VERSION = '0.5.0'
+end

data/templates/config/hanami-vite.json

@@ -0,0 +1,15 @@
+{
+  "all": {
+    "sourceCodeDir": "apps/web/frontend",
+    "watchAdditionalPaths": []
+  },
+  "development": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-dev",
+    "port": 3036
+  },
+  "test": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-test"
+  }
+}

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: vite_hanami
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Máximo Mussini
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vite_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- maximomussini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- lib/vite_hanami.rb
+- lib/vite_hanami/installation.rb
+- lib/vite_hanami/tag_helpers.rb
+- lib/vite_hanami/version.rb
+- templates/config/hanami-vite.json
+homepage: https://github.com/ElMassimo/vite_rails
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/vite_hanami@0.5.0/vite_hanami
+  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/vite_hanami@0.5.0/vite_hanami/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Use Vite in Hanami and bring joy to your JavaScript experience
+test_files: []