rmonitor 1.0.1 → 2.0.0

data/lib/rmonitor/version.rb

@@ -1,3 +1,3 @@
 class RMonitor
-  VERSION = '1.0.1'
+  VERSION = "2.0.0"
 end

data/lib/rmonitor/xrandr.rb

@@ -0,0 +1,16 @@
+class RMonitor
+  class XRandR
+    def initialize(options = {})
+      @invoker = options[:invoker] || Invoker.new(options)
+      @out = options[:out] || $stdout
+      @verbose = options[:verbose]
+      @dry_run = options[:dry_run]
+    end
+
+    def invoke(*args)
+      command = ("xrandr " + args.join(" ")).strip
+      @out.puts command if @verbose
+      @invoker.invoke(command) if args.empty? || !@dry_run
+    end
+  end
+end

data/test/actions/builder_test.rb

@@ -0,0 +1,27 @@
+require "test_helper"
+
+describe RMonitor::Actions::Builder do
+
+  describe "::define" do
+
+    it "should return an array consisting of actions" do
+      actual = RMonitor::Actions::Builder.define do
+        off "LVDS1"
+        dpi 96
+        on "HDMI1", :mode => "1920x1080", :rate => "60.0"
+        on "HDMI2", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      expected = [
+        {:name => "LVDS1", :action => :off},
+        {:name => :dpi, :value => 96, :action => :option},
+        {:name => "HDMI1", :action => :on, :mode => "1920x1080", :rate => "60.0"},
+        {:name => "HDMI2", :action => :on, :mode => "1920x1080", :rate => "60.0"}
+      ]
+
+      assert_equal expected, actual
+    end
+
+  end
+
+end

data/test/actions_test.rb

@@ -0,0 +1,60 @@
+require "test_helper"
+
+describe RMonitor::Actions do
+
+  describe "#create" do
+
+    it "should create on actions for used monitors" do
+      capabilities = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+        device "HDMI2", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      profile = RMonitor::Profile::Builder.define "docked" do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      on_actions = RMonitor::Actions::Builder.define do
+        on "HDMI1", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      assert_subset_of RMonitor::Actions.new(:capabilities => capabilities).create(profile), on_actions
+    end
+
+    it "should create off actions for unused monitors" do
+      capabilities = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+        device "HDMI2", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      profile = RMonitor::Profile::Builder.define "docked" do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      off_actions = RMonitor::Actions::Builder.define do
+        off "HDMI2"
+      end
+
+      assert_subset_of RMonitor::Actions.new(:capabilities => capabilities).create(profile), off_actions
+    end
+
+    it "should create option actions for profile options (eg. dpi)" do
+      capabilities = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+        device "HDMI2", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      profile = RMonitor::Profile::Builder.define "docked", :dpi => 96 do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      option_actions = RMonitor::Actions::Builder.define do
+        dpi 96
+      end
+
+      assert_subset_of RMonitor::Actions.new(:capabilities => capabilities).create(profile), option_actions
+    end
+
+  end
+
+end

data/test/cache_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+
+describe RMonitor::Cache do
+
+  describe "#invoke" do
+
+    it "should call Invoker#invoke the first time" do
+      invoker = MiniTest::Mock.new
+      invoker.expect :invoke, "foo", ["bar"]
+
+      assert_equal "foo", RMonitor::Cache.new(:invoker => invoker).invoke("bar")
+
+      invoker.verify
+    end
+
+    it "should return the cached reuslt the second time" do
+      invoker = MiniTest::Mock.new
+      invoker.expect :invoke, "foo", ["bar"]
+
+      cache = RMonitor::Cache.new(:invoker => invoker)
+
+      assert_equal "foo", cache.invoke("bar")
+      assert_equal "foo", cache.invoke("bar")
+
+      invoker.verify
+    end
+
+  end
+
+end

data/test/capabilities/builder_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+describe RMonitor::Capabilities::Builder do
+
+  describe "::define" do
+
+    it "should return an array consisting of device name and options" do
+      actual = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+        device "HDMI2", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      expected = [
+        {:name => "HDMI1", :mode => "1920x1080", :rate => "60.0"},
+        {:name => "HDMI2", :mode => "1920x1080", :rate => "60.0"}
+      ]
+
+      assert_equal expected, actual
+    end
+
+  end
+
+end

data/test/capabilities_test.rb

@@ -0,0 +1,114 @@
+require "test_helper"
+
+describe RMonitor::Capabilities do
+
+  describe "#parse" do
+
+    it "should correctly parse the most trivial case" do
+      actual = RMonitor::Capabilities.new.parse <<-OUTPUT
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0
+      OUTPUT
+
+      expected = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      assert_equal expected, actual
+    end
+
+    it "should correctly parse secondary rates for a mode" do
+      actual = RMonitor::Capabilities.new.parse <<-OUTPUT
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0    30.0
+      OUTPUT
+
+      expected = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+        device "HDMI1", :mode => "1920x1080", :rate => "30.0"
+      end
+
+      assert_equal expected, actual
+    end
+
+    it "should correctly parse the current mode / rate" do
+      actual = RMonitor::Capabilities.new.parse <<-OUTPUT
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0 +
+      OUTPUT
+
+      expected = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0", :current => true
+      end
+
+      assert_equal expected, actual
+    end
+
+    it "should correctly parse the native mode / rate" do
+      actual = RMonitor::Capabilities.new.parse <<-OUTPUT
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0*
+      OUTPUT
+
+      expected = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0", :native => true
+      end
+
+      assert_equal expected, actual
+    end
+
+    it "should correctly parse multiple rates" do
+      actual = RMonitor::Capabilities.new.parse <<-OUTPUT
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0
+           1400x1050       60.0
+      OUTPUT
+
+      expected = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+        device "HDMI1", :mode => "1400x1050", :rate => "60.0"
+      end
+
+      assert_equal expected, actual
+    end
+
+    it "should correctly parse multiple devices" do
+      actual = RMonitor::Capabilities.new.parse <<-OUTPUT
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0
+        HDMI2 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0
+      OUTPUT
+
+      expected = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+        device "HDMI2", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      assert_equal expected, actual
+    end
+
+    it "should not parse disconnected devices" do
+      actual = RMonitor::Capabilities.new.parse <<-OUTPUT
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0
+        HDMI2 disconnected (normal left inverted right x axis y axis)
+      OUTPUT
+
+      expected = RMonitor::Capabilities::Builder.define do
+        device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+      end
+
+      assert_equal expected, actual
+    end
+
+  end
+
+end

data/test/commands/cl/invoke_test.rb

@@ -0,0 +1,38 @@
+require "test_helper"
+require "stringio"
+
+describe RMonitor::Commands::CL::Invoke do
+
+  describe "#execute" do
+
+    it "should write to :err when RMonitor::Commands::Invoke raises UnknownProfileError" do
+      err = StringIO.new
+
+      non_cl_invoke = Object.new
+
+      def non_cl_invoke.execute(*)
+        raise RMonitor::UnknownProfileError
+      end
+
+      RMonitor::Commands::CL::Invoke.new(:invoke => non_cl_invoke, :err => err).execute("foo")
+
+      assert_equal "unknown profile\n", err.string
+    end
+
+    it "should write to :err when RMonitor::Commands::Invoke raises UninvokableProfileError" do
+      err = StringIO.new
+
+      non_cl_invoke = Object.new
+
+      def non_cl_invoke.execute(*)
+        raise RMonitor::UninvokableProfileError
+      end
+
+      RMonitor::Commands::CL::Invoke.new(:invoke => non_cl_invoke, :err => err).execute("foo")
+
+      assert_equal "profile is not invokable\n", err.string
+    end
+
+  end
+
+end

data/test/commands/cl/list_test.rb

@@ -0,0 +1,36 @@
+require "test_helper"
+require "stringio"
+
+describe RMonitor::Commands::CL::List do
+
+  describe "#execute" do
+
+    it "should output profiles in a human readable manner" do
+      profiles = RMonitor::Config::Builder.define do
+        profile "docked" do
+          device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+          device "HDMI2", :mode => "1920x1080", :rate => "60.0"
+        end
+
+        profile "default" do
+          device "eDP1", :mode => "1920x1080"
+        end
+      end
+
+      matcher = MiniTest::Mock.new
+      matcher.expect :invokable?, true, [profiles.first]
+      matcher.expect :invokable?, false, [profiles.last]
+
+      out = StringIO.new
+
+      RMonitor::Commands::CL::List.new(:profiles => profiles, :matcher => matcher, :out => out).execute
+
+      assert_equal <<-LIST, out.string
+docked\tinvokable\tHDMI1 (1920x1080 60.0)\tHDMI2 (1920x1080 60.0)
+default\tuninvokable\teDP1 (1920x1080)
+      LIST
+    end
+
+  end
+
+end

data/test/commands/cl/update_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+require "stringio"
+
+describe RMonitor::Commands::CL::Update do
+
+  describe "#execute" do
+
+    it "should write to :err when RMonitor::Commands::Update raises NoInvokableProfileError" do
+      err = StringIO.new
+
+      non_cl_update = Object.new
+
+      def non_cl_update.execute
+        raise RMonitor::NoInvokableProfileError
+      end
+
+      RMonitor::Commands::CL::Update.new(:update => non_cl_update, :err => err).execute
+
+      assert_equal "no invokable profile\n", err.string
+    end
+
+  end
+
+end

data/test/commands/invoke_test.rb

@@ -0,0 +1,86 @@
+require "test_helper"
+require "fakefs/safe"
+
+describe RMonitor::Commands::Invoke do
+
+  before :each do
+    FakeFS.activate!
+
+    RMonitor::Config.config_path = nil
+
+    FileUtils.mkdir_p File.dirname DEFAULT_CONFIG_PATH
+
+    File.write DEFAULT_CONFIG_PATH, <<-CONFIG
+        profile "docked" do
+          device "HDMI1", :mode => "1920x1080", :rate => "60.0"
+          device "HDMI2", :mode => "1920x1080", :rate => "60.0"
+        end
+
+        profile "default" do
+          device "eDP1", :mode => "1920x1080"
+        end
+    CONFIG
+  end
+
+  after :each do
+    FakeFS.deactivate!
+  end
+
+  describe "#execute" do
+
+    it "should throw an exception when given an unknown profile name" do
+      invoker = MiniTest::Mock.new
+
+      invoker.expect :invoke, <<-XRANDR, ["xrandr"]
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0
+      XRANDR
+
+      cache = RMonitor::Cache.new(:invoker => invoker)
+
+      assert_raises RMonitor::UnknownProfileError do
+        RMonitor::Commands::Invoke.new(:invoker => cache).execute("foo")
+      end
+    end
+
+    it "should throw an exception if a profile is not invokable" do
+      invoker = MiniTest::Mock.new
+
+      invoker.expect :invoke, <<-XRANDR, ["xrandr"]
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0
+      XRANDR
+
+      cache = RMonitor::Cache.new(:invoker => invoker)
+
+      assert_raises RMonitor::UninvokableProfileError do
+        RMonitor::Commands::Invoke.new(:invoker => cache).execute("docked")
+      end
+    end
+
+    it "should call xrandr on the system when given an existing profile name" do
+      invoker = MiniTest::Mock.new
+
+      invoker.expect :invoke, <<-XRANDR, ["xrandr"]
+        Screen 0: minimum 8 x 8, current 1920 x 1080, maximum 1920 x 1080
+        HDMI1 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0
+        HDMI2 connected (normal left inverted right x axis y axis)
+           1920x1080       60.0
+      XRANDR
+
+      invoker.expect :invoke, nil, ["xrandr --output HDMI1 --mode 1920x1080 --rate 60.0"]
+      invoker.expect :invoke, nil, ["xrandr --output HDMI2 --mode 1920x1080 --rate 60.0"]
+
+      cache = RMonitor::Cache.new(:invoker => invoker)
+
+      RMonitor::Commands::Invoke.new(:invoker => cache).execute("docked")
+
+      invoker.verify
+    end
+
+  end
+
+end