linux-kstat 0.1.0

data/CHANGES

@@ -0,0 +1,2 @@
+= 0.1.0 - 10-Feb-2011
+* Initial release

data/MANIFEST

@@ -0,0 +1,7 @@
+* CHANGES
+* README
+* MANIFEST
+* Rakefile
+* linux-kstat.gemspec
+* lib/linux/kstat.rb
+* test/test_linux_kstat.rb

data/README

@@ -0,0 +1,43 @@
+= Description
+  A Ruby library for gathering Linux kernel statistics out of /proc/stat.
+
+= Installation
+  gem install linux-kstat
+
+= Synopsis
+  require 'linux/kstat'
+
+  kstat = Linux::Kstat.new
+
+  p kstat[:cpu]
+  p kstat[:procs_running]
+
+= Details
+  The values for most of the keys are a single numeric value. However, in the
+  case of "cpu" keys, the result is a 7 element hash of numeric values. In
+  the case of the "intr" key, the value is an array containing the list of
+  interrupts.
+
+= Information about /proc/stat
+  See http://www.linuxhowtos.org/System/procstat.htm for more information
+  about the meaning of each of the fields.
+
+= Known Bugs
+  None known. Please report any bugs on the github project page.
+
+  http://www.github.com/djberg96/linux-kstat
+
+= License
+  Artistic 2.0
+
+= Copyright
+  (C) 2003-2011 Daniel J. Berger
+  All Rights Reserved.`
+
+= Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+
+= Author
+  Daniel J. Berger

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include('**/*.gem', '**/*.rbc')
+
+namespace :gem do
+  desc 'Build the linux-kstat gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('linux-kstat.gemspec'))
+    Gem::Builder.new(spec).build
+  end
+
+  desc "Install the linux-kstat gem"
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install #{file}"
+  end
+end
+
+Rake::TestTask.new do |t|
+  task :test => :clean
+  t.warning = true
+  t.verbose = true
+end
+
+task :default => :test

data/lib/linux/kstat.rb

@@ -0,0 +1,76 @@
+require 'forwardable'
+
+# The Linux module serves as a namespace only.
+module Linux
+  # The Kstat class encapsulates Linux kernel statistics derived from /proc/stat.
+  class Kstat
+    extend Forwardable
+
+    # The version of the linux-kstat library
+    VERSION = '0.1.0'
+
+    # :stopdoc:
+
+    # Delegate the the [] and inspect methods to the @hash variable
+    def_delegator(:@hash, :[])
+    def_delegator(:@hash, :inspect)
+
+    # :startdoc:
+
+    # Create a new Linux::Kstat instance. You can access the information
+    # stored in this object the same way you would access a hash key. Note
+    # that all keys are symbols.
+    #
+    # Example:
+    #
+    #   kstat = Linux::Kstat.new
+    #
+    #   kstat[:cpu] => {
+    #     :idle     => 250713454,
+    #     :iowait   => 2745691,
+    #     :irq      => 39717,
+    #     :softirq  => 31323,
+    #     :system   => 1881655,
+    #     :nice     => 117158,
+    #     :user     => 7137418
+    #   }
+    #
+    #   kstat[:processes] # => 1299560
+    #
+    def initialize
+      @hash = get_proc_stat_info
+    end
+
+    private
+
+    # Parse the information out of /proc/stat and assign keys and values to
+    # a hash that can be accessed via the Forwardable module.
+    #
+    def get_proc_stat_info
+      hash = {}
+
+      IO.readlines('/proc/stat').each{ |line|
+        info = line.split
+        if info.first =~ /^cpu/i
+          hash[info.first.to_sym] = {
+            :user    => info[1].to_i,
+            :nice    => info[2].to_i,
+            :system  => info[3].to_i,
+            :idle    => info[4].to_i,
+            :iowait  => info[5].to_i,
+            :irq     => info[6].to_i,
+            :softirq => info[7].to_i
+          }
+        else
+          if info.size > 2
+            hash[info.first.to_sym] = info[1..-1].map{ |e| e.to_i }
+          else
+            hash[info.first.to_sym] = info[1].to_i
+          end
+        end
+      }
+
+      hash
+    end
+  end
+end

data/linux-kstat.gemspec

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rbconfig'
+
+Gem::Specification.new do |gem|
+  gem.name       = 'linux-kstat'
+  gem.version    = '0.1.0'
+  gem.license    = 'Artistic 2.0'
+  gem.author     = 'Daniel J. Berger'
+  gem.email      = 'djberg96@gmail.com'
+  gem.homepage   = 'http://www.rubyforge.org/projects/shards'
+  gem.summary    = 'Ruby interface for Linux kernel stats in /proc/stat'
+  gem.test_files = Dir['test/test*']
+  gem.has_rdoc   = true
+  gem.files      = Dir['**/*'].reject{ |f| f.include?('git') }
+
+  gem.rubyforge_project = 'shards'
+  gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+
+  gem.description = <<-EOF
+    The linux-kstat library provides a hash style interface for reading
+    Linux kernel statistics read out of /proc/stat.
+  EOF
+
+  gem.add_development_dependency('test-unit', '>= 2.1.2')
+end

data/test/test_linux_kstat.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'linux/kstat'
+
+class TC_Linux_Kstat < Test::Unit::TestCase
+  def setup
+    @kstat = Linux::Kstat.new
+  end
+
+  test "version constant is set to the expected value" do
+    assert_equal('0.1.0', Linux::Kstat::VERSION)
+  end
+
+  test "kstat object can be accessed like a hash" do
+    assert_respond_to(@kstat, :[])
+    assert_nothing_raised{ @kstat[:cpu] }
+  end
+
+  test "kstat object contains expected keys" do
+    assert_kind_of(Hash, @kstat[:cpu])
+    assert_kind_of(Numeric, @kstat[:btime])
+    assert_kind_of(Array, @kstat[:intr])
+  end
+
+  test "values cannot be assigned to keys" do
+    assert_raise(NoMethodError){ @kstat[:cpu] = 'test' }
+  end
+
+  def teardown
+    @kstat = nil
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: linux-kstat
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :development
+  version_requirements: *id001
+description: "    The linux-kstat library provides a hash style interface for reading\n    Linux kernel statistics read out of /proc/stat.\n"
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
+files: 
+- Rakefile
+- README
+- lib/linux/kstat.rb
+- CHANGES
+- test/test_linux_kstat.rb
+- MANIFEST
+- linux-kstat.gemspec
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/shards
+licenses: 
+- Artistic 2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: shards
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby interface for Linux kernel stats in /proc/stat
+test_files: 
+- test/test_linux_kstat.rb