xrandrb 0.0.1

data/README.textile

@@ -0,0 +1,11 @@
+h2. xrandrb
+
+Ruby wrapper and toolkit for xrandr.
+
+h2. What is xrandr?
+
+Xrandr is the low level utility that most Linux setups use to handle external displays. Xrandr can do anything the typical monitor management GUI can - setting the main display, toggle mirroring, turning displays on and off, position the displays, and so on.
+
+h2. Why?
+
+Xrandr itself lacks some basic features, such as providing one command for toggling a display on and off. This wrapper makes xrandr easily scriptable, so that hackers with terminals doesn't have to have a GUI to manage external monitors - xrandrb should suffice.

data/bin/xrandrb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "xrandrb"
+require "xrandrb/cli"
+Xrandrb::Cli.new(ARGV)._run

data/lib/xrandrb/cli.rb

@@ -0,0 +1,134 @@
+class Xrandrb
+  class Cli
+    COMMANDS = ["status", "on", "off", "toggle", "update"]
+    HELP_FLAGS = ["--help", "-h"]
+
+    def initialize(argv)
+      @command = argv.shift
+      @argv = argv
+    end
+
+    def _run(xrandr_output = nil)
+      @x = Xrandrb.new(xrandr_output)
+
+      case @command
+      when nil
+        status
+      when *HELP_FLAGS
+        help
+      when *COMMANDS
+        if HELP_FLAGS.include?(@argv[0])
+          help(@command)
+        else
+          __send__(@command)
+        end
+      else
+        STDERR.puts "Unknown command '#{@command}'."
+        STDERR.puts "Available commands: #{COMMANDS.join(', ')}"
+        exit(1)
+      end
+    end
+
+    private
+
+    def status
+      queried_output = @argv.shift
+
+      if queried_output
+        output = @x[queried_output]
+        if output
+          if output.connected?
+            [["Preferred", output.preferred], ["Current", output.current]].each do |label, mode|
+              if mode
+                puts "%s: %s (%s hz)" % [label, mode.resolution, mode.fps]
+              else
+                puts "%s: Unknown" % [label]
+              end
+            end
+          else
+            puts "Disconnected."
+          end
+        else
+          STDERR.puts "Unknown output '#{queried_output}'."
+          exit(2)
+        end
+      else
+        grouped = @x.outputs.group_by {|o| o.connected? }
+        [["Connected", true], ["Disconnected", false]].each do |label, group|
+          puts "#{label}:"
+          puts "  " + grouped[group].map(&:name).join(", ")
+        end
+
+        # puts
+        # puts "Use 'xrandrb status [output]' for more info on that output."
+      end
+    end
+
+    def on
+      with_queried_output(@argv.shift) do |output|
+        puts "Turning on #{output.name}"
+        xrandr "--output #{output.name} --auto"
+      end
+    end
+
+    def off
+      with_queried_output(@argv.shift) do |output|
+        puts "Turning off #{output.name}"
+        xrandr "--output #{output.name} --auto --off"
+      end
+    end
+
+    def toggle
+      name = @argv.shift
+      with_queried_output(name) do |output|
+        @argv.unshift(name)
+        output.sending? ? off : on
+      end
+    end
+
+    def update
+      with_queried_output(@argv.shift) do |output|
+        xrandr "--output #{output.name}"
+      end
+    end
+
+    # Performs the call and proxies what's left in ARGV to the call.
+    def xrandr(options)
+      `xrandr #{options} #{@argv.join(' ')}`
+    end
+
+    def with_queried_output(name)
+      if name
+        output = @x[name]
+        if output
+          if output.connected?
+            yield(output)
+          else
+            STDOUT.puts "Output #{name} not connected."
+            exit(3)
+          end
+        else
+          STDOUT.puts "Unknown output '#{name}'."
+          exit(4)
+        end
+      else
+        STDOUT.puts "Please specify an output name. See 'xrandrb status' for a list of connected outputs."
+        exit(5)
+      end
+    end
+
+    def help(command)
+      if command
+        puts "Help texts for individual commands not implemented yet."
+      else
+        puts GLOBAL_HELP
+        puts "Usage: xrandrb COMMAND [ARGS]"
+        puts
+        puts "Available commands:"
+        puts "  " + COMMANDS.join(', ')
+        puts
+        puts "'xrandrb COMMAND --help' for help on a particular command."
+      end
+    end
+  end
+end

data/lib/xrandrb/mode.rb

@@ -0,0 +1,16 @@
+class Xrandrb
+  class Mode
+    attr_reader :resolution, :fps
+    def initialize(resolution, fps, current, preferred)
+      @resolution, @fps, @current, @preferred = resolution, fps, current, preferred
+    end
+
+    def preferred?
+      @preferred == true
+    end
+
+    def current?
+      @current == true
+    end
+  end
+end

data/lib/xrandrb/output.rb

@@ -0,0 +1,39 @@
+class Xrandrb
+  class Output
+    attr_reader :modes
+    attr_reader :name, :status, :current_resolution, :meta, :dimensions
+    def initialize(info)
+      @modes = []
+      @name, @status, @current_resolution, @meta, @dimensions =
+        *info.scan(/^([a-zA-Z0-9]+) (connected|disconnected) ?([0-9x\+]+)? \(([^\)]+)\) ?(.*)?$/)[0]
+    end
+
+    def add_modes(mode_spec)
+      resolution, fpses = mode_spec.scan(/^ +([0-9x]+) +(.+)$/)[0]
+      fpses = fpses.split(/ {2,}/)
+
+      fpses.each do |f|
+        preferred = (f[-1..-1] == "+")
+        current = (f[-2..-2] == "*")
+        fps = f[/^([0-9\.]+)/]
+        @modes.push(Xrandrb::Mode.new(resolution, fps, current, preferred))
+      end
+    end
+
+    def connected?
+      @status == "connected"
+    end
+
+    def sending?
+      !!current
+    end
+
+    def preferred
+      @modes.find {|m| m.preferred? }
+    end
+
+    def current
+      @modes.find {|m| m.current? }
+    end
+  end
+end

data/lib/xrandrb.rb

@@ -0,0 +1,29 @@
+require "xrandrb/output"
+require "xrandrb/mode"
+
+class Xrandrb
+  attr_reader :outputs
+  def initialize(xrandr_output = nil)
+    @xrandr = xrandr_output || `xrandr`
+    parse
+  end
+
+  # Gets output by name
+  def [](name)
+    @outputs.find {|o| o.name.downcase == name.downcase }
+  end
+
+  private
+
+  def parse
+    lines = @xrandr.split("\n")
+    @outputs = []
+    lines[1..-1].each do |line|
+      if line =~ /^ /
+        @outputs[-1].add_modes(line)
+      else
+        @outputs.push(Xrandrb::Output.new(line))
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require "test/unit"
+
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+require "xrandrb"
+
+class Test::Unit::TestCase
+  def fixture(name)
+    File.read(File.dirname(__FILE__) + "/fixtures/" + name)
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: xrandrb
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- August Lilleaas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-21 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: august.lilleaas@gmail.com
+executables: 
+- xrandrb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/xrandrb
+- lib/xrandrb/output.rb
+- lib/xrandrb/mode.rb
+- lib/xrandrb/cli.rb
+- lib/xrandrb.rb
+- test/test_helper.rb
+- README.textile
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper/enhancer for xrandrb, the Linux CLI monitor manager.
+test_files: []
+