librrd 0.2.0 → 1.0.0

data/README.md

@@ -17,6 +17,8 @@ The following systems, RRDtool versions and Ruby versions  have been tested.
   * Ruby 1.9.2p0, 1.8.7p302
   * Rubinius 1.1.0
   * ruby-enterpriseedition 1.8.7 2010.02
+* CentOS 5.5 (RRDtool 1.2.27)
+  * ruby-enterpriseedition 1.8.6 20090610
 * OpenBSD 4.8 (RRDtool 1.2.30)
   * Ruby 1.9.2p0, 1.8.7p302
 
@@ -25,7 +27,18 @@ The following systems, RRDtool versions and Ruby versions  have been tested.
 Make sure you have the development package of `librrd` installed.
 (like `librrd-dev` on Debian/Ubuntu) Then you can just `gem install`.
 
-        gem install librrd
+    gem install librrd
+
+# Developing
+
+Build the C extension:
+
+    ruby ext/librrd/extconf.rb
+    make
+
+Run the tests:
+
+    rake test
 
 # Contribute
 

data/Rakefile

@@ -46,7 +46,20 @@ end
 #
 #############################################################################
 
-task :default => :gemspec
+task :default => :test
+
+require 'rake/testtask'
+task :test => :build_rrd
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false
+end
+
+desc "Built the RRD.so"
+task :build_rrd do
+  sh "ruby ext/librrd/extconf.rb && make"
+end
 
 #############################################################################
 #

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/lib/librrd.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'RRD'
+
+LibRRD = RRD

data/librrd.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'librrd'
-  s.version           = '0.2.0'
-  s.date              = '2010-10-06'
+  s.version           = '1.0.0'
+  s.date              = '2011-01-15'
 
   s.summary     = "Ruby bindings for librrd"
   s.description = "Ruby bindings for librrd. Extracted from the RRDtool source."
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
 
   ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
   ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
-  s.require_paths = %w[ext]
+  s.require_paths = %w[ext lib]
 
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.md CHANGES.md]
@@ -41,8 +41,10 @@ Gem::Specification.new do |s|
     ext/librrd/1.3/main.c
     ext/librrd/1.4/main.c
     ext/librrd/extconf.rb
+    lib/librrd.rb
     librrd.gemspec
-    test.rb
+    test/test_librrd.rb
+    test/test_rrd.rb
   ]
   # = MANIFEST =
 

data/test/test_librrd.rb

@@ -0,0 +1,20 @@
+require 'test/unit'
+require 'librrd'
+
+class TestLibRRD < Test::Unit::TestCase
+  # RubyGems users expect when they install a gem that:
+  #
+  #   "gem name" == "name they require" == "name of object in global namespace".
+  #
+  # Alias RRD to LibRRD, so backwards compatibility is retained, but RubyGems
+  # users aren't surprised.
+  #
+
+  def test_constant_defined
+    assert(Object.const_defined?(:"LibRRD"))
+  end
+
+  def test_rrd_methods_defined
+    assert(%w(fetch dump graph update).all? {|m| LibRRD.methods.include?(m) })
+  end
+end

data/test/test_rrd.rb

@@ -0,0 +1,79 @@
+require 'test/unit'
+require 'time'
+require 'RRD'
+
+class TestRRD < Test::Unit::TestCase
+  def setup
+    @rrd_file   = 'test.rrd'
+    @png_file   = "#{File.basename(@rrd_file, '.rrd')}.png"
+    @start_time = Time.parse('2011-01-15').to_i
+    @end_time   = @start_time + 300 * 300
+  end
+
+  def teardown
+    File.unlink(@rrd_file) if File.exist?(@rrd_file)
+    File.unlink(@png_file) if File.exist?(@png_file)
+  end
+
+  def test_rrd_manipulation
+    assert_nothing_raised do
+      RRD.create(
+        @rrd_file,
+        "--start", "#{@start_time - 1}",
+        "--step", "300",
+        "DS:a:GAUGE:600:U:U",
+        "DS:b:GAUGE:600:U:U",
+        "RRA:AVERAGE:0.5:1:300"
+      )
+    end
+
+    assert_nothing_raised do
+      @start_time.step(@end_time, 300) do |i|
+        RRD.update(@rrd_file, "#{i}:#{rand(100)}:#{Math.sin(i / 800) * 50 + 50}")
+      end
+    end
+
+
+    (fstart, fend, data) = RRD.fetch(@rrd_file, "--start", @start_time.to_s, "--end",
+                                     @end_time.to_s, "AVERAGE")
+
+    assert_equal(1295046000, fstart)
+    assert_equal(1295136300, fend)
+    assert_equal(['a', 'b'], data)
+
+    assert_nothing_raised do
+      RRD.graph(
+        @png_file,
+        "--title", " RubyRRD Demo",
+        "--start", "#{@start_time + 3600}",
+        "--end", "start + 1000 min",
+        "--interlace",
+        "--imgformat", "PNG",
+        "--width=450",
+        "DEF:a=#{@rrd_file}:a:AVERAGE",
+        "DEF:b=#{@rrd_file}:b:AVERAGE",
+        "CDEF:line=TIME,2400,%,300,LT,a,UNKN,IF",
+        "AREA:b#00b6e4:beta",
+        "AREA:line#0022e9:alpha",
+        "LINE3:line#ff0000"
+      )
+    end
+    assert(File.exist?(@png_file))
+
+    assert_equal(@end_time, RRD.last(@rrd_file).to_i)
+
+    if RRD.respond_to?(:xport)
+      assert_nothing_raised do
+        fstart, fend, step, col, legend, data = RRD.xport(
+          "--start", start_time.to_s,
+          "--end", (start_time + 300 * 300).to_s,
+          "--step", 10.to_s,
+          "DEF:A=#{rrd}:a:AVERAGE",
+          "DEF:B=#{rrd}:b:AVERAGE",
+          "XPORT:A:a",
+          "XPORT:B:b"
+        )
+      end
+    end
+  end
+end

metadata

@@ -2,12 +2,12 @@
 name: librrd
 version: !ruby/object:Gem::Version 
   hash: 23
-  prerelease: false
+  prerelease: 
   segments: 
+  - 1
   - 0
-  - 2
   - 0
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Bernd Ahlers
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 +02:00
+date: 2011-01-15 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -43,8 +43,10 @@ files:
 - ext/librrd/1.3/main.c
 - ext/librrd/1.4/main.c
 - ext/librrd/extconf.rb
+- lib/librrd.rb
 - librrd.gemspec
-- test.rb
+- test/test_librrd.rb
+- test/test_rrd.rb
 has_rdoc: true
 homepage: http://github.com/bernd/librrd-ruby
 licenses: []
@@ -54,6 +56,7 @@ rdoc_options:
 - --charset=UTF-8
 require_paths: 
 - ext
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -75,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 2
 summary: Ruby bindings for librrd

data/test.rb

@@ -1,76 +0,0 @@
-#!/usr/bin/env ruby
-# $Id: test.rb,v 1.2 2002/10/22 17:34:00 miles Exp $
-# Driver does not carry cash.
-
-$: << '/scratch/rrd12build/lib/ruby/1.8/i386-linux/'
-
-require "RRD"
-
-name = "test"
-rrd = "#{name}.rrd"
-start_time = Time.now.to_i
-end_time = start_time.to_i + 300 * 300
-
-puts "creating #{rrd}"
-RRD.create(
-    rrd,
-    "--start", "#{start_time - 1}",
-    "--step", "300",
-	"DS:a:GAUGE:600:U:U",
-    "DS:b:GAUGE:600:U:U",
-    "RRA:AVERAGE:0.5:1:300")
-puts
-
-puts "updating #{rrd}"
-start_time.step(end_time, 300) { |i|
-    RRD.update(rrd, "#{i}:#{rand(100)}:#{Math.sin(i / 800) * 50 + 50}")
-}
-puts
-
-puts "fetching data from #{rrd}"
-(fstart, fend, data) = RRD.fetch(rrd, "--start", start_time.to_s, "--end", end_time.to_s, "AVERAGE")
-puts "got #{data.length} data points from #{fstart} to #{fend}"
-puts
-
-puts "generating graph #{name}.png"
-RRD.graph(
-   "#{name}.png",
-    "--title", " RubyRRD Demo", 
-    "--start", "#{start_time+3600}",
-    "--end", "start + 1000 min",
-    "--interlace", 
-    "--imgformat", "PNG",
-    "--width=450",
-    "DEF:a=#{rrd}:a:AVERAGE",
-    "DEF:b=#{rrd}:b:AVERAGE",
-    "CDEF:line=TIME,2400,%,300,LT,a,UNKN,IF",
-    "AREA:b#00b6e4:beta",
-    "AREA:line#0022e9:alpha",
-    "LINE3:line#ff0000")
-puts
-
-# last method test
-if end_time != RRD.last("#{rrd}").to_i
-    puts "last method expects #{Time.at(end_time)}."
-    puts "                But #{RRD.last("#{rrd}")} returns."
-end
-puts
-
-# xport method test
-if RRD.respond_to?(:xport)
-  puts "xporting data from #{rrd}"
-  (fstart,fend,step,col,legend,data)=RRD.xport(
-    "--start", start_time.to_s, 
-    "--end", (start_time + 300 * 300).to_s, 
-    "--step", 10.to_s, 
-    "DEF:A=#{rrd}:a:AVERAGE",
-    "DEF:B=#{rrd}:b:AVERAGE",
-    "XPORT:A:a",
-    "XPORT:B:b")
-  puts "Xported #{col} columns(#{legend.join(", ")}) with #{data.length} rows from #{fstart} to #{fend} and step #{step}\n"
-else
-  puts "Skipping xport test, method not available."
-end
-
-print "This script has created #{name}.png in the current directory\n";
-print "This demonstrates the use of the TIME and % RPN operators\n";