fusuma-plugin-wmctrl 0.4.0.pre → 0.4.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb925fbaa6b543ef479a4ab6cd1344059e33463a0f7f3df3049e1edd70d76ad6
-  data.tar.gz: 6b7420837c160600133777202abfac495ceac866074c0b427264fd81d9c429e0
+  metadata.gz: '069aaa7f3d06e2445189455621c251823ae6b012b3aae0c7ec717f013af5c4c9'
+  data.tar.gz: cabf1c51189097888bcc4f729ffbc985b3a953cbb65a260a517b807f234056bf
 SHA512:
-  metadata.gz: dfdc522616136c802daa4484fd340171d82aa22918fe8545bfdaa3c8b48265a42fe9045174a1c77454900f20fcb04b7f343f3a44cbd66cfa14e9b413de49ae15
-  data.tar.gz: 9f70a836df9ade7c00f894444b5e01925e7b2170c4af932c0ef07549124b14c65b5c1ce58d27caa51bbebcdc6702480805d5d3f102e0887bc5107fb49bef90c7
+  metadata.gz: d7e2d157ca4e01b97b09bebe5354069b03a43d3fa47234c39eb5bdfd8f92fa510139c48618d3e428ebbf8a0663dcaffe628b1f77c3c422abaa84203b91fd8a40
+  data.tar.gz: 216014d9644812c3992b7e8ba02f1816737eea4ce00f1097070c8b9acf15719ee874a4c635eaadc57711c4a5f1c427300031cc5ce5f91a60f484eda4534cd5f7

data/CHANGELOG.md

@@ -1,8 +1,8 @@
 # Changelog
 
-## [Unreleased](https://github.com/iberianpig/fusuma-plugin-wmctrl/tree/HEAD)
+## [v0.4.0.pre](https://github.com/iberianpig/fusuma-plugin-wmctrl/tree/v0.4.0.pre) (2020-11-09)
 
-[Full Changelog](https://github.com/iberianpig/fusuma-plugin-wmctrl/compare/v0.3.0...HEAD)
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-wmctrl/compare/v0.3.0...v0.4.0.pre)
 
 **Merged pull requests:**
 

data/README.md

@@ -10,15 +10,29 @@ Window Manager plugin for [Fusuma](https://github.com/iberianpig/fusuma)
 
 Run the following code in your terminal.
 
-### Install wmctrl
+### 1.Install wmctrl
+
+#### For Debian Based Distros (Ubuntu, Debian, Mint, Pop!_OS)
 
 ```
-$ sudo apt install wmctrl
+$ sudo apt install wmctrl -y
 ```
-### Install fusuma-plugin-wmctrl
+
+#### For Arch Based Distros (Manjaro, Arch)
+
+```
+sudo pacman -S wmctrl
+```
+
+### 2. Install fusuma-plugin-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)
+
+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)
+
 ```sh
 $ sudo gem install fusuma-plugin-wmctrl
 ```
@@ -95,6 +109,17 @@ swipe:
       workspace: 'prev'
 ```
 
+## Configuration
+
+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
+plugin: 
+  executors:
+    wmctrl_executor:
+      wrap-navigation: true
+```
+
 
 ## Contributing
 

data/fusuma-plugin-wmctrl.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |spec|
   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.pre'
+  spec.add_dependency 'fusuma', '~> 2.0.0.pre2'
 end

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

@@ -1,12 +1,29 @@
 # frozen_string_literal: true
 
 require 'posix/spawn'
+require 'singleton'
 
 module Fusuma
   module Plugin
     module Executors
       # Control Window or Workspaces by executing wctrl
       class WmctrlExecutor < Executor
+        # executor properties on config.yml
+        # @return [Array<Symbol>]
+        def execute_keys
+          %i[wmctrl workspace]
+        end
+
+        def config_param_types
+          {
+            'wrap-navigation': [TrueClass, FalseClass]
+          }
+        end
+
+        def initialize
+          Workspace.configure(wrap_navigation: config_params(:'wrap-navigation'))
+        end
+
         # execute wmctrl command
         # @param event [Event]
         # @return [nil]
@@ -74,25 +91,64 @@ module Fusuma
 
         # Manage workspace
         class Workspace
+          include Singleton
+
+          attr_accessor :wrap_navigation
+
           class << self
-            # get workspace number
+            # 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 current_workspace_num
-              text = `wmctrl -d`.split("\n").grep(/\*/).first
-              text.chars.first.to_i
+            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'
-                                current_workspace_num + 1
+                                next_workspace_num(step: 1)
                               when 'prev'
-                                current_workspace_num - 1
+                                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
 
@@ -116,9 +172,9 @@ module Fusuma
             def move_command(direction:)
               workspace_num = case direction
                               when 'next'
-                                Workspace.current_workspace_num + 1
+                                Workspace.next_workspace_num(step: 1)
                               when 'prev'
-                                Workspace.current_workspace_num - 1
+                                Workspace.next_workspace_num(step: -1)
                               else
                                 raise "#{direction} is invalid key"
                               end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-wmctrl
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre
+  version: 0.4.0.pre2
 platform: ruby
 authors:
 - iberianpig
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre
+        version: 2.0.0.pre2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre
+        version: 2.0.0.pre2
 description: fusuma-plugin-wmctrl is Fusuma plugin for window manager.
 email:
 - yhkyky@gmail.com
@@ -52,7 +52,7 @@ homepage: https://github.com/iberianpig/fusuma-plugin-wmctrl
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Wmctrl plugin for Fusuma
 test_files: []