rexer 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8deb1f0e6b437141c6bc838cf954ee5520cbc44d9aca368060c99a4e7ce17bf2
-  data.tar.gz: cf110fb2a483dda81792c355e5fb8e83388bcf2b1a5ff177e764a16e423fb3ad
+  metadata.gz: 710e00ac5d2fecb5d7ce297cf9999431a7cc77d19bfd88616462496380a811d6
+  data.tar.gz: 40155d5be1545c861bff45842df72d27d0a87ea3c096920fefa012dd80b9d710
 SHA512:
-  metadata.gz: 0e82d4c4bcda8901a8a44b1f9e3db8d4401f2e45781763f072fa6aea8eb75532cb3223d31b051fabee4f5afe4e53def13baa2df8d2c731aa7dee740c6548ac19
-  data.tar.gz: 0cdd7fa7759a3e94376b2539bef039c8ee5525b7c0358e8f19ab1409f5ff7946adf692f432c9bd862cb917ff7ab5b1661f0605d98b25f32a1ef4df75ddaf86a9
+  metadata.gz: 032d42c1c5ee5536bf7d5395989273fc2ceaf5adbf3605dddb5ff2f7ea7a16ba8b185d4294e6e91d5dbcda8653101eb28412e322911833aec3ffc151b3b13684
+  data.tar.gz: db390096e17b01ed36780a65f689c0b5cc25e71b55395c420e5bedaacbc67d53072113ac6b50276fdca628281fe00defb97e15e5752080fe6e650970a5a35892

data/README.md

@@ -64,7 +64,24 @@ Commands:
   rex version         # Show Rexer version
 ```
 
-### Defining environments and extensions for the environment
+#### rex install [ENV]
+
+Installs extensions in the specified ENV environment and makes them available for use. Specifically, it does the following:
+
+If the specified ENV is NOT currently installed, it adds all extensions in the ENV environment in `.extensions.rb`.
+
+If the specified ENV is currently installed, it compares the current `.extensions.lock` with `.extensions.rb` and does the following:
+* Installs additional extensions (the `installed` hook is executed).
+* Uninstalls deleted extensions (the `uninstalled` hook is executed).
+* Re-fetches extensions whose source settings has changed (for example, the `branch` or `tag` has changed) and runs the database migration if necessary.
+
+#### rex update
+
+Loads `.extensions.lock` and updates the currently installed extensions to the latest version. `.extensions.rb` is NOT referenced in this command.
+
+### Defining for each environment and extension
+
+You can define an environment and extensions for each environment using the `env ... do - end` block.
 
 ```ruby
 theme :bleuclair, github: { repo: "farend/redmine_theme_farend_bleuclair" }
@@ -76,7 +93,14 @@ env :stable do
 end
 ```
 
-In above example, the `bleuclair` theme and the `redmine_issues_panel` plugin are defined for the `default` environment. The `bleuclair` theme and the `redmine_issues_panel` plugin are defined for the `stable` environment.
+Definitions other than `env ... do - end` are implicitly defined as `env :default do - end`. Therefore, the above is resolved as follows:
+
+* default env
+  * bleuclair (master)
+  * redmine_issues_panel (master)
+* stable env
+  * bleuclair (support-propshaft)
+  * redmine_issues_panel (v1.0.2)
 
 If you want to install extensions for the `default` environment, run the following command.
 
@@ -102,6 +126,14 @@ rex install stable
 
 The above command uninstalls the extensions for the currently installed environment and installs the extensions for the `stable` environment.
 
+In addition, you can define as many environments as you like, and list the defined environments with the `rex envs` command.
+
+```
+$ rex envs
+default
+stable
+```
+
 ### Defining hooks
 
 You can define hooks for each extension.
@@ -120,6 +152,16 @@ plugin :redmica_s3, github: { repo: "redmica/redmica_s3" } do
 end
 ```
 
+### Configuring the command prefix
+
+You can set a prefix for the commands such as `bundle install` that Rexer executes with the `REXER_COMMAND_PREFIX` environment variable.
+
+```
+export REXER_COMMAND_PREFIX="docker compose exec -T app"
+```
+
+In the above case, the `bin/rails redmine:plugins:migrate` command is executed as `docker compose exec -T app bin/rails redmine:plugins:migrate`.
+
 ## Developing
 
 ### Running tests

data/exe/rex

@@ -5,7 +5,7 @@ require "rexer"
 begin
   Rexer::Cli.start(ARGV)
 rescue => e
-  puts "ERROR (#{e.class}): #{e.message}"
+  puts "\e[31mERROR (#{e.class}): #{e.message}\e[0m"
   puts e.backtrace if ENV["VERBOSE"]
   exit 1
 end

data/lib/rexer/cli.rb

@@ -5,6 +5,7 @@ module Rexer
     def self.exit_on_failure? = true
 
     class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed output"
+    class_option :quiet, type: :boolean, aliases: "-q", desc: "Minimal output"
 
     desc "install [ENV]", "Install the definitions in .extensions.rb for the specified environment"
     def install(env = "default")
@@ -50,6 +51,15 @@ module Rexer
 
     def initialize_options
       ENV["VERBOSE"] = "1" if options[:verbose]
+
+      verbosity_level = if options[:verbose]
+        :debug
+      elsif options[:quiet]
+        :error
+      else
+        :info
+      end
+      Rexer.verbosity = Commands::Verbosity.new(verbosity_level)
     end
   end
 end

data/lib/rexer/commands/install.rb

@@ -1,6 +1,8 @@
 module Rexer
   module Commands
     class Install
+      include ActionCallable
+
       def call(env)
         definition = load_definition(env)
         lock_definition = load_lock_definition
@@ -46,31 +48,31 @@ module Rexer
 
       def install(themes, plugins)
         themes.each do
-          Extension::Theme::Installer.new(_1).install
+          call_action Extension::Theme::Install, _1
         end
 
         plugins.each do
-          Extension::Plugin::Installer.new(_1).install
+          call_action Extension::Plugin::Install, _1
         end
       end
 
       def uninstall(themes, plugins)
         themes.each do
-          Extension::Theme::Uninstaller.new(_1).uninstall
+          call_action Extension::Theme::Uninstall, _1
         end
 
         plugins.each do
-          Extension::Plugin::Uninstaller.new(_1).uninstall
+          call_action Extension::Plugin::Uninstall, _1
         end
       end
 
       def reload_source(themes, plugins)
         themes.each do
-          Extension::Theme::SourceReloader.new(_1).reload
+          call_action Extension::Theme::ReloadSource, _1
         end
 
         plugins.each do
-          Extension::Plugin::SourceReloader.new(_1).reload
+          call_action Extension::Plugin::ReloadSource, _1
         end
       end
 

data/lib/rexer/commands/uninstall.rb

@@ -1,6 +1,8 @@
 module Rexer
   module Commands
     class Uninstall
+      include ActionCallable
+
       def initialize
         @lock_definition = Definition::Lock.load_data
       end
@@ -20,13 +22,13 @@ module Rexer
 
       def uninstall_plugins
         lock_definition.plugins.each do
-          Extension::Plugin::Uninstaller.new(_1).uninstall
+          call_action Extension::Plugin::Uninstall, _1
         end
       end
 
       def uninstall_themes
         lock_definition.themes.each do
-          Extension::Theme::Uninstaller.new(_1).uninstall
+          call_action Extension::Theme::Uninstall, _1
         end
       end
 

data/lib/rexer/commands/update.rb

@@ -1,6 +1,8 @@
 module Rexer
   module Commands
     class Update
+      include ActionCallable
+
       def initialize
         @lock_definition = Definition::Lock.load_data
       end
@@ -18,13 +20,13 @@ module Rexer
 
       def update_plugins
         lock_definition.plugins.each do
-          Extension::Plugin::Updater.new(_1).update
+          call_action Extension::Plugin::Update, _1
         end
       end
 
       def update_themes
         lock_definition.themes.each do
-          Extension::Theme::Updater.new(_1).update
+          call_action Extension::Theme::Update, _1
         end
       end
 

data/lib/rexer/commands.rb

@@ -0,0 +1,44 @@
+require "paint"
+
+module Rexer
+  module Commands
+    module ActionCallable
+      def call_action(action_class, *init_args)
+        progress_notifier = ProgressNotifier.new
+
+        action = action_class.new(*init_args)
+        action.subscribe(progress_notifier).call
+      end
+    end
+
+    class Verbosity < Data.define(:current_level)
+      LEVELS = %i[error info debug].freeze
+
+      LEVELS.each do |level|
+        define_method(:"#{level}?") { level == current_level }
+      end
+
+      def on?(level)
+        LEVELS.index(current_level) >= LEVELS.index(level)
+      end
+
+      def on(level, &block)
+        on?(level) ? block.call : nil
+      end
+    end
+
+    class ProgressNotifier
+      def started(process_title)
+        Rexer.verbosity.on(:info) { print "#{process_title} ... " }
+      end
+
+      def completed
+        Rexer.verbosity.on(:info) { puts Paint["done", :green] }
+      end
+
+      def processing(process_title)
+        Rexer.verbosity.on(:debug) { puts Paint[process_title, :gray] }
+      end
+    end
+  end
+end

data/lib/rexer/extension/plugin.rb

@@ -1,4 +1,5 @@
 require "open3"
+require "wisper"
 
 module Rexer
   module Extension
@@ -8,6 +9,8 @@ module Rexer
       end
 
       class Base
+        include Wisper::Publisher
+
         def initialize(definition)
           @definition = definition
           @name = definition.name
@@ -36,24 +39,39 @@ module Rexer
           return unless needs_db_migration?
 
           envs = {"NAME" => name.to_s}.merge(extra_envs)
-          _, error, status = Open3.capture3(envs, "bin/rails redmine:plugins:migrate")
+          cmds = cmd("bundle", "exec", "rake", Rexer.verbosity.debug? ? nil : "-q", "redmine:plugins:migrate")
+
+          broadcast(:processing, "Execute #{cmds} with #{envs}")
 
-          raise error unless status.success?
+          if Rexer.verbosity.debug?
+            system(envs, cmds, exception: true)
+          else
+            _, error, status = Open3.capture3(envs, cmds)
+            raise error unless status.success?
+          end
         end
 
         def source
           @source ||= Source.from_definition(definition.source)
         end
+
+        def cmd(*command)
+          [Rexer.config.command_prefix, *command].compact.join(" ")
+        end
       end
 
-      class Installer < Base
-        def install
+      class Install < Base
+        def call
           return if plugin_exists?
 
+          broadcast(:started, "Install #{name}")
+
           load_from_source
           run_bundle_install
           run_db_migrate
           hooks[:installed]&.call
+
+          broadcast(:completed)
         end
 
         private
@@ -65,18 +83,25 @@ module Rexer
         def run_bundle_install
           return unless plugin_dir.join("Gemfile").exist?
 
-          _, error, status = Open3.capture3("bundle install")
-          raise error unless status.success?
+          cmds = cmd("bundle", "install", Rexer.verbosity.debug? ? nil : "--quiet")
+
+          broadcast(:processing, "Execute #{cmds}")
+
+          system(cmds, exception: true)
         end
       end
 
-      class Uninstaller < Base
-        def uninstall
+      class Uninstall < Base
+        def call
           return unless plugin_exists?
 
+          broadcast(:started, "Uninstall #{name}")
+
           reset_db_migration
           remove_plugin
           hooks[:uninstalled]&.call
+
+          broadcast(:completed)
         end
 
         private
@@ -90,12 +115,16 @@ module Rexer
         end
       end
 
-      class Updater < Base
-        def update
+      class Update < Base
+        def call
           return unless plugin_exists?
 
+          broadcast(:started, "Update #{name}")
+
           update_source
           run_db_migrate
+
+          broadcast(:completed)
         end
 
         private
@@ -105,12 +134,16 @@ module Rexer
         end
       end
 
-      class SourceReloader < Base
-        def reload
+      class ReloadSource < Base
+        def call
           return unless plugin_exists?
 
+          broadcast(:started, "Reload #{name} source")
+
           reload_source
           run_db_migrate
+
+          broadcast(:completed)
         end
 
         private

data/lib/rexer/extension/theme.rb

@@ -1,3 +1,5 @@
+require "wisper"
+
 module Rexer
   module Extension
     module Theme
@@ -13,6 +15,8 @@ module Rexer
       end
 
       class Base
+        include Wisper::Publisher
+
         def initialize(definition)
           @definition = definition
           @name = definition.name
@@ -36,12 +40,16 @@ module Rexer
         end
       end
 
-      class Installer < Base
-        def install
+      class Install < Base
+        def call
           return if theme_exists?
 
+          broadcast(:started, "Install #{name}")
+
           load_from_source
           hooks[:installed]&.call
+
+          broadcast(:completed)
         end
 
         private
@@ -51,12 +59,16 @@ module Rexer
         end
       end
 
-      class Uninstaller < Base
-        def uninstall
+      class Uninstall < Base
+        def call
           return unless theme_exists?
 
+          broadcast(:started, "Uninstall #{name}")
+
           remove_theme
           hooks[:uninstalled]&.call
+
+          broadcast(:completed)
         end
 
         private
@@ -66,11 +78,15 @@ module Rexer
         end
       end
 
-      class Updater < Base
-        def update
+      class Update < Base
+        def call
           return unless theme_exists?
 
+          broadcast(:started, "Update #{name}")
+
           update_source
+
+          broadcast(:completed)
         end
 
         private
@@ -80,11 +96,15 @@ module Rexer
         end
       end
 
-      class SourceReloader < Base
-        def reload
+      class ReloadSource < Base
+        def call
           return unless theme_exists?
 
+          broadcast(:started, "Reload #{name} source")
+
           reload_source
+
+          broadcast(:completed)
         end
 
         private

data/lib/rexer/version.rb

@@ -1,3 +1,3 @@
 module Rexer
-  VERSION = "0.4.1"
+  VERSION = "0.6.0"
 end

data/lib/rexer.rb

@@ -6,6 +6,25 @@ module Rexer
   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.
+    #
+    # For example, if the command_prefix is set "docker compose exec -T app",
+    # then bundle install will be executed as follows:
+    #
+    #   docker compose exec -T app bundle install
+    #
+    :command_prefix
+  )
+
+  class << self
+    attr_accessor :verbosity
+
+    def config
+      @config ||= Config.new(command_prefix: ENV["REXER_COMMAND_PREFIX"])
+    end
+  end
 end
 
 require "pathname"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rexer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-17 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: Rexer is a tool for managing Redmine Extension (Plugin and Themes). It
   allows you to define extensions in a Ruby DSL and install, uninstall, update, and
   switch between different sets of the extensions.
@@ -69,6 +97,7 @@ files:
 - exe/rex
 - lib/rexer.rb
 - lib/rexer/cli.rb
+- lib/rexer/commands.rb
 - lib/rexer/commands/envs.rb
 - lib/rexer/commands/install.rb
 - lib/rexer/commands/state.rb