rexer 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c8c8383d931ce1824f0b3dff3b835d16b242803e3991f1ab9ff3b60df396ecc
-  data.tar.gz: 03270c384dfe36f34ee418a48847d671e470bb49f1699c69944a3f38326bdf37
+  metadata.gz: 7ae1d09f4a257d7ce265f52b7e8fd30c6d2891ca1fb756b9baeaaabe23f7cde1
+  data.tar.gz: 37bdbb2c6181c0f37070f18abfe755077c222d784bd90444d18de62022f18f7a
 SHA512:
-  metadata.gz: f06dd899a19bb55eab11bd5891b40ab1135cf5b2f4ee001b744bd2e2421a543470b960d6a7ea369efc9c96c98c1784eb1ff37a35445d1270ee5699c9a012ebb1
-  data.tar.gz: cb0652c4d01e86e99f2c727c29ebc276d988e5f174ec0be980df977ad8fdf0118234decec87143ba5da57b9b575466d1edf77bc6eec7cc0eef723bf1fdb2c408
+  metadata.gz: 1646431a82235a5b9be7e267676b3a3cb4b81761ff77d9b48cd87868ee59cb242c1e034c1dd1517c568da85e9ea621b57a7161be10388f986d74c22ce39e31a7
+  data.tar.gz: 9730f772b7c5403adfa6e477e76a330b808d78e862cb3a032c3e516c21af85499a737d3661f55337b32d1776359749763b3a1a06095fa39657d419e3387ac99b

data/README.md

@@ -1,11 +1,26 @@
-# Rexer: Redmine Extension manager
-
-Rexer is a tool for managing Redmine Extension, which means Redmine [Plugin](https://www.redmine.org/projects/redmine/wiki/Plugins) and [Theme](https://www.redmine.org/projects/redmine/wiki/Themes) in this tool.
+<div align="center">
+  <h1>Rexer</h1>
+  <p>Redmine Extension (Plugin and Theme) manager</p>
+</div>
+
+<p align="center">
+  <a href="https://github.com/hidakatsuya/rexer/actions/workflows/build.yml">
+    <img src="https://github.com/hidakatsuya/rexer/actions/workflows/build.yml/badge.svg" alt="Build">
+  </a>
+  <a href="https://badge.fury.io/rb/rexer">
+    <img src="https://badge.fury.io/rb/rexer.svg" alt="Gem Version">
+  </a>
+</p>
+
+Rexer is a command-line tool for managing Redmine Extension (Plugin and Theme).
 
 It is mainly aimed at helping with the development of Redmine and its plugins, allowing you to define extensions in a Ruby DSL and install, uninstall, update, and switch between different sets of the extensions.
 
-[![Build](https://github.com/hidakatsuya/rexer/actions/workflows/build.yml/badge.svg)](https://github.com/hidakatsuya/rexer/actions/workflows/build.yml)
-[![Gem Version](https://badge.fury.io/rb/rexer.svg)](https://badge.fury.io/rb/rexer)
+[![asciicast](https://asciinema.org/a/672754.svg?9)](https://asciinema.org/a/672754)
+
+## What is Redmine Extension?
+
+Redmine [Plugin](https://www.redmine.org/projects/redmine/wiki/Plugins) and [Theme](https://www.redmine.org/projects/redmine/wiki/Themes) are called Redmine Extension in this tool.
 
 ## Installation
 
@@ -19,14 +34,17 @@ Rexer is tested with Redmine v5.1 and trunk.
 
 ## Usage
 
-### Quick Start
+Run the following command in the root directory of the Redmine application.
 
-First, create a `.extensions.rb` file in the root directory of the Redmine application.
+```
+rex init
+```
+
+This command generates a `.extensions.rb`, so define the extensions you want to install in the file like below.
 
 ```ruby
 theme :bleuclair, github: { repo: "farend/redmine_theme_farend_bleuclair", branch: "support-propshaft" }
 
-plugin :view_customize, github: { repo: "onozaty/redmine-view-customize", tag: "v3.5.2" }
 plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel", tag: "v1.0.2" }
 ```
 
@@ -36,10 +54,18 @@ Then, run the following command in the root directory of the Redmine application
 rex install
 ```
 
-This command installs plugins and themes defined in the `.extensions.rb` file and generates the `.extensions.lock` file.
+This command performs the following steps for each extension defined in the `.extensions.rb` to install it and generates a `.extensions.lock`.
+
+For plugins:
+* Load the plugin from the specified `git` or `github` repository.
+* Run the `bundle install` command if the plugin has a `Gemfile`.
+* Run the `bundle exec rake redmine:plugins:migrate NAME=<plugin_name>` command if the plugin has any database migration.
+
+For themes:
+* Load the theme from the specified `git` or `github` repository.
 
 > [!NOTE]
-> The `.extensions.lock` file is a file that locks the state of the installed extensions, but it's NOT a file that locks the version of the extensions.
+> The `.extensions.lock` is a file for preserving the state of installed extensions, but not the version of an extension.
 
 If you want to uninstall the extensions, run the following command.
 
@@ -47,9 +73,9 @@ If you want to uninstall the extensions, run the following command.
 rex uninstall
 ```
 
-This command uninstalls the extensions and deletes the `.extensions.lock` file.
+This command uninstalls the extensions and deletes the `.extensions.lock`.
 
-### Commands
+## Commands
 
 ```
 $ rex
@@ -64,7 +90,7 @@ Commands:
   rex version         # Show Rexer version
 ```
 
-#### rex install [ENV]
+### rex install [ENV]
 
 Installs extensions in the specified ENV environment and makes them available for use. Specifically, it does the following:
 
@@ -73,12 +99,14 @@ If the specified ENV is NOT currently installed, it adds all extensions in the E
 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.
+* 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
 
 Loads `.extensions.lock` and updates the currently installed extensions to the latest version. `.extensions.rb` is NOT referenced in this command.
 
+## Advanced Usage
+
 ### Defining for each environment and extension
 
 You can define an environment and extensions for each environment using the `env ... do - end` block.

data/lib/rexer/cli.rb

@@ -9,6 +9,11 @@ module Rexer
     class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed output"
     class_option :quiet, type: :boolean, aliases: "-q", desc: "Minimal output"
 
+    desc "init", "Create a new .extensions.rb file"
+    def init
+      Commands::Init.new.call
+    end
+
     desc "install [ENV]", "Install the definitions in .extensions.rb for the specified environment"
     def install(env = "default")
       Commands::Install.new.call(env&.to_sym)

data/lib/rexer/commands/init.rb

@@ -0,0 +1,39 @@
+module Rexer
+  module Commands
+    class Init
+      def call
+        definition_file = Definition.file
+
+        if definition_file.exist?
+          puts Paint["#{definition_file.basename} already exists", :red]
+          exit 1
+        end
+
+        definition_file.write(template)
+
+        puts Paint["#{definition_file.expand_path} created", :green]
+      end
+
+      private
+
+      def template
+        <<~TEMPLATE
+          # Define themes and plugins you want to use in your Redmine here.
+          #
+          # Syntax for defining themes and plugins is as follows.
+          # For theme_id and plugin_id, specify the name of the installation directory.
+          #
+          #   theme :theme_a_id, github: { repo: "repo/theme_a" }
+          #   theme :theme_b_id, github: { repo: "repo/theme_b", ref: "abcdefghi" }
+          #   plugin :plugin_a_id, github: { repo: "repo/plugin_a", tag: "v1.0.0" }
+          #   plugin :plugin_b_id, git: { url: "https://github.com/repo/plugin_b.git", branch: "stable" }
+          #
+          # Then, run `rex install` to install these themes and plugins.
+          #
+          # For more usage, see https://github.com/hidakatsuya/rexer.
+
+        TEMPLATE
+      end
+    end
+  end
+end

data/lib/rexer/commands.rb

@@ -36,6 +36,10 @@ module Rexer
         Rexer.verbosity.on(:info) { puts Paint["done", :green] }
       end
 
+      def skipped(reason)
+        Rexer.verbosity.on(:info) { puts Paint["skipped (#{reason})", :yellow] }
+      end
+
       def processing(process_title)
         Rexer.verbosity.on(:debug) { puts Paint[process_title, :gray] }
       end

data/lib/rexer/extension/plugin.rb

@@ -62,10 +62,13 @@ module Rexer
 
       class Install < Base
         def call
-          return if plugin_exists?
-
           broadcast(:started, "Install #{name}")
 
+          if plugin_exists?
+            broadcast(:skipped, "Already exists")
+            return
+          end
+
           load_from_source
           run_bundle_install
           run_db_migrate
@@ -93,10 +96,13 @@ module Rexer
 
       class Uninstall < Base
         def call
-          return unless plugin_exists?
-
           broadcast(:started, "Uninstall #{name}")
 
+          unless plugin_exists?
+            broadcast(:skipped, "Not exists")
+            return
+          end
+
           reset_db_migration
           remove_plugin
           hooks[:uninstalled]&.call
@@ -121,6 +127,11 @@ module Rexer
 
           broadcast(:started, "Update #{name}")
 
+          unless source.updatable?
+            broadcast(:skipped, "Not updatable")
+            return
+          end
+
           update_source
           run_db_migrate
 

data/lib/rexer/extension/theme.rb

@@ -42,10 +42,13 @@ module Rexer
 
       class Install < Base
         def call
-          return if theme_exists?
-
           broadcast(:started, "Install #{name}")
 
+          if theme_exists?
+            broadcast(:skipped, "Already exists")
+            return
+          end
+
           load_from_source
           hooks[:installed]&.call
 
@@ -61,10 +64,13 @@ module Rexer
 
       class Uninstall < Base
         def call
-          return unless theme_exists?
-
           broadcast(:started, "Uninstall #{name}")
 
+          unless theme_exists?
+            broadcast(:skipped, "Not exists")
+            return
+          end
+
           remove_theme
           hooks[:uninstalled]&.call
 

data/lib/rexer/source/base.rb

@@ -15,6 +15,12 @@ module Rexer
         raise "Not implemented"
       end
 
+      # Check if the source can be updated to a newer version.
+      def updatable?
+        raise "Not implemented"
+      end
+
+      # Return the status of the source.
       def info = ""
     end
   end

data/lib/rexer/source/git.rb

@@ -19,6 +19,10 @@ module Rexer
         load(path)
       end
 
+      def updatable?
+        !branch.nil?
+      end
+
       def info
         branch || tag || ref || "master"
       end

data/lib/rexer/version.rb

@@ -1,3 +1,3 @@
 module Rexer
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rexer
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-20 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,9 +94,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-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.
+description: Rexer is a command-line 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.
 email:
 - hidakatsuya@gmail.com
 executables:
@@ -113,6 +113,7 @@ files:
 - lib/rexer/cli.rb
 - lib/rexer/commands.rb
 - lib/rexer/commands/envs.rb
+- lib/rexer/commands/init.rb
 - lib/rexer/commands/install.rb
 - lib/rexer/commands/state.rb
 - lib/rexer/commands/switch.rb
@@ -153,5 +154,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: A tool for managing Redmine Plugins and Themes
+summary: A command-line tool for managing Redmine Plugins and Themes
 test_files: []