fusuma-plugin-wmctrl 0.4.0.pre2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '069aaa7f3d06e2445189455621c251823ae6b012b3aae0c7ec717f013af5c4c9'
-  data.tar.gz: cabf1c51189097888bcc4f729ffbc985b3a953cbb65a260a517b807f234056bf
+  metadata.gz: 260a70ddbdd31218d0e43a7c354482b44d1cc17aaf7ece9fe3800ce7bf156c72
+  data.tar.gz: 0a15ae0fbe6c080fccc5e460400a3b77e062079e00f0a90dabdfb43d3c5d4dd2
 SHA512:
-  metadata.gz: d7e2d157ca4e01b97b09bebe5354069b03a43d3fa47234c39eb5bdfd8f92fa510139c48618d3e428ebbf8a0663dcaffe628b1f77c3c422abaa84203b91fd8a40
-  data.tar.gz: 216014d9644812c3992b7e8ba02f1816737eea4ce00f1097070c8b9acf15719ee874a4c635eaadc57711c4a5f1c427300031cc5ce5f91a60f484eda4534cd5f7
+  metadata.gz: e07ea3be6ceed205615ba3f22e57519b3dfad5e3fba29c099fffc35afa542bb33eef7c2143962cd1c987127b13472780c45f99f03d3f07e5e0ce9afda6e63178
+  data.tar.gz: a0fa6b1ba117356a3062a30e11c2f3969a2382c4adbd2b0327c03dbb404f89d9ed71d4564dbde8588d798b5297af46ad429efa7f64517ec807bbc5e57babf80b

data/README.md

@@ -29,7 +29,7 @@ sudo pacman -S wmctrl
 This plugin requires [Fusuma](https://github.com/iberianpig/fusuma#update) version 1.0 or later.
 
 
-**Note For Arch Based Distros:** By default in Arch Linux, when running ```gem```, gems are installed per-user (into ```~/.gem/ruby/```), instead of system-wide (into ```/usr/lib/ruby/gems/```). This is considered the best way to manage gems on Arch, because otherwise they might interfere with gems installed by Pacman. (From Arch Wiki)
+**Note For Arch Based Distros:** By default in Arch Linux, when running `gem`, gems are installed per-user (into `~/.gem/ruby/`), instead of system-wide (into `/usr/lib/ruby/gems/`). This is considered the best way to manage gems on Arch, because otherwise they might interfere with gems installed by Pacman. (From Arch Wiki)
 
 To install gems system-wide, see any of the methods listed on [Arch Wiki](https://wiki.archlinux.org/index.php/ruby#Installing_gems_system-wide)
 
@@ -46,6 +46,7 @@ Values following are available for `workspace`.
 
   * `prev` is value to switch current workspace to previous workspace.
   * `next` is value to switch current workspace to next workspace.
+  * [**[For grid-style workspaces only](#support-grid-style-workspace)**] `up` / `down` / `left` / `right` navigate to the workspace in the direction.
 
 ### `window:` property
 Add `window:` property in `~/.config/fusuma/config.yml`.
@@ -54,6 +55,7 @@ Values following are available for `window`.
 
   * `prev` is value to move active window to previous workspace.
   * `next` is value to move active window to next workspace.
+  * [**[For grid-style workspaces only](#support-grid-style-workspace)**] `up` / `down` / `left` / `right` move window to the workspace in the direction.
   * `fullscreen` is value to toggle fullscreen
     * `fullscreen: toggle` toggles the active window to fullscreen.
       ```yml
@@ -111,6 +113,8 @@ swipe:
 
 ## Configuration
 
+### Wrap navigation
+
 The plugin allows to enable (disabled by default) circular navigation between workspaces. To enable it set the following in your config file `~/.config/fusuma/config.yml`.
 
 ```yaml
@@ -120,6 +124,56 @@ plugin:
       wrap-navigation: true
 ```
 
+### Support grid-style workspace
+
+For grid-style workspace users, Fusuma has an option to move workspace up, down, left or right.
+To enable this option, set `matrix-col-size`.
+
+For example, for a 3x2 workspace, set `matrix-col-size: 3` to wmctrl_executor option.
+```yaml
+plugin:
+  executors:
+    wmctrl_executor:
+      matrix-col-size: 3
+```
+
+With this setting, the `up`/`down`/`left`/`right` properties will be enabled on `workspace:` and `window:`.
+
+#### Example
+
+```yaml
+swipe:
+  4:
+    up:
+      workspace: down
+      keypress:
+        LEFTSHIFT:
+          window: down
+    down:
+      workspace: up
+      keypress:
+        LEFTSHIFT:
+          window: up
+    left:
+      workspace: right
+      keypress:
+        LEFTSHIFT:
+          window: right
+    right:
+      workspace: left
+      keypress:
+        LEFTSHIFT:
+          window: left
+
+plugin:
+  executors:
+    wmctrl_executor:
+      matrix-col-size: 3
+```
+
+NOTE: `keypress:` property is enabled with fusuma-plugin-keypress
+https://github.com/iberianpig/fusuma-plugin-keypress
+
 
 ## Contributing
 

data/fusuma-plugin-wmctrl.gemspec

@@ -16,14 +16,13 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files          = Dir['{bin,lib,exe}/**/*', 'LICENSE*', 'README*', '*.gemspec']
+  spec.test_files     = Dir['{test,spec,features}/**/*']
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
-  spec.add_dependency 'fusuma', '~> 2.0.0.pre2'
+  spec.required_ruby_version = '>= 2.5.1' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
+  # support bionic (18.04LTS) 2.5.1
+  spec.add_dependency 'fusuma', '~> 2.0.0'
 end

data/lib/fusuma/plugin/executors/wmctrl_executor.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'posix/spawn'
-require 'singleton'
+require_relative '../wmctrl/window'
+require_relative '../wmctrl/workspace'
 
 module Fusuma
   module Plugin
@@ -11,17 +11,23 @@ module Fusuma
         # executor properties on config.yml
         # @return [Array<Symbol>]
         def execute_keys
-          %i[wmctrl workspace]
+          %i[workspace window]
         end
 
         def config_param_types
           {
-            'wrap-navigation': [TrueClass, FalseClass]
+            'wrap-navigation': [TrueClass, FalseClass],
+            'matrix-col-size': [Integer]
           }
         end
 
         def initialize
-          Workspace.configure(wrap_navigation: config_params(:'wrap-navigation'))
+          super()
+          @workspace = Workspace.new(
+            wrap_navigation: config_params(:'wrap-navigation'),
+            matrix_col_size: config_params(:'matrix-col-size')
+          )
+          @window = Window.new
         end
 
         # execute wmctrl command
@@ -31,7 +37,7 @@ module Fusuma
           return if search_command(event).nil?
 
           MultiLogger.info(wmctrl: search_command(event))
-          pid = POSIX::Spawn.spawn(search_command(event))
+          pid = Process.spawn(search_command(event))
           Process.detach(pid)
         end
 
@@ -49,6 +55,9 @@ module Fusuma
         # @return [NilClass]
         def search_command(event)
           search_workspace_command(event) || search_window_command(event)
+        rescue Workspace::InvalidOption => e
+          MultiLogger.error(e.message)
+          exit 1
         end
 
         private
@@ -59,10 +68,16 @@ module Fusuma
         def search_workspace_command(event)
           index = Config::Index.new([*event.record.index.keys, :workspace])
 
-          direction = Config.search(index)
-          return unless direction.is_a?(String)
-
-          Workspace.move_command(direction: direction)
+          case property = Config.search(index)
+          when 'prev', 'next'
+            @workspace.move_command(direction: property)
+          when 'left', 'right', 'up', 'down'
+            @workspace.move_command_for_matrix(direction: property)
+          when nil
+            nil
+          else
+            raise "#{property} is invalid key"
+          end
         end
 
         # @param event [Event]
@@ -73,113 +88,25 @@ module Fusuma
 
           case property = Config.search(index)
           when 'prev', 'next'
-            Window.move_command(direction: property)
+            @workspace.move_window_command(direction: property)
+          when 'left', 'right', 'up', 'down'
+            @workspace.move_window_command_for_matrix(direction: property)
           when 'fullscreen'
-            Window.fullscreen(method: 'toggle')
+            @window.fullscreen(method: 'toggle')
           when 'maximized'
-            Window.maximized(method: 'toggle')
+            @window.maximized(method: 'toggle')
           when 'close'
-            Window.close
+            @window.close
           when Hash
             if property[:fullscreen]
-              Window.fullscreen(method: property[:fullscreen])
+              @window.fullscreen(method: property[:fullscreen])
             elsif property[:maximized]
-              Window.maximized(method: property[:maximized])
-            end
-          end
-        end
-
-        # Manage workspace
-        class Workspace
-          include Singleton
-
-          attr_accessor :wrap_navigation
-
-          class << self
-            # configure properties of the workspace switcher
-            # @return [NilClass]
-            def configure(wrap_navigation:)
-              instance.wrap_navigation = wrap_navigation
-            end
-
-            # get next workspace number
-            # @return [Integer]
-            def next_workspace_num(step:)
-              current_workspace_num, total_workspace_num = workspace_values
-
-              next_workspace_num = current_workspace_num + step
-
-              return next_workspace_num unless instance.wrap_navigation
-
-              if next_workspace_num.negative?
-                next_workspace_num = total_workspace_num - 1
-              elsif next_workspace_num >= total_workspace_num
-                next_workspace_num = 0
-              else
-                next_workspace_num
-              end
-            end
-
-            def move_command(direction:)
-              workspace_num = case direction
-                              when 'next'
-                                next_workspace_num(step: 1)
-                              when 'prev'
-                                next_workspace_num(step: -1)
-                              else
-                                raise "#{direction} is invalid key"
-                              end
-              "wmctrl -s #{workspace_num}"
-            end
-
-            private
-
-            # get current workspace and total workspace numbers
-            # @return [Integer, Integer]
-            def workspace_values
-              wmctrl_output = `wmctrl -d`.split("\n")
-
-              current_line = wmctrl_output.grep(/\*/).first
-              # NOTE: stderror when failed to get desktop
-              # `Cannot get current desktop properties. (_NET_CURRENT_DESKTOP or _WIN_WORKSPACE property)`
-              return [0, 1] if current_line.nil? # If not found ,return desktop id as 0 and the total number as 1
-
-              current_workspace_num = current_line.chars.first.to_i
-              total_workspace_num = wmctrl_output.length
-
-              [current_workspace_num, total_workspace_num]
-            end
-          end
-        end
-
-        # Manage Window
-        class Window
-          class << self
-            # @param method [String] "toggle" or "add" or "remove"
-            def maximized(method:)
-              "wmctrl -r :ACTIVE: -b #{method},maximized_vert,maximized_horz"
-            end
-
-            def close
-              'wmctrl -c :ACTIVE:'
-            end
-
-            # @param method [String] "toggle" or "add" or "remove"
-            def fullscreen(method:)
-              "wmctrl -r :ACTIVE: -b #{method},fullscreen"
-            end
-
-            def move_command(direction:)
-              workspace_num = case direction
-                              when 'next'
-                                Workspace.next_workspace_num(step: 1)
-                              when 'prev'
-                                Workspace.next_workspace_num(step: -1)
-                              else
-                                raise "#{direction} is invalid key"
-                              end
-              "wmctrl -r :ACTIVE: -t #{workspace_num} ; wmctrl -s #{workspace_num}"
+              @window.maximized(method: property[:maximized])
             end
+          when nil
+            nil
+          else
+            raise "#{property} is invalid key"
           end
         end
       end

data/lib/fusuma/plugin/wmctrl/version.rb

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Wmctrl
-      VERSION = '0.4.0.pre2'
+      VERSION = '1.0.0'
     end
   end
 end

data/lib/fusuma/plugin/wmctrl/window.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Manage Window
+class Window
+  # @param method [String] "toggle" or "add" or "remove"
+  def maximized(method:)
+    "wmctrl -r :ACTIVE: -b #{method},maximized_vert,maximized_horz"
+  end
+
+  def close
+    'wmctrl -c :ACTIVE:'
+  end
+
+  # @param method [String] "toggle" or "add" or "remove"
+  def fullscreen(method:)
+    "wmctrl -r :ACTIVE: -b #{method},fullscreen"
+  end
+end

data/lib/fusuma/plugin/wmctrl/workspace.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+# Manage workspace
+class Workspace
+  class InvalidOption < StandardError; end
+
+  def initialize(wrap_navigation: nil, matrix_col_size: nil)
+    @wrap_navigation = wrap_navigation
+    @matrix_col_size = matrix_col_size
+  end
+
+  # get next workspace number
+  # @return [Integer]
+  def next_workspace_num(step:)
+    current_workspace_num, total_workspace_num = workspace_values
+
+    next_workspace_num = current_workspace_num + step
+
+    return next_workspace_num unless @wrap_navigation
+
+    if next_workspace_num.negative?
+      next_workspace_num = total_workspace_num - 1
+    elsif next_workspace_num >= total_workspace_num
+      next_workspace_num = 0
+    else
+      next_workspace_num
+    end
+    next_workspace_num
+  end
+
+  # @return [Array<Integer>]
+  def matrix_size(total_workspace_num)
+    must_have_matrix_option!
+    col_size = @matrix_col_size
+    row_size = (total_workspace_num / col_size)
+    [row_size.to_i, col_size.to_i]
+  end
+
+  def must_have_matrix_option!
+    return if @matrix_col_size
+
+    warn(<<~ERRRORMESSAGE)
+      Please set matrix-col-size to config.yml
+
+      ```config.yaml
+      plugin:
+        executors:
+          wmctrl_executor:
+            matrix-col-size: 2
+      ```
+    ERRRORMESSAGE
+    raise InvalidOption, 'You need to set matrix option to config.yml'
+  end
+
+  # @return [Integer]
+  # @raise RuntimeError
+  def next_workspace_num_for_matrix(direction:)
+    must_have_matrix_option!
+    current_workspace_num, total_workspace_num = workspace_values
+    row_size, col_size = matrix_size(total_workspace_num)
+    x = current_workspace_num % col_size
+    y = current_workspace_num / col_size
+    case direction
+    when 'right'
+      if x < col_size - 1
+        current_workspace_num + 1
+      elsif @wrap_navigation
+        current_workspace_num - (col_size - 1)
+      else
+        current_workspace_num
+      end
+    when 'left'
+      if x.positive?
+        current_workspace_num - 1
+      elsif @wrap_navigation
+        current_workspace_num + (col_size - 1)
+      else
+        current_workspace_num
+      end
+    when 'down'
+      if y < row_size - 1
+        current_workspace_num + col_size
+      elsif @wrap_navigation
+        (current_workspace_num + col_size) - total_workspace_num
+      else
+        current_workspace_num
+      end
+    when 'up'
+      if y.positive?
+        current_workspace_num - col_size
+      elsif @wrap_navigation
+        total_workspace_num + (current_workspace_num - col_size)
+      else
+        current_workspace_num
+      end
+    else
+      raise "#{direction} is invalid key"
+    end
+  end
+
+  def move_command(direction:)
+    workspace_num = case direction
+                    when 'next'
+                      next_workspace_num(step: 1)
+                    when 'prev'
+                      next_workspace_num(step: -1)
+                    else
+                      raise "#{direction} is invalid key"
+                    end
+    "wmctrl -s #{workspace_num}"
+  end
+
+  def move_command_for_matrix(direction:)
+    workspace_num = next_workspace_num_for_matrix(direction: direction)
+    "wmctrl -s #{workspace_num}"
+  end
+
+  def move_window_command(direction:)
+    workspace_num = case direction
+                    when 'next'
+                      next_workspace_num(step: 1)
+                    when 'prev'
+                      next_workspace_num(step: -1)
+                    else
+                      raise "#{direction} is invalid key"
+                    end
+    "wmctrl -r :ACTIVE: -t #{workspace_num} ; wmctrl -s #{workspace_num}"
+  end
+
+  def move_window_command_for_matrix(direction:)
+    workspace_num = next_workspace_num_for_matrix(direction: direction)
+    "wmctrl -r :ACTIVE: -t #{workspace_num} ; wmctrl -s #{workspace_num}"
+  end
+
+  private
+
+  # get current workspace and total workspace numbers
+  # @return [Integer, Integer]
+  def workspace_values
+    wmctrl_output = `wmctrl -d`.split("\n")
+
+    current_line = wmctrl_output.grep(/\*/).first
+    # NOTE: stderror when failed to get desktop
+    # `Cannot get current desktop properties. \
+    # (_NET_CURRENT_DESKTOP or _WIN_WORKSPACE property)`
+    return [0, 1] if current_line.nil?
+
+    current_workspace_num = current_line.chars.first.to_i
+    total_workspace_num = wmctrl_output.length
+
+    [current_workspace_num, total_workspace_num]
+  end
+end