plug 0.1.27 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b24b659f1fef423ad79f8327fcc139c2fe76855e46cc1891f058e90d0a3010f
-  data.tar.gz: 73d8bffaa03bf0e913ade43e26d1eefd57ccba71d22bcdd23f65caeca4424d05
+  metadata.gz: 93d959b1cce72eb10a7dfb1708c75acca84dae5bf7ec85b91a8b97e02c094b5c
+  data.tar.gz: fa51e5f82f7c8113b370c83c33c8b5119948e744f42e302f341073dd0bba20fa
 SHA512:
-  metadata.gz: 28ff4f598b31181a73247d0448ce972d7d7dc0afef95417e10a7f8b922d7444e1e0c897a9aaed253ab73aa1fe347c355f82f0cc9c234368a85ca0f9cb6de5f8e
-  data.tar.gz: 46e9dda363fa11bda56f4496e4b212a8c61293e2f0cf9b31613b940c32a744c8a4bf6e3d2968319ffe539a1c42c83d1059cac27f5960891beebd6ec8aa3a2a2c
+  metadata.gz: efd393e765ebba44fee818a02850193b3c3630cd6a1aa08da5dc1d8dfda764db432e4c421742b5bcfafdfb6e0c2f84226c01b8a0799c1e87c7a81f8833330cce
+  data.tar.gz: dae650a9a2304a57777eb6b76f33ea86a38a83bc27e3ae16e55e70bec94ad9a98dc0c391de7188638e187a8b244537a7eaef26c396bf945fe706c89db329b801

data/README.md

@@ -129,6 +129,15 @@ Make sure to **bump** the version. Rubygems don't accept version overrides.
 → gem push plug-<version>.gem
 ```
 
+### Publishing to `npmjs.com`
+
+Make sure to match the version with the Rubygems version.
+
+```bash
+→ npm login
+→ npm publish --access public
+```
+
 ### TODOs
 
 - Ability to disable all features using one button

data/app/helpers/plug/application_helper.rb

@@ -2,5 +2,15 @@
 
 module Plug
   module ApplicationHelper
+    def asset_tags
+      asset_source = defined?(ViteRuby) ? :vite : :other
+
+      case asset_source
+      when :vite
+        vite_javascript_tag 'entrypoints/plug'
+      else
+        raise 'Plug does not support asset pipelines anymore. Use Vite.js instead.'
+      end
+    end
   end
 end

data/app/views/layouts/plug/application.html.haml

@@ -6,5 +6,3 @@
     .container
       = render 'plug/shared/nav'
       = yield
-
-    /= render 'shared/footer'

data/app/views/plug/shared/_head.html.haml

@@ -3,9 +3,7 @@
   %meta{content: 'width=device-width, initial-scale=1.0', name: 'viewport'}/
   %title Plug
 
-  = stylesheet_link_tag     'plug/application', media: 'all'
-  = javascript_include_tag  'plug/application'
-  = favicon_link_tag        'plug/favicon.png'
   = csrf_meta_tags
+  = asset_tags
 
   %script{ defer: '', src: 'https://use.fontawesome.com/releases/v5.13.0/js/all.js' }

data/lib/generators/plug/install_generator.rb

@@ -11,5 +11,23 @@ module Plug
     def mount_engine
       inject_into_file('config/routes.rb', "\n  mount Plug::Engine => '/plug', as: 'plug'\n\n", before: /^end/)
     end
+
+    def setup_vite_assets
+      copy_file 'plug.vite.js', 'app/frontend/entrypoints/plug.js'
+    end
+
+    def add_plug_package
+      package_json_path = 'package.json'
+
+      if File.exist?(package_json_path)
+        package_json = JSON.parse(File.read(package_json_path))
+        package_json['dependencies'] ||= {}
+        package_json['dependencies']['@digitalnz/plug'] ||= "^#{Plug::VERSION}"
+
+        File.write(package_json_path, JSON.pretty_generate(package_json) + "\n")
+      else
+        say 'package.json not found. Please ensure you are running this generator in the root directory of your Rails project.', :red
+      end
+    end
   end
 end

data/lib/generators/plug/templates/plug.vite.js

@@ -0,0 +1,2 @@
+import "@digitalnz/plug/src/plug/stylesheets/base.scss";
+import "@digitalnz/plug/src/plug/base";

data/lib/plug/engine.rb

@@ -8,10 +8,12 @@ module Plug
   class Engine < ::Rails::Engine
     isolate_namespace Plug
 
-    initializer 'plug.assets.precompile' do |app|
-      app.config.assets.precompile += %w[
-        plug/application.js plug/application.css plug/favicon.png
-      ]
+    if defined?(Sprockets)
+      initializer 'plug.assets.precompile' do |app|
+        app.config.assets.precompile += %w[
+          plug/application.js plug/application.css plug/favicon.png
+        ]
+      end
     end
 
     config.generators do |g|

data/lib/plug/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Plug
-  VERSION = '0.1.27'
+  VERSION = '0.2.0' # Update version in package.json too
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: plug
 version: !ruby/object:Gem::Version
-  version: 0.1.27
+  version: 0.2.0
 platform: ruby
 authors:
 - Boost
 - DNZ
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -67,20 +67,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: sass-rails
-  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: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -189,28 +175,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/plug_manifest.js
-- app/assets/images/plug/favicon.png
-- app/assets/javascripts/plug/application.js
-- app/assets/javascripts/plug/trix-core.js
-- app/assets/stylesheets/plug/_settings.scss
-- app/assets/stylesheets/plug/application.scss
-- app/assets/stylesheets/plug/blocks/_alert.scss
-- app/assets/stylesheets/plug/blocks/_menu.scss
-- app/assets/stylesheets/plug/blocks/_nav.scss
-- app/assets/stylesheets/plug/blocks/_notice.scss
-- app/assets/stylesheets/plug/blocks/_state.scss
-- app/assets/stylesheets/plug/blocks/_task-button.scss
-- app/assets/stylesheets/plug/foundation_and_overrides.scss
-- app/assets/stylesheets/plug/milligram.scss
-- app/assets/stylesheets/plug/mixins/_bem.scss
-- app/assets/stylesheets/plug/normalize.scss
-- app/assets/stylesheets/plug/partials/_main.scss
-- app/assets/stylesheets/plug/partials/_utils.scss
-- app/assets/stylesheets/plug/trix-overrides.scss
-- app/assets/stylesheets/plug/trix.scss
-- app/assets/stylesheets/plug/variables/_colors.scss
-- app/assets/stylesheets/plug/variables/_typography.scss
 - app/controllers/plug/api/api_controller.rb
 - app/controllers/plug/api/features_controller.rb
 - app/controllers/plug/api/site_notices_controller.rb
@@ -245,6 +209,7 @@ files:
 - db/migrate/20180424015828_add_theme_to_plug_site_notice.rb
 - lib/generators/plug/install_generator.rb
 - lib/generators/plug/templates/plug.rb
+- lib/generators/plug/templates/plug.vite.js
 - lib/plug.rb
 - lib/plug/configuration.rb
 - lib/plug/constraint.rb
@@ -255,7 +220,12 @@ homepage: https://github.com/digitalnz/plug
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  ### Upgrading Plug from 0.1.x to 0.2.x ###
+
+  Due to introduction of Vite support, some additional dependencies and configuration will be needed.
+  Running `bin/rails g plug:install` will add extra js dependencies and configuration to your project.
+  `0.2.x`` doesn't support asset pipelines anymore. Use Vite.js instead.
 rdoc_options: []
 require_paths:
 - lib
@@ -271,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.32
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Rails engine that can plug/unplug features
 test_files: []

data/app/assets/config/plug_manifest.js

@@ -1,3 +0,0 @@
-//= link ../images/favicon.png
-//= link_directory ../javascripts/plug .js
-//= link_directory ../stylesheets/plug .css

data/app/assets/javascripts/plug/application.js

@@ -1,18 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .
-
-// Prevent drag and drop from the editor
-document.addEventListener('trix-file-accept', function(event) {
-  event.preventDefault();
-});