avo 2.14.3.pre.2.tailwindcss → 2.14.3.pre.3.jsbundling

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 000cbbb5361f9e2b283d18b20421f360e510f1320563fa480060035b31070d2c
-  data.tar.gz: ea51f134fedc9aacb232b4d5333d1d74807ffe93a32edc4daf46cc6c69cc0d3b
+  metadata.gz: 7ede274df957fa28cce74c79aee056b2e7da626cb5db843647cb56f3eeef8222
+  data.tar.gz: 5401228e96ad20d0e5d2e97937d8c83d135bdc666e7cf173166dd5b0d8c03ca5
 SHA512:
-  metadata.gz: a696a065e0af86bb02b9d1b44ac26cee640baeae95207528890a4be21a38496f7282f3609edf6d4458c4ec65357c4526553d20300d51562fd1a1ed271280b47b
-  data.tar.gz: 6f837374c20ef0a29b4382fefe9827de36f6c1543a9b7162c0ca9272d3fc1f99b4b5aff9823215f640711f86d9d33d106da69c819fcc111dc9d340361ad8bb78
+  metadata.gz: 8a4d2ac6b2011ddfd4dd8a6c699499dae18b6d3dbdfafaf31f2a27995f7c5d0301fa9b9e1927bba0efa16cc7207679265751500f07dfec247abfde869922b783
+  data.tar.gz: 0c7f1c148088882099d1c5f0c197b16232fa4f9300d6c422ad8db6fcd731b9386c9a1d3db29ab8dd7a588c3539a821e274afce051aaec87f6d1c8816865d265b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (2.14.3.pre.2.tailwindcss)
+    avo (2.14.3.pre.3.jsbundling)
       active_link_to
       addressable
       breadcrumbs_on_rails

data/app/views/layouts/avo/application.html.erb

@@ -9,10 +9,10 @@
     <%= render partial: 'avo/partials/head' %>
     <% if Avo::PACKED %>
       <%= javascript_include_tag "/avo-assets/avo.base", "data-turbo-track": "reload", defer: true %>
-      <%= stylesheet_link_tag "/avo-assets/avo.base", "data-turbo-track": "reload", defer: true %>
+      <%= stylesheet_link_tag "/avo-assets/avo", "data-turbo-track": "reload", defer: true %>
     <% else %>
       <%= javascript_include_tag "avo.base", "data-turbo-track": "reload", defer: true %>
-      <%= stylesheet_link_tag "avo.base", "data-turbo-track": "reload", defer: true %>
+      <%= stylesheet_link_tag "avo", "data-turbo-track": "reload", defer: true %>
       <% if Rails.env.development? %>
         <%= javascript_include_tag "hotwire-livereload", defer: true %>
       <% end %>

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "2.14.3.pre.2.tailwindcss" unless const_defined?(:VERSION)
+  VERSION = "2.14.3.pre.3.jsbundling" unless const_defined?(:VERSION)
 end

data/lib/generators/avo/base_generator.rb

@@ -7,11 +7,7 @@ module Generators
 
       def initialize(*args)
         super(*args)
-
-        # Don't output the version if requested so
-        unless args.include?(["--no-avo-version"])
-          invoke "avo:version", *args
-        end
+        invoke "avo:version", *args
       end
     end
   end

data/lib/generators/avo/js/install_generator.rb

@@ -0,0 +1,64 @@
+require_relative "../base_generator"
+
+module Generators
+  module Avo
+    module Js
+      class InstallGenerator < BaseGenerator
+        source_root File.expand_path("../templates", __dir__)
+
+        namespace "avo:js:install"
+        desc "Add custom JavaScript assets to your Avo project."
+
+        # possible values: importmap or esbuild
+        class_option :bundler, type: :string, default: "importmap"
+
+        def create_files
+          case options[:bundler].to_s
+          when "importmap"
+            install_for_importmap
+          when "esbuild"
+            install_for_esbuild
+          else
+            say "We don't know how to install Avo JS for this bundler \"#{options[:bundler]}\""
+          end
+        end
+
+        no_tasks do
+          def install_for_importmap
+            unless Rails.root.join("app", "javascript", "avo.custom.js").exist?
+              say "Add default app/javascript/avo.custom.js"
+              copy_file template_path("avo.custom.js"), "app/javascript/avo.custom.js"
+            end
+
+            say "Ejecting the _head.html.erb partial"
+            Rails::Generators.invoke("avo:eject", [":head", "--no-avo-version"], {destination_root: Rails.root})
+
+            say "Adding the JS asset to the partial"
+            append_to_file Rails.root.join("app", "views", "avo", "partials", "_head.html.erb"), "<%= javascript_importmap_tags \"avo.custom\" %>"
+
+            # pin to importmap
+            say "Pin the new entrypoint to your importmap config"
+            append_to_file Rails.root.join("config", "importmap.rb"), "\n# Avo custom JS entrypoint\npin \"avo.custom\", preload: true\n"
+          end
+
+          def install_for_esbuild
+            unless Rails.root.join("app", "javascript", "avo.custom.js").exist?
+              say "Add default app/javascript/avo.custom.js"
+              copy_file template_path("avo.custom.js"), "app/javascript/avo.custom.js"
+            end
+
+            say "Ejecting the _head.html.erb partial"
+            Rails::Generators.invoke("avo:eject", [":head", "--no-avo-version"], {destination_root: Rails.root})
+
+            say "Adding the JS asset to the partial"
+            append_to_file Rails.root.join("app", "views", "avo", "partials", "_head.html.erb"), "<%= javascript_include_tag \"avo.custom\", \"data-turbo-track\": \"reload\", defer: true %>"
+          end
+
+          def template_path(filename)
+            Pathname.new(__dir__).join("..", "templates", "js", filename).to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/avo/templates/js/avo.custom.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line no-console
+console.log('Hi from Avo custom JS 👋')

data/lib/tasks/avo_tasks.rake

@@ -3,9 +3,9 @@
 #   # Task goes here
 # end
 
-desc "Installs Avo assets and bundles them for when you want to use the GitHub repo in your app"
-task "avo:build-assets" do
-  spec = get_gem_spec "avo"
+desc 'Installs Avo assets and bundles them for when you want to use the GitHub repo in your app'
+task 'avo:build-assets' do
+  spec = get_gem_spec 'avo'
   # Uncomment to enable only when the source is github.com
   # enabled = spec.source.to_s.include?('https://github.com/avo-hq/avo')
   enabled = true
@@ -15,8 +15,8 @@ task "avo:build-assets" do
     path = spec.full_gem_path
 
     Dir.chdir(path) do
-      system "yarn"
-      system "yarn prod:build"
+      system 'yarn'
+      system 'yarn prod:build'
     end
 
     puts "Done"
@@ -28,10 +28,10 @@ end
 # From
 # https://stackoverflow.com/questions/9322078/programmatically-determine-gems-path-using-bundler
 def get_gem_spec(name)
-  spec = Bundler.load.specs.find { |s| s.name == name }
+  spec = Bundler.load.specs.find{|s| s.name == name }
   raise GemNotFound, "Could not find gem '#{name}' in the current bundle." unless spec
-  if spec.name == "bundler"
-    return File.expand_path("../../../", __FILE__)
+  if spec.name == 'bundler'
+    return File.expand_path('../../../', __FILE__)
   end
 
   spec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: avo
 version: !ruby/object:Gem::Version
-  version: 2.14.3.pre.2.tailwindcss
+  version: 2.14.3.pre.3.jsbundling
 platform: ruby
 authors:
 - Adrian Marin
@@ -263,7 +263,7 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/avo_manifest.js
-- app/assets/stylesheets/avo.base.css
+- app/assets/stylesheets/avo.css
 - app/assets/stylesheets/css/active-storage.css
 - app/assets/stylesheets/css/breadcrumbs.css
 - app/assets/stylesheets/css/buttons.css
@@ -1887,11 +1887,11 @@ files:
 - lib/generators/avo/field_generator.rb
 - lib/generators/avo/filter_generator.rb
 - lib/generators/avo/install_generator.rb
+- lib/generators/avo/js/install_generator.rb
 - lib/generators/avo/locales_generator.rb
 - lib/generators/avo/named_base_generator.rb
 - lib/generators/avo/resource_generator.rb
 - lib/generators/avo/resource_tool_generator.rb
-- lib/generators/avo/tailwindcss/install_generator.rb
 - lib/generators/avo/templates/action.tt
 - lib/generators/avo/templates/cards/chartkick_card.tt
 - lib/generators/avo/templates/cards/chartkick_card_sample.tt
@@ -1913,6 +1913,7 @@ files:
 - lib/generators/avo/templates/filters/select_filter.tt
 - lib/generators/avo/templates/filters/text_filter.tt
 - lib/generators/avo/templates/initializer/avo.tt
+- lib/generators/avo/templates/js/avo.custom.js
 - lib/generators/avo/templates/locales/avo.en.yml
 - lib/generators/avo/templates/locales/avo.fr.yml
 - lib/generators/avo/templates/locales/avo.nb-NO.yml
@@ -1923,18 +1924,15 @@ files:
 - lib/generators/avo/templates/resource_tools/partial.tt
 - lib/generators/avo/templates/resource_tools/resource_tool.tt
 - lib/generators/avo/templates/standalone_action.tt
-- lib/generators/avo/templates/tailwindcss/Procfile.dev
-- lib/generators/avo/templates/tailwindcss/avo.tailwind.css
 - lib/generators/avo/templates/tool/controller.tt
 - lib/generators/avo/templates/tool/sidebar_item.tt
 - lib/generators/avo/templates/tool/view.tt
 - lib/generators/avo/tool_generator.rb
 - lib/generators/avo/version_generator.rb
 - lib/tasks/avo_tasks.rake
-- lib/tasks/tailwindcss_rails.rake
-- public/avo-assets/avo.base.css
 - public/avo-assets/avo.base.js
 - public/avo-assets/avo.base.js.map
+- public/avo-assets/avo.css
 - public/avo-assets/fonts/inter-v7-latin-500.eot
 - public/avo-assets/fonts/inter-v7-latin-500.svg
 - public/avo-assets/fonts/inter-v7-latin-500.ttf

data/lib/generators/avo/tailwindcss/install_generator.rb

@@ -1,54 +0,0 @@
-require_relative "../base_generator"
-
-module Generators
-  module Avo
-    module Tailwindcss
-      class InstallGenerator < BaseGenerator
-        source_root File.expand_path("../templates", __dir__)
-
-        namespace "avo:tailwindcss:install"
-        desc "Add Tailwindcss to your Avo project."
-
-        def create_files
-          unless tailwindcss_installed?
-            system "./bin/bundle add tailwindcss-rails"
-            system "./bin/rails tailwindcss:install"
-          end
-
-          unless Rails.root.join("app", "assets", "stylesheets", "avo.tailwind.css").exist?
-            say "Add default app/assets/stylesheets/avo.tailwind.css"
-            copy_file template_path("avo.tailwind.css"), "app/assets/stylesheets/avo.tailwind.css"
-          end
-
-          if Rails.root.join("Procfile.dev").exist?
-            append_to_file "Procfile.dev", "css: bin/rails avo:tailwindcss:watch\n"
-          else
-            say "Add default Procfile.dev"
-            copy_file template_path("Procfile.dev"), "Procfile.dev"
-
-            say "Ensure foreman is installed"
-            run "gem install foreman"
-          end
-
-          append_to_file "Procfile.dev", "avo_css: bin/rails tailwindcss:watch\n"
-
-          say "Ejecting the _head.html.erb partial"
-          Rails::Generators.invoke("avo:eject", [":head", "--no-avo-version"], {destination_root: Rails.root})
-
-          say "Adding the CSS asset to the partial"
-          prepend_to_file Rails.root.join("app", "views", "avo", "partials", "_head.html.erb"), "<%= stylesheet_link_tag \"avo.tailwind.css\", media: \"all\" %>"
-        end
-
-        no_tasks do
-          def template_path(filename)
-            Pathname.new(__dir__).join("..", "templates", "tailwindcss", filename).to_s
-          end
-
-          def tailwindcss_installed?
-            Rails.root.join("config", "tailwind.config.js").exist? || Rails.root.join("tailwind.config.js").exist?
-          end
-        end
-      end
-    end
-  end
-end

data/lib/generators/avo/templates/tailwindcss/Procfile.dev

@@ -1,2 +0,0 @@
-web: bin/rails server -p 3000
-css: bin/rails avo:tailwindcss:watch

data/lib/generators/avo/templates/tailwindcss/avo.tailwind.css

@@ -1,13 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-/*
-
-@layer components {
-  .btn-primary {
-    @apply py-2 px-4 bg-blue-200;
-  }
-}
-
-*/

data/lib/tasks/tailwindcss_rails.rake

@@ -1,24 +0,0 @@
-# Use the user provided asset or use the default
-ASSET_FILE = ARGV[0] || "app/assets/builds/avo.tailwind.css"
-# Se the tailwindcss-rails package name
-TAILWINDCSS_RAILS = "tailwindcss-rails"
-
-# Check if tailwindcss-rails is being used
-if Gem.loaded_specs.key? TAILWINDCSS_RAILS
-  # Get the path
-  GEM_PATH = Gem.loaded_specs[TAILWINDCSS_RAILS].full_gem_path
-  # Compose the compile command
-  AVO_TAILWIND_COMPILE_COMMAND = "#{RbConfig.ruby} #{Pathname.new(GEM_PATH)}/exe/tailwindcss -i '#{Rails.root.join("app/assets/stylesheets/avo.css")}' -o '#{Rails.root.join(ASSET_FILE)}' -c '#{Rails.root.join("config/tailwind.config.js")}' --minify"
-
-  namespace "avo:tailwindcss" do
-    desc "Build your Tailwind CSS"
-    task :build do
-      system(AVO_TAILWIND_COMPILE_COMMAND, exception: true)
-    end
-
-    desc "Watch and build your Tailwind CSS on file changes"
-    task :watch do
-      system "#{AVO_TAILWIND_COMPILE_COMMAND} -w"
-    end
-  end
-end