macaddr 0.0.2 → 1.0.0

data/README

@@ -15,6 +15,16 @@ INSTALL
 
   gem install macaddr
 
+HISTORY
+
+  1.0.0:
+
+    - rdoc added
+
+    - eric hodel kicks ass.  to find why, see
+
+      http://drawohara.com/post/44678286/eric-hodel-kicks-ass
+
 SYNOPSIS
 
   require 'macaddr'

data/gemspec.rb

@@ -16,7 +16,6 @@ Gem::Specification::new do |spec|
   spec.require_path = "lib" 
   spec.autorequire = lib
 
-  spec.has_rdoc = File::exist? "doc" 
   spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
   #spec.add_dependency 'lib', '>= version'
 

data/lib/macaddr.rb

@@ -1,6 +1,38 @@
+##
+# Cross platform MAC address determination.  Works for:
+# * /sbin/ifconfig
+# * /bin/ifconfig
+# * ifconfig
+# * ipconfig /all
+#
+# To return the first MAC address on the system:
+#
+#   Mac.address
+#
+# To return an array of all MAC addresses:
+#
+#   Mac.address.list
+
 module Mac
+  VERSION = '1.0.0'
+
+  def Mac.version() ::Mac::VERSION end
+
   class << self
+
+    ##
+    # Accessor for the system's first MAC address, requires a call to #address
+    # first
+
     attr_accessor "mac_address"
+
+    ##
+    # Discovers and returns the system's MAC addresses.  Returns the first
+    # MAC address, and includes an accessor #list for the remaining addresses:
+    #
+    #   Mac.addr # => first address
+    #   Mac.addr.list # => all addresses
+
     def address
       return @mac_address if defined? @mac_address and @mac_address
       re = %r/[^:\-](?:[0-9A-F][0-9A-F][:\-]){5}[0-9A-F][0-9A-F][^:\-]/io
@@ -14,20 +46,24 @@ module Mac
         next unless stdout and stdout.size > 0
         lines = stdout and break
       end
-      raise "all of #{ cmds.join ' ' } failed" unless lines 
+      raise "all of #{ cmds.join ' ' } failed" unless lines
 
       candidates = lines.select{|line| line =~ re}
       raise 'no mac address candidates' unless candidates.first
       candidates.map!{|c| c[re].strip}
 
       maddr = candidates.first
-      raise 'no mac address found' unless maddr 
+      raise 'no mac address found' unless maddr
 
       maddr.strip!
       maddr.instance_eval{ @list = candidates; def list() @list end }
 
       @mac_address = maddr
     end
+
+    ##
+    # Shorter alias for #address
+
     alias_method "addr", "address"
   end
 end

metadata

@@ -1,50 +1,57 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: macaddr
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-09-08 00:00:00 -06:00
-summary: macaddr
-require_paths: 
-- lib
-email: ara.t.howard@gmail.com
-homepage: http://codeforpeople.com/lib/ruby/macaddr/
-rubyforge_project: 
-description: 
-autorequire: macaddr
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.0.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Ara T. Howard
+autorequire: macaddr
+bindir: bin
+cert_chain: []
+
+date: 2008-08-04 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ara.t.howard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - gemspec.rb
 - install.rb
 - lib
 - lib/macaddr.rb
 - README
-test_files: []
-
+has_rdoc: false
+homepage: http://codeforpeople.com/lib/ruby/macaddr/
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: macaddr
+test_files: []