psdk-cli 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e1c68b5b558c65d5b9befc52c67bb126daa9375154ee17a0c51ba7f849061c3
-  data.tar.gz: 915b045d732b8eb562aee73ed431a0fb3f5ee195a4676876ca68d9140ddb726e
+  metadata.gz: 6295fefe865cbe37d27bb3f32e56a66ed1ce9a69501eb18c974101003a961e1d
+  data.tar.gz: 7478cdb74640fa0e52aecefce1fc3445cfc6ec78bccd1f5a29263de93550d960
 SHA512:
-  metadata.gz: a70f48b02327d705364a89464f49666969707cd62c90aa2ee2f87997443433b95f06d0274c060fa8544646f2e9f1dec02c87ec3e2460183503290c1a75fee61a
-  data.tar.gz: b7501d4824fde0501759909b134bb9731f29705b57d9c3319dbf2f8d74674009bb60801534bf219415b658f65acdd22546f144bf9cbe6bc1f01b590e5d2663a3
+  metadata.gz: 477617bf0fbef65be4a5f4c9a3088cd882df1a0abd0169384740ea77c5552b687a6d9a8dde58dab53841e70c7564054f6987ca89b599d1180244c24e23915ab7
+  data.tar.gz: c11218c05638142d4f6b7e36ce0620508d424f141791d1466ac089aadb9125aa955766d7d59fdfc9ed7671b6eab37fbc93b10ad38343ecee7f9a5da6926bc205

data/.idea/plugin/PluginManager.md

@@ -0,0 +1,65 @@
+## Story
+
+Source: [Github Issue #10](https://github.com/PokemonWorkshop/psdk-cli/issues/10)
+
+### Description
+
+As a developer, I want to use `psdk-plugin` to manage my PSDK plugins (create, test, update) to simplify maintenance.
+
+> [!NOTE]
+> We'll remove the plugin command from PSDK (aside the one for loading the plugin) and psdk cli will be responsible of plugin management (including build).
+> It'll accept both workflow:
+> - Plugin inside a PSDK project (meaning the resources are expected to be at the root of the project and scripts at the root of the plugin)
+> - Plugin outside a PSDK project (meaning both resources and scripts are expected to be at the root of the plugin)
+> The definition file remain the same for both workflow  
+
+### Acceptance criteria
+
+- [ ] `psdk-plugin` exposes the same arguments as the original plugin manager.
+- [ ] The command detects the project or switches to standalone mode.
+- [ ] A clear message lists available actions (list, build).
+
+## Information about `PluginManager.rb`
+
+This file depends on Yuki::VD (defined in `lib/psdk/helpers/900 Yuki__VD.rb`)
+
+This file was taken out of Pokémon SDK and currently is only working in the context of a PSDK project.
+
+In the psdk-cli I want the following commands:
+
+- `PluginManager.start(:build, 'plugin_name')`
+- `PluginManager.start(:list)`
+
+The `PluginManager.start(:load)` should never work in the psdk-cli as it's supposed to run in a game not in the CLI.
+
+Currently, the build process expects the following structure:
+
+- `scripts/{plugin_name}/config.yml` (plugin configuration file)
+- `scripts/{plugin_name}/script/**/*.rb` (scripts, automatic)
+- `graphics/**/*.*` (added_file)
+- `Data/**/*.*` (added_files)
+- `audio/**/*.*` (added_files)
+
+I want this process to be preserved if psdk-cli is running in a PSDK project (`Configuration.project_path != nil`). And if I'm not in a project (or a --no-psdk-project flag is set). I want the following structure so developing plugins is easier:
+
+- `config.yml` (plugin configuration file)
+- `scripts/**/*.rb` (scripts, automatic)
+- `graphics/**/*.*` (added_file)
+- `Data/**/*.*` (added_files)
+- `audio/**/*.*` (added_files)
+
+In this structure, it's assumed that we are inside `{plugin_name}` (if we use `.` as plugin directory we should skip the plugin_name argument of `PluginManager.start(:build)` since the name is also inside `config.yml`)
+
+## Task to perform
+
+1. Explode `PluginManager.rb` in several ruby scripts that are able to perform the following operations:
+   - `list` all the plugins of current project (should fail if not in a project)
+   - `build` a plugin (name is optional, if not provided and not in a project, it's `.`)
+2. Rewrite the Build command so it's
+   1. Verbose (explaining each stuff it does and where it is)
+   2. Able to work outside of a psdk project (should also state it's not in a PSDK project)
+3. Move the exploded PluginManager files to `lib/psdk/helpers/plugin-manager`
+4. Write a script in `lib/psdk/cli` to expose the `psdk-cli plugin` cli commands
+5. Write a `psdk-plugin` file in `exe` (so I can run `psdk-plugin` instead of `psdk-cli plugin`)
+6. Write unit tests in `spec` for Exploded PluginManager files
+7. Write unit tests in `spec` for the `psdk-cli plugin` commands

data/.solargraph.yml

@@ -1,19 +1,19 @@
 ---
 include:
-- Rakefile
-- Gemfile
-- "*.gemspec"
-- "**/*.rb"
+  - Rakefile
+  - Gemfile
+  - "*.gemspec"
+  - "**/*.rb"
 exclude:
-- spec/**/*
-- test/**/*
-- vendor/**/*
-- ".bundle/**/*"
+  - spec/**/*
+  - test/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
 require: []
 domains: []
 reporters:
-- rubocop
-- require_not_found
+  - rubocop
+  # - require_not_found
 formatter:
   rubocop:
     cops: safe
@@ -21,5 +21,6 @@ formatter:
     only: []
     extra_args: []
 require_paths: []
-plugins: []
+plugins:
+  - solargraph-rspec
 max_files: 5000

data/CHANGELOG.md

@@ -1,5 +1,9 @@
+# Changelog
+
 ## [Unreleased]
 
+- Implement `psdk-use version`, `commit`, `mr`, and `latest` sub-commands.
+
 ## [0.1.0] - 2025-11-12
 
 - Initial release

data/README.md

@@ -12,7 +12,7 @@ gem install psdk-cli
 
 ## Usage
 
-In a terminal you can run `psdk-cli` it will list all the available commands. 
+In a terminal you can run `psdk-cli` it will list all the available commands.
 
 Please note that sub command (such as `psdk-cli plugin`) can be executed using the shortcut `psdk-<sub>` (eg. `psdk-plugin` for `psdk-cli plugin`).
 

data/exe/psdk-use

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'psdk/cli/use'
+
+Psdk::Cli::Use.start

data/lib/psdk/cli/configuration.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Psdk
+  module Cli
+    # Class holding the configuration of the Cli
+    class Configuration
+      # Filename of the project configuration
+      PROJECT_CONFIGURATION_FILENAME = '.psdk-cli.yml'
+
+      # Path where all the global configuration are stored
+      PATH = File.join(ENV.fetch('PSDK_CLI_DIR', Dir.home || ENV['USERPROFILE'] || '~'), '.psdk-cli')
+
+      # Filename of the global configuration
+      GLOBAL_CONFIGURATION_FILENAME = File.join(PATH, 'config.yml')
+
+      # Create a new configuration
+      # @param hash [Hash] configuration hash
+      def initialize(hash)
+        hash = {} unless hash.is_a?(Hash)
+        # @type [String]
+        @studio_path = ''
+        # @type [Array<String>]
+        @project_paths = []
+
+        self.studio_path = hash[:studio_path] if hash.key?(:studio_path)
+        self.project_paths = hash[:project_paths] if hash.key?(:project_paths)
+      end
+
+      # Get the Pokémon Studio path
+      # @return [String]
+      attr_reader :studio_path
+
+      # Set the Pokémon Studio path
+      # @param path [String]
+      def studio_path=(path)
+        unless Dir.exist?(path) || path.empty?
+          puts "[Error] Invalid studio_path at `#{path}`, this path does not exists"
+          return
+        end
+        # TODO: add check for locating psdk-binaries
+        @studio_path = path
+      end
+
+      # Get the project paths
+      # @return [Array<String>]
+      attr_reader :project_paths
+
+      # Set the project_paths
+      # @param paths [Array<String>]
+      def project_paths=(paths)
+        unless paths.is_a?(Array)
+          puts '[Error] project_paths is not an array'
+          return
+        end
+        unless paths.all? { |path| path.is_a?(String) }
+          puts '[Error] some of the project paths are not path'
+          return
+        end
+
+        @project_paths = paths
+      end
+
+      def to_h
+        return {
+          studio_path: @studio_path,
+          project_paths: @project_paths
+        }
+      end
+
+      class << self
+        @global = nil
+        @local = nil
+
+        # Get the project path
+        # @return [String | nil]
+        attr_reader :project_path
+
+        # Get the configuration
+        # @param type [:global | :local]
+        # @return [Configuration]
+        def get(type)
+          @global ||= Configuration.new(load_hash(GLOBAL_CONFIGURATION_FILENAME))
+          return @global if type == :global
+
+          project_path = find_project_path
+          @local = nil if @project_path != project_path
+          @project_path = project_path
+          @local ||= Configuration.new(
+            @global.to_h.merge(load_hash(File.join(*@project_path, PROJECT_CONFIGURATION_FILENAME)))
+          )
+
+          return @local
+        end
+
+        # Save the configuration
+        def save
+          make_config_global_dir
+          File.write(GLOBAL_CONFIGURATION_FILENAME, YAML.dump(@global.to_h))
+          return unless @local && @project_path
+
+          local_configuration = @local.to_h
+          # Delete global configuration keys
+          local_configuration.delete(:project_paths)
+
+          File.write(File.join(@project_path, PROJECT_CONFIGURATION_FILENAME), YAML.dump(local_configuration))
+        end
+
+        private
+
+        def make_config_global_dir
+          dirname = File.dirname(GLOBAL_CONFIGURATION_FILENAME)
+          return if Dir.exist?(dirname)
+
+          Dir.mkdir(dirname)
+        end
+
+        def load_hash(path)
+          return {} unless File.exist?(path)
+
+          return YAML.load_file(path, symbolize_names: true, freeze: true)
+        rescue StandardError => e
+          puts "[Error] failed to load configuration (#{e.message})"
+          puts e.backtrace
+          return {}
+        end
+
+        # Get the project path
+        # @return [String | nil]
+        def find_project_path
+          current_path = Dir.pwd.gsub('\\', '/').split('/')
+          all_options = current_path.size.downto(2).map { |i| File.join(*current_path[0...i]) }
+          return all_options.find { |path| File.exist?(File.join(path, 'project.studio')) }
+        end
+      end
+    end
+  end
+end

data/lib/psdk/cli/plugin.rb

@@ -8,10 +8,39 @@ module Psdk
     class Plugin < Thor
       package_name 'psdk-plugin'
 
-      # TODO: remove this and actually implement the plugin cli
-      desc 'fake ARG1', 'run a fake command with ARG1 as first argument'
-      def fake(arg1)
-        puts "Fake called with ARG1=#{arg1}"
+      desc 'list', 'List all installed plugins in the current PSDK project'
+      def list
+        require_relative 'configuration'
+        require_relative '../helpers/plugin_manager'
+        Psdk::Cli::Configuration.get(:local)
+
+        unless Psdk::Cli::Configuration.project_path
+          puts 'Error: You must be inside a PSDK project to use `psdk-plugin list`.'
+          exit(1)
+        end
+
+        PluginManager.list
+      end
+
+      desc 'build [PLUGIN_NAME]', 'Build a plugin (requires to be at the root of the project or the plugin)'
+      option :no_psdk_project, type: :boolean, desc: 'Force standalone mode (build outside a PSDK project)'
+      option :out_dir, type: :string, default: '.', desc: 'Output directory for the generated .psdkplug file'
+      def build(plugin_name = nil) # rubocop:disable Metrics/MethodLength
+        require_relative 'configuration'
+        require_relative '../helpers/plugin_manager'
+        Psdk::Cli::Configuration.get(:local)
+
+        in_project = Psdk::Cli::Configuration.project_path
+        in_project = false if options[:no_psdk_project]
+
+        plugin_name = '.' if !in_project && plugin_name.nil?
+
+        unless plugin_name
+          puts 'Error: You must provide a plugin_name when building inside a PSDK project.'
+          exit(1)
+        end
+
+        PluginManager.build(plugin_name, in_project: in_project, out_dir: options[:out_dir])
       end
     end
   end

data/lib/psdk/cli/use.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Psdk
+  module Cli
+    # Class responsible of handling the psdk-use cli commands
+    class Use < Thor
+      package_name 'psdk-use'
+
+      desc 'studio [--delete]', 'make the project use Pokemon Studio PSDK version.'
+      method_option :delete, type: :boolean, aliases: '--delete',
+                             desc: 'delete local pokemonsdk folder'
+      def studio
+        ensure_project
+        require_relative '../helpers/psdk'
+        PSDK.unuse_local_pokemonsdk(delete: options[:delete])
+      end
+
+      desc 'version [PSDK_VERSION]', 'make the project use a specific PSDK version'
+      def version(psdk_version)
+        ensure_project
+        require_relative '../helpers/psdk'
+        PSDK.use_version(psdk_version)
+      end
+
+      desc 'commit [SHA1]', 'make the project use a specific PSDK commit'
+      def commit(sha1)
+        ensure_project
+        require_relative '../helpers/psdk'
+        PSDK.use_commit(sha1)
+      end
+
+      desc 'mr [ID]', 'make the project use a specific MR'
+      def mr(id)
+        ensure_project
+        require_relative '../helpers/psdk'
+        PSDK.use_mr(id)
+      end
+
+      desc 'latest', 'make the project use the latest PSDK commit from development'
+      def latest
+        ensure_project
+        require_relative '../helpers/psdk'
+        PSDK.use_latest
+      end
+
+      private
+
+      def ensure_project
+        require_relative 'configuration'
+        Configuration.get(:local)
+        return if Configuration.project_path
+
+        $stderr.puts 'Not in a project'
+        exit(1)
+      end
+    end
+  end
+end

data/lib/psdk/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Psdk
   module Cli
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/psdk/cli.rb

@@ -3,6 +3,7 @@
 require 'thor'
 require_relative 'cli/version'
 require_relative 'cli/plugin'
+require_relative 'cli/use'
 
 module Psdk
   module Cli
@@ -12,13 +13,25 @@ module Psdk
     class Main < Thor
       package_name 'psdk-cli'
 
-      desc('version', 'show the psdk-cli version')
+      desc 'version', 'show the psdk-cli version'
+      method_option :no_psdk_version, type: :boolean, aliases: '--no-psdk-version',
+                                      desc: 'do not search and show PSDK version'
       def version
-        puts "psdk-cli v#{VERSION}"
+        require_relative 'helpers/version'
+        Version.run(options[:no_psdk_version])
+      end
+
+      desc 'update', 'update the psdk-cli'
+      def update
+        require_relative 'helpers/version_update'
+        VersionUpdate.check_and_update
       end
 
       desc 'plugin', 'manage PSDK plugins'
       subcommand 'plugin', Plugin
+
+      desc 'use', 'manage project\'s PSDK version'
+      subcommand 'use', Use
     end
   end
 end

data/lib/psdk/helpers/900 Yuki__VD.rb

@@ -0,0 +1,147 @@
+# rubocop:disable all
+module Yuki
+  # Class that helps to read Virtual Directories
+  #
+  # In reading mode, the Virtual Directories can be loaded to RAM if MAX_SIZE >= VD.size
+  #
+  # All the filenames inside the Yuki::VD has to be downcased filename in utf-8
+  #
+  # Note : Encryption is up to the developper and no longer supported on the basic script
+  class VD
+    # @return [String] the filename of the current Yuki::VD
+    attr_reader :filename
+
+    # Is the debug info on ?
+    DEBUG_ON = ARGV.include?('debug-yuki-vd')
+    # The max size of the file that can be loaded in memory
+    MAX_SIZE = 10 * 1024 * 1024 # 10Mo
+    # List of allowed modes
+    ALLOWED_MODES = %i[read write update]
+    # Size of the pointer at the begin of the file
+    POINTER_SIZE = 4
+    # Unpack method of the pointer at the begin of the file
+    UNPACK_METHOD = 'L'
+    # Create a new Yuki::VD file or load it
+    # @param filename [String] name of the Yuki::VD file
+    # @param mode [:read, :write, :update] if we read or write the virtual directory
+    def initialize(filename, mode)
+      @mode = mode = fix_mode(mode)
+      @filename = filename
+      send("initialize_#{mode}")
+    end
+
+    # Read a file data from the VD
+    # @param filename [String] the file we want to read its data
+    # @return [String, nil] the data of the file
+    def read_data(filename)
+      return nil unless @file
+
+      pos = @hash[filename]
+      return nil unless pos
+
+      @file.pos = pos
+      size = @file.read(POINTER_SIZE).unpack1(UNPACK_METHOD)
+      return @file.read(size)
+    end
+
+    # Test if a file exists in the VD
+    # @param filename [String]
+    # @return [Boolean]
+    def exists?(filename)
+      @hash[filename] != nil
+    end
+
+    # Write a file with its data in the VD
+    # @param filename [String] the file name
+    # @param data [String] the data of the file
+    def write_data(filename, data)
+      return unless @file
+
+      @hash[filename] = @file.pos
+      @file.write([data.bytesize].pack(UNPACK_METHOD))
+      @file.write(data)
+    end
+
+    # Add a file to the Yuki::VD
+    # @param filename [String] the file name
+    # @param ext_name [String, nil] the file extension
+    def add_file(filename, ext_name = nil)
+      sub_filename = ext_name ? "#{filename}.#{ext_name}" : filename
+      write_data(filename, File.binread(sub_filename))
+    end
+
+    # Get all the filename
+    # @return [Array<String>]
+    def get_filenames
+      @hash.keys
+    end
+
+    # Close the VD
+    def close
+      return unless @file
+
+      if @mode != :read
+        pos = [@file.pos].pack(UNPACK_METHOD)
+        @file.write(Marshal.dump(@hash))
+        @file.pos = 0
+        @file.write(pos)
+      end
+      @file.close
+      @file = nil
+    end
+
+    private
+
+    # Initialize the Yuki::VD in read mode
+    def initialize_read
+      @file = File.new(filename, 'rb')
+      pos = @file.pos = @file.read(POINTER_SIZE).unpack1(UNPACK_METHOD)
+      @hash = Marshal.load(@file)
+      load_whole_file(pos) if pos < MAX_SIZE
+    rescue Errno::ENOENT
+      @file = nil
+      @hash = {}
+      log_error(format('%<filename>s not found', filename: filename)) if DEBUG_ON
+    end
+
+    # Load the VD in the memory
+    # @param size [Integer] size of the VD memory
+    def load_whole_file(size)
+      @file.pos = 0
+      data = @file.read(size)
+      @file.close
+      @file = StringIO.new(data, 'rb+')
+      @file.pos = 0
+    end
+
+    # Initialize the Yuki::VD in write mode
+    def initialize_write
+      @file = File.new(filename, 'wb')
+      @file.pos = POINTER_SIZE
+      @hash = {}
+    end
+
+    # Initialize the Yuki::VD in update mode
+    def initialize_update
+      @file = File.new(filename, 'rb+')
+      pos = @file.pos = @file.read(POINTER_SIZE).unpack1(UNPACK_METHOD)
+      @hash = Marshal.load(@file)
+      @file.pos = pos
+    end
+
+    # Fix the input mode in case it's a String
+    # @param mode [Symbol, String]
+    # @return [Symbol] one of the value of ALLOWED_MODES
+    def fix_mode(mode)
+      return mode if ALLOWED_MODES.include?(mode)
+
+      r = (mode = mode.downcase).include?('r')
+      w = mode.include?('w')
+      plus = mode.include?('+')
+      return :update if plus || (r && w)
+      return :read if r
+
+      return :write
+    end
+  end
+end