vite_padrino 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af9f03237868ee2b38532114c3d2871ce20186d1b3151c11c39fe70c3816a9dd
+  data.tar.gz: 38465a79692508566c2b12eb6e088b477315c093c98f870c1e62563e8a9bc824
+SHA512:
+  metadata.gz: 0b2d4f7eaabbdf7e70cbf111c13f6256154329ba3e4110d37c110f347a890e20c8d35293774c499f8d632618e4a38f3a0d64362db13bb78358cb6ad108df9632
+  data.tar.gz: fa16a3aca5e4f6fec1898e3f68fac8b6722a45adc9a5e8d66ff6c4c023e0019b521d333102a62261e412c8b4071e9d474a25cb0c81f6e3e9ac723e42ad7b4e40

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 0.5.0 (2021-02-25)
+
+
+### Features
+
+* Create Vite.js integration with Padrino ([#17](https://github.com/ElMassimo/vite_ruby/issues/17)) ([9e9a0a6](https://github.com/ElMassimo/vite_ruby/commit/9e9a0a67abceed0a784d3c2e0554c717d7f5d1d6))
+
+
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 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,117 @@
+<h1 align="center">
+  <a href="https://vite-ruby.netlify.app/">
+    <img src="https://raw.githubusercontent.com/ElMassimo/vite_ruby/main/docs/public/logo.svg" width="120px"/>
+  </a>
+
+  <br>
+
+  <a href="https://vite-ruby.netlify.app/">
+    Vite Padrino
+  </a>
+
+  <br>
+
+  <p align="center">
+    <a href="https://github.com/ElMassimo/vite_ruby/actions">
+      <img alt="Build Status" src="https://github.com/ElMassimo/vite_ruby/workflows/build/badge.svg"/>
+    </a>
+    <a href="https://codeclimate.com/github/ElMassimo/vite_ruby">
+      <img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/vite_ruby/badges/gpa.svg"/>
+    </a>
+    <a href="https://codeclimate.com/github/ElMassimo/vite_ruby">
+      <img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/vite_ruby/badges/coverage.svg"/>
+    </a>
+    <a href="https://rubygems.org/gems/vite_padrino">
+      <img alt="Gem Version" src="https://img.shields.io/gem/v/vite_padrino.svg?colorB=e9573f"/>
+    </a>
+    <a href="https://github.com/ElMassimo/vite_ruby/blob/master/LICENSE.txt">
+      <img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/>
+    </a>
+  </p>
+</h1>
+
+[website]: https://vite-ruby.netlify.app/
+[configuration reference]: https://vite-ruby.netlify.app/config/
+[features]: https://vite-ruby.netlify.app/guide/introduction.html
+[guides]: https://vite-ruby.netlify.app/guide/
+[config]: https://vite-ruby.netlify.app/config/
+[vite_rails]: https://github.com/ElMassimo/vite_ruby
+[webpacker]: https://github.com/rails/webpacker
+[vite]: http://vitejs.dev/
+[config file]: https://github.com/ElMassimo/vite_ruby/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_ruby/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
+[Discussions]: https://github.com/ElMassimo/vite_ruby/discussions
+[vite_rails]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_rails
+[vite_ruby]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_ruby
+[vite_padrino]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_padrino
+[no bundling]: https://vitejs.dev/guide/introduction.html#the-problem
+[bundling]: https://vitejs.dev/guide/introduction.html#why-bundle-for-production
+
+[Vite] is to frontend tooling as Ruby to programming, pure joy! 😍
+
+[__Vite Padrino__][vite_padrino] provides easy setup for Padrino web apps, as well as idiomatic tag helpers.
+
+## Why Vite? 🤔
+
+Vite [does not bundle your code during development][no bundling], which means the
+dev server is extremely __fast to start__, and your changes will be __updated instantly__.
+
+In production, Vite [bundles your code][bundling]
+with tree-shaking, lazy-loading, and common chunk splitting out of the box, to achieve optimal loading performance.
+
+## 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_padrino'
+```
+
+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 Padrino 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_padrino.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'vite_ruby'
+require 'vite_padrino/version'
+require 'vite_padrino/tag_helpers'
+
+module VitePadrino
+  # Internal: Called when the Rack app is available.
+  def self.registered(app)
+    if RACK_ENV != 'production' && ViteRuby.run_proxy?
+      app.use(ViteRuby::DevServerProxy, ssl_verify_none: true)
+    end
+    included(app)
+  end
+
+  # Internal: Called when the module is registered in the Padrino app.
+  def self.included(base)
+    base.send :include, VitePadrino::TagHelpers
+  end
+end

data/lib/vite_padrino/installation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'vite_padrino'
+
+# Internal: Extends the base installation script from Vite Ruby to work for a
+# typical Padrino app.
+module VitePadrino::Installation
+  PADRINO_TEMPLATES = Pathname.new(File.expand_path('../../templates', __dir__))
+
+  # Override: Setup a typical apps/web Padrino app to use Vite.
+  def setup_app_files
+    cp PADRINO_TEMPLATES.join('config/padrino-vite.json'), config.config_path
+    inject_line_after root.join('app/app.rb'), 'register', '    register VitePadrino'
+    append root.join('Rakefile'), <<~RAKE
+      require 'vite_padrino'
+      ViteRuby.install_tasks
+    RAKE
+  end
+
+  # Override: Inject the vite client and sample script to the default HTML template.
+  def install_sample_files
+    super
+    inject_line_after root.join('app/views/layouts/application.haml'), '%title', <<-HTML
+    = vite_client_tag
+    = vite_javascript_tag 'application'
+    HTML
+  end
+end
+
+ViteRuby::CLI::Install.prepend(VitePadrino::Installation)

data/lib/vite_padrino/tag_helpers.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Public: Allows to render HTML tags for scripts and styles processed by Vite.
+module VitePadrino::TagHelpers
+  # Public: Renders a script tag for vite/client to enable HMR in development.
+  def vite_client_tag
+    return unless src = vite_manifest.vite_client_src
+
+    tag(:scripk, 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_tag(*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_include_tag(*entries.fetch(:scripts), crossorigin: crossorigin, type: type, **options)
+    tags << vite_preload_tag(*entries.fetch(:imports), crossorigin: crossorigin) unless skip_preload_tags
+    tags << stylesheet_link_tag(*entries.fetch(:stylesheets)) unless skip_style_tags
+    tags
+  end
+
+  # Public: Renders a <script> tag for the specified Vite entrypoints.
+  def vite_typescript_tag(*names, **options)
+    vite_javascript_tag(*names, asset_type: :typescript, extname: false, **options)
+  end
+
+  # Public: Renders a <link> tag for the specified Vite entrypoints.
+  def vite_stylesheet_tag(*names, **options)
+    style_paths = names.map { |name| vite_asset_path(name, type: :stylesheet) }
+    stylesheet_link_tag(*style_paths, **options)
+  end
+
+private
+
+  # Internal: Returns the current manifest loaded by Vite Ruby.
+  def vite_manifest
+    ViteRuby.instance.manifest
+  end
+
+  # Internal: Renders a modulepreload link tag.
+  def vite_preload_tag(*sources, crossorigin:)
+    sources.map { |source|
+      href = asset_path(source)
+      try(:request).try(:send_early_hints, 'Link' => %(<#{ href }>; rel=modulepreload; as=script; crossorigin=#{ crossorigin }))
+      tag(:link, rel: 'modulepreload', href: href, as: 'script', crossorigin: crossorigin)
+    }.join("\n").html_safe
+  end
+end

data/lib/vite_padrino/version.rb

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

data/templates/config/padrino-vite.json

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

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: vite_padrino
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Máximo Mussini
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-25 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
+- LICENSE.txt
+- README.md
+- lib/vite_padrino.rb
+- lib/vite_padrino/installation.rb
+- lib/vite_padrino/tag_helpers.rb
+- lib/vite_padrino/version.rb
+- templates/config/padrino-vite.json
+homepage: https://github.com/ElMassimo/vite_ruby
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_padrino@0.5.0/vite_padrino
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_padrino@0.5.0/vite_padrino/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 Padrino and bring joy to your JavaScript experience
+test_files: []