rexer 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564e86a618538937d2e68d85f1b625a8fa3ebddc8e4891fb12a4598eb2f944a5
-  data.tar.gz: 4e21379d1dae8ee68c301ee0f4be43a1034b585af097a9713ae3b238a8795ffe
+  metadata.gz: 2b58d350ffc9bafc33b202240ed26a3ecf6228a29677ba2cca1938c81bd32576
+  data.tar.gz: 68d15da77b4838c6bbd97e35bd2b301c2cdf0d738176cc24fe62a07c1e486013
 SHA512:
-  metadata.gz: f542f39676156e026985ab85853133e0efe09681cf8671bf8f2370fa9f0c2301a5d0f7422cdc042219b7475f2e15b28ec35807ae12285c132dba8e4729fc9203
-  data.tar.gz: 4632bde598651690ce5b685d7d80b657ef6567fe074ce392575cf87f8b705a4ce6f3b75495a74b311d2a1b6949fca65b0a660c1b9c653b31a7086b7b4d3decf3
+  metadata.gz: 3ef4db2f19d7fc91b28d265b8afe6a51080553ec4d2bd8f9a02824c05ed166593a1fbe44ed7e28a3a2ec3eb40d98a255963eb953b4e900340902ec4499a619cd
+  data.tar.gz: 330a05a5692158e30db7a3a4f55d2b830b18265dfb1fb277e5b73f27af113002014234431a8abe2f8a2932c2ca16f65b3c76121e483f9add212bcd0e45e74de4

data/README.md

@@ -9,13 +9,13 @@ It is mainly aimed at helping with the development of Redmine and its plugins, a
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
-
-    bundle add rexer
+```
+gem install rexer
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Supported Redmine
 
-    gem install rexer
+Rexer is tested with Redmine v5.1 and trunk.
 
 ## Usage
 
@@ -55,6 +55,7 @@ This command uninstalls the extensions and deletes the `.extensions.lock` file.
 $ rex
 Commands:
   rex help [COMMAND]  # Describe available commands or one specific command
+  rex envs            # Show the list of defined environments in .extensions.rb
   rex install [ENV]   # Install extensions for the specified environment
   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
@@ -116,29 +117,31 @@ plugin :redmica_s3, github: { repo: "redmica/redmica_s3" } do
   uninstalled do
     Pathname.new("config", "s3.yml").delete
   end
-
-  updated do
-    puts "updated"
-  end
 end
 ```
 
 ## Developing
 
-### Running integration tests
+### Running tests
 
 First, you need to build the docker image for the integration tests.
 
 ```
-rake rexer:test:build_integration_test_image
+rake test:prepare_integration
 ```
 
-Then, you can run the integration tests.
+Then, you can run all tests.
 
 ```
 rake test
 ```
 
+Or, you can only the integration tests as follows.
+
+```
+rake test:integration
+```
+
 ### Formatting and Linting code
 
 This project uses [Standard](https://github.com/standardrb/standard) for code formatting and linting. You can format and check the code by running the following commands.

data/lib/rexer/cli.rb

@@ -31,6 +31,11 @@ module Rexer
       Commands::State.new.call
     end
 
+    desc "envs", "Show the list of defined environments in .extensions.rb"
+    def envs
+      Commands::Envs.new.call
+    end
+
     desc "version", "Show Rexer version"
     def version
       puts Rexer::VERSION

data/lib/rexer/commands/envs.rb

@@ -0,0 +1,24 @@
+module Rexer
+  module Commands
+    class Envs
+      def initialize
+        @definition = Definition.load_data
+      end
+
+      def call
+        defined_envs.each do
+          puts _1
+        end
+      end
+
+      private
+
+      attr_reader :definition
+
+      def defined_envs
+        all_envs = definition.plugins.map(&:env) + definition.themes.map(&:env)
+        all_envs.uniq
+      end
+    end
+  end
+end

data/lib/rexer/commands/install.rb

@@ -28,7 +28,7 @@ module Rexer
 
         install(diff.added_themes, diff.added_plugins)
         uninstall(diff.deleted_themes, diff.deleted_plugins)
-        update(diff.changed_themes, diff.changed_plugins)
+        reload_source(diff.source_changed_themes, diff.source_changed_plugins)
 
         create_lock_file(definition.env)
         print_state
@@ -64,13 +64,13 @@ module Rexer
         end
       end
 
-      def update(themes, plugins)
+      def reload_source(themes, plugins)
         themes.each do
-          Extension::Theme::Updater.new(_1).update
+          Extension::Theme::SourceReloader.new(_1).reload
         end
 
         plugins.each do
-          Extension::Plugin::Updater.new(_1).update
+          Extension::Plugin::SourceReloader.new(_1).reload
         end
       end
 

data/lib/rexer/commands/state.rb

@@ -39,10 +39,8 @@ module Rexer
         end
       end
 
-      def source_info(source_def)
-        source_def.then {
-          Source.const_get(_1.type.capitalize).new(**_1.options).info
-        }
+      def source_info(definition_source)
+        Source.from_definition(definition_source).info
       end
 
       def no_lock_file_found

data/lib/rexer/definition/diff.rb

@@ -22,21 +22,21 @@ module Rexer
         old_data.themes - new_data.themes
       end
 
-      def changed_plugins
+      def source_changed_plugins
         old_plugins = old_data.plugins
 
         (new_data.plugins & old_plugins).select do |new_plugin|
           old_plugin = old_plugins.find { _1.name == new_plugin.name }
-          plugin_changed?(old_plugin, new_plugin)
+          plugin_source_changed?(old_plugin, new_plugin)
         end
       end
 
-      def changed_themes
+      def source_changed_themes
         old_themes = old_data.themes
 
         (new_data.themes & old_themes).select do |new_theme|
           old_theme = old_themes.find { _1.name == new_theme.name }
-          theme_changed?(old_theme, new_theme)
+          theme_source_changed?(old_theme, new_theme)
         end
       end
 
@@ -44,11 +44,11 @@ module Rexer
 
       attr_reader :old_data, :new_data
 
-      def plugin_changed?(old_plugin, new_plugin)
+      def plugin_source_changed?(old_plugin, new_plugin)
         old_plugin.source != new_plugin.source
       end
 
-      def theme_changed?(old_theme, new_theme)
+      def theme_source_changed?(old_theme, new_theme)
         old_theme.source != new_theme.source
       end
     end

data/lib/rexer/definition/dsl.rb

@@ -11,7 +11,7 @@ module Rexer
         @plugins << Definition::Plugin.new(
           name: name,
           source: build_source(opts),
-          hooks: build_hooks(hooks, %i[installed uninstalled updated]),
+          hooks: build_hooks(hooks, %i[installed uninstalled]),
           env: @env
         )
       end
@@ -20,7 +20,7 @@ module Rexer
         @themes << Definition::Theme.new(
           name: name,
           source: build_source(opts),
-          hooks: build_hooks(hooks, %i[installed uninstalled updated]),
+          hooks: build_hooks(hooks, %i[installed uninstalled]),
           env: @env
         )
       end
@@ -54,7 +54,7 @@ module Rexer
       end
 
       def build_source(opts)
-        type = opts.keys.find { Rexer::Source::Base.source_names.include?(_1) }
+        type = opts.keys.find { Rexer::Source.names.include?(_1) }
         Source.new(type, opts[type]) if type
       end
     end

data/lib/rexer/extension/plugin.rb

@@ -42,9 +42,7 @@ module Rexer
         end
 
         def source
-          @source ||= definition.source.then do |src|
-            Source.const_get(src.type.capitalize).new(**src.options)
-          end
+          @source ||= Source.from_definition(definition.source)
         end
       end
 
@@ -90,7 +88,6 @@ module Rexer
 
           update_source
           run_db_migrate
-          hooks[:updated]&.call
         end
 
         private
@@ -99,6 +96,24 @@ module Rexer
           source.update(plugin_dir.to_s)
         end
       end
+
+      class SourceReloader < Base
+        def reload
+          return unless plugin_exists?
+
+          reload_source
+          run_db_migrate
+        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

@@ -2,7 +2,14 @@ module Rexer
   module Extension
     module Theme
       def self.dir
-        Pathname.new("themes")
+        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
@@ -25,9 +32,7 @@ module Rexer
         end
 
         def source
-          @source ||= definition.source.then do |src|
-            Source.const_get(src.type.capitalize).new(**src.options)
-          end
+          @source ||= Source.from_definition(definition.source)
         end
       end
 
@@ -66,7 +71,6 @@ module Rexer
           return unless theme_exists?
 
           update_source
-          hooks[:updated]&.call
         end
 
         private
@@ -75,6 +79,23 @@ module Rexer
           source.update(theme_dir.to_s)
         end
       end
+
+      class SourceReloader < Base
+        def reload
+          return unless theme_exists?
+
+          reload_source
+        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/source/base.rb

@@ -1,16 +1,16 @@
 module Rexer
   module Source
     class Base
-      def self.source_names = @source_names ||= []
-
       def self.inherited(subclass)
-        source_names << subclass.name.split("::").last.downcase.to_sym
+        Source.names << subclass.name.split("::").last.downcase.to_sym
       end
 
+      # Load the source to the given path.
       def load(_path)
         raise "Not implemented"
       end
 
+      # Update to the latest version of the source.
       def update(_path)
         raise "Not implemented"
       end

data/lib/rexer/source.rb

@@ -0,0 +1,9 @@
+module Rexer
+  module Source
+    def self.names = @names ||= []
+
+    def self.from_definition(source)
+      const_get(source.type.capitalize).new(**source.options)
+    end
+  end
+end

data/lib/rexer/version.rb

@@ -1,3 +1,3 @@
 module Rexer
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rexer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -69,6 +69,7 @@ files:
 - exe/rex
 - lib/rexer.rb
 - lib/rexer/cli.rb
+- lib/rexer/commands/envs.rb
 - lib/rexer/commands/install.rb
 - lib/rexer/commands/state.rb
 - lib/rexer/commands/switch.rb
@@ -81,6 +82,7 @@ files:
 - lib/rexer/definition/lock.rb
 - lib/rexer/extension/plugin.rb
 - lib/rexer/extension/theme.rb
+- lib/rexer/source.rb
 - lib/rexer/source/base.rb
 - lib/rexer/source/git.rb
 - lib/rexer/source/github.rb