sapristi 0.1.31 → 0.1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbe69ef3d4dc1b95146ae12ed0806a35e5248d213c2e9c25421cf70e702642bd
-  data.tar.gz: 61ba8b136d1dd8b7f34b55a945bb4297d046b7277bbcdcc3d6da5b72b73af415
+  metadata.gz: 841eaad20944eda7c31a7e9557a2edcb1c894184b89226715d4d07a0959cc4ab
+  data.tar.gz: 9ca9977a9fe31b3c8bef49af27a939c0b069843dae18a6316e5eba8e35beffca
 SHA512:
-  metadata.gz: a9b2f36d57d26ec4489a88c810c6e46f465188c8b545ed22b5a034a1152fe25a703fae8cd255741584189a01b4ae7126c1eb50be63a5f0c28b8a889ec494aeca
-  data.tar.gz: d0e84f6ebf91c6a726da427d63e664e9a0b133650ebe9d860ec7518c5a0888a91c546ccd4ef962c6d68970e1f776ea12e8fdccbd9aab01e79851e7088118fc0f
+  metadata.gz: 33fd1ecdde12c32c02dc8aacf1ad6dd8d0cc7af0e96d46b6e86c04551969965b72f6de0602c195f2549fa4145bf70131448f0216f34a062ae6a5c732d45800b0
+  data.tar.gz: d354af47aea67215e560744c36220b02af47728e06cdb1178a750c96e755578f1943c7845a556e51bae2788c15132bd7fb4628e9d715a207b928a5b2f8be77f9

data/README.md

@@ -1,6 +1,6 @@
 # Sapristi
 
-[![Maintainability](https://api.codeclimate.com/v1/badges/e168b7940a847148f617/maintainability)](https://codeclimate.com/github/sapristi-tool/sapristi/maintainability)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e168b7940a847148f617/maintainability)](https://codeclimate.com/github/sapristi-tool/sapristi/maintainability) ![Gem](https://img.shields.io/gem/v/sapristi?style=plastic)
 
 ![Sapristi image](/assets/images/sapristi.jpg)
 
@@ -22,27 +22,33 @@ Install gem
 
   > `-f FILE` load your definitions from another file, ie: sapristi -f ~/machine_learning_definitions.csv
 
-  > `-v | --verbose` verbose mode.
+  > `-v | --verbose` verbose mode
 
-  > `--dry-run` dry mode, show your definitions but it doesn't execute them.
+  > `--dry-run` dry mode, show your definitions but it doesn't execute them
 
   > `-g|--group name` load definitions tagged with group, ie: sapristi -g social
+  
+  > `-h|--help` show help
+  
+  > `-m|--monitors` show available monitors info (including work area size) and exits
+
+  > `-w|--wait-time wait-time-in-seconds` set wait time for detecting a window (default: 30)
 
 
 ### Configuration example: ~/.sapristi.csv
 
 | __Title__ | __Command__                                                                         | __Monitor__ | __X__          | __Y__          | __Width__  | __Height__ | __Workspace__ | __Group__    |
 |-------|---------------------------------------------------------------------------------|---------|------------|------------|--------|--------|-----------|----------|
-|       | subl ~/projects/ruby/sapristi                                                   |         | 0          | 0          | 60%    | 100%   | 0         | sapristi |
-|       | terminator --working-directory=~/projects/ruby/sapristi                         |         | 60%        | 0          | 40%    | 50%    | 0         | sapristi |
+|       | subl ~/projects/ruby/sapristi                                                   |         | 0%         | 0%         | 60%    | 100%   | 0         | sapristi |
+|       | terminator --working-directory=~/projects/ruby/sapristi                         |         | 60%        | 0%         | 40%    | 50%    | 0         | sapristi |
 |       | zeal                                                                            |         | 60%        | 50%        | 40%    | 50%    | 0         | sapristi |
-|       | subl ~/projects/python/stuff                                                    |         | 0          | 0          | 60%    | 100%   | 1         | python   |
-|       | terminator --working-directory=~/projects/python/stuff                          |         | 60%        | 0          | 40%    | 50%    | 1         | python   |
+|       | subl ~/projects/python/stuff                                                    |         | 0%         | 0%         | 60%    | 100%   | 1         | python   |
+|       | terminator --working-directory=~/projects/python/stuff                          |         | 60%        | 0%         | 40%    | 50%    | 1         | python   |
 |       | firefox --new-window https://docs.python.org/3/index.html                       |         | 60%        | 50%        | 40%    | 50%    | 1         | python   |
-|       | firefox --new-window https://www.gmail.com                                      |         | 0          | 0          | 50%    | 100%   | 2         | social   |
-|       | firefox --new-window https://www.slack.com                                      |         | 50%        | 0          | 50%    | 50%    | 2         | social   |
-|       | firefox --new-window https://www.twitter.com                                    |         | 50%        |            | 50%    | 50%    | 2         | social   |
-|       | sol                                                                             | DP-2    | 0          | 0          | 100%   | 100%   | 3         | games    |
+|       | firefox --new-window https://www.gmail.com                                      |         | 0%         | 0%         | 50%    | 100%   | 2         | social   |
+|       | firefox --new-window https://www.slack.com                                      |         | 50%        | 0%         | 50%    | 50%    | 2         | social   |
+|       | firefox --new-window https://www.twitter.com                                    |         | 50%        | 0%         | 50%    | 50%    | 2         | social   |
+|       | sol                                                                             | DP-2    | 0%         | 0%         | 100%   | 100%   | 3         | games    |
 
 The configuration file is a CSV file (comma delimited, no separator). First line is the header line, next lines are definitions. Each definition prescribes:
  - How choose a window from the current ones, or how to launch a program to produce the window: __Title__, __Command__
@@ -52,17 +58,17 @@ The configuration file is a CSV file (comma delimited, no separator). First line
 
 The table above represents a CSV file like the one below:
 ```
-Title,Command,Monitor,X,Y,Width,Height,Workspace
-,subl ~/projects/ruby/sapristi,0,0,60%,100%,0,sapristi
-,terminator --working-directory=~/projects/ruby/sapristi,60%,0,40%,50%,0,sapristi
-,zeal,60%,50%,40%,50%,0,sapristi
-,subl ~/projects/python/stuff,0,0,60%,100%,1,python
-,terminator --working-directory=~/projects/python/stuff,60%,0,40%,50%,1,python
-,firefox --new-window https://docs.python.org/3/index.html,60%,50%,40%,50%,1,python
-,firefox --new-window https://www.gmail.com,0,0,50%,100%,2,social
-,firefox --new-window https://www.slack.com,50%,0,50%,50%,2,social
-,firefox --new-window https://www.twitter.com,50%,50%,50%,2,social
-,sol,DP-2,0,0,100%,100%,3,games
+Title,Command,Monitor,X,Y,Width,Height,Workspace,Group
+,subl ~/projects/ruby/sapristi,,0%,0%,60%,100%,0,sapristi
+,terminator --working-directory=~/projects/ruby/sapristi,,60%,0%,40%,50%,0,sapristi
+,zeal,,60%,50%,40%,50%,0,sapristi
+,subl ~/projects/python/stuff,,0%,0%,60%,100%,1,python
+,terminator --working-directory=~/projects/python/stuff,,60%,0%,40%,50%,1,python
+,firefox --new-window https://docs.python.org/3/index.html,,60%,50%,40%,50%,1,python
+,firefox --new-window https://www.gmail.com,,0%,0%,50%,100%,2,social
+,firefox --new-window https://www.slack.com,,50%,0%,50%,50%,2,social
+,firefox --new-window https://www.twitter.com,,50%,50%,50%,50%,2,social
+,sol,DP-2,0%,0%,100%,100%,3,games
 ```
 
 
@@ -73,24 +79,27 @@ Title,Command,Monitor,X,Y,Width,Height,Workspace
   - Twitter.+Firefox
   - System Monitor
 
-- __Command__(optional): A command. If __Title__ is not provided or there isn't a window that matches it, sapristi will execute __Command__.
-Every line has to define a __Title__, a __Command__ or both. Examples:
+- __Command__(optional): A command. If __Title__ is not provided or there isn't a window that matches it, sapristi will execute __Command__. Examples:
   - firefox --new-window https://www.twitter.com
   - terminator --working-directory=~/projects/python/stuff
   
-
+  (Every line has to define a __Title__, **OR** a __Command__ or both)
+  
 - __Monitor__(optional): Monitor name (check your monitor names with xrandr) If a definition specifies a monitor not present or if is empty, window will be placed in the main monitor of the actual environment.
   - Use monitor when specified.
   - Use main monitor if monitor name is not found.
   - Use main monitor if __Monitor__ is not provided.
   
 - __X__(mandatory): Absolute or relative. Horizontal top left coordinate to place the window:
-  - Absolute (pixels): ie 100, 200, 250.
+  - Absolute (monitor width): ie 100, 200, 250.
   - Relative (monitor workarea): 10%, 20%, 50%. Percentage has to be an integer between 0 and 100. 
 
 - __Y__(mandatory): Absolute or relative. Vertical top left coordinate to place the window:
-  - Absolute (pixels): ie 100, 200, 250.
+  - Absolute (monitor monitor height): ie 100, 200, 250.
   - Relative (monitor workarea): 10%, 20%, 50%. Percentage has to be an integer between 0 and 100. 
+  
+  The work area should be considered when positioning menus and similar popups, to avoid placing them below panels, docks or other desktop components.
+  ![workarea image](/assets/images/workarea.jpg)
 
 - __Width__(mandatory): Absolute (pixels) or relative (workarea) Window width. Examples: 100, 50%. 
 

data/bin/sapristi

@@ -11,12 +11,13 @@ module Sapristi
     end
 
     def run(args)
-      options = ArgumentsParser.new.parse args
-      build(options)
-
-      options.file ? @sapristi.run(options.file) : @sapristi.run
+      @options = ArgumentsParser.new.parse args
+      setup
+      process
     rescue Error => e
       exit_error 1, e.message
+    rescue OptionParser::InvalidOption => e
+      exit_error 1, "Error: #{e}, check sapristi -h"
     rescue StandardError => e
       error_file = save_stacktrace e
 
@@ -25,10 +26,17 @@ module Sapristi
 
     private
 
-    def build(options)
-      @sapristi.verbose! if options.verbose
-      @sapristi.dry! if options.dry
-      @sapristi.filter!(options.group) if options.group
+    def process
+      return MonitorManager.new.show_monitors if @options.show_monitors
+
+      @options.file ? @sapristi.run(@options.file) : @sapristi.run
+    end
+
+    def setup
+      @sapristi.verbose! if @options.verbose
+      @sapristi.dry! if @options.dry
+      @sapristi.filter!(@options.group) if @options.group
+      @sapristi.wait_time!(@options.wait_time) if @options.wait_time
     end
 
     def save_stacktrace(error)

data/lib/sapristi/arguments_parser.rb

@@ -21,16 +21,36 @@ module Sapristi
     end
 
     # This method smells of :reek:TooManyStatements
+    # rubocop:disable  Metrics/AbcSize
+    # rubocop:disable  Metrics/MethodLength
     def self.populate_options(opts, args)
       opts.banner = 'Usage: sapristi [options]'
       opts.on('-v', '--verbose', 'Verbose mode') { |value| args.verbose = value }
       opts.on('-g', '--group GROUP', 'Use named group definitions') { |value| args.group = value }
+      opts.on('-w', '--wait-time NUMBER_OF_SECONDS (1-120), default=30', 'Wait time for detecting a window') do |value|
+        args.wait_time = parse_integer(value, 1, 120)
+      end
       opts.on('--dry-run', 'Dry run') { |value| args.dry = value }
       opts.on('-f', '--file FILE', 'Read configuration from FILE') { |file| args.file = file }
       opts.on('-h', '--help', 'Prints this help') do
         puts opts
         exit
       end
+      opts.on('-m', '--monitors', 'Show monitor\'s info') { args.show_monitors = true }
+    end
+    # rubocop:enable  Metrics/AbcSize
+    # rubocop:enable  Metrics/MethodLength
+
+    def self.parse_integer(value, min = nil, max = nil)
+      raise OptionParser::InvalidOption, "'#{value}' is not an integer" unless value.match(/^[0-9]+$/)
+
+      integer = value.to_i
+      raise OptionParser::InvalidOption, "requires a wait time > 0, provided=#{value}" unless min.nil? || integer >= min
+      unless max.nil? || integer <= max
+        raise OptionParser::InvalidOption, "requires a wait time <= 120 seconds, provided=#{value}"
+      end
+
+      integer
     end
   end
 end

data/lib/sapristi/definition_processor.rb

@@ -5,8 +5,11 @@ module Sapristi
     def initialize(window_manager = WindowManager.new, process_manager = NewProcessWindowDetector.new)
       @window_manager = window_manager
       @process_manager = process_manager
+      @wait_time = 30
     end
 
+    attr_accessor :wait_time
+
     def process_definition(definition)
       window = get_window definition.title, definition.command
 
@@ -21,7 +24,7 @@ module Sapristi
 
     def get_window(title, command)
       (title && find_one_by_title(title)) ||
-        (command && @process_manager.detect_window_for_process(command, title)) ||
+        (command && @process_manager.detect_window_for_process(command, title, @wait_time)) ||
         raise(Error, "Couldn't produce a window for this definition")
     end
 

data/lib/sapristi/monitor.rb

@@ -12,6 +12,12 @@ module Sapristi
 
     ATTRIBUTES = %i[id main name x y offset_x offset_y work_area work_area_width work_area_height].freeze
 
+    def to_s
+      # rubocop:disable Layout/LineLength
+      "#{id} #{main ? 'main' : '    '} #{name} #{x}x#{y} workarea[x=#{work_area[0]}, y=#{work_area[1]}, width=#{work_area_width}, height=#{work_area_height}]"
+      # rubocop:enable Layout/LineLength
+    end
+
     attr_reader(*ATTRIBUTES)
 
     def hash

data/lib/sapristi/monitor_manager.rb

@@ -21,6 +21,13 @@ module Sapristi
       @os_manager.monitors
     end
 
+    def show_monitors
+      the_monitors = monitors
+
+      puts "Monitors: #{the_monitors.size}"
+      the_monitors.each_value { |monitor| puts monitor }
+    end
+
     private
 
     def monitor_present?(name)

data/lib/sapristi/new_process_window_detector.rb

@@ -47,9 +47,9 @@ module Sapristi
       start_time = Time.now
 
       while Time.now - start_time < timeout_in_seconds # && waiter.alive?
-        process_window = detect_new_windows.find { |window| window_for?(waiter, program, title, window) }
+        new_window = detect_new_windows.find { |window| window_for?(waiter, program, title, window) }
 
-        return process_window if process_window
+        return new_window if new_window && !splash?(new_window)
 
         sleep 0.2
       end
@@ -105,5 +105,17 @@ module Sapristi
     def new_window?(window)
       !previous_windows_ids.include?(window.id)
     end
+
+    def splash?(window)
+      skip_taskbar?(window) || skip_pager?(window)
+    end
+
+    def skip_taskbar?(window)
+      window.state.include? '_NET_WM_STATE_SKIP_TASKBAR'
+    end
+
+    def skip_pager?(window)
+      window.state.include? '_NET_WM_STATE_SKIP_PAGER'
+    end
   end
 end

data/lib/sapristi/sapristi.rb

@@ -7,6 +7,7 @@ module Sapristi
       @definition_processor = definition_processor
       @dry = false
       @verbose = false
+      @group = nil
     end
 
     def run(conf_file = Sapristi.user_default_configuration_file)
@@ -32,6 +33,10 @@ module Sapristi
       logger.level = :info if logger.level > Logger::INFO
     end
 
+    def wait_time!(wait_time)
+      @definition_processor.wait_time = wait_time
+    end
+
     def filter!(group)
       @group = group
     end

data/lib/sapristi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sapristi
-  VERSION = '0.1.31'
+  VERSION = '0.1.32'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sapristi
 version: !ruby/object:Gem::Version
-  version: 0.1.31
+  version: 0.1.32
 platform: ruby
 authors:
 - Sapristi dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-25 00:00:00.000000000 Z
+date: 2020-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -284,6 +284,7 @@ files:
 - README.md
 - Rakefile
 - assets/images/sapristi.jpg
+- assets/images/workarea.jpg
 - bin/console
 - bin/sapristi
 - bin/setup