dag-amazing 0.1

data/lib/amazing/options.rb

@@ -0,0 +1,93 @@
+# Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'optparse'
+
+module Amazing
+
+  # Parse and manage command line options
+  class Options < Hash
+    def initialize(args=ARGV)
+      @args = args
+      initialize_defaults
+      initialize_parser
+    end
+
+    def parse(args=@args)
+      @parser.parse!(args)
+    end
+
+    def help
+      @parser.help
+    end
+
+    private
+
+    def initialize_defaults
+      self[:config] = Dir["#{ENV["HOME"]}/.amazing/config.{rb,yml,yaml}"][0]
+      self[:loglevel] = "info"
+      self[:include] = []
+      self[:autoinclude] = true
+      self[:update] = []
+    end
+
+    def initialize_parser
+      @parser = OptionParser.new do |opts|
+        opts.on("-c", "--config FILE", "Configuration file (~/.amazing/config.{rb,yml,yaml})") do |config|
+          self[:config] = config
+        end
+
+        opts.on("-g", "--scaffold [AWESOMERC]", "Generate a scaffold config") do |awesomerc|
+          self[:scaffold] = awesomerc || File.expand_path("~/.awesomerc")
+        end
+
+        opts.on("-l", "--log-level LEVEL", "Severity threshold (info)") do |level|
+          self[:loglevel] = level
+        end
+
+        opts.on("-s", "--stop", "Stop the running amazing process") do
+          self[:stop] = true
+        end
+
+        opts.on("-i", "--include SCRIPT", "Include a widgets script") do |script|
+          self[:include] << script
+        end
+
+        opts.on("--no-auto-include", "Don't auto include from ~/.amazing/widgets/") do
+          self[:autoinclude] = false
+        end
+
+        opts.on("-u", "--update [WIDGET]", "Update a widget and exit") do |widget|
+          if widget
+            self[:update] << widget
+          else
+            self[:update] = :all
+          end
+        end
+
+        opts.on("-w", "--list-widgets [WIDGET]", "List available widgets or options and fields for a widget") do |widget|
+          self[:listwidgets] = widget || true
+        end
+
+        opts.on("-t", "--test-widget WIDGET [OPTIONS]", "Dump field values for a widget configured with inline YAML") do |widget|
+          self[:test] = widget
+        end
+
+        opts.on("-h", "--help", "You're looking at it") do
+          self[:help] = true
+        end
+      end
+    end
+  end
+end

data/lib/amazing/proc_file.rb

@@ -0,0 +1,59 @@
+# Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Amazing
+
+  # Parse a /proc file
+  #
+  #   cpuinfo = ProcFile.parse_file("cpuinfo")
+  #   cpuinfo[1]["model name"]
+  #   #=> "AMD Turion(tm) 64 X2 Mobile Technology TL-50"
+  class ProcFile
+    include Enumerable
+
+    def self.parse_file(file)
+      file = File.expand_path(file, "/proc")
+      new(File.new(file))
+    end
+
+    def initialize(string_or_io)
+      case string_or_io
+      when String
+        content = string_or_io
+      when IO
+        content = string_or_io.read
+        string_or_io.close
+      end
+      @list = [{}]
+      content.each_line do |line|
+        if sep = line.index(":")
+          @list[-1][line[0..sep-1].strip] = line[sep+1..-1].strip
+        else
+          @list << {}
+        end
+      end
+      @list.pop if @list[-1].empty?
+    end
+
+    def each
+      @list.each do |section|
+        yield section
+      end
+    end
+
+    def [](section)
+      @list[section]
+    end
+  end
+end

data/lib/amazing/string.rb

@@ -0,0 +1,19 @@
+# Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class String
+  def camel_case
+    split(/[\s_-]/).map {|t| t[0].chr.upcase + t[1..-1] unless t.empty? }.join
+  end
+end

data/lib/amazing/widget.rb

@@ -0,0 +1,140 @@
+# Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'amazing/helpers/pango_markup'
+require 'erb'
+
+module Amazing
+
+  # Raised by widgets, and is then rescued and logged
+  class WidgetError < Exception
+  end
+
+  # Parent class for widget construction, example:
+  #
+  #   class Clock < Widget
+  #     description "Displays date and time"
+  #     dependency "some/library", "how to get the library (url, gem name...)"
+  #     option :time_format, "Time format as described in DATE(1)", "%R"
+  #     field :time, "Formatted time"
+  #     default "@time"
+  # 
+  #     init do
+  #       @time = Time.now.strftime(@time_format)
+  #       raise WidgetError, "An error occured!" if some_error?
+  #     end
+  #   end
+  class Widget
+    include Helpers::PangoMarkup
+    include ERB::Util
+
+    def initialize(opts={})
+      self.class.dependencies.each do |name, description|
+        begin
+          require name
+        rescue LoadError
+          raise WidgetError, "Missing dependency #{name.inspect}#{if description then " [#{description}]" end}"
+        end
+      end
+      self.class.options.each do |key, value|
+        instance_variable_set "@#{key}".to_sym, value[:default]
+      end
+      opts.each do |key, value|
+        instance_variable_set "@#{key}".to_sym, value
+      end
+      self.class.fields.each do |key, value|
+        instance_variable_set "@#{key}".to_sym, value[:default]
+      end
+      self.class.init.each do |block|
+        instance_eval(&block)
+      end
+      @default = case self.class.default
+      when Proc
+        instance_eval(&self.class.default)
+      when String
+        instance_eval(self.class.default)
+      end
+    end
+
+    def self.description(description=nil)
+      if description
+        @description = description
+      else
+        @description
+      end
+    end
+
+    def self.dependency(name, description=nil)
+      @dependencies ||= {}
+      @dependencies[name] = description
+    end
+
+    def self.dependencies
+      @dependencies || {}
+    end
+
+    def self.option(name, description=nil, default=nil)
+      @options ||= {}
+      @options[name] = {:description => description, :default => default}
+    end
+
+    def self.options
+      @options || {}
+    end
+
+    def self.field(name, description=nil, default=nil)
+      @fields ||= {}
+      @fields[name] = {:description => description, :default => default}
+    end
+
+    def self.fields
+      @fields || {}
+    end
+
+    def self.default(format=nil, &block) # :yields:
+      if format
+        @default = format
+      elsif block
+        @default = block
+      else
+        @default
+      end
+    end
+
+    def self.init(&block) # :yields:
+      if block
+        @init ||= []
+        @init << block
+      else
+        @init
+      end
+    end
+
+    def formatize(format=nil)
+      ERB.new(case format
+      when Proc
+        instance_eval(&format)
+      when String
+        instance_eval(format)
+      else
+        case self.class.default
+        when Proc
+          instance_eval(&self.class.default)
+        when String
+          instance_eval(self.class.default)
+        end
+      end.to_s).result(binding())
+    end
+  end
+end

data/lib/amazing/widgets.rb

@@ -0,0 +1,37 @@
+# Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'amazing/widgets/ac_adapter'
+require 'amazing/widgets/alsa'
+require 'amazing/widgets/battery'
+require 'amazing/widgets/clock'
+require 'amazing/widgets/cpu_info'
+require 'amazing/widgets/cpu_usage'
+require 'amazing/widgets/file'
+require 'amazing/widgets/file_system'
+require 'amazing/widgets/gmail'
+require 'amazing/widgets/maildir'
+require 'amazing/widgets/memory'
+require 'amazing/widgets/moc'
+require 'amazing/widgets/mpd'
+require 'amazing/widgets/net_traffic'
+require 'amazing/widgets/noop'
+require 'amazing/widgets/pacman'
+require 'amazing/widgets/raggle'
+require 'amazing/widgets/sup'
+
+module Amazing
+  module Widgets
+  end
+end

data/lib/amazing/widgets/ac_adapter.rb

@@ -0,0 +1,31 @@
+# Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'amazing/widget'
+require 'amazing/proc_file'
+
+module Amazing
+  module Widgets
+    class AcAdapter < Widget
+      description "AC adapter status"
+      field :online, "Online status"
+      default { @online ? "online" : "offline" }
+
+      init do
+        state = ProcFile.parse_file(Dir["/proc/acpi/ac_adapter/*/state"][0])[0]["state"]
+        @online = {"on-line" => true, "off-line" => false}[state]
+      end
+    end
+  end
+end

data/lib/amazing/widgets/alsa.rb

@@ -0,0 +1,35 @@
+# Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'amazing/widget'
+
+module Amazing
+  module Widgets
+    class Alsa < Widget
+      description "Various data for the ALSA mixer"
+      option :mixer, "ALSA mixer name", "Master"
+      field :volume, "Volume in percentage", 0
+      default { @volume }
+
+      init do
+        IO.popen("amixer get #@mixer", IO::RDONLY) do |am|
+          out = am.read
+          volumes = out.scan(/\[(\d+)%\]/).flatten
+          volumes.each {|vol| @volume += vol.to_i }
+          @volume = @volume / volumes.size
+        end
+      end
+    end
+  end
+end

data/lib/amazing/widgets/battery.rb

@@ -0,0 +1,51 @@
+# Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'amazing/widget'
+require 'amazing/proc_file'
+
+module Amazing
+  module Widgets
+    class Battery < Widget
+      description "Remaining battery power in percentage"
+      option :battery, "Battery number", 1
+      field :state, "Charging state, :charged, :charging or :discharging"
+      field :percentage, "Power percentage"
+      default { @percentage.to_i }
+
+      init do
+        batinfo = ProcFile.parse_file("acpi/battery/BAT#@battery/info")[0]
+        batstate = ProcFile.parse_file("acpi/battery/BAT#@battery/state")[0]
+        remaining = batstate["remaining capacity"].to_i
+        lastfull = batinfo["last full capacity"].to_i
+        @state = batstate["charging state"].to_sym
+        @percentage = (remaining * 100) / lastfull.to_f
+      end
+    end
+
+    private
+
+    def charged?
+      @state == :charged
+    end
+
+    def charging?
+      @state == :charging
+    end
+
+    def discharging?
+      @state == :discharging
+    end
+  end
+end