volay 0.0.1

data/MANIFEST

@@ -0,0 +1,38 @@
+.gitignore
+.rubocop.yml
+.travis.yml
+Gemfile
+LICENSE
+MANIFEST
+README.md
+Rakefile
+bin/volay
+glade/icons/volume-high.png
+glade/icons/volume-low.png
+glade/icons/volume-medium.png
+glade/icons/volume-muted.png
+glade/volay.glade
+lib/volay.rb
+lib/volay/app.rb
+lib/volay/cli.rb
+lib/volay/config.rb
+lib/volay/exceptions.rb
+lib/volay/mixer/alsa.rb
+lib/volay/mixer/default.rb
+lib/volay/utils.rb
+lib/volay/version.rb
+lib/volay/volay.rb
+lib/volay/widget/events.rb
+lib/volay/widget/system_tray.rb
+lib/volay/widget/volume_control.rb
+spec/spec_helper.rb
+spec/volay/app_spec.rb
+spec/volay/config_spec.rb
+spec/volay/mixer/alsa_spec.rb
+spec/volay/mixer/default_spec.rb
+spec/volay/utils_spec.rb
+spec/volay/widget/volume_control_spec.rb
+task/manifest.rake
+task/rubocop.rake
+task/spec.rake
+volay.gemspec

data/README.md

@@ -0,0 +1,52 @@
+#Volay, the Volume System Tray
+
+[![Build Status](https://travis-ci.org/PierreRambaud/volay.svg)](https://travis-ci.org/PierreRambaud/volay)
+
+##Requirements
+
+ * Ruby 1.9.3 or newer
+
+##Installation
+
+From Rubygems:
+
+```
+$ gem install volay
+```
+
+From Github:
+
+```
+$ git clone https://github.com/PierreRambaud/volay.git
+$ cd volay
+$ bundle install
+$ bundle exec rake install
+```
+
+## Usage
+
+```bash
+$ volay -h
+Volay, the Volume System Tray.
+    -d, --down PERCENT               Down volume
+    -l, --log_level LEVEL            Set the log level (debug, info, warn, error, fatal)
+    -m, --toggle-mute                Toggle mute
+    -u, --up PERCENT                 Up volume
+    -h, --help                       Show this message
+```
+
+If no arguments are passed, the Gtk app is launched.
+
+## Running tests
+
+To run unit tests:
+`$ bundle exec rake spec`
+
+To check code style:
+`$ bundle exec rake rubocop`
+
+To run all tests:
+`$ bundle exec rake`
+
+## License
+See [LICENSE](LICENSE) file

data/Rakefile

@@ -0,0 +1,9 @@
+
+require 'bundler/gem_tasks'
+GEMSPEC = Gem::Specification.load('gemirro.gemspec')
+
+Dir['./task/*.rake'].each do |task|
+  import(task)
+end
+
+task default: [:rubocop, :spec]

data/bin/volay

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/volay', __FILE__)
+
+# Module volay
+module Volay
+  # Main class to display app or control volume
+  class Main
+    def initialize
+      cli = Volay::CLI.new
+      cli.parse_options
+      Volay::Config.set(:log_level, cli.config[:log_level])
+      Volay::Config.init_config
+      if [:up, :down, :mute].any? { |k| cli.config.key?(k) }
+        sound(cli.config)
+      else
+        app
+      end
+    end
+
+    def sound(config)
+      Volay::Config.mixer.up(config[:up]) unless config[:up].nil?
+      Volay::Config.mixer.down(config[:down]) unless config[:down].nil?
+      Volay::Config.mixer.toggle if config[:mute]
+    end
+
+    def app
+      Gtk.init
+      Volay::App.new('glade/volay.glade')
+      Gtk.main
+    end
+  end
+end
+
+Volay::Main.new

data/glade/volay.glade

@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated with glade 3.18.3 -->
+<interface>
+  <requires lib="gtk+" version="3.6"/>
+  <object class="GtkIconFactory" id="icon_factory">
+    <sources>
+      <source stock-id="volume-high" filename="/glade/icons/volume-high.png"/>
+      <source stock-id="volume-medium" filename="/glade/icons/volume-medium.png"/>
+      <source stock-id="volume-muted" filename="/glade/icons/volume-muted.png"/>
+      <source stock-id="volume-low" filename="/glade/icons/volume-low.png"/>
+    </sources>
+  </object>
+  <object class="GtkMenu" id="popup_menu">
+    <property name="visible">True</property>
+    <property name="can_focus">False</property>
+    <child>
+      <object class="GtkImageMenuItem" id="popup_menu_quit">
+        <property name="label">gtk-quit</property>
+        <property name="visible">True</property>
+        <property name="can_focus">False</property>
+        <property name="use_underline">True</property>
+        <property name="use_stock">True</property>
+        <property name="always_show_image">True</property>
+        <signal name="activate" handler="on_popup_menu_quit_activate" swapped="no"/>
+      </object>
+    </child>
+  </object>
+  <object class="GtkStatusIcon" id="status_icon">
+    <property name="stock">volume-muted</property>
+    <signal name="button-press-event" handler="on_status_icon_button_press_event" swapped="no"/>
+    <signal name="popup-menu" handler="on_status_icon_popup_menu" swapped="no"/>
+  </object>
+  <object class="GtkAdjustment" id="volume_adjustement">
+    <property name="upper">100</property>
+    <property name="step_increment">1</property>
+    <property name="page_increment">10</property>
+    <signal name="value-changed" handler="on_volume_adjustement_value_changed" swapped="no"/>
+  </object>
+  <object class="GtkWindow" id="system_tray_window">
+    <property name="width_request">25</property>
+    <property name="height_request">200</property>
+    <property name="can_focus">True</property>
+    <property name="events">GDK_FOCUS_CHANGE_MASK</property>
+    <property name="resizable">False</property>
+    <property name="modal">True</property>
+    <property name="window_position">mouse</property>
+    <property name="type_hint">popup-menu</property>
+    <property name="focus_on_map">False</property>
+    <property name="decorated">False</property>
+    <property name="deletable">False</property>
+    <signal name="focus-out-event" handler="on_system_tray_window_focus_out_event" swapped="no"/>
+    <signal name="show" handler="on_system_tray_window_show" swapped="no"/>
+    <child>
+      <object class="GtkBox" id="volume_control_box">
+        <property name="visible">True</property>
+        <property name="can_focus">False</property>
+        <property name="orientation">vertical</property>
+        <child>
+          <object class="GtkScale" id="volume_scale">
+            <property name="visible">True</property>
+            <property name="can_focus">True</property>
+            <property name="orientation">vertical</property>
+            <property name="adjustment">volume_adjustement</property>
+            <property name="inverted">True</property>
+            <property name="round_digits">0</property>
+            <property name="digits">0</property>
+            <signal name="realize" handler="on_volume_scale_realize" swapped="no"/>
+          </object>
+          <packing>
+            <property name="expand">True</property>
+            <property name="fill">True</property>
+            <property name="position">0</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkToggleButton" id="toggle_mute">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <property name="receives_default">True</property>
+            <property name="always_show_image">True</property>
+            <signal name="toggled" handler="on_toggle_mute_toggled" swapped="no"/>
+            <child>
+              <object class="GtkImage" id="toggle_mute_image">
+                <property name="visible">True</property>
+                <property name="can_focus">False</property>
+                <property name="stock">volume-muted</property>
+              </object>
+            </child>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">True</property>
+            <property name="position">1</property>
+          </packing>
+        </child>
+      </object>
+    </child>
+  </object>
+</interface>

data/lib/volay/app.rb

@@ -0,0 +1,62 @@
+# Volay module
+module Volay
+  # App class
+  class App < Gtk::Builder
+    attr_accessor :signals_list
+    attr_reader :mixer, :utils
+
+    ##
+    # Initialize application
+    #
+    # @param [String] path Path to glade file
+    #
+    def initialize(path)
+      super()
+
+      Gtk::Settings.default.gtk_button_images = true
+
+      initialize_ui(path)
+      initialize_mixer
+      initialize_events
+    end
+
+    private
+
+    ##
+    # Initialize events
+    #
+    def initialize_events
+      @signals_list = {}
+      @utils = Volay::Utils.new(self)
+      @utils.update_status_icon
+      Volay::Widget::SystemTray.new(self)
+      Volay::Widget::VolumeControl.new(self)
+
+      connect_signals do |handler|
+        @signals_list[handler] if @signals_list.key?(handler)
+      end
+    end
+
+    ##
+    # Initialize mixer for controlling volume
+    #
+    def initialize_mixer
+      @mixer ||= Volay::Config.mixer
+    end
+
+    ##
+    # Intiailize ui by overriding icons path
+    #
+    # @param [String] path Path to glade file
+    #
+    def initialize_ui(path)
+      # Override Icon path to prevent
+      # Gtk-CRITICAL **:gtk_icon_source_set_filename:
+      ui = File.read(path)
+      ui.gsub!(%r{/glade/icons},
+               File.expand_path('../../glade/icons',
+                                File.dirname(__FILE__)))
+      add_from_string(ui)
+    end
+  end
+end

data/lib/volay/cli.rb

@@ -0,0 +1,44 @@
+# Volay module
+module Volay
+  # CLI implementation
+  class CLI
+    include Mixlib::CLI
+
+    banner('Volay, the Volume System Tray.')
+
+    option(:help,
+           short: '-h',
+           long: '--help',
+           description: 'Show this message',
+           on: :tail,
+           boolean: true,
+           show_options: true,
+           exit: 0)
+
+    option(:log_level,
+           short: '-l LEVEL',
+           long: '--log_level LEVEL',
+           description: 'Set the log level (debug, info, warn, error, fatal)',
+           in: %w(debug info warn error fatal),
+           default: :info,
+           proc: proc { |l| l.to_sym })
+
+    option(:up,
+           short: '-u PERCENT',
+           long: '--up PERCENT',
+           description: 'Up volume',
+           proc: proc { |l| l.to_i })
+
+    option(:down,
+           short: '-d PERCENT',
+           long: '--down PERCENT',
+           description: 'Down volume',
+           proc: proc { |l| l.to_i })
+
+    option(:mute,
+           short: '-m',
+           long: '--toggle-mute',
+           boolean: true,
+           description: 'Toggle mute')
+  end
+end

data/lib/volay/config.rb

@@ -0,0 +1,91 @@
+# Volay module
+module Volay
+  # Config class
+  class Config
+    attr_reader :logger, :mixer, :options
+
+    ##
+    # Get option
+    #
+    # @return [Mixed]
+    #
+    def self.init_config
+      File.write(config_file, '') unless File.exist?(config_file)
+      logger.level = get(:log_level)
+    end
+
+    ##
+    # Get option
+    #
+    # @return [Mixed]
+    #
+    def self.get(option)
+      @options ||= {}
+      @options[option.to_sym] if @options.key?(option.to_sym)
+    end
+
+    ##
+    # Set option
+    #
+    # @param [String|Symbol] option Option key
+    # @param [Mixed] value Option value
+    #
+    def self.set(option, value)
+      @options ||= {}
+      @options[option.to_sym] = value
+    end
+
+    ##
+    # Get config file
+    #
+    # @return [String]
+    #
+    def self.config_file
+      File.expand_path('~/.volay')
+    end
+
+    ##
+    # Get logger
+    #
+    # @return [Logger]
+    #
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    ##
+    # Initialize mixer for controlling volume
+    #
+    def self.mixer
+      @mixer ||= begin
+                   if which('amixer')
+                     Volay::Mixer::Alsa.new
+                   else
+                     fail MixerNotFound
+                   end
+                 end
+    end
+
+    ##
+    # Cross-platform way of finding an executable in the $PATH.
+    #
+    # Example:
+    #   which('ruby') #=> /usr/bin/ruby
+    #   which('foo') #=> nil
+    #
+    # @param [String] cmd Which command
+    # @return [String|NilClass]
+    #
+    def self.which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/volay/exceptions.rb

@@ -0,0 +1,6 @@
+# Volay Module
+module Volay
+  # Mixer not found
+  class MixerNotFound < StandardError
+  end
+end

data/lib/volay/mixer/alsa.rb

@@ -0,0 +1,48 @@
+# Volay module
+module Volay
+  # Mixer module
+  module Mixer
+    # Alsa class for playing with amixer
+    class Alsa < Default
+      DEFAULT_VALUE = 2
+
+      def up(value = DEFAULT_VALUE)
+        command("-q set Master #{value}%+")
+      end
+
+      def down(value = DEFAULT_VALUE)
+        command("-q set Master #{value}%-")
+      end
+
+      def value=(value)
+        command("-q set Master #{value}%")
+      end
+
+      def toggle
+        command('-q set Master toggle')
+      end
+
+      def current
+        result = command('get Master')
+        max_value = result.match(/ 0 - (\d+)/)[1].to_i
+        current_percent = result.match(/\[([0-9]+)%\]\s+\[o(?:n|ff)\]/)[1].to_i
+        current_value = ((current_percent * max_value) / 100).to_i
+        current_state = result.match(/\[([a-z]+)\]/)[1].to_s
+
+        { value: current_value,
+          max_value: max_value,
+          percent: current_percent,
+          muted: current_state == 'on' ? false : true }
+      end
+
+      private
+
+      def command(cmd)
+        result = Mixlib::ShellOut.new("amixer #{cmd}")
+        result.run_command
+        Volay::Config.logger.error(result.stderr) unless result.stderr.empty?
+        result.stdout
+      end
+    end
+  end
+end

data/lib/volay/mixer/default.rb

@@ -0,0 +1,72 @@
+# Volay module
+module Volay
+  # Mixer module
+  module Mixer
+    # Default class
+    class Default
+      ##
+      # Up the volume
+      #
+      def up(*)
+        fail NotImplementedError
+      end
+
+      ##
+      # Down the volume
+      #
+      def down(*)
+        fail NotImplementedError
+      end
+
+      ##
+      # Set the volume
+      #
+      def value=(*)
+        fail NotImplementedError
+      end
+
+      ##
+      # Toggle mute
+      #
+      def toggle
+        fail NotImplementedError
+      end
+
+      ##
+      # Current data, value, max_value,
+      # percent and muted
+      #
+      def current
+        fail NotImplementedError
+      end
+
+      ##
+      # Current value
+      #
+      def max_value
+        current[:value]
+      end
+
+      ##
+      # Current value
+      #
+      def value
+        current[:value]
+      end
+
+      ##
+      # Current percent
+      #
+      def percent
+        current[:percent]
+      end
+
+      ##
+      # Is muted
+      #
+      def muted?
+        current[:muted]
+      end
+    end
+  end
+end

data/lib/volay/utils.rb

@@ -0,0 +1,40 @@
+# Volay module
+module Volay
+  # Utils class
+  class Utils
+    attr_reader :app
+
+    ##
+    # Initialize utils class
+    #
+    # @param [Gtk::Builder] app Application
+    #
+    def initialize(app)
+      @app = app
+    end
+
+    ##
+    # Change status icon stock
+    #
+    def update_status_icon
+      icon = status_icon
+      @app.get_object('status_icon')
+        .set_stock(icon)
+      @app.get_object('toggle_mute_image')
+        .set_stock(icon)
+    end
+
+    def status_icon
+      case @app.mixer.percent
+      when 66..100
+        icon = 'volume-high'
+      when 33..65
+        icon = 'volume-medium'
+      when 0..32
+        icon = 'volume-low'
+      end unless @app.mixer.muted?
+
+      icon.nil? ? 'volume-muted' : icon
+    end
+  end
+end

data/lib/volay/version.rb

@@ -0,0 +1,4 @@
+# Volay module
+module Volay
+  VERSION = '0.0.1'
+end

data/lib/volay/volay.rb

@@ -0,0 +1,11 @@
+require 'gtk3'
+require 'mixlib-cli'
+
+unless $LOAD_PATH.include?(File.expand_path('../', __FILE__))
+  $LOAD_PATH.unshift(File.expand_path('../', __FILE__))
+end
+
+require 'volay/version'
+require 'volay/app'
+require 'volay/cli'
+require 'volay/widget/events'

data/lib/volay/widget/events.rb

@@ -0,0 +1,22 @@
+# Volay module
+module Volay
+  # Widgets components
+  module Widget
+    # Events class
+    class Events
+      attr_reader :app
+
+      ##
+      # Initialize signals events
+      #
+      def initialize(app)
+        @app = app
+
+        methods.each do |name|
+          next unless name.match(/^on_/)
+          @app.signals_list[name.to_s] = method(name)
+        end
+      end
+    end
+  end
+end