rexer 0.14.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03a1f270989ff656e5fd97e105ecd8d21be59755e2f3112746db636c5b2a9e7c
-  data.tar.gz: 42154270a3d8684f58ec80537cd2d5237dd0cde468bd44b3db0dd89fe7084a7c
+  metadata.gz: 61d1b3b0172a3db2da03ac1f428f447a5296df8430fabaf21f4ce1cb1f96ce41
+  data.tar.gz: 8dc2852d1ef7f6052d2c8d09cba035276fd7b039bc109be732d0599142a27059
 SHA512:
-  metadata.gz: 3b7544710bb51bb0a6e5cb6de61deac2c6fbea1116d11b62f064c76a844af5664037083dbe30685421af467f7346676ba9655ceb59e2310a455e435ea7f7274b
-  data.tar.gz: 91d31bf09b9dd719760ab4cc88c32542cc441f215ce68e7d95831e8e0789695215dbf49d70279e51d43c5a45886d6d6f6045540d0210c577153b706d3dcf0fa6
+  metadata.gz: 72c9335b6be10bb6a7220d3b632ce2d0c20719165b5e93d17244e5f8c4412ea8fad0b36e805ae1cba51ef652d77afce8dd98676bfe1dcfb0b14e24249cf4fa8d
+  data.tar.gz: b708a563d706ba42aad33a1daa40a5d7a7c4365c481be516d423a2a05176f8b4c0f6ef68afae27ca571ba55a99f03b3dbf51e10de497f91f672f781ff87a762a

data/README.md

@@ -79,23 +79,23 @@ This command uninstalls the extensions and deletes the `.extensions.lock`.
 ```
 $ rex
 Commands:
-  rex envs                         # Show the list of environments and their extensions defined in .extensions.rb
-  rex help [COMMAND]               # Describe available commands or one specific command
-  rex init                         # Create a new .extensions.rb file
-  rex install [ENV]                # Install the definitions in .extensions.rb for the specified environment
-  rex reinstall [PLUGIN or THEME]  # Uninstall extensions for the currently installed environment and install them again
-  rex state                        # Show the current state of the installed extensions
-  rex switch [ENV]                 # Uninstall extensions for the currently installed environment and install extensions for the specified environment
-  rex uninstall                    # Uninstall extensions for the currently installed environment based on the state in .extensions.lock and remove the lock file
-  rex update                       # Update extensions for the currently installed environment to the latest version if extensions are updateable
-  rex version                      # Show Rexer version
+  rex envs                    # Show the list of environments and their extensions defined in .extensions.rb
+  rex help [COMMAND]          # Describe available commands or one specific command
+  rex init                    # Create a new .extensions.rb file
+  rex install [env]           # Install the definitions in .extensions.rb for the specified environment
+  rex reinstall [extension]   # Uninstall extensions for the currently installed environment and install them again
+  rex state                   # Show the current state of the installed extensions
+  rex switch [env]            # Uninstall extensions for the currently installed environment and install extensions for the specified environment
+  rex uninstall               # Uninstall extensions for the currently installed environment based on the state in .extensions.lock and remove the lock file
+  rex update [extensions...]  # Update extensions for the currently installed environment to the latest version if extensions are updateable. If no extensions are specified, all extensions are updated
+  rex version                 # Show Rexer version
 
 Options:
   -v, [--verbose], [--no-verbose], [--skip-verbose]  # Detailed output
   -q, [--quiet], [--no-quiet], [--skip-quiet]        # Minimal output
 ```
 
-### rex install [ENV]
+### rex install [env]
 
 Installs extensions in the specified ENV environment and makes them available for use. Specifically, it does the following:
 
@@ -106,7 +106,7 @@ If the specified ENV is currently installed, it compares the current `.extension
 * Uninstalls deleted extensions (the `uninstalled` hook is executed).
 * Reload extensions whose source settings has changed (for example, the `branch` or `tag` has changed) and runs the database migration if necessary.
 
-### rex update
+### rex update [extensions...]
 
 Loads `.extensions.lock` and updates the currently installed extensions to the latest version. `.extensions.rb` is NOT referenced in this command.
 

data/lib/rexer/cli.rb

@@ -15,7 +15,7 @@ module Rexer
       Commands::Init.new.call
     end
 
-    desc "install [ENV]", "Install the definitions in .extensions.rb for the specified environment"
+    desc "install [env]", "Install the definitions in .extensions.rb for the specified environment"
     def install(env = "default")
       Commands::Install.new.call(env&.to_sym)
     end
@@ -25,19 +25,19 @@ module Rexer
       Commands::Uninstall.new.call
     end
 
-    desc "reinstall [PLUGIN or THEME]", "Uninstall extensions for the currently installed environment and install them again"
+    desc "reinstall [extension]", "Uninstall extensions for the currently installed environment and install them again"
     def reinstall(extension_name)
       Commands::Reinstall.new.call(extension_name)
     end
 
-    desc "switch [ENV]", "Uninstall extensions for the currently installed environment and install extensions for the specified environment"
+    desc "switch [env]", "Uninstall extensions for the currently installed environment and install extensions for the specified environment"
     def switch(env = "default")
       Commands::Switch.new.call(env&.to_sym)
     end
 
-    desc "update", "Update extensions for the currently installed environment to the latest version if extensions are updateable"
-    def update
-      Commands::Update.new.call
+    desc "update [extensions...]", "Update extensions for the currently installed environment to the latest version if extensions are updateable. If no extensions are specified, all extensions are updated"
+    def update(*extension_names)
+      Commands::Update.new.call(extension_names)
     end
 
     desc "state", "Show the current state of the installed extensions"

data/lib/rexer/commands/envs.rb

@@ -10,8 +10,12 @@ module Rexer
         defined_envs.each.with_index do |env, i|
           puts env
 
-          definition_with(env).then { _1.themes + _1.plugins }.each do
-            puts "  #{_1.name} (#{Source.from_definition(_1.source).info})"
+          themes_in(env) do
+            print_extension_definition(_1)
+          end
+
+          plugins_in(env) do
+            print_extension_definition(_1)
           end
 
           puts if i < defined_envs.size - 1
@@ -22,11 +26,20 @@ module Rexer
 
       attr_reader :definition
 
-      def definition_with(env)
-        definition.with(
-          plugins: definition.plugins.select { _1.env == env },
-          themes: definition.themes.select { _1.env == env }
-        )
+      def print_extension_definition(extension_def)
+        puts "  #{extension_def.name} (#{Source.from_definition(extension_def.source).info})"
+      end
+
+      def themes_in(env)
+        definition.themes.each do
+          yield _1 if _1.env == env
+        end
+      end
+
+      def plugins_in(env)
+        definition.plugins.each do
+          yield _1 if _1.env == env
+        end
       end
     end
   end

data/lib/rexer/commands/state.rb

@@ -20,29 +20,27 @@ module Rexer
       attr_reader :lock_definition
 
       def print_plugins
-        plugins = lock_definition.plugins
-        return if plugins.empty?
+        plugin_defs = lock_definition.plugins
+        return if plugin_defs.empty?
 
         puts "\nPlugins:"
-        plugins.each do
-          puts " * #{_1.name} (#{source_info(_1.source)})"
+        plugin_defs.each do
+          plugin = Extension::Entity::Plugin.new(_1)
+          puts " * #{plugin.name} (#{plugin.source_info})"
         end
       end
 
       def print_themes
-        themes = lock_definition.themes
-        return if themes.empty?
+        theme_defs = lock_definition.themes
+        return if theme_defs.empty?
 
         puts "\nThemes:"
-        themes.each do
-          puts " * #{_1.name} (#{source_info(_1.source)})"
+        theme_defs.each do
+          theme = Extension::Entity::Theme.new(_1)
+          puts " * #{theme.name} (#{theme.source_info})"
         end
       end
 
-      def source_info(definition_source)
-        Source.from_definition(definition_source).info
-      end
-
       def no_lock_file_found
         lock_definition.nil?.tap { |result|
           puts "No lock file found" if result

data/lib/rexer/commands/switch.rb

@@ -7,7 +7,7 @@ module Rexer
 
       def call(env)
         return if no_lock_file_found
-        return if already_on(env)
+        return if already_in(env)
 
         Uninstall.new.call
         Install.new.call(env)
@@ -23,9 +23,9 @@ module Rexer
         }
       end
 
-      def already_on(env)
+      def already_in(env)
         (lock_definition.env == env).tap do |result|
-          puts "Already on #{env} environment" if result
+          puts "Already in #{env} environment" if result
         end
       end
     end

data/lib/rexer/commands/update.rb

@@ -7,29 +7,37 @@ module Rexer
         @lock_definition = Definition::Lock.load_data
       end
 
-      def call
+      def call(extension_names)
         return if no_lock_file_found
 
-        update_themes
-        update_plugins
+        extension_names ||= []
+        extension_names.map!(&:to_sym)
+
+        update_themes(extension_names)
+        update_plugins(extension_names)
       end
 
       private
 
       attr_reader :lock_definition
 
-      def update_plugins
-        lock_definition.plugins.each do
+      def update_plugins(extension_names)
+        filter_by_name(lock_definition.plugins, extension_names).each do
           call_action Extension::Plugin::Update, _1
         end
       end
 
-      def update_themes
-        lock_definition.themes.each do
+      def update_themes(extension_names)
+        filter_by_name(lock_definition.themes, extension_names).each do
           call_action Extension::Theme::Update, _1
         end
       end
 
+      def filter_by_name(extensions, extension_names)
+        return extensions unless extension_names.any?
+        extensions.select { extension_names.include?(_1.name) }
+      end
+
       def no_lock_file_found
         lock_definition.nil?.tap { |result|
           puts "No lock file found" if result

data/lib/rexer/extension/entity.rb

@@ -0,0 +1,55 @@
+require "active_support/core_ext/class/attribute"
+
+module Rexer
+  module Extension
+    module Entity
+      class Base
+        class_attribute :root_dir
+
+        def initialize(definition)
+          @definition = definition
+          @hooks = definition.hooks || {}
+          @name = definition.name
+        end
+
+        attr_reader :hooks, :name
+
+        def exist?
+          path.exist? && !path.empty?
+        end
+
+        def path
+          @path ||= root_dir.join(name.to_s)
+        end
+
+        def source_info
+          @source_info ||= source.info(path)
+        end
+
+        def source
+          @source ||= Source.from_definition(definition.source)
+        end
+
+        private
+
+        attr_reader :definition
+      end
+
+      class Plugin < Base
+        self.root_dir = Pathname.new("plugins")
+
+        def contains_db_migrations?
+          path.join("db", "migrate").then { _1.exist? && !_1.empty? }
+        end
+
+        def contains_gemfile?
+          path.join("Gemfile").exist?
+        end
+      end
+
+      class Theme < Base
+        self.root_dir = Pathname.new("themes")
+      end
+    end
+  end
+end

data/lib/rexer/extension/plugin/action.rb

@@ -9,36 +9,21 @@ module Rexer
 
         def initialize(definition)
           @definition = definition
-          @name = definition.name
-          @hooks = definition.hooks || {}
+          @plugin = Entity::Plugin.new(definition)
         end
 
         private
 
-        attr_reader :name, :hooks, :definition
-
-        def plugin_root_dir
-          Pathname.new("plugins")
-        end
-
-        def plugin_dir
-          @plugin_dir ||= plugin_root_dir.join(name.to_s)
-        end
-
-        def plugin_exists?
-          plugin_dir.exist? && !plugin_dir.empty?
-        end
+        attr_reader :plugin
 
         def needs_db_migration?
-          plugin_dir.join("db", "migrate").then {
-            _1.exist? && !_1.empty?
-          }
+          plugin.contains_db_migrations?
         end
 
         def run_db_migrate(extra_envs = {})
           return unless needs_db_migration?
 
-          envs = {"NAME" => name.to_s}.merge(extra_envs)
+          envs = {"NAME" => plugin.name.to_s}.merge(extra_envs)
           cmds = build_cmd("bundle", "exec", "rake", Rexer.verbosity.debug? ? nil : "-q", "redmine:plugins:migrate", envs:)
 
           broadcast(:processing, "Execute #{cmds}")
@@ -51,10 +36,6 @@ module Rexer
           end
         end
 
-        def source
-          @source ||= Source.from_definition(definition.source)
-        end
-
         def build_cmd(*command, envs: {})
           envs_str = envs.map { [_1, _2].join("=") }
           [Rexer.config.command_prefix, *command, *envs_str].compact.join(" ")

data/lib/rexer/extension/plugin/install.rb

@@ -3,9 +3,9 @@ module Rexer
     module Plugin
       class Install < Action
         def call
-          broadcast(:started, "Install #{name}")
+          broadcast(:started, "Install #{plugin.name}")
 
-          if plugin_exists?
+          if plugin.exist?
             broadcast(:skipped, "Already exists")
             return
           end
@@ -13,7 +13,7 @@ module Rexer
           load_from_source
           run_bundle_install
           run_db_migrate
-          hooks[:installed]&.call
+          call_installed_hook
 
           broadcast(:completed)
         end
@@ -21,11 +21,11 @@ module Rexer
         private
 
         def load_from_source
-          source.load(plugin_dir.to_s)
+          plugin.source.load(plugin.path.to_s)
         end
 
         def run_bundle_install
-          return unless plugin_dir.join("Gemfile").exist?
+          return unless plugin.contains_gemfile?
 
           cmds = build_cmd("bundle", "install", Rexer.verbosity.debug? ? nil : "--quiet")
 
@@ -33,6 +33,10 @@ module Rexer
 
           system(cmds, exception: true)
         end
+
+        def call_installed_hook
+          plugin.hooks[:installed]&.call
+        end
       end
     end
   end

data/lib/rexer/extension/plugin/reload_source.rb

@@ -3,9 +3,9 @@ module Rexer
     module Plugin
       class ReloadSource < Action
         def call
-          return unless plugin_exists?
+          return unless plugin.exist?
 
-          broadcast(:started, "Reload #{name} source")
+          broadcast(:started, "Reload #{plugin.name} source")
 
           reload_source
           run_db_migrate
@@ -16,10 +16,8 @@ module Rexer
         private
 
         def reload_source
-          plugin_dir.to_s.then { |dir|
-            FileUtils.rm_rf(dir)
-            source.load(dir)
-          }
+          plugin.path.rmtree
+          plugin.source.load(plugin.path.to_s)
         end
       end
     end

data/lib/rexer/extension/plugin/uninstall.rb

@@ -3,16 +3,16 @@ module Rexer
     module Plugin
       class Uninstall < Action
         def call
-          broadcast(:started, "Uninstall #{name}")
+          broadcast(:started, "Uninstall #{plugin.name}")
 
-          unless plugin_exists?
+          unless plugin.exist?
             broadcast(:skipped, "Not exists")
             return
           end
 
           reset_db_migration
           remove_plugin
-          hooks[:uninstalled]&.call
+          call_uninstalled_hook
 
           broadcast(:completed)
         end
@@ -24,7 +24,11 @@ module Rexer
         end
 
         def remove_plugin
-          plugin_dir.rmtree
+          plugin.path.rmtree
+        end
+
+        def call_uninstalled_hook
+          plugin.hooks[:uninstalled]&.call
         end
       end
     end

data/lib/rexer/extension/plugin/update.rb

@@ -3,11 +3,11 @@ module Rexer
     module Plugin
       class Update < Action
         def call
-          return unless plugin_exists?
+          return unless plugin.exist?
 
-          broadcast(:started, "Update #{name}")
+          broadcast(:started, "Update #{plugin.name}")
 
-          unless source.updatable?
+          unless plugin.source.updatable?
             broadcast(:skipped, "Not updatable")
             return
           end
@@ -21,7 +21,7 @@ module Rexer
         private
 
         def update_source
-          source.update(plugin_dir.to_s)
+          plugin.source.update(plugin.path)
         end
       end
     end

data/lib/rexer/extension/theme/action.rb

@@ -8,36 +8,12 @@ module Rexer
 
         def initialize(definition)
           @definition = definition
-          @name = definition.name
-          @hooks = definition.hooks || {}
+          @theme = Entity::Theme.new(definition)
         end
 
         private
 
-        attr_reader :name, :hooks, :definition
-
-        def theme_root_dir
-          public_themes = Pathname.pwd.join("public", "themes")
-
-          if public_themes.exist?
-            # When Redmine version is v5.1 or older, public/themes is used.
-            public_themes
-          else
-            Pathname.new("themes")
-          end
-        end
-
-        def theme_dir
-          @theme_dir ||= theme_root_dir.join(name.to_s)
-        end
-
-        def theme_exists?
-          theme_dir.exist? && !theme_dir.empty?
-        end
-
-        def source
-          @source ||= Source.from_definition(definition.source)
-        end
+        attr_reader :theme
       end
     end
   end

data/lib/rexer/extension/theme/install.rb

@@ -3,15 +3,15 @@ module Rexer
     module Theme
       class Install < Action
         def call
-          broadcast(:started, "Install #{name}")
+          broadcast(:started, "Install #{theme.name}")
 
-          if theme_exists?
+          if theme.exist?
             broadcast(:skipped, "Already exists")
             return
           end
 
           load_from_source
-          hooks[:installed]&.call
+          call_installed_hook
 
           broadcast(:completed)
         end
@@ -19,7 +19,11 @@ module Rexer
         private
 
         def load_from_source
-          source.load(theme_dir.to_s)
+          theme.source.load(theme.path.to_s)
+        end
+
+        def call_installed_hook
+          theme.hooks[:installed]&.call
         end
       end
     end

data/lib/rexer/extension/theme/reload_source.rb

@@ -3,9 +3,9 @@ module Rexer
     module Theme
       class ReloadSource < Action
         def call
-          return unless theme_exists?
+          return unless theme.exist?
 
-          broadcast(:started, "Reload #{name} source")
+          broadcast(:started, "Reload #{theme.name} source")
 
           reload_source
 
@@ -15,10 +15,8 @@ module Rexer
         private
 
         def reload_source
-          theme_dir.to_s.then { |dir|
-            FileUtils.rm_rf(dir)
-            source.load(dir)
-          }
+          theme.path.rmtree
+          theme.source.load(theme.path.to_s)
         end
       end
     end

data/lib/rexer/extension/theme/uninstall.rb

@@ -3,15 +3,15 @@ module Rexer
     module Theme
       class Uninstall < Action
         def call
-          broadcast(:started, "Uninstall #{name}")
+          broadcast(:started, "Uninstall #{theme.name}")
 
-          unless theme_exists?
+          unless theme.exist?
             broadcast(:skipped, "Not exists")
             return
           end
 
           remove_theme
-          hooks[:uninstalled]&.call
+          call_uninstalled_hook
 
           broadcast(:completed)
         end
@@ -19,7 +19,11 @@ module Rexer
         private
 
         def remove_theme
-          theme_dir.rmtree
+          theme.path.rmtree
+        end
+
+        def call_uninstalled_hook
+          theme.hooks[:uninstalled]&.call
         end
       end
     end

data/lib/rexer/extension/theme/update.rb

@@ -3,9 +3,9 @@ module Rexer
     module Theme
       class Update < Action
         def call
-          return unless theme_exists?
+          return unless theme.exist?
 
-          broadcast(:started, "Update #{name}")
+          broadcast(:started, "Update #{theme.name}")
 
           update_source
 
@@ -15,7 +15,7 @@ module Rexer
         private
 
         def update_source
-          source.update(theme_dir.to_s)
+          theme.source.update(theme.path.to_s)
         end
       end
     end

data/lib/rexer/source/base.rb

@@ -17,7 +17,7 @@ module Rexer
       end
 
       # Return the status of the source.
-      def info = ""
+      def info(_work_dir = nil) = ""
     end
   end
 end

data/lib/rexer/source/git.rb

@@ -9,7 +9,6 @@ module Rexer
         @branch = branch
         @tag = tag
         @ref = ref
-        @reference = branch || tag || ref
       end
 
       def load(path)
@@ -25,27 +24,35 @@ module Rexer
         branch || reference.nil?
       end
 
-      def info
-        URI.parse(url).then do |uri|
-          "#{uri.host}#{uri.path}@#{reference_name}"
-        end
+      def info(work_dir = nil)
+        uri = URI.parse(url).then { "#{_1.host}#{_1.path}" }
+        ref = reference(short_ref: true) || current_branch(work_dir)
+
+        [uri, ref].compact.join("@")
       end
 
       private
 
-      attr_reader :url, :reference, :branch, :tag, :ref
+      attr_reader :url, :branch, :tag
 
       def checkout(git)
         reference&.then { git.checkout(_1) }
       end
 
-      def reference_name
-        branch || tag || short_ref || "main"
+      def reference(short_ref: false)
+        branch || tag || ref(short: short_ref)
+      end
+
+      def ref(short: false)
+        return nil unless @ref
+        return @ref unless short
+
+        @ref.match?(/^[a-z0-9]+$/) ? @ref.slice(0, 7) : @ref
       end
 
-      def short_ref
-        return unless ref
-        ref.match?(/^[a-z0-9]+$/) ? ref.slice(0, 7) : ref
+      def current_branch(work_dir)
+        return nil unless work_dir
+        ::Git.open(work_dir).current_branch
       end
     end
   end

data/lib/rexer/source/github.rb

@@ -6,8 +6,8 @@ module Rexer
         super(url: "https://github.com/#{repo}", branch: branch, tag: tag, ref: ref)
       end
 
-      def info
-        "#{@repo}@#{reference_name}"
+      def info(work_dir = nil)
+        [@repo, reference(short_ref: true) || current_branch(work_dir)].compact.join("@")
       end
     end
   end

data/lib/rexer/version.rb

@@ -1,3 +1,3 @@
 module Rexer
-  VERSION = "0.14.1"
+  VERSION = "0.16.0"
 end

data/lib/rexer.rb

@@ -1,12 +1,4 @@
 module Rexer
-  def self.definition_file
-    ".extensions.rb"
-  end
-
-  def self.definition_lock_file
-    ".extensions.lock"
-  end
-
   Config = Data.define(
     # The prefix of the command such as bundle install and bin/rails redmine:plugins:migrate.
     #
@@ -21,6 +13,14 @@ module Rexer
   class << self
     attr_accessor :verbosity
 
+    def definition_file
+      ".extensions.rb"
+    end
+
+    def definition_lock_file
+      ".extensions.lock"
+    end
+
     def config
       @config ||= Config.new(command_prefix: ENV["REXER_COMMAND_PREFIX"])
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rexer
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-25 00:00:00.000000000 Z
+date: 2025-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -139,6 +139,7 @@ files:
 - lib/rexer/definition/diff.rb
 - lib/rexer/definition/dsl.rb
 - lib/rexer/definition/lock.rb
+- lib/rexer/extension/entity.rb
 - lib/rexer/extension/plugin/action.rb
 - lib/rexer/extension/plugin/install.rb
 - lib/rexer/extension/plugin/reload_source.rb
@@ -167,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="