package_json 0.1.0

data/lib/package_json/managers/yarn_berry_like.rb

@@ -0,0 +1,81 @@
+class PackageJson
+  module Managers
+    class YarnBerryLike < Base
+      def initialize(package_json)
+        super(package_json, binary_name: "yarn")
+      end
+
+      # Installs the dependencies specified in the `package.json` file
+      def install(frozen: false)
+        raw("install", with_frozen_flag(frozen))
+      end
+
+      # Provides the "native" command for installing dependencies with this package manager for embedding into scripts
+      def native_install_command(frozen: false)
+        build_full_cmd("install", with_frozen_flag(frozen))
+      end
+
+      # Adds the given packages
+      def add(packages, type: :production)
+        raw("add", [package_type_install_flag(type)].compact + packages)
+      end
+
+      # Removes the given packages
+      def remove(packages)
+        raw("remove", packages)
+      end
+
+      # Runs the script assuming it is defined in the `package.json` file
+      def run(
+        script_name,
+        args = [],
+        silent: false
+      )
+        raw("run", build_run_args(script_name, args, _silent: silent))
+      end
+
+      # Provides the "native" command for running the script with args for embedding into shell scripts
+      def native_run_command(
+        script_name,
+        args = [],
+        silent: false
+      )
+        build_full_cmd("run", build_run_args(script_name, args, _silent: silent))
+      end
+
+      def native_exec_command(
+        script_name,
+        args = []
+      )
+        build_full_cmd("exec", build_run_args(script_name, args, _silent: false))
+      end
+
+      private
+
+      def build_run_args(script_name, args, _silent:)
+        [script_name, *args]
+      end
+
+      def with_frozen_flag(frozen)
+        return ["--immutable"] if frozen
+
+        # we make frozen lockfile behaviour consistent with the other package managers as
+        # yarn berry automatically enables frozen lockfile if it detects it's running in CI
+        ["--no-immutable"]
+      end
+
+      def package_type_install_flag(type)
+        case type
+        when :production
+          nil
+        when :dev
+          "--dev"
+        when :optional
+          "--optional"
+        else
+          raise Error, "unsupported package install type \"#{type}\""
+        end
+      end
+    end
+  end
+end

data/lib/package_json/managers/yarn_classic_like.rb

@@ -0,0 +1,95 @@
+class PackageJson
+  module Managers
+    class YarnClassicLike < Base
+      def initialize(package_json)
+        super(package_json, binary_name: "yarn")
+      end
+
+      # Installs the dependencies specified in the `package.json` file
+      def install(frozen: false)
+        raw("install", with_frozen_flag(frozen))
+      end
+
+      # Provides the "native" command for installing dependencies with this package manager for embedding into scripts
+      def native_install_command(frozen: false)
+        build_full_cmd("install", with_frozen_flag(frozen))
+      end
+
+      # Adds the given packages
+      def add(packages, type: :production)
+        raw("add", [package_type_install_flag(type)].compact + packages)
+      end
+
+      # Removes the given packages
+      def remove(packages)
+        raw("remove", packages)
+      end
+
+      # Runs the script assuming it is defined in the `package.json` file
+      def run(
+        script_name,
+        args = [],
+        silent: false
+      )
+        raw("run", build_run_args(script_name, args, silent: silent))
+      end
+
+      # Provides the "native" command for running the script with args for embedding into shell scripts
+      def native_run_command(
+        script_name,
+        args = [],
+        silent: false
+      )
+        build_full_cmd("run", build_run_args(script_name, args, silent: silent))
+      end
+
+      def native_exec_command(
+        script_name,
+        args = []
+      )
+        [File.join(fetch_bin_path, script_name), *args]
+      end
+
+      private
+
+      def fetch_bin_path
+        require "open3"
+
+        command = build_full_cmd("bin", []).join(" ")
+        stdout, stderr, status = Open3.capture3(command, chdir: @package_json.directory)
+
+        unless status.success?
+          raise PackageJson::Error, "#{command} failed with exit code #{status.exitstatus}: #{stderr}"
+        end
+
+        stdout.chomp
+      end
+
+      def build_run_args(script_name, args, silent:)
+        args = [script_name, *args]
+
+        args.unshift("--silent") if silent
+        args
+      end
+
+      def with_frozen_flag(frozen)
+        return ["--frozen-lockfile"] if frozen
+
+        []
+      end
+
+      def package_type_install_flag(type)
+        case type
+        when :production
+          nil
+        when :dev
+          "--dev"
+        when :optional
+          "--optional"
+        else
+          raise Error, "unsupported package install type \"#{type}\""
+        end
+      end
+    end
+  end
+end

data/lib/package_json/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class PackageJson
+  VERSION = "0.1.0"
+end

data/lib/package_json.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative "package_json/managers/base"
+require_relative "package_json/managers/bun_like"
+require_relative "package_json/managers/npm_like"
+require_relative "package_json/managers/pnpm_like"
+require_relative "package_json/managers/yarn_berry_like"
+require_relative "package_json/managers/yarn_classic_like"
+require_relative "package_json/version"
+require "json"
+
+class PackageJson
+  class Error < StandardError; end
+
+  class NotImplementedError < Error; end
+
+  attr_reader :manager, :directory
+
+  def self.fetch_default_fallback_manager
+    ENV.fetch("PACKAGE_JSON_FALLBACK_MANAGER", "npm").to_sym
+  end
+
+  def self.read(path_to_directory = Dir.pwd, fallback_manager: PackageJson.fetch_default_fallback_manager)
+    unless File.exist?("#{path_to_directory}/package.json")
+      raise Error, "#{path_to_directory} does not contain a package.json"
+    end
+
+    new(path_to_directory, fallback_manager: fallback_manager)
+  end
+
+  def initialize(path_to_directory = Dir.pwd, fallback_manager: PackageJson.fetch_default_fallback_manager)
+    @directory = File.absolute_path(path_to_directory)
+
+    existed = ensure_package_json_exists
+
+    @manager = new_package_manager(determine_package_manager(fallback_manager))
+
+    # only record the packageManager automatically if we created the package.json
+    record_package_manager! unless existed
+  end
+
+  def fetch(key, default = (no_default_set_by_user = true; nil))
+    contents = read_package_json
+
+    if no_default_set_by_user
+      contents.fetch(key)
+    else
+      contents.fetch(key, default)
+    end
+  end
+
+  # Merges the hash returned by the passed block into the existing content of the `package.json`
+  def merge!
+    pj = read_package_json
+
+    write_package_json(pj.merge(yield read_package_json))
+  end
+
+  def delete!(key)
+    pj = read_package_json
+
+    value = pj.delete(key)
+
+    write_package_json(pj)
+
+    value
+  end
+
+  def record_package_manager!
+    merge! { { "packageManager" => "#{manager.binary}@#{manager.version}" } }
+  end
+
+  private
+
+  def determine_package_manager(fallback_manager)
+    package_manager = fetch("packageManager", nil)
+
+    return fallback_manager if package_manager.nil?
+
+    name, version = package_manager.split("@")
+
+    if name == "yarn"
+      raise Error, "a major version must be present for Yarn" if version.nil? || version.empty?
+      return :yarn_classic if version.start_with?("1")
+
+      return :yarn_berry
+    end
+
+    name.to_sym
+  end
+
+  def new_package_manager(package_manager_name)
+    case package_manager_name
+    when :npm
+      PackageJson::Managers::NpmLike.new(self)
+    when :yarn_berry
+      PackageJson::Managers::YarnBerryLike.new(self)
+    when :yarn_classic
+      PackageJson::Managers::YarnClassicLike.new(self)
+    when :pnpm
+      PackageJson::Managers::PnpmLike.new(self)
+    when :bun
+      PackageJson::Managers::BunLike.new(self)
+    else
+      raise Error, "unsupported package manager \"#{package_manager_name}\""
+    end
+  end
+
+  def package_json_path
+    "#{directory}/package.json"
+  end
+
+  def ensure_package_json_exists
+    return true if File.exist?(package_json_path)
+
+    write_package_json({})
+
+    false
+  end
+
+  def read_package_json
+    JSON.parse(File.read(package_json_path))
+  end
+
+  def write_package_json(contents)
+    File.write(package_json_path, "#{JSON.pretty_generate(contents)}\n")
+  end
+end

data/sig/package_json/managers/base.rbs

@@ -0,0 +1,57 @@
+class PackageJson
+  module Managers
+    class Base
+      attr_reader binary: String
+
+      def initialize: (PackageJson package_json, binary_name: String) -> self
+
+      def version: () -> String
+
+      def install: (?frozen: bool) -> (bool | nil)
+
+      def install!: (?frozen: bool) -> void
+
+      def native_install_command: (?frozen: bool) -> Array[String]
+
+      def add: (Array[String] packages, ?type: :production | :dev | :optional) -> (bool | nil)
+
+      def add!: (Array[String] packages, ?type: :production | :dev | :optional) -> void
+
+      def remove: (Array[String] packages) -> (bool | nil)
+
+      def remove!: (Array[String] packages) -> void
+
+      def run: (
+          String script_name,
+          ?Array[String] args,
+          ?silent: bool
+        ) -> (bool | nil)
+
+      def run!: (
+          String script_name,
+          ?Array[String] args,
+          ?silent: bool
+        ) -> void
+
+      def native_run_command: (
+          String script_name,
+          ?Array[String] args,
+          ?silent: bool
+        ) -> Array[String]
+
+      def native_exec_command: (
+          String script_name,
+          ?Array[String] args
+        ) -> Array[String]
+
+      private
+
+      @binary: String
+      @package_json: PackageJson
+
+      def build_full_cmd: (String sub_cmd, Array[String] args) -> Array[String]
+
+      def raw: (String sub_cmd, Array[String] args) -> (bool | nil)
+    end
+  end
+end

data/sig/package_json/managers/bun_like.rbs

@@ -0,0 +1,19 @@
+class PackageJson
+  module Managers
+    class BunLike < Base
+      def initialize: (PackageJson package_json) -> self
+
+      private
+
+      def build_run_args: (
+          String script_name,
+          Array[String] args,
+          _silent: bool
+        ) -> Array[String]
+
+      def with_frozen_flag: (bool frozen) -> Array[String]
+
+      def package_type_install_flag: (Symbol type) -> (String | nil)
+    end
+  end
+end

data/sig/package_json/managers/npm_like.rbs

@@ -0,0 +1,17 @@
+class PackageJson
+  module Managers
+    class NpmLike < Base
+      def initialize: (PackageJson package_json) -> self
+
+      private
+
+      def build_run_args: (
+          String script_name,
+          Array[String] args,
+          silent: bool
+        ) -> Array[String]
+
+      def package_type_install_flag: (Symbol type) -> String
+    end
+  end
+end

data/sig/package_json/managers/pnpm_like.rbs

@@ -0,0 +1,19 @@
+class PackageJson
+  module Managers
+    class PnpmLike < Base
+      def initialize: (PackageJson package_json) -> self
+
+      private
+
+      def build_run_args: (
+          String script_name,
+          Array[String] args,
+          silent: bool
+        ) -> Array[String]
+
+      def with_frozen_flag: (bool frozen) -> Array[String]
+
+      def package_type_install_flag: (Symbol type) -> String
+    end
+  end
+end

data/sig/package_json/managers/yarn_berry_like.rbs

@@ -0,0 +1,19 @@
+class PackageJson
+  module Managers
+    class YarnBerryLike < Base
+      def initialize: (PackageJson package_json) -> self
+
+      private
+
+      def build_run_args: (
+          String script_name,
+          Array[String] args,
+          _silent: bool
+        ) -> Array[String]
+
+      def with_frozen_flag: (bool frozen) -> Array[String]
+
+      def package_type_install_flag: (Symbol type) -> (String | nil)
+    end
+  end
+end

data/sig/package_json/managers/yarn_classic_like.rbs

@@ -0,0 +1,21 @@
+class PackageJson
+  module Managers
+    class YarnClassicLike < Base
+      def initialize: (PackageJson package_json) -> self
+
+      private
+
+      def fetch_bin_path: () -> String
+
+      def build_run_args: (
+          String script_name,
+          Array[String] args,
+          silent: bool
+        ) -> Array[String]
+
+      def with_frozen_flag: (bool frozen) -> Array[String]
+
+      def package_type_install_flag: (Symbol type) -> (String | nil)
+    end
+  end
+end

data/sig/package_json.rbs

@@ -0,0 +1,38 @@
+class PackageJson
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class NotImplementedError < Error
+  end
+
+  attr_reader manager: Managers::Base
+  attr_reader directory: String
+
+  def self.fetch_default_fallback_manager: () -> Symbol
+
+  def self.read: (?String path_to_directory, ?package_manager: (:npm | :yarn_berry | :yarn_classic | :pnpm | :bun)) -> PackageJson
+
+  def initialize: (?String path_to_directory, ?package_manager: (:npm | :yarn_berry | :yarn_classic | :pnpm | :bun)) -> PackageJson
+
+  def fetch: (String key, ?untyped default) -> (String | Hash[String, untyped] | Array[untyped])
+
+  def merge!: () { (Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped] } -> void
+
+  private
+
+  @directory: String
+
+  def determine_package_manager: (Symbol fallback_manager) -> Symbol
+
+  def new_package_manager: (Symbol package_manager_name) -> Managers::Base
+
+  def package_json_path: () -> String
+
+  def ensure_package_json_exists: ((:npm | :yarn_berry | :yarn_classic | :pnpm | :bun) package_manager) -> void
+
+  def read_package_json: () -> void
+
+  def write_package_json: (_ToJson contents) -> void
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: package_json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gareth Jones
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-09-15 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- open-source@ackama.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".prettierignore"
+- ".prettierrc.json"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/package_json.rb
+- lib/package_json/managers/base.rb
+- lib/package_json/managers/bun_like.rb
+- lib/package_json/managers/npm_like.rb
+- lib/package_json/managers/pnpm_like.rb
+- lib/package_json/managers/yarn_berry_like.rb
+- lib/package_json/managers/yarn_classic_like.rb
+- lib/package_json/version.rb
+- sig/package_json.rbs
+- sig/package_json/managers/base.rbs
+- sig/package_json/managers/bun_like.rbs
+- sig/package_json/managers/npm_like.rbs
+- sig/package_json/managers/pnpm_like.rbs
+- sig/package_json/managers/yarn_berry_like.rbs
+- sig/package_json/managers/yarn_classic_like.rbs
+homepage: https://github.com/G-Rath/package_json
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/G-Rath/package_json
+  source_code_uri: https://github.com/G-Rath/package_json
+  changelog_uri: https://github.com/G-Rath/package_json
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: The missing gem for managing package.json files in Ruby
+test_files: []