rexer 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86612492af231c5ed6d00b8fe44c305a62013b2aeb3571bbb70c4d53e8ed6b30
-  data.tar.gz: 1cf5c21eb32b9a30829c1dcc9b823902dd9a560190a44ae9976288f4c340e5f3
+  metadata.gz: 236c94fc48362e83c23049edb3b1b21311385622a66793fa19240f42fb702388
+  data.tar.gz: 7707f18ae6e414d9390080944292f8537a11b19f03ce93d6142dc106129f7e04
 SHA512:
-  metadata.gz: da47f60be431db339d94dbaa944b4732495cc2f29088413826a3828c03c6e140fa438c967f38ed68881058f89d2caff0c3751adf569c9110579e508c29016135
-  data.tar.gz: 4c48a3ebffb2341d93adde02983cb9019587e00f0be83060f57237967c07fa955a94e2ba34a129392d33be3bc862b557586b931dc02ad4e74135556f17dc239c
+  metadata.gz: 12a8e53ccdb53e9da0bbd66787eb4377031353e51d3d3785d3242006cbfe7445acbd5f136664bc5e681d76333ea8e082f7b92b8f1c0fe4923fb41a8a947526bd
+  data.tar.gz: f487865de3c6f4064f72e0dae4fca83c9a8c17a711d26e0fb1e2c78058db44b510930cc67d856a19d71059e9cf46f95aeb3d24821266157dfd3eb2e627bfae77

data/README.md

@@ -16,8 +16,6 @@ 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.
 
-[![demo](docs/demo-v0.8.0.gif)](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.
@@ -80,15 +78,16 @@ This command uninstalls the extensions and deletes the `.extensions.lock`.
 ```
 $ rex
 Commands:
-  rex envs            # Show the list of environments and their extensions defined in .extensions.rb
-  rex help [COMMAND]  # Describe available commands or one specific command
-  rex init            # Create a new .extensions.rb file
-  rex install [ENV]   # Install the definitions in .extensions.rb 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
-  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 version         # Show Rexer version
+  rex envs                         # Show the list of environments and their extensions defined in .extensions.rb
+  rex help [COMMAND]               # Describe available commands or one specific command
+  rex init                         # Create a new .extensions.rb file
+  rex install [ENV]                # Install the definitions in .extensions.rb for the specified environment
+  rex reinstall [PLUGIN or THEME]  # Uninstall extensions for the currently installed environment and install them again
+  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 version                      # Show Rexer version
 
 Options:
   -v, [--verbose], [--no-verbose], [--skip-verbose]  # Detailed output
@@ -204,6 +203,25 @@ In the above case, the `bin/rails redmine:plugins:migrate` command is executed a
 
 ## Developing
 
+### Running the command
+
+You can run the command in your local environment without installing the gem as follows.
+
+Setting up the development environment.
+
+```
+$ git clone <this repository>
+$ cd rexer
+$ bundle install
+```
+
+Running the command.
+
+```
+$ cd /path/to/your-local-redmine-source
+$ /your-local-rexer-source/bin/dev state
+```
+
 ### Running tests
 
 First, you need to build the docker image for the integration tests.
@@ -233,6 +251,36 @@ rake standard
 rake standard:fix
 ```
 
+### Profiling
+
+Print the call-stack profile.
+
+```
+$ PROFILE=s /your-local-rexer-source/bin/dev state
+...
+
+== Profile ==
+==================================
+  Mode: wall(1000)
+  Samples: 298 (1.97% miss rate)
+  GC: 36 (12.08%)
+==================================
+     TOTAL    (pct)     SAMPLES    (pct)     FRAME
+       261  (87.6%)         147  (49.3%)     Kernel#require
+       ...
+```
+
+Print the benchmark.
+
+```
+$ PROFILE=b /your-local-rexer-source/bin/dev state
+...
+
+== Benchmark ==
+      user     system      total        real
+  0.253115   0.030599   0.283714 (  0.283681)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/hidakatsuya/rexer.

data/bin/dev

@@ -2,4 +2,39 @@
 
 require_relative "../lib/rexer"
 
-Rexer::Cli.start(ARGV)
+def with_profiling(profile = false)
+  case ENV["PROFILE"]
+
+  # PROFILE=s dev state
+  when "s", "stack"
+    require "stackprof"
+
+    profile = StackProf.run(mode: :wall, interval: 1000) do
+      yield
+    end
+
+    puts
+    puts "== Profile =="
+    StackProf::Report.new(profile).print_text
+
+  # PROFILE=b dev state
+  when "b", "bench"
+    require "benchmark"
+
+    bench = Benchmark.measure do
+      yield
+    end
+
+    puts
+    puts "== Benchmark =="
+    puts Benchmark::CAPTION
+    puts bench
+
+  else
+    yield
+  end
+end
+
+with_profiling(ENV["PROFILE"]) do
+  Rexer::Cli.start(ARGV)
+end

data/lib/rexer/cli.rb

@@ -24,6 +24,11 @@ module Rexer
       Commands::Uninstall.new.call
     end
 
+    desc "reinstall [PLUGIN or THEME]", "Uninstall extensions for the currently installed environment and install them again"
+    def reinstall(extension_name)
+      Commands::Reinstall.new.call(extension_name)
+    end
+
     desc "switch [ENV]", "Uninstall extensions for the currently installed environment and install extensions for the specified environment"
     def switch(env = "default")
       Commands::Switch.new.call(env&.to_sym)

data/lib/rexer/commands/init.rb

@@ -1,5 +1,3 @@
-require "paint"
-
 module Rexer
   module Commands
     class Init

data/lib/rexer/commands/reinstall.rb

@@ -0,0 +1,53 @@
+module Rexer
+  module Commands
+    class Reinstall
+      include ActionCallable
+
+      Action = Data.define(:install, :uninstall)
+
+      def initialize
+        @lock_definition = Definition::Lock.load_data
+      end
+
+      def call(extension_name)
+        return if no_lock_file_found
+
+        extension, action = find_extension_with_action(extension_name.to_sym)
+
+        if extension.nil?
+          puts "#{extension_name} is not installed"
+          return
+        end
+
+        reinstall(extension, action)
+      end
+
+      private
+
+      attr_reader :lock_definition
+
+      def find_extension_with_action(name)
+        lock_definition.plugins.find { _1.name == name }&.then do |plugin|
+          action = Action.new(Extension::Plugin::Install, Extension::Plugin::Uninstall)
+          return [plugin, action]
+        end
+
+        lock_definition.themes.find { _1.name == name }&.then do |theme|
+          action = Action.new(Extension::Theme::Install, Extension::Theme::Uninstall)
+          return [theme, action]
+        end
+      end
+
+      def reinstall(extension, action)
+        call_action action.uninstall, extension
+        call_action action.install, extension
+      end
+
+      def no_lock_file_found
+        lock_definition.nil?.tap { |result|
+          puts "No lock file found" if result
+        }
+      end
+    end
+  end
+end

data/lib/rexer/definition/dsl.rb

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

data/lib/rexer/source/base.rb

@@ -1,6 +1,10 @@
 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,5 +1,7 @@
 module Rexer
   module Source
+    def self.names = @names ||= []
+
     def self.from_definition(source)
       const_get(source.type.capitalize).new(**source.options)
     end

data/lib/rexer/version.rb

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

data/lib/rexer.rb

@@ -32,3 +32,4 @@ 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.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 2024-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -115,6 +115,7 @@ files:
 - lib/rexer/commands/envs.rb
 - lib/rexer/commands/init.rb
 - lib/rexer/commands/install.rb
+- lib/rexer/commands/reinstall.rb
 - lib/rexer/commands/state.rb
 - lib/rexer/commands/switch.rb
 - lib/rexer/commands/uninstall.rb