vite_ruby 1.2.8 → 1.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e208284305c3370dd47dac35ef06af231c8ddd55b13b8870b7f32179e4c350c4
-  data.tar.gz: 1390d37229bf7d4139b0df3ce08d7e7b64877e2ad7ec041b7d49722545caa652
+  metadata.gz: ab9424e5c414c6c857c3e2b9fdeacbff44e5cdc7b39229085ff515f56e02b659
+  data.tar.gz: 2cc6fbd84be485d474d019f1e1767cb38bb34078066e551a449bd371cdc1d0bf
 SHA512:
-  metadata.gz: b99b7aaf20cb938245f5f83f61d5aace6ffc40519f139b51b9fa9ecd86c14b9098cfafb0b966e08048d64cb62848ff25b4ee086990b44469a44ec739c61712ba
-  data.tar.gz: cf4db82501767990f54d994a0c8fce16404a9d5156ef956990a1b3fb403ddd8a71a8e220f629c03c6d188400cc40176be650a2985dde6d2c677838fa25a87fee
+  metadata.gz: 8d08d31fe3266b032b9c81b61325b947883ae4435ca9df7038aa1e41d6382763169525d53acb4e52d7b3dd895b40aa923ed5248950ae2007380b767ed8f2f581
+  data.tar.gz: f109af25dd73336fc23685a3ad879d5b44cd2d9bcaf1523e427f4cb63aa9f950ad1d23462e8e4bddd4e9834e0f4c222d1a6d05d335bbead4dcb594686e05ea51

data/CHANGELOG.md

@@ -1,3 +1,46 @@
+## [1.2.13](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.12...vite_ruby@1.2.13) (2021-06-30)
+
+
+### Features
+
+* Improve the error message when npm packages are missing ([9159557](https://github.com/ElMassimo/vite_ruby/commit/9159557e5152547554cfe519fae8dbefe26686fb))
+
+
+
+## [1.2.12](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.11...vite_ruby@1.2.12) (2021-06-08)
+
+
+### Features
+
+* Support Ruby 2.4 ([#87](https://github.com/ElMassimo/vite_ruby/issues/87)) ([8fc4d49](https://github.com/ElMassimo/vite_ruby/commit/8fc4d49c82817623df81d6f9f94654ea726eb050))
+
+
+
+## [1.2.11](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.10...vite_ruby@1.2.11) (2021-05-10)
+
+### Refactor
+
+* Upgrade to dry-cli 0.7 while avoiding dependency on `dry-files` ([f5b87e](https://github.com/ElMassimo/vite_ruby/commit/f5b87e69790e48397d15e609b44118e399c9493d))
+
+
+## [1.2.10](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.9...vite_ruby@1.2.10) (2021-05-09)
+
+
+### Bug Fixes
+
+* Lock dry-cli to 0.6 since 0.7 has breaking changes (close [#76](https://github.com/ElMassimo/vite_ruby/issues/76)) ([9883458](https://github.com/ElMassimo/vite_ruby/commit/9883458443cb0047cd4cceaf02de2a86066d624e))
+
+
+
+## [1.2.9](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.8...vite_ruby@1.2.9) (2021-05-04)
+
+
+### Bug Fixes
+
+* Stream output during installation and don't skip installation of npm packages when no lockfile is detected ([#73](https://github.com/ElMassimo/vite_ruby/issues/73)) ([028a5ba](https://github.com/ElMassimo/vite_ruby/commit/028a5bae359085a36aa942d2ad63c23616a00ffb))
+
+
+
 ## [1.2.8](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.7...vite_ruby@1.2.8) (2021-04-29)
 
 

data/lib/vite_ruby.rb

@@ -10,6 +10,7 @@ loader.ignore("#{ __dir__ }/install")
 loader.ignore("#{ __dir__ }/tasks")
 loader.ignore("#{ __dir__ }/exe")
 loader.inflector.inflect('cli' => 'CLI')
+loader.inflector.inflect('io' => 'IO')
 loader.setup
 
 class ViteRuby
@@ -72,7 +73,7 @@ class ViteRuby
     # variant of Vite Ruby.
     def framework_libraries
       SUPPORTED_FRAMEWORKS.map { |framework|
-        if library = Gem.loaded_specs["vite_#{ framework }"]
+        if library = (Gem.loaded_specs["vite_#{ framework }"] || Gem.loaded_specs["vite_#{ framework }_legacy"])
           [framework, library]
         end
       }.compact

data/lib/vite_ruby/builder.rb

@@ -69,7 +69,7 @@ private
   def build_with_vite(*args)
     logger.info 'Building with Vite ⚡️'
 
-    stdout, stderr, status = ViteRuby.run(['build', *args], capture: true)
+    stdout, stderr, status = ViteRuby.run(['build', *args])
     log_build_result(stdout, stderr.to_s, status)
 
     status.success?

data/lib/vite_ruby/cli/build.rb

@@ -1,25 +1,13 @@
 # frozen_string_literal: true
 
-class ViteRuby::CLI::Build < Dry::CLI::Command
-  CURRENT_ENV = ENV['RACK_ENV'] || ENV['RAILS_ENV']
+class ViteRuby::CLI::Build < ViteRuby::CLI::Vite
   DEFAULT_ENV = CURRENT_ENV || 'production'
 
-  def self.shared_options
-    option(:mode, default: self::DEFAULT_ENV, values: %w[development production test], aliases: ['m'], desc: 'The build mode for Vite')
-    option(:clobber, desc: 'Clear cache and previous builds', type: :boolean, aliases: %w[clean clear])
-    option(:debug, desc: 'Run Vite in verbose mode, printing all debugging output', aliases: ['verbose'], type: :boolean)
-    option(:inspect, desc: 'Run Vite in a debugging session with node --inspect-brk', aliases: ['inspect-brk'], type: :boolean)
-    option(:trace_deprecation, desc: 'Run Vite in debugging mode with node --trace-deprecation', aliases: ['trace-deprecation'], type: :boolean)
-  end
-
   desc 'Bundle all entrypoints using Vite.'
   shared_options
   option(:force, desc: 'Force the build even if assets have not changed', type: :boolean)
 
-  def call(mode:, args: [], clobber: false, **boolean_opts)
-    ViteRuby.env['VITE_RUBY_MODE'] = mode
-    ViteRuby.commands.clobber if clobber
-    boolean_opts.map { |name, value| args << "--#{ name }" if value }
-    block_given? ? yield(args) : ViteRuby.commands.build_from_task(*args)
+  def call(**options)
+    super { |args| ViteRuby.commands.build_from_task(*args) }
   end
 end

data/lib/vite_ruby/cli/dev.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ViteRuby::CLI::Dev < ViteRuby::CLI::Build
+class ViteRuby::CLI::Dev < ViteRuby::CLI::Vite
   DEFAULT_ENV = CURRENT_ENV || 'development'
 
   desc 'Start the Vite development server.'
@@ -8,6 +8,6 @@ class ViteRuby::CLI::Dev < ViteRuby::CLI::Build
   option(:force, desc: 'Force Vite to re-bundle dependencies', type: :boolean)
 
   def call(**options)
-    super { |args| ViteRuby.run(args) }
+    super { |args| ViteRuby.run(args, exec: true) }
   end
 end

data/lib/vite_ruby/cli/file_utils.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'fileutils'
+
+# NOTE: Extracted from dry-cli version 0.6.0, which later removed this file as
+# it was refactored and extracted into the more complete (and complex) dry-files.
+module ViteRuby::CLI::FileUtils
+  class << self
+    # Creates a new file or rewrites the contents of an existing file.
+    #
+    # @since 1.2.11
+    # @api private
+    def write(path, *content)
+      mkdir_p(path)
+      File.open(path, File::CREAT | File::WRONLY | File::TRUNC) do |file|
+        file.write(Array(content).flatten.join)
+      end
+    end
+
+    # Copies source into destination.
+    #
+    # @since 1.2.11
+    # @api private
+    def cp(source, destination)
+      mkdir_p(destination)
+      FileUtils.cp(source, destination)
+    end
+
+    # Adds a new line at the bottom of the file.
+    #
+    # @since 1.2.11
+    # @api private
+    def append(path, contents)
+      mkdir_p(path)
+
+      content = File.readlines(path)
+      content << "\n" unless content.last.end_with?("\n")
+      content << "#{ contents }\n"
+
+      write(path, content)
+    end
+
+    # Replace first line in `path` that contains `target` with `replacement`.
+    #
+    # @since 1.2.11
+    # @api private
+    def replace_first_line(path, target, replacement)
+      content = File.readlines(path)
+      content[index(content, path, target)] = "#{ replacement }\n"
+
+      write(path, content)
+    end
+
+    # Inject `contents` in `path` before `target`.
+    #
+    # @since 1.2.11
+    # @api private
+    def inject_line_before(path, target, contents)
+      _inject_line_before(path, target, contents, method(:index))
+    end
+
+    # Inject `contents` in `path` after `target`.
+    #
+    # @since 1.2.11
+    # @api private
+    def inject_line_after(path, target, contents)
+      _inject_line_after(path, target, contents, method(:index))
+    end
+
+    # Inject `contents` in `path` after last `target`.
+    #
+    # @since 1.2.11
+    # @api private
+    def inject_line_after_last(path, target, contents)
+      _inject_line_after(path, target, contents, method(:rindex))
+    end
+
+  private
+
+    # Creates all parent directories for the given file path.
+    #
+    # @since 1.2.11
+    # @api private
+    def mkdir_p(path)
+      Pathname.new(path).dirname.mkpath
+    end
+
+    # @since 1.2.11
+    # @api private
+    def index(content, path, target)
+      content.index { |line| line.include?(target) } ||
+        raise(ArgumentError, "Cannot find `#{ target }' inside `#{ path }'.")
+    end
+
+    # @since 1.2.11
+    # @api private
+    def rindex(content, path, target)
+      content.rindex { |line| line.include?(target) } ||
+        raise(ArgumentError, "Cannot find `#{ target }' inside `#{ path }'.")
+    end
+
+    # @since 1.2.11
+    # @api private
+    def _inject_line_before(path, target, contents, finder)
+      content = File.readlines(path)
+      i = finder.call(content, path, target)
+
+      content.insert(i, "#{ contents }\n")
+      write(path, content)
+    end
+
+    # @since 1.2.11
+    # @api private
+    def _inject_line_after(path, target, contents, finder)
+      content = File.readlines(path)
+      i = finder.call(content, path, target)
+
+      content.insert(i + 1, "#{ contents }\n")
+      write(path, content)
+    end
+  end
+end

data/lib/vite_ruby/cli/install.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/cli/utils/files'
 require 'stringio'
-require 'open3'
 
 class ViteRuby::CLI::Install < Dry::CLI::Command
   desc 'Performs the initial configuration setup to get started with Vite Ruby.'
@@ -50,9 +48,9 @@ private
 
   def_delegators 'ViteRuby', :config
 
-  %i[append cp inject_line_after inject_line_after_last inject_line_before write].each do |util|
+  %i[append cp inject_line_after inject_line_after_last inject_line_before replace_first_line write].each do |util|
     define_method(util) { |*args|
-      Dry::CLI::Utils::Files.send(util, *args) rescue nil
+      ViteRuby::CLI::FileUtils.send(util, *args) rescue nil
     }
   end
 
@@ -73,11 +71,12 @@ private
   def install_js_dependencies
     package_json = root.join('package.json')
     write(package_json, '{}') unless package_json.exist?
+
     Dir.chdir(root) do
       deps = "vite@#{ ViteRuby::DEFAULT_VITE_VERSION } vite-plugin-ruby@#{ ViteRuby::DEFAULT_PLUGIN_VERSION }"
-      stdout, stderr, status = Open3.capture3({}, "npx --yes --package @antfu/ni -- ni -D #{ deps }")
-      stdout, stderr, = Open3.capture3({}, "yarn add -D #{ deps }") unless status.success?
-      say(stdout, "\n", stderr)
+      _, stderr, status = ViteRuby::IO.capture("npx --package @antfu/ni -- ni -D #{ deps }", stdin_data: "\n")
+      _, stderr, = ViteRuby::IO.capture("yarn add -D #{ deps }") unless status.success?
+      say("Could not install JS dependencies.\n", stderr) unless stderr.to_s.empty?
     end
   end
 

data/lib/vite_ruby/cli/vite.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class ViteRuby::CLI::Vite < Dry::CLI::Command
+  CURRENT_ENV = ENV['RACK_ENV'] || ENV['RAILS_ENV']
+
+  def self.shared_options
+    option(:mode, default: self::DEFAULT_ENV, values: %w[development production test], aliases: ['m'], desc: 'The build mode for Vite')
+    option(:clobber, desc: 'Clear cache and previous builds', type: :boolean, aliases: %w[clean clear])
+    option(:debug, desc: 'Run Vite in verbose mode, printing all debugging output', aliases: ['verbose'], type: :boolean)
+    option(:inspect, desc: 'Run Vite in a debugging session with node --inspect-brk', aliases: ['inspect-brk'], type: :boolean)
+    option(:trace_deprecation, desc: 'Run Vite in debugging mode with node --trace-deprecation', aliases: ['trace-deprecation'], type: :boolean)
+  end
+
+  def call(mode:, args: [], clobber: false, **boolean_opts)
+    ViteRuby.env['VITE_RUBY_MODE'] = mode
+    ViteRuby.commands.clobber if clobber
+    boolean_opts.map { |name, value| args << "--#{ name }" if value }
+    yield(args)
+  end
+end

data/lib/vite_ruby/io.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+# Public: Builds on top of Ruby I/O open3 providing a friendlier experience.
+module ViteRuby::IO
+  class << self
+    # Internal: A modified version of capture3 that can continuosly print stdout.
+    # NOTE: Streaming output provides a better UX when running bin/vite build.
+    def capture(*cmd, with_output: $stdout.method(:puts), stdin_data: '', **opts)
+      return Open3.capture3(*cmd, **opts) unless with_output
+
+      Open3.popen3(*cmd, **opts) { |stdin, stdout, stderr, wait_threads|
+        stdin << stdin_data
+        stdin.close
+        out = Thread.new { read_lines(stdout, &with_output) }
+        err = Thread.new { stderr.read }
+        [out.value, err.value, wait_threads.value]
+      }
+    end
+
+    # Internal: Reads and yield every line in the stream. Returns the full content.
+    def read_lines(io)
+      buffer = +''
+      while line = io.gets
+        buffer << line
+        yield line
+      end
+      buffer
+    end
+  end
+end

data/lib/vite_ruby/missing_executable_error.rb

@@ -4,7 +4,7 @@
 class ViteRuby::MissingExecutableError < ViteRuby::Error
   def initialize(error = nil)
     super <<~MSG
-      ❌ The vite binary is not available. Have you installed Vite?
+      ❌ The vite binary is not available. Have you installed the npm packages?
 
       :troubleshooting:
       #{ error }

data/lib/vite_ruby/runner.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'open3'
-
 # Public: Executes Vite commands, providing conveniences for debugging.
 class ViteRuby::Runner
   def initialize(vite_ruby)
@@ -9,10 +7,13 @@ class ViteRuby::Runner
   end
 
   # Public: Executes Vite with the specified arguments.
-  def run(argv, capture: false)
+  def run(argv, exec: false)
     Dir.chdir(config.root) {
       cmd = command_for(argv)
-      capture ? capture3_with_output(*cmd, chdir: config.root) : Kernel.exec(*cmd)
+      return Kernel.exec(*cmd) if exec
+
+      log_or_noop = ->(line) { logger.info('vite') { line } } unless config.hide_build_console_output
+      ViteRuby::IO.capture(*cmd, chdir: config.root, with_output: log_or_noop)
     }
   rescue Errno::ENOENT => error
     raise ViteRuby::MissingExecutableError, error
@@ -41,26 +42,4 @@ private
     bin_path = config.vite_bin_path
     File.exist?(bin_path) ? bin_path : "#{ `npm bin`.chomp }/vite"
   end
-
-  # Internal: A modified version of capture3 that continuosly prints stdout.
-  # NOTE: This improves the experience of running bin/vite build.
-  def capture3_with_output(*cmd, **opts)
-    return Open3.capture3(*cmd, opts) if config.hide_build_console_output
-
-    Open3.popen3(*cmd, opts) { |_stdin, stdout, stderr, wait_threads|
-      out = Thread.new { read_lines(stdout) { |l| logger.info('vite') { l } } }
-      err = Thread.new { stderr.read }
-      [out.value, err.value, wait_threads.value]
-    }
-  end
-
-  # Internal: Reads and yield every line in the stream. Returns the full content.
-  def read_lines(io)
-    buffer = +''
-    while line = io.gets
-      buffer << line
-      yield line
-    end
-    buffer
-  end
 end

data/lib/vite_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ViteRuby
-  VERSION = '1.2.8'
+  VERSION = '1.2.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.13
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rack-proxy
   requirement: !ruby/object:Gem::Requirement
@@ -142,48 +142,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -219,12 +177,15 @@ files:
 - lib/vite_ruby/cli/build.rb
 - lib/vite_ruby/cli/clobber.rb
 - lib/vite_ruby/cli/dev.rb
+- lib/vite_ruby/cli/file_utils.rb
 - lib/vite_ruby/cli/install.rb
 - lib/vite_ruby/cli/version.rb
+- lib/vite_ruby/cli/vite.rb
 - lib/vite_ruby/commands.rb
 - lib/vite_ruby/config.rb
 - lib/vite_ruby/dev_server_proxy.rb
 - lib/vite_ruby/error.rb
+- lib/vite_ruby/io.rb
 - lib/vite_ruby/manifest.rb
 - lib/vite_ruby/missing_entrypoint_error.rb
 - lib/vite_ruby/missing_executable_error.rb
@@ -237,8 +198,8 @@ homepage: https://github.com/ElMassimo/vite_ruby
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@1.2.8/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@1.2.8/vite_ruby/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@1.2.13/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@1.2.13/vite_ruby/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -247,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="