device_space_left 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+0.1.0 (September 09, 2010)
+
+* First release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,15 @@
+= DeviceSpaceLeft
+
+Small ruby gem/plugin giving you the ability to retrieve easily the space available on your devices.
+
+== Usage
+
+* DeviseSpaceLeft.percent_used('/home')
+* DeviseSpaceLeft.percent_free('/dev/md2')
+* DeviseSpaceLeft.space_available('/dev/md2')
+* DeviseSpaceLeft.space_used('/dev/md2')
+* DeviseSpaceLeft.size('/dev/md2')
+
+Tested on Ubuntu and OsX
+
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano, released under the MIT license

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+
+desc "Run specs for current Rails version"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = lambda {
+    ["-c --format specdoc"]
+  }
+end
+
+task :default => :spec

data/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'device_space_left'

data/lib/device_space_left.rb

@@ -0,0 +1,112 @@
+module DeviceSpaceLeft
+
+private
+  
+  # Return the df linux command output
+  def self.df
+    `df`
+  end
+
+  def self.parse_df_size(size)
+    return size if !(String === size)
+    
+    return (size.to_f * 1024 * 1024 * 1024 * 1024).to_i if size.index('T')
+    return (size.to_f * 1024 * 1024 * 1024).to_i if size.index('G')
+    return (size.to_f * 1024 * 1024).to_i if size.index('M')
+    return (size.to_f * 1024).to_i if size.index('K')
+    return (size.to_i) if size.index('B')
+
+    size.to_i
+  end
+  
+  # Return a df infos line corresponding to the filesystem name or to the mount point
+  def self.find_df_infos(mount_name)
+    h = df_hashed
+    return h[mount_name.to_sym] if h[mount_name.to_sym]
+
+    h.each_value do |v|
+      return v if v[:filesystem] == mount_name.to_s
+    end
+
+    return nil
+  end
+
+  # Return a value or a max looking through the df hash
+  def self.find_value_or_max(value_name, mount_name = nil, max_meth = :max)
+    h = df_hashed
+    
+    if mount_name
+      t = find_df_infos(mount_name)
+      return t[value_name] if t
+    end
+
+    max = []
+    h.each_value do |v|
+      max << v[value_name]
+    end
+    
+    if max_meth == :sum and max
+      total = 0
+      max.each { |v| total += v }
+      return total
+    end
+    
+    max.send(max_meth) || 0
+  end
+
+public
+  
+  # Return the df output in a ruby hash
+  def self.df_hashed
+    h = {}
+
+    df.strip.split("\n").each do |l|
+      if l.size > 10
+        tab = l.strip.split(/ +/)
+        if tab.first != 'Filesystem'
+          size = parse_df_size(tab[1])
+          used = parse_df_size(tab[2])
+          available = parse_df_size(tab[3])
+          percent_used = tab[4].gsub('%', '').to_i
+      
+          h[tab.last.to_sym] = {:filesystem => tab[0], :size => size, :used => used, :available => available, :percent_used => percent_used, :mount_on => tab.last}
+        end
+      end
+    end
+
+    return h
+  end
+  
+  # Return the percentage of used space on the device named "mount_name"
+  # If mount_name is nil => Return the maximum
+  def self.percent_used(mount_name = nil)
+    find_value_or_max(:percent_used, mount_name)
+  end
+
+  # Return the percentage of free space on "mount_name"
+  # If mount_name is nil => Return the minimum
+  def self.percent_free(mount_name = nil)
+    100 - find_value_or_max(:percent_used, mount_name)
+  end
+  
+  # Return the space available on "mount_name"
+  # If mount_name is nil => Return the minimum
+  def self.space_available(mount_name = nil)
+    find_value_or_max(:available, mount_name, :min)
+  end
+  
+  # Return the space used on "mount_name"
+  # If mount_name is nil => Return the maximum
+  def self.space_used(mount_name = nil)
+    find_value_or_max(:used, mount_name)
+  end
+  
+  # Return the size of "mount_name"
+  # If mount_name is nil => Return the total
+  def self.size(mount_name = nil)
+    find_value_or_max(:size, mount_name, :sum)
+  end
+  
+  
+
+end

data/spec/device_space_left/device_space_left_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe :device_space_left do
+
+  let(:dsl) { DeviceSpaceLeft }
+
+  it "check if df return something" do
+    dsl.df.should_not be nil
+    dsl.df.size.should > 10
+  end
+  
+  context "with stubbed df" do
+
+    before do
+      
+      fake_df = <<-EOF
+
+      Filesystem            Size  Used Avail Use% Mounted on
+      /dev/md1              5.0G  2.0G  2.8G  42% /
+      none                  987M  200K  986M   1% /dev
+      none                  987M     0  987M   0% /dev/shm
+      none                  987M   84K  986M   1% /var/run
+      none                  987M     0  987M   0% /var/lock
+      none                  987M     0  987M   0% /lib/init/rw
+      /dev/md2              4.1T  882G  3.0T  23% /home
+      EOF
+      
+      dsl.stub!(:df).and_return(fake_df)
+    end
+
+    it "should return correct percent used when device given" do
+      dsl.percent_used('/home').should == 23
+      dsl.percent_used('/dev/md2').should == 23
+    end
+    
+    it "should return max percent used when no device given" do
+      dsl.percent_used(nil).should == 42
+    end
+    
+    it "should return free percent" do
+      dsl.percent_free('/home').should == 77
+      dsl.percent_free('/dev/md2').should == 77
+      dsl.percent_free(nil).should == 58
+    end
+
+    it "should return correct space available" do
+      dsl.space_available('/home').should == 3.0 * 1024 * 1024 * 1024 * 1024
+      dsl.space_available(nil).should == 986 * 1024 * 1024
+    end
+
+    it "should return correct space used" do
+      dsl.space_used('/home').should == 882 * 1024 * 1024 * 1024
+      dsl.space_used(nil).should == 882 * 1024 * 1024 * 1024
+    end
+    
+    it "should return correct total size" do
+      dsl.size('/home').should == (4.1 * 1024 * 1024 * 1024 * 1024).to_i
+      dsl.size(nil).should == 4518541105561
+    end
+    
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../init.rb'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: device_space_left
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Guillaume Luccisano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-09 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: device_space_left is a small plugin giving you the ability to retrieve easily the space available on your devices
+email: guillaume.luccisano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/device_space_left.rb
+- spec/device_space_left/device_space_left_spec.rb
+- spec/spec_helper.rb
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/kwi/device_space_left
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: device_space_left
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Small ruby gem/plugin giving you the ability to retrieve easily the space available on your devices
+test_files: []
+