rexer 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 236c94fc48362e83c23049edb3b1b21311385622a66793fa19240f42fb702388
-  data.tar.gz: 7707f18ae6e414d9390080944292f8537a11b19f03ce93d6142dc106129f7e04
+  metadata.gz: 13397d6c2ce415899b6435654c7bfabdf78c6c85aa2988a7879b64b630550dba
+  data.tar.gz: c1edbd2a8faa415b4796218176367c5f3b97cb9c5ce755c060029c1b1e4290af
 SHA512:
-  metadata.gz: 12a8e53ccdb53e9da0bbd66787eb4377031353e51d3d3785d3242006cbfe7445acbd5f136664bc5e681d76333ea8e082f7b92b8f1c0fe4923fb41a8a947526bd
-  data.tar.gz: f487865de3c6f4064f72e0dae4fca83c9a8c17a711d26e0fb1e2c78058db44b510930cc67d856a19d71059e9cf46f95aeb3d24821266157dfd3eb2e627bfae77
+  metadata.gz: 267698125ab41b6886d7a0f01bb4db14e0c2703de47dc8099d4f6ebe59bf18410785ddb2a11815c3cc6dbe3aa47e3c35abacc32bdefed265f003bb066ee2c4e4
+  data.tar.gz: eb76a0f49f4c13e47855e4b3eb2443e413aa25a87d66e854eccc820d21e55a3940480af9acdb0bc729efb0b1959891245bf43ba6f41964d6a7b31f8cb9c79478

data/README.md

@@ -109,6 +109,99 @@ If the specified ENV is currently installed, it compares the current `.extension
 
 Loads `.extensions.lock` and updates the currently installed extensions to the latest version. `.extensions.rb` is NOT referenced in this command.
 
+### Short commands available
+
+The command to execute is determined by a forward match, so you can use like the following short commands.
+
+```
+rex ins # means install
+rex st  # maens state
+rex sw  # means switch
+rex e   # means envs
+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

data/lib/rexer/definition/dsl.rb

@@ -63,7 +63,7 @@ module Rexer
       end
 
       def build_source(opts)
-        type = opts.keys.find { Rexer::Source.names.include?(_1) }
+        type = (opts.keys & Rexer::Source::TYPE.keys).first
         Source.new(type, opts[type]) if type
       end
     end

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

@@ -0,0 +1,65 @@
+require "open3"
+require "wisper"
+
+module Rexer
+  module Extension
+    module Plugin
+      class Action
+        include Wisper::Publisher
+
+        def initialize(definition)
+          @definition = definition
+          @name = definition.name
+          @hooks = definition.hooks || {}
+        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
+
+        def needs_db_migration?
+          plugin_dir.join("db", "migrate").then {
+            _1.exist? && !_1.empty?
+          }
+        end
+
+        def run_db_migrate(extra_envs = {})
+          return unless needs_db_migration?
+
+          envs = {"NAME" => 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}")
+
+          if Rexer.verbosity.debug?
+            system(cmds, exception: true)
+          else
+            _, error, status = Open3.capture3(cmds)
+            raise error unless status.success?
+          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(" ")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Rexer
+  module Extension
+    module Plugin
+      class Install < Action
+        def call
+          broadcast(:started, "Install #{name}")
+
+          if plugin_exists?
+            broadcast(:skipped, "Already exists")
+            return
+          end
+
+          load_from_source
+          run_bundle_install
+          run_db_migrate
+          hooks[:installed]&.call
+
+          broadcast(:completed)
+        end
+
+        private
+
+        def load_from_source
+          source.load(plugin_dir.to_s)
+        end
+
+        def run_bundle_install
+          return unless plugin_dir.join("Gemfile").exist?
+
+          cmds = build_cmd("bundle", "install", Rexer.verbosity.debug? ? nil : "--quiet")
+
+          broadcast(:processing, "Execute #{cmds}")
+
+          system(cmds, exception: true)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Rexer
+  module Extension
+    module Plugin
+      class ReloadSource < Action
+        def call
+          return unless plugin_exists?
+
+          broadcast(:started, "Reload #{name} source")
+
+          reload_source
+          run_db_migrate
+
+          broadcast(:completed)
+        end
+
+        private
+
+        def reload_source
+          plugin_dir.to_s.then { |dir|
+            FileUtils.rm_rf(dir)
+            source.load(dir)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Rexer
+  module Extension
+    module Plugin
+      class Uninstall < Action
+        def call
+          broadcast(:started, "Uninstall #{name}")
+
+          unless plugin_exists?
+            broadcast(:skipped, "Not exists")
+            return
+          end
+
+          reset_db_migration
+          remove_plugin
+          hooks[:uninstalled]&.call
+
+          broadcast(:completed)
+        end
+
+        private
+
+        def reset_db_migration
+          run_db_migrate("VERSION" => "0")
+        end
+
+        def remove_plugin
+          plugin_dir.rmtree
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Rexer
+  module Extension
+    module Plugin
+      class Update < Action
+        def call
+          return unless plugin_exists?
+
+          broadcast(:started, "Update #{name}")
+
+          unless source.updatable?
+            broadcast(:skipped, "Not updatable")
+            return
+          end
+
+          update_source
+          run_db_migrate
+
+          broadcast(:completed)
+        end
+
+        private
+
+        def update_source
+          source.update(plugin_dir.to_s)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require "wisper"
+
+module Rexer
+  module Extension
+    module Theme
+      class Action
+        include Wisper::Publisher
+
+        def initialize(definition)
+          @definition = definition
+          @name = definition.name
+          @hooks = definition.hooks || {}
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Rexer
+  module Extension
+    module Theme
+      class Install < Action
+        def call
+          broadcast(:started, "Install #{name}")
+
+          if theme_exists?
+            broadcast(:skipped, "Already exists")
+            return
+          end
+
+          load_from_source
+          hooks[:installed]&.call
+
+          broadcast(:completed)
+        end
+
+        private
+
+        def load_from_source
+          source.load(theme_dir.to_s)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Rexer
+  module Extension
+    module Theme
+      class ReloadSource < Action
+        def call
+          return unless theme_exists?
+
+          broadcast(:started, "Reload #{name} source")
+
+          reload_source
+
+          broadcast(:completed)
+        end
+
+        private
+
+        def reload_source
+          theme_dir.to_s.then { |dir|
+            FileUtils.rm_rf(dir)
+            source.load(dir)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Rexer
+  module Extension
+    module Theme
+      class Uninstall < Action
+        def call
+          broadcast(:started, "Uninstall #{name}")
+
+          unless theme_exists?
+            broadcast(:skipped, "Not exists")
+            return
+          end
+
+          remove_theme
+          hooks[:uninstalled]&.call
+
+          broadcast(:completed)
+        end
+
+        private
+
+        def remove_theme
+          theme_dir.rmtree
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Rexer
+  module Extension
+    module Theme
+      class Update < Action
+        def call
+          return unless theme_exists?
+
+          broadcast(:started, "Update #{name}")
+
+          update_source
+
+          broadcast(:completed)
+        end
+
+        private
+
+        def update_source
+          source.update(theme_dir.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/rexer/source/base.rb

@@ -1,10 +1,6 @@
 module Rexer
   module Source
     class Base
-      def self.inherited(subclass)
-        Source.names << subclass.name.split("::").last.downcase.to_sym
-      end
-
       # Load the source to the given path.
       def load(_path)
         raise "Not implemented"

data/lib/rexer/source.rb

@@ -1,9 +1,12 @@
 module Rexer
   module Source
-    def self.names = @names ||= []
+    TYPE = {
+      git: Git,
+      github: Github
+    }.freeze
 
     def self.from_definition(source)
-      const_get(source.type.capitalize).new(**source.options)
+      TYPE[source.type].new(**source.options)
     end
   end
 end

data/lib/rexer/version.rb

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

data/lib/rexer.rb

@@ -32,4 +32,3 @@ require "zeitwerk"
 
 loader = Zeitwerk::Loader.for_gem
 loader.setup
-loader.eager_load

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rexer
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-25 00:00:00.000000000 Z
+date: 2024-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -125,8 +125,16 @@ files:
 - lib/rexer/definition/diff.rb
 - lib/rexer/definition/dsl.rb
 - lib/rexer/definition/lock.rb
-- lib/rexer/extension/plugin.rb
-- lib/rexer/extension/theme.rb
+- lib/rexer/extension/plugin/action.rb
+- lib/rexer/extension/plugin/install.rb
+- lib/rexer/extension/plugin/reload_source.rb
+- lib/rexer/extension/plugin/uninstall.rb
+- lib/rexer/extension/plugin/update.rb
+- lib/rexer/extension/theme/action.rb
+- lib/rexer/extension/theme/install.rb
+- lib/rexer/extension/theme/reload_source.rb
+- lib/rexer/extension/theme/uninstall.rb
+- lib/rexer/extension/theme/update.rb
 - lib/rexer/source.rb
 - lib/rexer/source/base.rb
 - lib/rexer/source/git.rb

data/lib/rexer/extension/plugin.rb

@@ -1,172 +0,0 @@
-require "open3"
-require "wisper"
-
-module Rexer
-  module Extension
-    module Plugin
-      def self.dir
-        Pathname.new("plugins")
-      end
-
-      class Base
-        include Wisper::Publisher
-
-        def initialize(definition)
-          @definition = definition
-          @name = definition.name
-          @hooks = definition.hooks || {}
-        end
-
-        private
-
-        attr_reader :name, :hooks, :definition
-
-        def plugin_dir
-          @plugin_dir ||= Plugin.dir.join(name.to_s)
-        end
-
-        def plugin_exists?
-          plugin_dir.exist? && !plugin_dir.empty?
-        end
-
-        def needs_db_migration?
-          plugin_dir.join("db", "migrate").then {
-            _1.exist? && !_1.empty?
-          }
-        end
-
-        def run_db_migrate(extra_envs = {})
-          return unless needs_db_migration?
-
-          envs = {"NAME" => 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}")
-
-          if Rexer.verbosity.debug?
-            system(cmds, exception: true)
-          else
-            _, error, status = Open3.capture3(cmds)
-            raise error unless status.success?
-          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(" ")
-        end
-      end
-
-      class Install < Base
-        def call
-          broadcast(:started, "Install #{name}")
-
-          if plugin_exists?
-            broadcast(:skipped, "Already exists")
-            return
-          end
-
-          load_from_source
-          run_bundle_install
-          run_db_migrate
-          hooks[:installed]&.call
-
-          broadcast(:completed)
-        end
-
-        private
-
-        def load_from_source
-          source.load(plugin_dir.to_s)
-        end
-
-        def run_bundle_install
-          return unless plugin_dir.join("Gemfile").exist?
-
-          cmds = build_cmd("bundle", "install", Rexer.verbosity.debug? ? nil : "--quiet")
-
-          broadcast(:processing, "Execute #{cmds}")
-
-          system(cmds, exception: true)
-        end
-      end
-
-      class Uninstall < Base
-        def call
-          broadcast(:started, "Uninstall #{name}")
-
-          unless plugin_exists?
-            broadcast(:skipped, "Not exists")
-            return
-          end
-
-          reset_db_migration
-          remove_plugin
-          hooks[:uninstalled]&.call
-
-          broadcast(:completed)
-        end
-
-        private
-
-        def reset_db_migration
-          run_db_migrate("VERSION" => "0")
-        end
-
-        def remove_plugin
-          plugin_dir.rmtree
-        end
-      end
-
-      class Update < Base
-        def call
-          return unless plugin_exists?
-
-          broadcast(:started, "Update #{name}")
-
-          unless source.updatable?
-            broadcast(:skipped, "Not updatable")
-            return
-          end
-
-          update_source
-          run_db_migrate
-
-          broadcast(:completed)
-        end
-
-        private
-
-        def update_source
-          source.update(plugin_dir.to_s)
-        end
-      end
-
-      class ReloadSource < Base
-        def call
-          return unless plugin_exists?
-
-          broadcast(:started, "Reload #{name} source")
-
-          reload_source
-          run_db_migrate
-
-          broadcast(:completed)
-        end
-
-        private
-
-        def reload_source
-          plugin_dir.to_s.then { |dir|
-            FileUtils.rm_rf(dir)
-            source.load(dir)
-          }
-        end
-      end
-    end
-  end
-end

data/lib/rexer/extension/theme.rb

@@ -1,127 +0,0 @@
-require "wisper"
-
-module Rexer
-  module Extension
-    module Theme
-      def self.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
-
-      class Base
-        include Wisper::Publisher
-
-        def initialize(definition)
-          @definition = definition
-          @name = definition.name
-          @hooks = definition.hooks || {}
-        end
-
-        private
-
-        attr_reader :name, :hooks, :definition
-
-        def theme_dir
-          @theme_dir ||= Theme.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
-      end
-
-      class Install < Base
-        def call
-          broadcast(:started, "Install #{name}")
-
-          if theme_exists?
-            broadcast(:skipped, "Already exists")
-            return
-          end
-
-          load_from_source
-          hooks[:installed]&.call
-
-          broadcast(:completed)
-        end
-
-        private
-
-        def load_from_source
-          source.load(theme_dir.to_s)
-        end
-      end
-
-      class Uninstall < Base
-        def call
-          broadcast(:started, "Uninstall #{name}")
-
-          unless theme_exists?
-            broadcast(:skipped, "Not exists")
-            return
-          end
-
-          remove_theme
-          hooks[:uninstalled]&.call
-
-          broadcast(:completed)
-        end
-
-        private
-
-        def remove_theme
-          theme_dir.rmtree
-        end
-      end
-
-      class Update < Base
-        def call
-          return unless theme_exists?
-
-          broadcast(:started, "Update #{name}")
-
-          update_source
-
-          broadcast(:completed)
-        end
-
-        private
-
-        def update_source
-          source.update(theme_dir.to_s)
-        end
-      end
-
-      class ReloadSource < Base
-        def call
-          return unless theme_exists?
-
-          broadcast(:started, "Reload #{name} source")
-
-          reload_source
-
-          broadcast(:completed)
-        end
-
-        private
-
-        def reload_source
-          theme_dir.to_s.then { |dir|
-            FileUtils.rm_rf(dir)
-            source.load(dir)
-          }
-        end
-      end
-    end
-  end
-end