r3status 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c2c2e2a5985350fdd7009f16224f8d0ce2aa225
-  data.tar.gz: cdfe3f6a14611a3159ff9c362809e77fe62e224c
+  metadata.gz: bafcfeb5316e7a7e409f3a17553495aa16c245ba
+  data.tar.gz: 23b1bdd423b22a0477455529117a6ff345580a11
 SHA512:
-  metadata.gz: 6671a6a365fff74396378124de0da333ecf9bec77a1f78fed5fdf54bbf3e70ac79a2662d211814d31eb83ef34f3943d69dff37e5d3e6e25dd4d9d939bea149e3
-  data.tar.gz: 6ee838c35dd8b83b2900eff0cdd522d1a9e3cb239e4e389869978459c643840abb0afee8ae2dd01379d47c5fad2a755386658fa1acef1ca530109a337a2a27c4
+  metadata.gz: 617319555169430b21f652e533283527b259fad49d806bc11ac2bdf5543efb57187ebf350880640b3abe270aef48586f47208dd9deb0ef77f286de505295eca3
+  data.tar.gz: f3dc133d86ae42da95eb48d895f2ea1933265262dc561447cf33fb3a7e6939cc0102e182124169fe120dae54d5beccef8e06bd9d9ee1cfa674dc22cb45f66eee

data/lib/r3status/blocks/async.rb

@@ -0,0 +1,33 @@
+module R3Status::Blocks
+  # A base block for blocks who need to run the update procedure at a 
+  # different interval than general update interval, or ones who need
+  # to run in the background.
+  class Async < Base
+    # The update interval (in seconds) of the block.
+    attr_accessor :update_interval
+    
+    # Creates a new instance of this class.
+    # If a block is passed, it will be stored and yielded when the block is clicked.
+    def initialize(**args, &block)
+      args = {update_interval: 3}.merge(args)
+      super(args, &block)
+    end
+    
+    # When first called, starts the update loop. Ignored afterwards.
+    def update
+      return unless @updater_thread.nil?
+      @updater_thread = Thread.new do
+        loop_with_interval(update_interval) { async_update }
+      end
+    end
+    
+    # Signals the block to release any resources.
+    def terminate
+      @updater_thread.kill
+    end
+    
+    # When implemented in derived classes, updates the text and color of this block.
+    # Implmentations should set the #full_text and #text_color attributes.
+    def async_update; end
+  end
+end

data/lib/r3status/blocks/base.rb

@@ -0,0 +1,91 @@
+require 'securerandom'
+# Contains the default blocks that can be used using StatusLine.
+module R3Status::Blocks  
+  # A base class for blocks, providing the needed methods and attributes.
+  # Can be use both as a base for other blocks and as a block in itself.
+  #
+  # ==== Examples
+  #   b = Blocks::Base.new(full_text: "0") do |block, button|
+  #     block.full_text = button.to_s
+  #   end
+  class Base
+    # The default text color. Will be used if no color was supplied, or +nil+ was given.
+    DEFAULT_COLOR = '#ffffff'
+    # The default format. Will be used if no format was supplied, or +nil+ was given.
+    DEFAULT_FORMAT = '%{val}'
+    
+    attr_accessor( 
+      :full_text,
+      :text_color,
+      :name,
+      :formats, 
+      :colors, 
+      :clicked_block
+    )
+    
+    # Creates a new instance of this class.
+    # If a block is passed, it will be stored and yielded when the block is clicked.
+    def initialize(**args, &block)
+      @colors ||= {}
+      @formats ||= Hash.new(DEFAULT_FORMAT)
+      
+      args.each do |k, v|
+        v.default = v[:default] if (v.is_a? Hash) && (v.key? :default)
+        send "#{k}=", v
+      end
+      
+      @clicked_block = block
+      @name ||= SecureRandom.uuid
+      @full_text ||= format
+    end
+    
+    # When implemented in derived classes, updates the text and color of this block.
+    # Implmentations should set the #full_text and #text_color attributes.
+    def update; end
+     
+    # Handles mouse interaction with the block.
+    # If a block was supplied to the constructor, it will be yielded.
+    # button (Fixnum):: The mouse button that was used.
+    # x, y (Fixnum / Float):: The pointer coordinates on the screen.
+    def clicked(button, x, y)
+      return if @clicked_block.nil?
+      args = [self, button, x, y].take(@clicked_block.arity)
+      @clicked_block.(*args)
+    end
+    
+    # Returns the string representation of this block.
+    # prefix::
+    def to_s(prefix: nil, postfix: nil)
+      %({"full_text": "#{prefix}#{full_text}#{postfix}", 
+          "color": "#{text_color || DEFAULT_COLOR}", "name": "#{name}",
+          "separator": false})
+    end
+    
+    # Returns the default format string.
+    def format
+      formats.default 
+    end
+    
+    # Sets the default format string.
+    def format=(fmt)
+      formats.default = fmt 
+    end
+    
+    # Returns the default color.
+    def color
+      colors.default
+    end
+    
+    # Sets the default color.
+    def color=(color)
+      colors.default = color
+    end
+    
+    # Signals the block to release any resources.
+    def terminate; end
+    
+    # When implemented in derived class, returns the current state of the block,
+    # if available.
+    def state; end
+  end
+end

data/lib/r3status/blocks/clock.rb

@@ -0,0 +1,28 @@
+module R3Status::Blocks
+  # A block that displays the current date and time.
+  #
+  # ==== States
+  #   :am, :pm
+  #
+  # ==== Format values
+  # See http://www.ruby-doc.org/core-2.1.3/Time.html#method-i-strftime
+  class Clock < Base
+  
+    # Creates a new instance of this class.
+    # If a block is passed, it will be stored and yielded when the block is clicked.
+    def initialize(**args, &block)
+      args = {format: "%H:%m %e/%M/%Y"}.merge(args)
+      super(args, &block)
+    end
+    
+    # Updates the text and color of this block.
+    def update
+      self.full_text = Time.now.strftime(formats[state])
+    end
+    
+    # Returns the current state of the block
+    def state
+      Time.now.strftime('%P').to_sym
+    end
+  end
+end

data/lib/r3status/blocks/keyboard_layout.rb

@@ -0,0 +1,39 @@
+module R3Status::Blocks
+  # A block that acts as a keyboard layout indicator.
+  #
+  # ==== States
+  # There are no constant states. A state is the current keyboard layout,
+  # as specified by the system. (e.g. +:us+ for US English, +:ru+ for Russian)
+  #
+  # ==== Format values
+  # +%{val}+, +%{sym}+: The current language symbol.
+  class KeyboardLayout < Base
+    
+    # Creates a new instance of this class.
+    # If a block is passed, it will be stored and yielded when the block is clicked.
+    def initialize(**args, &block)
+      super(args, &block)
+    end
+    
+    # Updates the text and color of this block.
+    def update
+      sym = state
+      @full_text = formats[sym] % {val: sym, sym: sym}
+      @text_color = colors[sym]
+    end
+    
+    # Returns the current state of the block.
+    def state
+      if command? "xkblayout-state"
+        `xkblayout-state print %s`
+      else
+        `setxkbmap -query | awk -F"(|[ ]+)" '/layout:/ { print $2 }'`
+      end.chomp.to_sym
+    end
+    
+    # Determines if a shell command exists.
+    def command?(command)
+       system("which #{command} > /dev/null 2>&1")
+    end
+  end
+end

data/lib/r3status/blocks/power.rb

@@ -0,0 +1,59 @@
+module R3Status::Blocks
+  # A block that acts as a power indicator.
+  #
+  # ==== States:
+  #   :charging, :discharging, :full, :unknown, :no_battery
+  #
+  # ==== Format Values
+  # +%{val}+, +%{capacity}+: The current battery capacity.
+  class Power < Base
+    # The path of the battery on the disk. Examples:
+    #  * /sys/class/power_supply/BAT1/
+    #  * /proc/acpi/battery/BAT0/
+    attr_accessor :path
+    
+    # Creates a new instance of this class.
+    # If a block is passed, it will be stored and yielded when the block is clicked.
+    def initialize(**args, &block)
+      args = {colors: {charging: '#6DBB45', discharging: '#F4C91D'},
+              formats: {charging: 'Bat(charge) %{capacity}%',
+                        default: 'Bat %{capacity}%'}}.merge(args)
+      super(args, &block)
+      
+      
+      @path = get_battery_path if path.nil?
+      path << '/' if path[-1] != '/'
+    end
+    
+    # Updates the text and color of this block.
+    def update
+      cap, st = capacity, state
+      
+      @full_text = formats[st] % {val: cap, capacity: cap, state: st}
+      @text_color = colors[st]
+    end
+    
+    # Returns the current state of the block
+    def state
+      return :no_battery unless File.exist? path
+      `cat #{path}status`.chomp.downcase.to_sym 
+    end
+    
+    # Returns the current capacity of the battery, or +nil+ if no battery found.
+    def capacity
+      return nil if state == :no_battery
+      `cat #{path}capacity`.chomp.to_i
+    end
+    
+    # Try to find a valid battery path.
+    def get_battery_path
+      base_paths = ["/proc/acpi/battery/", "/sys/class/power_supply/"]
+      base_paths.each do |p|
+        if Dir.exist? p
+          return p + (Dir.entries(p) - %w{ . .. }).last
+        end
+      end
+      
+    end
+  end
+end

data/lib/r3status/{shell_block.rb → blocks/shell.rb}

@@ -1,5 +1,5 @@
-module R3Status
-  class ShellBlock < StaticBlock
+module R3Status::Blocks    
+  class Shell < Base
     attr_accessor :command, :click_commands
     
     def initialize(**args, &block)
@@ -28,5 +28,6 @@ module R3Status
         `#{click_commands[button]}`
       end
     end
+    
   end
 end

data/lib/r3status/blocks/volume.rb

@@ -0,0 +1,83 @@
+module R3Status::Blocks
+  # A block that acts as a volume indicator.
+  # It displays the current Master Volume, and allows to user to change it using scrolling,
+  # and muting using the middle mouse button.
+  #
+  # ==== States
+  #   :muted, :unmuted
+  #
+  # ==== Format values
+  # +%{val}+, +%{volume}+: The current system volume.
+  class Volume < Base
+    # The amount of volume (in percents) to change with scroll.
+    attr_accessor :step
+    
+    # Creates a new instance of this class.
+    # If a block is passed, it will be stored and yielded when the block is clicked.
+    def initialize(**args, &block)
+      args = {formats: {muted: " %{volume}%", unmuted: " %{volume}%"},
+              colors: {muted: '#7CCdCD', unmuted: '#ffffff'}, step: 5,
+              name: "volume_master"}.merge(args)
+      
+      super(args, &block)
+    end
+    
+    # Updates the text and color of this block.
+    def update
+      vol = volume
+      muted = muted? ? :muted : :unmuted
+      @text_color = colors[muted]
+      @full_text = formats[muted] % {val: vol, volume: vol}
+    end
+    
+    # Handles mouse interaction with the block.
+    # If a block was supplied to the constructor, it will be yielded.
+    # button (Fixnum):: The mouse button that was used.
+    # x, y (Fixnum / Float):: The pointer coordinates on the screen.
+    def clicked(button, x, y)
+      super(button, x, y)
+      case button
+      when 4
+        increase
+      when 2
+        toggle_mute
+      when 5
+        decrease
+      end
+    end
+    
+    # Toggles the mute state of the system volume.
+    def toggle_mute
+      `amixer -q set Master toggle`
+    end
+    
+    # Increases the system volume by the given amount.
+    # step:: The amount of volume to increase. If +nil+, the value default value,
+    # or the one supplied in the constructor, will be used.
+    def increase(step = nil)
+      `amixer -c 0 set Master #{step || @step}%+ unmute`
+    end
+    
+    # Decreases the system volume by the given amount.
+    # step:: The amount of volume to decrease. If +nil+, the value default value,
+    # or the one supplied in the constructor, will be used.
+    def decrease(step = nil)
+      `amixer -c 0 set Master #{step || @step}%- unmute`
+    end
+    
+    # Returns the current system volume.
+    def volume
+      `amixer -c 0 get Master | grep Mono: | cut -d " " -f6 | tr -d [,],%`.to_i
+    end
+    
+    # Returns the mute state of the system volume.
+    def muted?
+      `amixer -c 0 get Master | grep Mono: | cut -d " " -f8 | tr -d [,]`.chomp == "off"
+    end
+    
+    # Returns the current state of the block
+    def state
+      muted? ? :muted : :unmuted
+    end
+  end
+end

data/lib/r3status/blocks.rb

@@ -1,15 +1,41 @@
-require_relative './block.rb'
+module R3Status; end
 
-require_relative './static_block.rb'
+require_relative './blocks/base.rb'
 
-require_relative './time_block.rb'
+require_relative './blocks/clock.rb'
 
-require_relative './volume_block.rb'
+require_relative './blocks/volume.rb'
 
-require_relative './battery_block.rb'
+require_relative './blocks/power.rb'
 
-require_relative './keyboard_layout_block.rb'
+require_relative './blocks/keyboard_layout.rb'
 
-require_relative './shell_block.rb'
+require_relative './blocks/shell.rb'
 
-require_relative './async_block.rb'
+require_relative './blocks/async.rb'
+
+module R3Status
+  # Alias for Blocks::Base
+  Block               = Blocks::Base
+  
+  # Alias for Blocks::Base
+  StaticBlock         = Blocks::Base
+  
+  # Alias for Blocks::Volume
+  VolumeBlock         = Blocks::Volume
+  
+  # Alias for Blocks::Clock
+  TimeBlock           = Blocks::Clock
+  
+  # Alias for Blocks::Power
+  BatteryBlock        = Blocks::Power
+  
+  # Alias for Blocks::KeyboardLayout
+  KeyboardLayoutBlock = Blocks::KeyboardLayout
+  
+  # Alias for Blocks::Async
+  AsyncBlock          = Blocks::Async
+  
+  # Alias for Blocks::Shell
+  ShellBlock          = Blocks::Shell
+end

data/lib/r3status.rb

@@ -2,7 +2,11 @@ require_relative './r3status/blocks.rb'
 require 'json'
 
 module R3Status
-
+  # Specifies the mouse buttons and their IDs.
+  MOUSE_BUTTONS = {primary: 1, middle: 2, secondary: 3, scroll_up: 4, scroll_down: 5}
+  
+  # Loops over the given block at the specified interval.
+  # The interval is the time between yields, not between a yield's ends the next's start.
   def loop_with_interval secs
     loop do
       start = Time.now
@@ -11,10 +15,27 @@ module R3Status
       sleep(interval) if interval > 0
     end
   end
-
+  
+  # This class encapsulates a status output.
+  # Blocks are added by the user and are displayed each iteration.
+  # ==== Example
+  #   s = StatusLine.new
+  #   s = StatusLine.new update_interval: 3
+  #
+  #   s << Blocks::Volume.new
+  #   
+  #   s.run
   class StatusLine
-    attr_reader :blocks, :prefix, :postfix, :update_interval
+    # A list blocks to display, right to left, in the bar.
+    attr_reader :blocks
+    # An object (e.g. _String_) that will be inserted at the start of a block's text. Default: _" "_.
+    attr_accessor :prefix
+    # An object (e.g. _String_)that will be inserted at the ebd of a block's text. Default: _nil_.
+    attr_accessor :postfix 
+    # The time (in seconds) between iterations. Default: _0.4_.
+    attr_accessor :update_interval
     
+    # Creates a new StatusLine object.
     def initialize(prefix: " ", postfix: nil, update_interval: 0.4)
       @blocks = []
       @prefix = prefix
@@ -22,41 +43,20 @@ module R3Status
       @update_interval = update_interval
     end
     
+    # Appends a new block to this StatusLine object.
     def << block
       @blocks << block
     end
     
-    def transmission
-      @blocks.map { |i| i.to_s(postfix: @postfix, prefix: @prefix) }.
-              reject { |i| i.nil? }.inject { |i, j| i << ",#{j}"}
-    end
-    
-    def parse str
-      return if str.length < 2
-      obj = nil
-      str = str.strip.sub(/\A\,/ , "")
-      
-      begin
-        obj = JSON.parse(str)
-      rescue Exception => e
-        return
-      end
-      
-      block = @blocks.find { |b| b.name == obj["name"] }
-      block.clicked(obj["button"], obj["x"], obj["y"]) unless block.nil?
-    end
-    
+    # Starts the operation of the status line and the output of the data to the standard output.
     def run
       @reader_thread = Thread.new do
-        begin
         loop do
           s = gets.chomp
           parse s
         end
-        rescue Exception => e
-          File.open("log.txt", 'a') {|f| f.puts e.backtrace }
-        end
-      end.run
+      end
+      @reader_thread.run
       
       at_exit do
         @reader_thread.kill
@@ -70,5 +70,29 @@ module R3Status
       end
       
     end
+    
+    private
+    # Generates a single transmission.
+    def transmission
+      @blocks.map { |i| i.to_s(postfix: @postfix, prefix: 
+      @prefix) }.
+              reject { |i| i.nil? }.inject { |i, j| i << ",#{j}"}
+    end
+    
+    # Parses a single input from i3bar.
+    def parse(str)
+      return if str.length < 2
+      obj = nil
+      str = str.strip.sub(/\A\,/ , "")
+      
+      begin
+        obj = JSON.parse(str)
+      rescue Exception => e
+        return
+      end
+      
+      block = @blocks.find { |b| b.name == obj["name"] }
+      block.clicked(obj["button"], obj["x"], obj["y"]) unless block.nil?
+    end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: r3status
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Gilad Naaman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
-dependencies: []
+date: 2014-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: r3status is ruby implmentation of the i3bar protocol, and is an alternative
   to the default i3status.
 email: gilad.doom@gmail.com
@@ -18,15 +32,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/r3status.rb
-- lib/r3status/async_block.rb
-- lib/r3status/battery_block.rb
-- lib/r3status/block.rb
 - lib/r3status/blocks.rb
-- lib/r3status/keyboard_layout_block.rb
-- lib/r3status/shell_block.rb
-- lib/r3status/static_block.rb
-- lib/r3status/time_block.rb
-- lib/r3status/volume_block.rb
+- lib/r3status/blocks/async.rb
+- lib/r3status/blocks/base.rb
+- lib/r3status/blocks/clock.rb
+- lib/r3status/blocks/keyboard_layout.rb
+- lib/r3status/blocks/power.rb
+- lib/r3status/blocks/shell.rb
+- lib/r3status/blocks/volume.rb
 homepage: https://github.com/Gilnaa/R3Status
 licenses:
 - LGPL3

data/lib/r3status/async_block.rb

@@ -1,24 +0,0 @@
-module R3Status
-  class AsyncBlock < Block
-    attr_accessor :update_interval, :updater_thread
-    
-    def initialize(**args)
-      args = {update_interval: 3}.merge(args)
-      super(args)
-    end
-    
-    def update
-      @full_text
-      return if @updater_pid.is_a? Fixnum
-      @updater_thread = Thread.new do
-        loop_with_interval(update_interval) { async_update }
-      end
-    end
-    
-    def terminate
-      @updater_thread.kill
-    end
-    
-    def async_update; end
-  end
-end

data/lib/r3status/battery_block.rb

@@ -1,23 +0,0 @@
-module R3Status
-  class BatteryBlock < Block
-    attr_accessor :path
-    
-    def initialize(**args)
-      args = {colors: {charging: '#6DBB45', discharging: '#F4C91D'},
-              formats: {charging: 'Bat(charge) %{capacity}%',
-                        default: 'Bat %{capacity}%'}}.merge(args)
-      super(args)
-    end
-    
-    def update
-      cap, st = capacity, status
-      
-      @full_text = formats[st] % {val: cap, capacity: cap, status: st}
-      @text_color = colors[st]
-    end
-    
-    private
-    def status; `cat #{path}status`.chomp.downcase.to_sym end
-    def capacity; `cat #{path}capacity`.chomp end
-  end
-end

data/lib/r3status/block.rb

@@ -1,37 +0,0 @@
-module R3Status
-  class Block
-    DEFAULT_COLOR = '#ffffff'
-    DEFAULT_FORMAT = '%{val}'
-    
-    attr_accessor :full_text, :text_color, :name, :formats, :colors
-    
-    def initialize(**args)
-      self.colors ||= {}
-      self.formats ||= Hash.new(DEFAULT_FORMAT)
-      args.each do |k, v|
-        v.default = v[:default] if (v.is_a? Hash) && (v.key? :default)
-        send "#{k}=", v
-      end
-    end
-    
-    def update; end
-     
-    def terminate; end
-     
-    def clicked(button, x, y); end
-    
-    def to_s(prefix: nil, postfix: nil)
-      %({"full_text": "#{prefix}#{full_text}#{postfix}", 
-          "color": "#{text_color || DEFAULT_COLOR}", "name": "#{name}",
-          "separator": false})
-    end
-    
-    def format
-      formats.default 
-    end
-    
-    def format=(fmt)
-      @formats.default = fmt 
-    end
-  end
-end

data/lib/r3status/keyboard_layout_block.rb

@@ -1,17 +0,0 @@
-module R3Status
-  class KeyboardLayoutBlock < Block
-    def initialize(**args)
-      super(args)
-    end
-    
-    def update
-      sym = language_symbol
-      @full_text = formats[sym] % {val: sym, sym: sym}
-      @text_color = colors[sym]
-    end
-    
-    def language_symbol
-      `xkblayout-state print %s`.chomp.to_sym
-    end
-  end
-end

data/lib/r3status/static_block.rb

@@ -1,22 +0,0 @@
-require 'securerandom'
-
-module R3Status
-  class StaticBlock < Block
-    attr_accessor :clicked_block
-    
-    def initialize(**args, &block)
-      @clicked_block = block
-      
-      super(args)
-      
-      @full_text ||= format
-      @name ||= SecureRandom.uuid
-    end
-    
-    def clicked(button, x, y)
-      return if @clicked_block.nil?
-      args = [self, button, x, y].take(@clicked_block.arity)
-      @clicked_block.(*args)
-    end
-  end
-end

data/lib/r3status/time_block.rb

@@ -1,13 +0,0 @@
-module R3Status
-  class TimeBlock < Block
-    
-    def initialize(**args)
-      args = {format: "%H:%m @ %e/%M/%Y"}.merge(args)
-      super(args)
-    end
-    
-    def update
-      self.full_text = Time.now.strftime(format)
-    end
-  end
-end

data/lib/r3status/volume_block.rb

@@ -1,48 +0,0 @@
-module R3Status
-  class VolumeBlock < Block
-    attr_accessor :step
-    
-    def initialize(**args)
-      args = {formats: {muted: " %{volume}%", unmuted: " %{volume}%"},
-              colors: {muted: '#7CCdCD', unmuted: '#ffffff'}, step: 5,
-              name: "volume_master"}.merge(args)
-      
-      super(args)
-    end
-    
-    def update
-      vol = volume
-      muted = muted? ? :muted : :unmuted
-      @text_color = colors[muted]
-      @full_text = formats[muted] % {val: vol, volume: vol}
-    end
-    
-    def clicked button, x, y
-      case button
-      when 4
-        increase
-      when 2
-        toggle_mute
-      when 5
-        decrease
-      end
-    end
-    
-    private
-    def toggle_mute
-      `amixer -q set Master toggle`
-    end
-    def increase
-      `amixer -c 0 set Master #{step}%+ unmute`
-    end
-    def decrease
-      `amixer -c 0 set Master #{step}%- unmute`
-    end
-    def volume
-      `amixer -c 0 get Master | grep Mono: | cut -d " " -f6 | tr -d [,],%`.to_i
-    end
-    def muted?
-      `amixer -c 0 get Master | grep Mono: | cut -d " " -f8 | tr -d [,]`.chomp == "off"
-    end
-  end
-end