rexer 0.13.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13397d6c2ce415899b6435654c7bfabdf78c6c85aa2988a7879b64b630550dba
-  data.tar.gz: c1edbd2a8faa415b4796218176367c5f3b97cb9c5ce755c060029c1b1e4290af
+  metadata.gz: 03a1f270989ff656e5fd97e105ecd8d21be59755e2f3112746db636c5b2a9e7c
+  data.tar.gz: 42154270a3d8684f58ec80537cd2d5237dd0cde468bd44b3db0dd89fe7084a7c
 SHA512:
-  metadata.gz: 267698125ab41b6886d7a0f01bb4db14e0c2703de47dc8099d4f6ebe59bf18410785ddb2a11815c3cc6dbe3aa47e3c35abacc32bdefed265f003bb066ee2c4e4
-  data.tar.gz: eb76a0f49f4c13e47855e4b3eb2443e413aa25a87d66e854eccc820d21e55a3940480af9acdb0bc729efb0b1959891245bf43ba6f41964d6a7b31f8cb9c79478
+  metadata.gz: 3b7544710bb51bb0a6e5cb6de61deac2c6fbea1116d11b62f064c76a844af5664037083dbe30685421af467f7346676ba9655ceb59e2310a455e435ea7f7274b
+  data.tar.gz: 91d31bf09b9dd719760ab4cc88c32542cc441f215ce68e7d95831e8e0789695215dbf49d70279e51d43c5a45886d6d6f6045540d0210c577153b706d3dcf0fa6

data/README.md

@@ -28,7 +28,7 @@ gem install rexer
 
 ## Supported Redmine
 
-Rexer is tested with Redmine v5.1 and trunk.
+Rexer is tested with Redmine v6.0 and trunk.
 
 ## Usage
 
@@ -41,9 +41,10 @@ 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" }
+theme :bleuclair, github: { repo: "farend/redmine_theme_farend_bleuclair", branch: "master" }
 
 plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel", tag: "v1.0.2" }
+plugin :redmica_ui_extension, github: { repo: "redmica/redmica_ui_extension", ref: "4fdc298bc310be2ab295008c0ee522b0ec0e319a" }
 ```
 
 Then, run the following command in the root directory of the Redmine application.
@@ -86,7 +87,7 @@ Commands:
   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
+  rex update                       # Update extensions for the currently installed environment to the latest version if extensions are updateable
   rex version                      # Show Rexer version
 
 Options:
@@ -123,85 +124,6 @@ rex v   # means version
 and more...
 ```
 
-## Syntax of .extensions.rb file
-
-### Plugin
-
-```ruby
-plugin :plugin_name, <source>: { ... }
-```
-
-### Theme
-
-```ruby
-theme :theme_name, <source>: { ... }
-```
-
-### Source
-
-#### Git
-
-```ruby
-plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel" }
-```
-```ruby
-# Specify the branch
-plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel", branch: "main" }
-# Specify the tag
-plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel", tag: "v1.0.0" }
-# Specify the commit
-plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel", ref: "5cfb8ccbabb2fad2c8f2273a4dda3f16ef2de124" }
-```
-
-#### GitHub
-
-```ruby
-plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel", tag: "v1.0.0" }
-```
-
-### Env
-
-```ruby
-plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel" }
-
-# This is the same as the above.
-env :default do
-  plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel" }
-end
-
-env :stable do
-  plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel", tag: "v1.0.2" }
-end
-
-env :default, :stable do
-  theme :bleuclair, github: { repo: "farend/redmine_theme_farend_bleuclair" }
-end
-```
-
-### Hooks
-
-```ruby
-plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel" } do
-  installed do
-    puts "The plugin has been installed."
-  end
-
-  uninstalled do
-    puts "The plugin has been uninstalled."
-  end
-end
-
-theme :bleuclair, github: { repo: "farend/redmine_theme_farend_bleuclair" } do
-  installed do
-    puts "The theme has been installed."
-  end
-
-  uninstalled do
-    puts "The theme has been uninstalled."
-  end
-end
-```
-
 ## Advanced Usage
 
 ### Defining for each environment and extension
@@ -209,25 +131,25 @@ end
 You can define an environment and extensions for each environment using the `env ... do - end` block.
 
 ```ruby
-plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel" }
+plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel", branch: "master" }
 
 env :stable do
-  plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel", tag: "v1.0.2" }
+  plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel", tag: "v1.0.2" }
 end
 
 env :default, :stable do
-  theme :bleuclair, github: { repo: "farend/redmine_theme_farend_bleuclair", branch: "support-propshaft" }
+  theme :bleuclair, github: { repo: "farend/redmine_theme_farend_bleuclair" }
 end
 ```
 
 Definitions other than `env ... do - end` are implicitly defined as `env :default do - end`. Therefore, the above is resolved as follows:
 
 * default env
-  * bleuclair (support-propshaft)
-  * redmine_issues_panel (master)
+  * bleuclair (farend/redmine_theme_farend_bleuclair@main)
+  * redmine_issues_panel (redmica/redmine_issues_panel@master)
 * stable env
-  * bleuclair (support-propshaft)
-  * redmine_issues_panel (v1.0.2)
+  * bleuclair (farend/redmine_theme_farend_bleuclair@main)
+  * redmine_issues_panel (redmica/redmine_issues_panel@v1.0.2)
 
 If you want to install extensions for the `default` environment, run the following command.
 
@@ -258,12 +180,12 @@ In addition, you can define as many environments as you like, and list the defin
 ```
 $ rex envs
 default
-  bleuclair (support-propshaft)
-  redmine_issues_panel (master)
+  bleuclair (farend/redmine_theme_farend_bleuclair@main)
+  redmine_issues_panel (redmica/redmine_issues_panel@master)
 
 stable
-  bleuclair (support-propshaft)
-  redmine_issues_panel (v1.0.2)
+  bleuclair (farend/redmine_theme_farend_bleuclair@main)
+  redmine_issues_panel (redmica/redmine_issues_panel@v1.0.2)
 ```
 
 ### Defining hooks
@@ -294,6 +216,85 @@ 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`.
 
+## Extensions.rb Syntax
+
+### Plugin
+
+```ruby
+plugin :plugin_name, <source>: { ... }
+```
+
+### Theme
+
+```ruby
+theme :theme_name, <source>: { ... }
+```
+
+### Source
+
+#### Git
+
+```ruby
+plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel" }
+```
+```ruby
+# Specify the branch
+plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel", branch: "main" }
+# Specify the tag
+plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel", tag: "v1.0.0" }
+# Specify the commit
+plugin :redmine_issues_panel, git: { url: "https://github.com/redmica/redmine_issues_panel", ref: "5cfb8ccbabb2fad2c8f2273a4dda3f16ef2de124" }
+```
+
+#### GitHub
+
+```ruby
+plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel", tag: "v1.0.0" }
+```
+
+### Env
+
+```ruby
+plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel" }
+
+# This is the same as the above.
+env :default do
+  plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel" }
+end
+
+env :stable do
+  plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel", tag: "v1.0.2" }
+end
+
+env :default, :stable do
+  theme :bleuclair, github: { repo: "farend/redmine_theme_farend_bleuclair" }
+end
+```
+
+### Hooks
+
+```ruby
+plugin :redmine_issues_panel, github: { repo: "redmica/redmine_issues_panel" } do
+  installed do
+    puts "The plugin has been installed."
+  end
+
+  uninstalled do
+    puts "The plugin has been uninstalled."
+  end
+end
+
+theme :bleuclair, github: { repo: "farend/redmine_theme_farend_bleuclair" } do
+  installed do
+    puts "The theme has been installed."
+  end
+
+  uninstalled do
+    puts "The theme has been uninstalled."
+  end
+end
+```
+
 ## Developing
 
 ### Running the command

data/lib/rexer/cli.rb

@@ -1,6 +1,7 @@
 require "thor"
 require "dotenv"
 require "erb"
+require "active_support/core_ext/object/blank"
 
 module Rexer
   class Cli < Thor
@@ -34,7 +35,7 @@ module Rexer
       Commands::Switch.new.call(env&.to_sym)
     end
 
-    desc "update", "Update extensions for the currently installed environment to the latest version"
+    desc "update", "Update extensions for the currently installed environment to the latest version if extensions are updateable"
     def update
       Commands::Update.new.call
     end

data/lib/rexer/source/git.rb

@@ -1,4 +1,5 @@
 require "git"
+require "uri"
 
 module Rexer
   module Source
@@ -8,6 +9,7 @@ module Rexer
         @branch = branch
         @tag = tag
         @ref = ref
+        @reference = branch || tag || ref
       end
 
       def load(path)
@@ -20,19 +22,30 @@ module Rexer
       end
 
       def updatable?
-        !branch.nil?
+        branch || reference.nil?
       end
 
       def info
-        branch || tag || ref || "master"
+        URI.parse(url).then do |uri|
+          "#{uri.host}#{uri.path}@#{reference_name}"
+        end
       end
 
       private
 
-      attr_reader :url, :branch, :tag, :ref
+      attr_reader :url, :reference, :branch, :tag, :ref
 
       def checkout(git)
-        (branch || tag || ref)&.then { git.checkout(_1) }
+        reference&.then { git.checkout(_1) }
+      end
+
+      def reference_name
+        branch || tag || short_ref || "main"
+      end
+
+      def short_ref
+        return unless ref
+        ref.match?(/^[a-z0-9]+$/) ? ref.slice(0, 7) : ref
       end
     end
   end

data/lib/rexer/source/github.rb

@@ -2,8 +2,13 @@ module Rexer
   module Source
     class Github < Git
       def initialize(repo:, branch: nil, tag: nil, ref: nil)
+        @repo = repo
         super(url: "https://github.com/#{repo}", branch: branch, tag: tag, ref: ref)
       end
+
+      def info
+        "#{@repo}@#{reference_name}"
+      end
     end
   end
 end

data/lib/rexer/version.rb

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

data/lib/rexer.rb

@@ -27,6 +27,7 @@ module Rexer
   end
 end
 
+require "active_support"
 require "pathname"
 require "zeitwerk"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rexer
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-20 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 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.