freespace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7ca7ccb0195b80ea7ca110c8c6f7dba13674445
+  data.tar.gz: 582e4e516010004266dc7cad46e9f08156a2dab7
+SHA512:
+  metadata.gz: eef62893fea0324e2215388e6dd8e48aff3d526bb6d40e9b35bad29072b7463efd54004ff60971c0e5b7fd4f150efe79e9ecc54349820e280ce318568219bd6a
+  data.tar.gz: b0e262a5d8824620ef50e457e891fb03f8fc239fb53d7d938e085b977ed93d1405a181f6b7eacefc0339920bfe4f3edf78a85ea797c6f622b5aafc6232aca887

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in freespace.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jamie Little
+
+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.md

@@ -0,0 +1,35 @@
+# Freespace
+
+A Ruby module that allows you to get the free space available on a path in a human readable form.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'freespace'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freespace
+
+## Usage
+
+```ruby
+
+Freespace::get_free_space('/','GB')
+
+```
+
+This will return a hash with the amount of freespace and unit:
+
+```ruby
+
+{:free_space=>25, :unit=>"GB"}
+
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "freespace"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/freespace.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freespace/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "freespace"
+  spec.version       = Freespace::VERSION
+  spec.authors       = ["Jamie Little"]
+  spec.email         = ["jamielittle@outlook.com"]
+
+  spec.summary       = ["Get the amount of free space at a filesystem path"]
+  spec.description   = ["A simple module that uses data from sys-filesystem to get a human readable amount of free space on a path"]
+  spec.homepage      = "https://github.com/little9/freespace"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_runtime_dependency "sys-filesystem"
+end

data/lib/freespace/version.rb

@@ -0,0 +1,3 @@
+module Freespace
+  VERSION = "0.1.0"
+end

data/lib/freespace.rb

@@ -0,0 +1,41 @@
+require_relative "./freespace/version"
+require 'sys/filesystem'
+include Sys
+
+module Freespace
+  KB = 1024
+  MB = 1048576
+  GB = 1073741824
+  TB = 1099511627776
+  
+  def self.get_free_space(location,unit=nil)
+    stats = Filesystem.stat(location)
+    
+    if unit == 'KB'
+      free_space = stats.blocks_available * stats.block_size / Freespace::KB
+    end
+
+    if unit == 'MB'
+      free_space = stats.blocks_available * stats.block_size / Freespace::MB
+    end
+
+    if unit == 'GB'
+      free_space = stats.blocks_available * stats.block_size / Freespace::GB
+    end
+    
+    if unit == 'TB'
+      free_space = stats.blocks_available * stats.block_size / Freespace::TB
+    end
+
+    if unit == nil
+      unit = 'MB'
+      free_space = stats.blocks_available * stats.block_size / Freespace::MB
+    end
+
+    free_space_hash = { :free_space => free_space , :unit => unit }
+    
+    return free_space_hash
+  end
+end
+
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: freespace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Little
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sys-filesystem
+  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: '["A simple module that uses data from sys-filesystem to get a human
+  readable amount of free space on a path"]'
+email:
+- jamielittle@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freespace.gemspec
+- lib/freespace.rb
+- lib/freespace/version.rb
+homepage: https://github.com/little9/freespace
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: '["Get the amount of free space at a filesystem path"]'
+test_files: []