rmonitor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b64db8dea8068825d234898319c35aa04457999f
+  data.tar.gz: d95a141b9c7c761a6c417693eac1e3f7cd439876
+SHA512:
+  metadata.gz: 143917bc10cbfd192d084629c75829a452299199d3c097a8b878dd3fcc97e0b08349d6226d0ebbb5f8fb77ed23a9858baf9ff3d9f17453b71c2dfeb25741bcde
+  data.tar.gz: 9e37a31319ecf41021da2f3c9a9c99670eaa5b2f99a63bcc9a13e67afe484ea9c510912c8903c4d0370414ef6238a4b169b89b776dd5722749424da10b39aa49

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    rmonitor (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rmonitor!
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Jonas Amundsen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,205 @@
+## RMonitor
+
+[![Build Status](https://travis-ci.org/badeball/rmonitor.png)](https://travis-ci.org/badeball/rmonitor)
+
+RMonitor is a tool for creating monitor profiles that are easily invoked. This
+is useful when you often find yourself in situations with different monitor
+configurations. It consists of one executable and a ruby configuration file.
+The following example shows a configuration containing monitor profiles
+representing three different monitor setups.
+
+```ruby
+profile "docked" do
+  device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+  device "HDMI2", :mode => "1920x1080", :rate => "60.0", :right_of => "HDMI1"
+end
+
+profile "projector" do
+  device "LVDS1", :mode => "1280x800", :rate => "60.0"
+  device "VGA1", :right_of => "LVDS1"
+end
+
+profile "default" do
+  device "LVDS1"
+end
+```
+
+Usage:
+
+```
+Usage: rmonitor [option]
+    -c, --create [NAME]              Create and output a profile with an optional name
+    -i, --invoke NAME                Invoke a profile with a given name
+    -u, --update                     Invoke the most preferable profile
+    -v, --verbose                    Verbose output
+    -d, --dry-run                    Do everything except actually update
+        --config-path PATH           Specify the path to the configuration file (defaults to ~/.config/rmonitor/config.rb
+    -h, --help                       Show this message
+        --version                    Print the version number of rmonitor
+```
+
+### --create [NAME]
+
+Outputs a profile for your current setup.
+
+```
+$ rmonitor --create "docked"
+profile "docked" do
+  device "HDMI1", :mode => "1920x1080", :rate => "60.0", :pos => "0x0"
+  device "HDMI2", :mode => "1920x1080", :rate => "60.0", :pos => "1920x0"
+end
+```
+
+### --invoke NAME
+
+Invokes a monitor profile by generating an xrandr query.
+
+### --update
+
+Parses the configuration file from top to bottom and invokes the first
+invokable profile based on what devices that are currently connected. This is
+likely the most used option and may for instance be used to automatically
+configure your screens upon startup.
+
+## Installation
+
+The utility can be installed using `gem`, but is also packaged for Arch Linux.
+
+```
+$ gem install rmonitor
+```
+
+It can be installed system-wide using the following options.
+
+```
+$ gem install --no-user-install -i "$(ruby -e'puts Gem.default_dir')" -n /usr/bin rmonitor
+```
+
+### Arch Linux
+
+```
+$ yaourt -Syua ruby-rmonitor
+```
+
+## Configurable options
+
+The following examples shows how RMonitor can be configured.
+
+```ruby
+# Specify device location with position
+profile "docked" do
+  device "HDMI1", :pos => "0x0"
+  device "HDMI2", :pos => "1920x0"
+end
+```
+
+```ruby
+# Specify device location relative to another device
+# Similar options include :left_of, :above, :below
+profile "docked" do
+  device "HDMI1"
+  device "HDMI2", :right_of => "HDMI1"
+end
+```
+
+```ruby
+# Specify device mode (resolution), best rate is chosen automatically
+profile "docked" do
+  device "HDMI1", :mode => "1920x1080"
+  device "HDMI2", :mode => "1920x1080"
+end
+```
+
+```ruby
+# Specify device rate, best mode (resolution is chosen automatically
+profile "docked" do
+  device "HDMI1", :rate => "60.0"
+  device "HDMI2", :rate => "60.0"
+end
+```
+
+```ruby
+# Specify device mode (resolution) and rate
+profile "docked" do
+  device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+  device "HDMI2", :mode => "1920x1080", :rate => "60.0"
+end
+```
+
+```ruby
+# Specify dpi (dots per inch)
+profile "docked", :dpi => 96 do
+  device "HDMI1"
+  device "HDMI2"
+end
+```
+
+## Changelog
+
+### 1.0.0
+
+* The -a option is removed.
+* Fixed a bug that caused rates with of more than one decimal to not get picked up.
+* Error messages are now outputted to stderr and the program exits with a non-zero status.
+* The library is now turned into a gem.
+* Added a --config-path option.
+* Added a --version option.
+
+### 0.0.9
+
+* Added one-letter short options.
+* Fixed an issue where it was impossible to specify DPI as an integer.
+
+### 0.0.8
+
+* Added a --dry-run option.
+* Added a --verbose option.
+* Added option for user defined rules to profiles.
+
+An :only_if or :not_if option may be specified with a profile. The value
+should correspond to a method defined within the configuration file and
+should return whether or not the profile can be invoked.
+
+The following code shows an example of how this is used.
+
+```ruby
+def laptop_lid_open?
+  File.read('/proc/acpi/button/lid/LID/state').match(/open/)
+end
+
+profile "docked", :only_if => :laptop_lid_open? do
+  device "LVDS1"
+  device "VGA1", :right_of => "LVDS1"
+end
+```
+
+### 0.0.7
+
+* Added support for the --reflect directive.
+* Added support for the --rotate directive.
+* Added support for the --same-as directive.
+
+### 0.0.6
+
+* Added support for the --dpi directive.
+
+### 0.0.5
+
+* Fixing bug with finding best configuration.
+* Added support for the --primary directive.
+
+### 0.0.4
+
+* The generated command for changing monitor profile now contains a part that first turns of all monitors.
+
+### 0.0.3
+
+* Correcting a bug in deducing invokability.
+
+### 0.0.2
+
+* Fixing bug with device specified without options.
+
+### 0.0.1
+
+* Initial work on the project.

data/bin/rmonitor

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'rmonitor'
+require 'rmonitor/version'
+
+RMonitor.config_path = File.join(Dir.home, '.config', 'rmonitor', 'config.rb')
+
+class << self
+  attr_accessor :options
+end
+
+self.options = { :action => :create }
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: rmonitor [option]"
+
+  opts.on("-c", "--create [NAME]", String, "Create and output a profile with an optional name") do |name|
+    options[:action] = :create
+    options[:name] = name
+  end
+
+  opts.on("-i", "--invoke NAME", String, "Invoke a profile with a given name") do |name|
+    options[:action] = :invoke
+    options[:name] = name
+  end
+
+  opts.on("-u", "--update", "Invoke the most preferable profile") do
+    options[:action] = :update
+  end
+
+  opts.on("-v", "--verbose", "Verbose output") do
+    options[:verbose] = true
+  end
+
+  opts.on("-d", "--dry-run", "Do everything except actually update (implies -v)") do
+    options[:dry_run] = true
+    options[:verbose] = true
+  end
+
+  opts.on("--config-path PATH", String, "Specify the path to the configuration file (defaults to ~/.config/rmonitor/config.rb") do |config_path|
+    RMonitor.config_path = config_path
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Print the version number of rmonitor") do
+    puts "rmonitor #{RMonitor::VERSION}"
+    exit
+  end
+end.parse!
+
+def v_puts(content)
+  if options[:verbose]
+    puts content
+  end
+end
+
+def exit_with(content)
+  $stderr.puts content
+  exit! 1
+end
+
+rm = RMonitor.load
+
+if options[:action] == :update
+  # Find the first invokable profile
+  profile = rm.profiles.find do |profile|
+    RMonitor::Profiles.invokable?(rm.devices, profile)
+  end
+
+  if profile
+    v_puts "Found #{profile[:name].inspect} that is invokable."
+    options[:name] = profile[:name]
+    options[:action] = :invoke
+  else
+    exit_with 'no invokable profile exists'
+  end
+end
+
+if options[:action] == :invoke
+  profile = rm.profiles.find { |p| p[:name] == options[:name] }
+
+  if profile
+    if RMonitor::Profiles.invokable?(rm.devices, profile)
+      command = RMonitor::Profiles.to_xrandr(rm.devices, profile)
+      v_puts "Invoking #{profile[:name].inspect} by running #{command.inspect}."
+      exec(command) unless options[:dry_run]
+    else
+      exit_with 'this profile is not invokable'
+    end
+  else
+    exit_with 'no profile with that name exists'
+  end
+
+elsif options[:action] == :create
+  puts "profile #{(options[:name] || 'My profile').inspect} do"
+  rm.devices.each do |device|
+    if device[:enabled]
+      puts '  device %s, :mode => %s, :rate => %s, :pos => %s' % [
+          device[:name].inspect,
+          device[:configuration][:mode].inspect,
+          device[:configuration][:rate].inspect,
+          device[:pos].inspect,
+      ]
+    end
+  end
+  puts 'end'
+end

data/lib/rmonitor.rb

@@ -0,0 +1,23 @@
+require 'fileutils'
+
+require 'rmonitor/devices'
+require 'rmonitor/profiles'
+
+class RMonitor
+  class XRandRArgumentError < ArgumentError; end
+
+  class << self
+    attr_accessor :config_path
+  end
+
+  attr_accessor :devices, :profiles
+
+  def initialize(raw_devices_data, raw_profiles_data)
+    @devices  = Devices.parse(raw_devices_data)
+    @profiles = Profiles.parse(raw_profiles_data)
+  end
+
+  def self.load
+    self.new(`xrandr -q`, File.new(config_path).read)
+  end
+end

data/lib/rmonitor/devices.rb

@@ -0,0 +1,29 @@
+require 'rmonitor/helpers/xrandr_read_helpers'
+
+class RMonitor
+  class Devices
+    extend XRandRReadHelpers
+
+    def self.parse(devices_data)
+      # Split the blocks of XRandR output
+      blocks  = split_blocks(devices_data)
+
+      # Filter out blocks that are not devices
+      devices = collect_devices(blocks)
+
+      # Create a data structure for each block
+      devices.map! do |device|
+        {
+            :name           => extract_name(device),
+            :pos            => extract_pos(device),
+            :connected      => extract_connected(device),
+            :enabled        => extract_enabled(device),
+            :configuration  => extract_configuration(device),
+            :configurations => extract_configurations(device),
+        }
+      end
+
+      devices
+    end
+  end
+end

data/lib/rmonitor/helpers/dsl_helpers.rb

@@ -0,0 +1,38 @@
+class RMonitor
+  module DSLHelpers
+    class ProfileBuilder
+      attr_accessor :profiles
+
+      def initialize
+        @profiles = []
+      end
+
+      def profile(name, options = {}, &block)
+        device_builder = DeviceBuilder.new
+        device_builder.instance_eval(&block)
+
+        if options[:only_if]
+          options[:only_if] = method(options[:only_if])
+        elsif options[:not_if]
+          options[:not_if] = method(options[:not_if])
+        end
+
+        @profiles << { :name => name,
+                       :options => options,
+                       :devices => device_builder.devices }
+      end
+    end
+
+    class DeviceBuilder
+      attr_accessor :devices
+
+      def initialize
+        @devices = []
+      end
+
+      def device(name, options = {})
+        @devices << { :name => name }.merge(options)
+      end
+    end
+  end
+end