volay 0.0.1

data/lib/volay/widget/system_tray.rb

@@ -0,0 +1,91 @@
+# Volay module
+module Volay
+  # Widgets components
+  module Widget
+    # Events class
+    class SystemTray < Events
+      LEFT_CLICK = 1
+      RIGHT_CLICK = 3
+
+      ##
+      # When left click on the status icon, popup the window menu
+      #
+      # @param [Gtk::Widget] widget Widget
+      # @param [Gtk::Event] event Event
+      #
+      def on_status_icon_button_press_event(_widget, event)
+        return unless event.is_a?(Gdk::EventButton) &&
+                      event.button == LEFT_CLICK
+        window = @app.get_object('system_tray_window')
+        posx, posy = get_position(window)
+        window.move(posx, posy)
+        @app.get_object('system_tray_window').show_all
+      end
+
+      ##
+      # When click outside the window
+      #
+      def on_system_tray_window_focus_out_event
+        @app.get_object('system_tray_window').hide
+      end
+
+      ##
+      # When right click on the status icon
+      #
+      # @param [Gtk::Widget] widget Widget
+      # @param [Gtk::Event] event Event
+      # @param [Integer] time Time
+      def on_status_icon_popup_menu(_widget, _event, time)
+        popup_menu = @app.get_object('popup_menu')
+        popup_menu.show_all
+        popup_menu.popup(nil, nil, 0, time)
+      end
+
+      ##
+      # When quit button is clicked
+      #
+      def on_popup_menu_quit_activate
+        Gtk.main_quit
+      end
+
+      ##
+      # Retrieve the good position to be above
+      # the status icon
+      #
+      # @param [Gtk::Window] window Window
+      #
+      def get_position(window)
+        screen, rectangle, orientation = @app.get_object('status_icon').geometry
+        window.set_screen(screen)
+        monitor_num = screen.get_monitor_at_point(rectangle.x, rectangle.y)
+        monitor = screen.get_monitor_geometry(monitor_num)
+        window_width, window_height = window.size
+
+        if orientation == Gtk::Orientation::VERTICAL
+          if monitor.width - rectangle.x == rectangle.width
+            # right panel
+            posx = monitor.x + monitor.width - window_width - rectangle.width
+          else
+            # left panel
+            posx = rectangle.x + rectangle.width
+            posy = rectangle.y
+          end
+        else
+          if (rectangle.y + rectangle.height + window_height <=
+              monitor.y + monitor.height)
+            posy = rectangle.y + rectangle.height
+          else
+            posy = rectangle.y - window_height
+            if (rectangle.x + window_width <= monitor.x + monitor.width)
+              posx = rectangle.x
+            else
+              posx = monitor.x + monitor.width - window_width
+            end
+          end
+        end
+
+        [posx, posy]
+      end
+    end
+  end
+end

data/lib/volay/widget/volume_control.rb

@@ -0,0 +1,37 @@
+# Volay module
+module Volay
+  # Widgets components
+  module Widget
+    # Events class
+    class VolumeControl < Events
+      ##
+      # When system tray window is showed
+      #
+      def on_system_tray_window_show
+        @app.get_object('volume_adjustement')
+          .value = @app.mixer.percent
+        @app.utils.update_status_icon
+      end
+
+      ##
+      # When slider have its adjustement value changed
+      #
+      def on_volume_adjustement_value_changed(widget)
+        Thread.new do
+          @app.mixer.value = widget.value
+          @app.utils.update_status_icon
+        end
+      end
+
+      ##
+      # When mute toggle image is clicked
+      #
+      def on_toggle_mute_toggled
+        Thread.new do
+          @app.mixer.toggle
+          @app.utils.update_status_icon
+        end
+      end
+    end
+  end
+end

data/lib/volay.rb

@@ -0,0 +1,20 @@
+require 'gtk3'
+require 'logger'
+require 'mixlib/cli'
+require 'mixlib/shellout'
+
+unless $LOAD_PATH.include?(File.expand_path('../', __FILE__))
+  $LOAD_PATH.unshift(File.expand_path('../', __FILE__))
+end
+
+require 'volay/version'
+require 'volay/config'
+require 'volay/exceptions'
+require 'volay/app'
+require 'volay/cli'
+require 'volay/utils'
+require 'volay/widget/events'
+require 'volay/widget/system_tray'
+require 'volay/widget/volume_control'
+require 'volay/mixer/default'
+require 'volay/mixer/alsa'

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/spec/volay/app_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'fakefs/spec_helpers'
+require 'gtk3'
+require 'volay/app'
+require 'volay/utils'
+require 'volay/widget/events'
+require 'volay/widget/system_tray'
+require 'volay/widget/volume_control'
+require 'volay/mixer/default'
+require 'volay/mixer/alsa'
+require 'volay/exceptions'
+
+describe 'Volay::App' do
+  include FakeFS::SpecHelpers
+
+  context '#events' do
+    def app_events
+    end
+
+    it 'should return alsa' do
+      allow_any_instance_of(Volay::App).to receive(:initialize_mixer)
+      allow_any_instance_of(Volay::App).to receive(:initialize_ui)
+      allow_any_instance_of(Volay::Utils).to receive(:update_status_icon)
+      allow_any_instance_of(Volay::App).to receive(:connect_signals)
+        .and_yield('on_status_icon_button_press_event')
+
+      File.write('something', '')
+      app = Volay::App.new('something')
+      expect(app.signals_list).to be_a(Hash)
+    end
+  end
+
+  context '#ui' do
+    it 'should return alsa' do
+      allow_any_instance_of(Volay::App).to receive(:initialize_mixer)
+      allow_any_instance_of(Volay::App).to receive(:initialize_events)
+
+      xml = <<-EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated with glade 3.18.3 -->
+<interface>
+  <requires lib="gtk+" version="3.2"/>
+  <object class="GtkIconFactory" id="icon_factory">
+    <sources>
+  <source stock-id="volume-muted" filename="/glade/icons/volume-muted.png"/>
+    </sources>
+  </object>
+</interface>
+EOF
+
+      File.write('something', xml)
+      app = Volay::App.new('something')
+      expect(app.get_object('icon_factory')).to be_a(Gtk::IconFactory)
+    end
+  end
+end

data/spec/volay/config_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'logger'
+require 'volay/config'
+require 'volay/mixer/default'
+require 'volay/mixer/alsa'
+require 'volay/exceptions'
+
+describe 'Volay::Config' do
+  include FakeFS::SpecHelpers
+
+  it 'should return config file' do
+    config_file = Volay::Config.config_file
+    expect(config_file).to be_a(String)
+    expect(config_file).to match(/.volay$/)
+  end
+
+  it 'should return logger' do
+    expect(Volay::Config.logger).to be_a(Logger)
+  end
+
+  it 'should set and get config' do
+    Volay::Config.set('test', 'something')
+    expect(Volay::Config.get('test')).to eq('something')
+    expect(Volay::Config.get(:test)).to eq('something')
+    expect(Volay::Config.get(:something)).to be_nil
+  end
+
+  context '#which' do
+    let(:config) do
+      FileUtils.mkdir_p('/usr/bin')
+      File.write('/usr/bin/ruby', '')
+      File.chmod(0777, '/usr/bin/ruby')
+    end
+
+    it 'should find ruby executable' do
+      config
+      expect(Volay::Config.which('ruby')).to eq('/usr/bin/ruby')
+    end
+
+    it "shouldn't find amixer executable" do
+      config
+      expect(Volay::Config.which('amixer')).to be_nil
+    end
+  end
+
+  context '#mixer' do
+    def app_mixer(prog)
+      FileUtils.mkdir_p('/usr/bin')
+      File.write("/usr/bin/#{prog}", '')
+      File.chmod(0777, "/usr/bin/#{prog}")
+    end
+
+    it 'should not return pulseaudio' do
+      app_mixer('pulseaudio-ctl')
+      expect { Volay::Config.mixer }
+        .to raise_error(Volay::MixerNotFound)
+    end
+
+    it 'should return alsa' do
+      app_mixer('amixer')
+      expect(Volay::Config.mixer).to be_a(Volay::Mixer::Alsa)
+    end
+  end
+end

data/spec/volay/mixer/alsa_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'mixlib/shellout'
+require 'volay/mixer/default'
+
+describe 'Volay::Mixer::Alsa' do
+  let(:mixer) do
+    Volay::Mixer::Alsa.new
+  end
+
+  def stub_shellout(cmd, stdout = '', stderr = '')
+    allow_any_instance_of(Mixlib::ShellOut).to receive(:run_command)
+    allow_any_instance_of(Mixlib::ShellOut).to receive(:new)
+      .with("amixer #{cmd}")
+    allow_any_instance_of(Mixlib::ShellOut).to receive(:stdout)
+      .and_return(stdout)
+    allow_any_instance_of(Mixlib::ShellOut).to receive(:stderr)
+      .and_return(stderr)
+  end
+
+  it 'should raise error when calling up' do
+    stub_shellout('-q set Master 2%+', 'Yes')
+    expect(mixer.up).to eq('Yes')
+  end
+
+  it 'should raise error when calling down' do
+    stub_shellout('-q set Master 2%-', 'Yes')
+    expect(mixer.down).to eq('Yes')
+  end
+
+  it 'should raise error when calling value=' do
+    stub_shellout('-q set Master 50%', 'Yes')
+    expect(mixer.value = '50').to eq('50')
+  end
+
+  it 'should raise error when calling toggle' do
+    stub_shellout('-q set Master toggle', 'Yes')
+    expect(mixer.toggle).to eq('Yes')
+  end
+
+  it 'should raise error when calling current' do
+    stdout = <<-EOF
+Simple mixer control 'Master',0
+  Capabilities: pvolume pswitch pswitch-joined
+  Playback channels: Front Left - Front Right
+  Limits: Playback 0 - 65536
+  Mono:
+  Front Left: Playback 13108 [20%] [off]
+  Front Right: Playback 13108 [20%] [off]
+EOF
+    stub_shellout('get Master', stdout)
+    expect(mixer.current).to eq(value: 13_107,
+                                max_value: 65_536,
+                                percent: 20,
+                                muted: true)
+  end
+end

data/spec/volay/mixer/default_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'volay/mixer/default'
+
+describe 'Volay::Mixer::Default' do
+  let(:mixer) do
+    Volay::Mixer::Default.new
+  end
+
+  it 'should raise error when calling up' do
+    expect { mixer.up }.to raise_error(NotImplementedError)
+  end
+
+  it 'should raise error when calling down' do
+    expect { mixer.down }.to raise_error(NotImplementedError)
+  end
+
+  it 'should raise error when calling value=' do
+    expect { mixer.value = '50' }.to raise_error(NotImplementedError)
+  end
+
+  it 'should raise error when calling toggle' do
+    expect { mixer.toggle }.to raise_error(NotImplementedError)
+  end
+
+  it 'should raise error when calling current' do
+    expect { mixer.current }.to raise_error(NotImplementedError)
+  end
+
+  it 'should raise error when calling value' do
+    expect { mixer.value }.to raise_error(NotImplementedError)
+  end
+
+  it 'should raise error when calling max_value' do
+    expect { mixer.max_value }.to raise_error(NotImplementedError)
+  end
+
+  it 'should raise error when calling percent' do
+    expect { mixer.percent }.to raise_error(NotImplementedError)
+  end
+
+  it 'should raise error when calling muted' do
+    expect { mixer.muted? }.to raise_error(NotImplementedError)
+  end
+end

data/spec/volay/utils_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'volay/utils'
+
+describe 'Volay::Utils' do
+  context 'status_icon' do
+    def prepare(image, muted, volume_percent)
+      app = double
+      toggle_image = double
+      status_icon = double
+      mixer = double
+      allow(app).to receive(:mixer).and_return(mixer)
+      allow(app).to receive(:get_object)
+        .with('status_icon').and_return(status_icon)
+      allow(app).to receive(:get_object)
+        .with('toggle_mute_image').and_return(toggle_image)
+      allow(mixer).to receive(:muted?)
+        .and_return(muted)
+      allow(mixer).to receive(:percent)
+        .and_return(volume_percent)
+      [status_icon, toggle_image].each do |element|
+        allow(element).to receive(:set_stock)
+          .with(image).once.and_return(true)
+      end
+
+      app
+    end
+
+    it 'should change icon to low' do
+      app = prepare('volume-low', false, 20)
+      utils = Volay::Utils.new(app)
+      expect(utils.update_status_icon).to be_truthy
+    end
+
+    it 'should change icon to medium' do
+      app = prepare('volume-medium', false, 40)
+      utils = Volay::Utils.new(app)
+      expect(utils.update_status_icon).to be_truthy
+    end
+
+    it 'should change icon to high' do
+      app = prepare('volume-high', false, 80)
+      utils = Volay::Utils.new(app)
+      expect(utils.update_status_icon).to be_truthy
+    end
+
+    it 'should change icon to muted' do
+      app = prepare('volume-muted', true, 0)
+      utils = Volay::Utils.new(app)
+      expect(utils.update_status_icon).to be_truthy
+    end
+  end
+end

data/spec/volay/widget/volume_control_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'volay/widget/volume_control'
+
+describe 'Volay::Widget::VolumeControl' do
+  let(:app) do
+    app = double
+    allow(app).to receive(:mixer).and_return(double)
+    allow(app).to receive(:signals_list).and_return({})
+    app
+  end
+
+  let(:vc) do
+    Volay::Widget::VolumeControl.new(app)
+  end
+
+  it 'on volume scale' do
+    utils = double
+    volume = double
+    allow(volume).to receive(:value=).and_return(20)
+    allow(app).to receive(:get_object).once.with('volume_adjustement')
+      .and_return(volume)
+    allow(app).to receive(:utils).once.and_return(utils)
+    allow(utils).to receive(:update_status_icon).once.and_return(true)
+    allow(app.mixer).to receive(:percent).and_return(20)
+    expect(vc.on_system_tray_window_show).to be_truthy
+  end
+end

data/task/manifest.rake

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+desc 'Generates the MANIFEST file'
+task :manifest do
+  files  = `git ls-files`.split("\n").sort
+  handle = File.open(File.expand_path('../../MANIFEST', __FILE__), 'w')
+
+  handle.write(files.join("\n"))
+  handle.close
+end

data/task/rubocop.rake

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop)

data/task/spec.rake

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+desc 'Run Rspec tests'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--color --format documentation'
+end

data/volay.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('../lib/volay/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'volay'
+  s.version = Volay::VERSION
+  s.authors = ['Pierre Rambaud']
+  s.email = 'pierre.rambaud86@gmail.com'
+  s.license = 'GPL-3.0'
+  s.summary = 'The Volume system tray'
+  s.homepage = 'http://github.com/PierreRambaud/volay'
+  s.description = 'Really simple volume system tray written in ruby.'
+  s.executables = ['volay']
+  s.files = File.read(File.expand_path('../MANIFEST', __FILE__)).split("\n")
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'mixlib-cli', '~>1.5.0'
+  s.add_dependency 'mixlib-shellout', '~>2.0.1'
+  s.add_dependency 'gtk3', '~>2.2'
+
+  s.add_development_dependency 'fakefs', '~>0.6.0'
+  s.add_development_dependency 'rake', '~>10.0'
+  s.add_development_dependency 'rack-test', '~>0.6'
+  s.add_development_dependency 'rspec', '~>3.0'
+  s.add_development_dependency 'simplecov', '~>0.9'
+  s.add_development_dependency 'rubocop', '~>0.25'
+end