xrandr 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22d9b48ee5fbeaf0c16d9d36826f9fd83bcaf292
+  data.tar.gz: d21fc1b476c1cd301cdc0fb3d1ecc0d090c799d8
+SHA512:
+  metadata.gz: 8b2b346c588b1d3bc3dc254cb9eccd844ef2ffd84f971cf2202aae51ddeb59ef7c0839632be9c2924269a6f3554244dd27c102ce165d17091ff7e74ea0e1aa39
+  data.tar.gz: c7a03d27ff658f5739c86c88b0fab7bbaaa9597604dac087cedfc1ccc6643103bf5572d4676ec889665a97010ec57d75a1a86262ba4aac86435535734c77bf98

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xrandr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Fernando Martinez
+
+MIT License
+
+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,87 @@
+# xrandr
+
+A ruby interface to [xrandr](http://www.x.org/wiki/Projects/XRandR/)
+
+## Install
+
+`gem install xrandr`
+
+(or use your preferred gemset/dependency management tool)
+
+## Usage
+
+### Outputs
+
+Gives you the status of each of the outputs
+
+```ruby
+
+Xrandr.new.outputs #=> [ <Xrandr::Output{ id: 1, name: 'LVDS1', connected: true, mode: '1920x1080' }>, <Xrandr::Output { id: 2, name: 'VGA1', connected: false }> ]
+
+```
+
+Access specific output parameters
+
+```ruby
+randr = Xrandr.new
+vga = randr.output(1)
+
+vga.connected #=> true
+vga.name #=> 'VGA1'
+vga.mode #=> '1920x1080'
+
+```
+
+```ruby
+randr = Xrandr.new
+vga = randr.output('VGA1')
+
+vga.connected #=> true
+vga.name #=> 'VGA1'
+vga.mode #=> '1920x1080'
+
+```
+
+### Configure
+
+
+```ruby
+xrandr = Xrandr.new
+
+# setting global options
+xrandr.configure(fb: '1920x1080', no_primary: true)
+
+
+# setting per output options
+xrandr.configure('VGA1', auto: true)
+
+# also, can specify the output by index
+xrandr.configure('VGA2', mode: '1920x1080', right_of: 'VGA1')
+
+
+```
+
+After all outputs are configured, call `#apply!` to execute the command.
+
+```ruby
+
+xrandr.apply!
+
+```
+
+or call `#command`, to get the command line string that would be run
+```ruby
+
+xrandr.command #=> "xrandr --fb 1920x1080 --no_primary --output VGA1 --auto --output LVDS1 --mode 1920x1080 --pos 1921x0"
+
+```
+
+For all available configuration parameter see you can `man xrandr`
+
+## Contributing
+
+Open an issue, lets talk.
+
+## License
+
+See UNLICENSE

data/lib/xrandr.rb

@@ -0,0 +1,147 @@
+module Xrandr
+  VERSION = '0.0.2'
+
+  class Control
+    attr_reader :screens, :outputs, :command
+
+    def initialize(parser = Parser.new)
+      @screens, @outputs = * parser.parse
+      @command = 'xrandr'
+    end
+
+    def configure(output = nil, **options)
+      output = find_output(output) if output
+
+      command << " --output #{output.name}" if output
+      command << options.map do |option, value|
+        value = nil if value == true
+        " --#{option} #{value}".rstrip
+      end.join(' ')
+    end
+
+    def find_output(output)
+      if output.kind_of? Output
+        output
+      elsif output.kind_of? String
+        outputs.find {|o| o.name == output}
+      elsif output.kind_of? Integer
+        outputs[output]
+      else
+        raise ArgumentError, "Expecting a string, an integer or an Xrandr::Output instance"
+      end
+    end
+    alias_method :[], :find_output
+
+    def apply!
+      Kernel.system(command)
+      initialize
+    end
+  end
+
+  class Parser
+    attr_reader :data
+    def initialize(data = `xrandr --query`)
+      @data = data
+    end
+
+    def parse
+      screens_data, outputs_data = data.split("\n").group_by {|line| line.start_with?('Screen') }.values
+
+      [ parse_screens(screens_data), parse_outputs(outputs_data) ]
+    end
+
+    def parse_screens(data); []; end # TODO
+
+    def parse_outputs(data)
+      # join output info line with each of its modes
+      data = data.slice_when {|before, after| !after.start_with?(' ')}
+
+      data.map do |output_data|
+        parse_output(output_data)
+      end
+    end
+
+    def parse_output(data)
+      data, *modes = data
+
+      args = {
+              name:       /[a-zA-Z0-9\-\_]+/,
+              connected:  /connected|disconnected/,
+              primary:    /primary/,
+              resolution: /\d+x\d+\+\d+\+\d+/,
+              info:       /\([^\)]+\)/,
+              dimensions: /[0-9+]+mm x [0-9]+mm/,
+             }
+      .map {|token, regex| [token, data.scan(regex).first] }
+      .to_h
+
+      # split resolution and position values split all values, coherce to integers, split the array in halfs, assign each half)
+      args[:resolution], args[:position] = args[:resolution].split(/x|\+/).each_slice(2).map {|v| v.join('x') }  if args[:resolution]
+
+      # Coherce parameters
+      args[:connected] = args[:connected] == 'connected'
+      args[:primary]   = args[:primary] == 'primary'
+
+      # Parse modes
+      args[:modes] = parse_modes(modes)
+
+      Output.new args
+    end
+
+    def parse_modes(modes)
+      modes.map do |data|
+        parse_mode data
+      end
+    end
+
+    def parse_mode(data)
+      matches = data.lstrip.match(/^(?<resolution>\d+x\d+i?) +(?<rate>[\d\.]+)(?<current>[\* ])(?<preferred>[\+ ]).*/)
+
+      resolution = matches[:resolution].gsub 'i', '' if matches[:resolution]
+      args = {
+              resolution: resolution,
+              rate: matches[:rate],
+              current: matches[:current] == '*',
+              preferred: matches[:preferred] == '+',
+             }
+
+      Mode.new args
+    end
+  end
+
+  class Output
+    attr_reader :name, :connected, :primary, :resolution, :position, :info, :dimensions, :modes
+
+    def initialize(name:, connected:, primary: false, resolution: nil, position: nil, info: '', dimensions: '', modes: [])
+      raise ArgumentError, "must provide a name for the output" unless name
+      raise ArgumentError, "connected cant be nil" unless connected == true || connected == false
+      @name = name
+      @connected = connected
+      @primary = primary
+      @resolution = resolution
+      @position = position
+      @info = info
+      @dimensions = dimensions
+      @modes = modes
+    end
+
+    def current
+      modes.detect(&:current)
+    end
+
+    def preferred
+      modes.detect(&:preferred)
+    end
+  end
+
+  class Mode
+    attr_reader :resolution, :rate, :current, :preferred
+
+    def initialize(args={})
+      @resolution = args.fetch :resolution
+      @rate = args.fetch :rate
+      @current = args.fetch :current
+      @preferred = args.fetch :preferred
+    end
+  end
+end

data/test/all.rb

@@ -0,0 +1 @@
+Dir['**/*_test.rb'].each &method(:load)

data/test/control_test.rb

@@ -0,0 +1,82 @@
+require_relative 'helper'
+require_relative '../lib/xrandr'
+
+module Xrandr
+  class XrandrTest < Minitest::Test
+    def outputs
+      [ Output.new(name: 'VGA1', connected: true), Output.new(name: 'VGA2', connected: true), Output.new(name: 'VGA3', connected: true) ]
+    end
+  end
+
+  class ControlTest < XrandrTest
+    def test_find_ouput_finds_an_output_by_name
+      parser = MockParser.new([], outputs)
+      xrandr = Control.new(parser)
+      output = outputs[2]
+
+      assert_equal outputs[2].name, xrandr.find_output(output).name
+    end
+
+    def test_find_ouput_finds_an_output_by_name
+      parser = MockParser.new([], outputs)
+      xrandr = Control.new(parser)
+
+      assert_equal outputs[1].name, xrandr.find_output('VGA2').name
+    end
+
+    def test_find_ouput_finds_an_output_by_index
+      parser = MockParser.new([], outputs)
+
+      xrandr = Control.new(parser)
+
+      assert_equal outputs[1].name, xrandr.find_output(1).name
+    end
+  end
+
+  class XrandrConfigureGlobalParametersTest < XrandrTest
+    def test_param_with_arguments
+      xrandr = Control.new MockParser.new([], [])
+      xrandr.configure fb: '2000x2000'
+
+      assert_equal 'xrandr --fb 2000x2000', xrandr.command
+    end
+
+    def test_switch_param
+      xrandr = Control.new MockParser.new([], [])
+      xrandr.configure noprimary: true
+
+      assert_equal 'xrandr --noprimary', xrandr.command
+    end
+  end
+
+  class XrandrConfigureOutputParametersTest < XrandrTest
+    def test_configure_output_by_name
+      xrandr = Control.new MockParser.new([], outputs)
+
+      xrandr.configure 'VGA1', mode: '2000x2000'
+
+      assert_equal 'xrandr --output VGA1 --mode 2000x2000', xrandr.command
+    end
+
+    def test_configure_output_by_index
+      xrandr =  Control.new MockParser.new([], outputs)
+
+      xrandr.configure 0, primary: true
+
+      assert_equal 'xrandr --output VGA1 --primary', xrandr.command
+    end
+
+    def test_configure_output_param_with_a_switch_argument
+      xrandr = Control.new MockParser.new([], outputs)
+      xrandr.configure 'VGA1', primary: true
+
+      assert_equal 'xrandr --output VGA1 --primary', xrandr.command
+    end
+  end
+
+  MockParser = Struct.new(:screens, :outputs) do
+    def parse
+      [screens, outputs]
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1 @@
+require 'minitest/autorun'

data/test/output_test.rb

@@ -0,0 +1,18 @@
+require_relative 'helper'
+require_relative '../lib/xrandr'
+
+module Xrandr
+  class OutputTest < Minitest::Test
+    def test_new_raises_if_no_name
+      assert_raises ArgumentError do
+        Output.new connected: false
+      end
+    end
+
+    def test_new_raises_if_no_connection_info
+      assert_raises ArgumentError do
+        Output.new name: 'o'
+      end
+    end
+  end
+end

data/test/parser_test.rb

@@ -0,0 +1,132 @@
+require_relative 'helper'
+require_relative '../lib/xrandr'
+
+module Xrandr
+
+  class Parser::ParseOutputTest < Minitest::Test
+    def test_parse_outputs_returns_an_array_of_outputs
+      o = [
+           "LVDS1 connected primary 1366x768+0+0 (normal left inverted right x axis y axis) 309mm x 174mm",
+           "  1366x768      60.07*+","  1024x768      60.00  ",
+           "  800x600       60.32    56.25  ",
+           "  640x480       59.94  ",
+           "VGA1 connected 1920x1080+1366+0 (normal left inverted right x axis y axis) 309mm x 174mm",
+           "  1920x1080      60.07*+",
+           "  1024x768      60.00  ",
+           "  800x600       60.32    56.25  ",
+           "  640x480       59.94  ",
+           "DP1 disconnected (normal left inverted right x axis y axis)",
+           "DP2 disconnected (normal left inverted right x axis y axis)"
+          ]
+
+      outputs = Parser.new.parse_outputs o
+
+      assert 4, outputs.size
+      assert outputs[0].connected
+      assert outputs[1].connected
+      refute outputs[2].connected
+      refute outputs[3].connected
+      assert 3, outputs[0].modes.size
+      assert 4, outputs[1].modes.size
+    end
+
+    def test_parses_connected_output_lines
+      session = Parser.new
+      o = ["LVDS1 connected 1366x768+0+0 (normal left inverted right x axis y axis) 309mm x 174mm","  1366x768      60.07*+","  1024x768      60.00  ","  800x600       60.32    56.25  ","  640x480       59.94  "]
+
+      output = session.parse_output o
+
+      assert_equal "LVDS1", output.name
+      assert output.connected
+      assert_equal '1366x768', output.resolution
+      assert_equal '0x0', output.position
+      assert_equal '(normal left inverted right x axis y axis)', output.info
+      assert_equal '309mm x 174mm', output.dimensions
+      assert_equal 4, output.modes.size
+      refute output.primary
+    end
+
+    def test_parses_primary
+      session = Parser.new
+      o = ['LVDS1 connected primary 1366x768+0+0 (normal left inverted right x axis y axis) 309mm x 174mm',"  1366x768      60.07*+","  1024x768      60.00  ","  800x600       60.32    56.25  ","  640x480       59.94  "]
+
+      output = session.parse_output o
+
+      assert_equal "LVDS1", output.name
+      assert output.connected
+      assert_equal '1366x768', output.resolution
+      assert_equal '0x0', output.position
+      assert_equal '(normal left inverted right x axis y axis)', output.info
+      assert_equal '309mm x 174mm', output.dimensions
+      assert output.primary
+      assert_equal 4, output.modes.size
+    end
+
+    def test_parses_disconnected_output_lines
+      session = Parser.new
+      output = session.parse_output ["DP1 disconnected (normal left inverted right x axis y axis)"]
+
+      refute output.connected
+      assert_equal 'DP1', output.name
+      assert_equal '(normal left inverted right x axis y axis)', output.info
+      assert_nil output.dimensions
+      assert_nil output.resolution
+      assert_nil output.position
+      assert_empty output.modes
+      refute  output.primary
+    end
+  end
+
+  class Parser::ParseModeTest < Minitest::Test
+    def test_returns_a_mode
+      mode = Parser.new.parse_mode("   1366x768      60.07*+")
+      assert_equal '1366x768', mode.resolution
+      assert_equal '60.07', mode.rate
+      assert mode.current
+      assert mode.preferred
+    end
+
+    def test_parses_preferred_attribute_correctly
+      mode = Parser.new.parse_mode("   1366x768      60.07 +")
+      assert mode.preferred
+      mode = Parser.new.parse_mode("   1366x768      60.07  ")
+      refute mode.preferred
+
+      mode = Parser.new.parse_mode("   1366x768      60.07*+")
+      assert mode.preferred
+      mode = Parser.new.parse_mode("   1366x768      60.07* ")
+      refute mode.preferred
+    end
+
+    def test_parses_current_attribute_correctly
+      mode = Parser.new.parse_mode("   1366x768      60.07* ")
+      assert mode.current
+      mode = Parser.new.parse_mode("   1366x768      60.07  ")
+      refute mode.current
+
+      mode = Parser.new.parse_mode("   1366x768      60.07*+")
+      assert mode.current
+      mode = Parser.new.parse_mode("   1366x768      60.07 +")
+      refute mode.current
+    end
+
+    def test_parse_modes_returns_a_collection_of_modes
+      session = Parser.new
+      modes = session.parse_modes ["   1024x768      60.00 +", "   1920x1080      60.00  ", "   1366x768      60.07* "]
+
+      assert_equal "1024x768", modes[0].resolution
+      assert_equal "1920x1080", modes[1].resolution
+      assert_equal "1366x768", modes[2].resolution
+    end
+
+    # some systems names the modes like 1920x1080i
+    def test_parse_modes_allows_i_suffix
+      session = Parser.new
+      modes = session.parse_modes ["   1024x768i      60.00 +", "   1920x1080i      60.00  ", "   1366x768i      60.07* "]
+
+      assert_equal "1024x768", modes[0].resolution
+      assert_equal "1920x1080", modes[1].resolution
+      assert_equal "1366x768", modes[2].resolution
+    end
+  end
+end

data/xrandr.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xrandr'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xrandr"
+  spec.version       = Xrandr::VERSION
+  spec.authors       = ["Fernando Martínez"]
+  spec.email         = ["fernando.martinez@live.com.ar"]
+  spec.summary       = %q{ A ruby wrapper for Xrandr }
+  spec.description   = %q{ A ruby wrapper for Xrandr }
+  spec.homepage      = "https://github.com/f-3r/xrandr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "minitest", "~> 5.7"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: xrandr
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Fernando Martínez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+description: " A ruby wrapper for Xrandr "
+email:
+- fernando.martinez@live.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/xrandr.rb
+- test/all.rb
+- test/control_test.rb
+- test/helper.rb
+- test/output_test.rb
+- test/parser_test.rb
+- xrandr.gemspec
+homepage: https://github.com/f-3r/xrandr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for Xrandr
+test_files:
+- test/all.rb
+- test/control_test.rb
+- test/helper.rb
+- test/output_test.rb
+- test/parser_test.rb