cpu 0.0.0 → 0.0.1

data/CHANGES

@@ -0,0 +1,4 @@
+2011-07-03 (0.0.1)
+  * Add documentation and license information.
+2011-07-03 (0.0.0)
+  * Initial Version

data/COPYING

@@ -0,0 +1,340 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/README.rdoc

@@ -0,0 +1,35 @@
+= CPU information in Ruby/Linux
+
+== Description
+
+Library to gather CPU information (load averages, usage, temperature) in Ruby
+on Linux
+
+
+== Installation
+
+To install cpu via its gem type:
+
+# gem install cpu
+
+To install from the source repository, just type into the command line as root:
+
+# rake install
+
+== Documentation
+
+To create the documentation of this module, type
+
+$ rake doc
+
+and the API documentation is generated.
+
+== Author
+
+Florian Frank mailto:flori@ping.de
+
+== License
+
+This is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License Version 2 as published by
+the Free Software Foundation: http://www.gnu.org/copyleft/gpl.html

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/cpu.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cpu}
-  s.version = "0.0.0"
+  s.version = "0.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Florian Frank}]
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.email = %q{flori@ping.de}
   s.executables = [%q{coretemp}]
   s.extra_rdoc_files = [%q{README.rdoc}]
-  s.files = [%q{Gemfile}, %q{README.rdoc}, %q{Rakefile}, %q{VERSION}, %q{bin/coretemp}, %q{cpu.gemspec}, %q{lib/cpu.rb}, %q{lib/cpu/load.rb}, %q{lib/cpu/msr.rb}, %q{lib/cpu/processor.rb}, %q{lib/cpu/shared.rb}, %q{lib/cpu/usage.rb}, %q{lib/cpu/usage_sampler.rb}, %q{lib/cpu/version.rb}, %q{munin/coretemp}, %q{tests/load_test.rb}, %q{tests/msr_test.rb}, %q{tests/usage_test.rb}]
+  s.files = [%q{CHANGES}, %q{COPYING}, %q{Gemfile}, %q{README.rdoc}, %q{Rakefile}, %q{VERSION}, %q{bin/coretemp}, %q{cpu.gemspec}, %q{lib/cpu.rb}, %q{lib/cpu/load.rb}, %q{lib/cpu/msr.rb}, %q{lib/cpu/processor.rb}, %q{lib/cpu/shared.rb}, %q{lib/cpu/usage.rb}, %q{lib/cpu/usage_sampler.rb}, %q{lib/cpu/version.rb}, %q{munin/coretemp}, %q{tests/load_test.rb}, %q{tests/msr_test.rb}, %q{tests/usage_test.rb}]
   s.homepage = %q{http://flori.github.com/cpu}
   s.rdoc_options = [%q{--main}, %q{README.rdoc}, %q{--title}, %q{CPU}]
   s.require_paths = [%q{lib}]

data/lib/cpu.rb

@@ -19,13 +19,13 @@ module CPU
   end
   self.t_j_max = 95
 
-  # XXX
+  # The base exception class for all CPU related exceptions.
   class CPUError < StandardError; end
 
   # This exception is thrown if an invalid ProcessorId is queried.
   class InvalidProcessorIdError < CPUError; end
 
-  # XXX
+  # This excpetion is raised if sample data couldn't be read.
   class NoSampleDataError < CPUError; end
 
   class << self
@@ -59,11 +59,13 @@ module CPU
       end
     end
 
+    # Return the number of processors in this computer.
     def num_processors
       @num_processors or processors
       @num_processors
     end
 
+    # Return the number of cores in the processor(s) of this computer.
     def num_cores
       @num_cores or processors
       @num_cores
@@ -71,10 +73,12 @@ module CPU
 
     alias to_a processors
 
+    # Iterate over every Processor instance identified by a distinct core.
     def each_core(&block)
       processors.uniq_by(&:core_id).each(&block)
     end
 
+    # Return all Processor instances identified by a distinct core.
     def cores
       each_core.to_a
     end
@@ -93,6 +97,9 @@ module CPU
       Load.new
     end
 
+    # Return an array of all Processor instances for this machine, but also
+    # measure CPU usage during the next +interval+ seconds or during the
+    # runtime of the given block.
     def usage(interval = 1)
       before_usage = UsageSampler.new
       if block_given?
@@ -107,8 +114,11 @@ module CPU
       end
     end
 
-    def sum_usage_processor(interval = 1)
-      processors = usage(interval)
+    # Return a single Processor instance, measure CPU usage during the next
+    # +interval+ seconds or during the runtime of the given block, and then
+    # sum up the CPU usage in this instance.
+    def sum_usage_processor(interval = 1, &block)
+      processors = usage(interval, &block)
       processor = Processor.new -1, -1
       processor.num_processors = processor.num_cores = 1
       processor.temperature = processors.map(&:temperature).max

data/lib/cpu/load.rb

@@ -2,48 +2,66 @@ module CPU
   class Load
     include Shared
 
+    # Create a new CPU::Load instance providing CPU load averages data.
     def initialize
       @load_data = File.open('/proc/loadavg') do |loadavg|
         loadavg.readline.split(/\s+/).first(3).map(&:to_f)
       end
     end
 
+    # Return the load average for the last minute.
     def last_minute
       @load_data[0]
     end
 
+    # Return the load average for the last minute, divided by the number of
+    # cores.
     def last_minute_by_core
       last_minute / num_cores
     end
 
+    # Return the load average for the last minute, divided by the number of
+    # processors.
     def last_minute_by_processor
       last_minute / num_processors
     end
 
+    # Return the load average for the last 5 minutes.
     def last_5_minutes
       @load_data[1]
     end
 
+    # Return the load average for the last 5 minutes, divided by the number of
+    # cores.
     def last_5_minutes_by_core
       last_5_minutes / num_cores
     end
 
+    # Return the load average for the last 5 minutes, divided by the number of
+    # processors.
     def last_5_minutes_by_processor
       last_5_minutes / num_processors
     end
 
+    # Return the load average for the last 15 minutes.
     def last_15_minutes
       @load_data[2]
     end
 
+    # Return the load average for the last 15 minutes, divided by the number of
+    # cores.
     def last_15_minutes_by_core
       last_15_minutes / num_cores
     end
 
+    # Return the load average for the last 15 minutes, divided by the number of
+    # processors.
     def last_15_minutes_by_processor
       last_15_minutes / num_processors
     end
 
+    # Return 1 minute, 5 minutes, and 15 minutes load data as an array of
+    # floating point values.
     def to_a
       @load_data.dup
     end

data/lib/cpu/msr.rb

@@ -12,6 +12,8 @@ module CPU
       sleep 1
     end
 
+    # Create a new wrapper for the msr kernel file associated with
+    # +processor_id+.
     def initialize(processor_id)
       self.class.available? or self.class.load_module
       begin

data/lib/cpu/processor.rb

@@ -22,9 +22,16 @@ module CPU
 
     attr_writer :usage
 
-    def usage(interval = 1)
+    # Measure CPU usage for this Processor instance during the next +interval+
+    # or during the runtime of the given block. Іf CPU usage on all processors
+    # of the system should be measured, it's better (=faster) to use the
+    # CPU.usage method instead.
+    def usage(interval = 1, &block)
       unless @usage
-        if processor = CPU.usage(interval).find { |p| p.processor_id == processor_id }
+        if processor = CPU.usage(interval, &block).find {
+          |p| p.processor_id == processor_id
+        }
+        then
           @usage = processor.usage
         end
       end

data/lib/cpu/shared.rb

@@ -9,6 +9,8 @@ module CPU
       end
     end
 
+    # Set the number of processors (this causes them to becomed fixed in the
+    # object the CPU::Shared module was mixed into).
     attr_writer :num_processors
 
     # Returns the number of cores in this computer
@@ -20,6 +22,8 @@ module CPU
       end
     end
 
+    # Set the number of cores (this causes them to becomed fixed in the object
+    # the CPU::Shared module was mixed into).
     attr_writer :num_cores
   end
 end

data/lib/cpu/usage.rb

@@ -3,6 +3,7 @@ module CPU
                            :system, :idle, :start_at, :stop_at)
     include Shared
 
+    # Add this CPU::Usage instance to the other and return a resulting sum object.
     def +(other)
       self.class.new(*(
         [
@@ -17,10 +18,13 @@ module CPU
       )
     end
 
+    # Subtract the other from this CPU::Usage instance the other and return a
+    # resulting difference object.
     def -(other)
       self + other * -1
     end
 
+    # Multiply the cpu times in this CPU::Usage instance with +scalar+.
     def *(scalar)
       scalar = scalar.to_f
       self.class.new(*(
@@ -36,22 +40,30 @@ module CPU
       )
     end
 
+    # Divide the cpu times in this CPU::Usage instance by +scalar+.
     def /(scalar)
       self * (1.0 / scalar)
     end
 
+    # Return the cpu time that where used to process instructions since booting
+    # up the system.
     def process_time
       user + nice + system
     end
 
+    # Return the real time passed in the range of all CPU::Usage instances,
+    # that were used to create this summed up CPU::Usage instance. If this
+    # isn't a sum object, this value will be 0.0.
     def real_time
       stop_at - start_at
     end
 
+    # Return the total cpu time that has passed since booting the system.
     def total_time
       values_at(2..-3).inject(0.0) { |s,  x| s + x }
     end
 
+    # Return the CPU usage as a percentage number between 0.0..100.0.
     def percentage(time = total_time)
       100.0 * process_time / time
     end

data/lib/cpu/usage_sampler.rb

@@ -1,19 +1,28 @@
 module CPU
   class UsageSampler
+    # Creates a new UsageSampler instance.
     def initialize
       sample
     end
 
+    # Return all CPU::Usage instances stored in this UsageSampler, if any.
     attr_reader :usages
 
+    # Returns a CPU::Usage instance, that sums up all CPU::Usage instances for
+    # all processors in this computer.
     def sum_usages
       @usages and @usages.values.inject(&:+)
     end
 
+    # This regular expression is used to parse cpu times from the /proc/stat
+    # kernel file.
     CPU = /^cpu(\d+)#{'\s+(\d+)' * 4}/
 
+    # This value is used to convert cpu times from jiffies into seconds.
     USER_HZ = 100
 
+    # Take one sample of CPU usage data for every processor in this computer
+    # and store them in the +usages+ attribute.
     def sample
       total, @usages = nil, {}
       timestamp = Time.now

data/lib/cpu/version.rb

@@ -1,6 +1,6 @@
 module CPU
   # CPU version
-  VERSION         = '0.0.0'
+  VERSION         = '0.0.1'
   VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cpu
 version: !ruby/object:Gem::Version 
+  hash: 29
   prerelease: 
-  version: 0.0.0
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Florian Frank
@@ -20,6 +25,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 2
+        - 2
         version: 0.2.2
   type: :runtime
   version_requirements: *id001
@@ -32,6 +42,8 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- CHANGES
+- COPYING
 - Gemfile
 - README.rdoc
 - Rakefile
@@ -66,12 +78,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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: []