mac_address 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c118549679a92fcacaa8390c4a1c0d95357440f3
-  data.tar.gz: e42d4ebbc91d2139d88f7a86923ba1f01f7eaa94
+  metadata.gz: c43f112f891d36f920a3bb25a2a31970041a703a
+  data.tar.gz: 55e14042efbf71216d56dd6cb546dffb008dad23
 SHA512:
-  metadata.gz: 5976c405c52eaf7f046cdcadd42f7d3b0cdce02fef264cc8831618811af3a30928eff7972d1fec4c0d8252f0cf557645b7d8f70ecf2281cf6c825b4628828a91
-  data.tar.gz: ca5f8859ddb7f018310fb2a28c7343276f7a2cfb35eb1d15032acc64cb2547e0eae4927e13b17bd80e6d5f60ecac7edc0578b87d7914dc7d1473d7558ac4abbb
+  metadata.gz: 2cc9b9046eddc6c56828fa3bea6c8baafbdf9a03a47a4f8251f09f74387cc6b2f8057b351d65ea50725ba715f324d472a9849c837eb7cc6aa7567d07894689d5
+  data.tar.gz: 5ba83ddd0ee5e8633f0d24db413af238f26fb9eff80f68297f2756110f913bd89f6ea0679aaef66367aaaecbc09647a78debf47954531cd7f353e1a155792267

data/README.md

@@ -1,2 +1,72 @@
-mac_address
-===========
+# Mac Address
+
+[![Build Status](https://travis-ci.org/uceem/mac_address.svg?branch=master)](https://travis-ci.org/uceem/mac_address)
+
+A Mac Address utility that can validate mac address formats and convert strings to valid macs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'mac_address'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install mac_address
+```
+
+## Usage
+
+```ruby
+MacAddress.new("aa:bb:cc:dd:ee:ff")
+# => #<MacAddress:0x007fe783981788 @mac_str="aabbccddeeff">
+
+MacAddress.new("aa:bb:cc:dd:ee:ff").to_s # => 'aabbccddee'
+MacAddress.new("invalid mac")            # => Raises ArgumentError
+MacAddress.new("aa:bb:cc:dd:ee:ff").to_i # => 187723572702975
+```
+
+The MacAddress class will also remove any cruft or extraneous content. If there's a mac to be found, MacAddress will find it:
+
+```ruby
+MacAddress.new("aa:bb:cc:dd:ee:ff:qqqqq")
+# => #<MacAddress:0x007fe783981788 @mac_str="aabbccddeeff">
+
+MacAddress.new("&*^*&(aa:bb:cc:dd:ee:ff:")
+# => #<MacAddress:0x007fe783981788 @mac_str="aabbccddeeff">
+```
+
+### String Extending
+
+```ruby
+'aa:bb:cc:dd:ee:ff'.to_mac               # => 'aabbccddeeff'
+'aa:bb:cc:dd:ee:ff:xx'.to_mac            # => 'aabbccddeeff'
+''.to_mac                                # => Raises ArgumentError
+'aa:bb:cc:dd:ee:ff'.valid_mac?           # => true
+'aa:bb:cc:dd:ee:ff:*&^*qqqq'.valid_mac?  # => true
+'aabbcc'.valid_mac?                      # => false
+```
+
+Enable strict mode for validation.
+
+```ruby
+'aa:bb:cc:dd:ee:ff'.valid_mac?(strict: true)          # => true
+'aa:bb:cc:dd:ee:ff:*&^*qqqq'.valid_mac?(strict: true) # => false
+```
+
+## Contributing
+
+  1. Fork it
+  2. Create your feature branch (git checkout -b my-new-feature)
+  3. Commit your changes (git commit -am 'Add some feature')
+  4. Push to the branch (git push origin my-new-feature)
+  5. Create new Pull Request

data/lib/mac_address.rb

@@ -2,8 +2,13 @@ require 'str_quote'
 require 'mac_address/version'
 
 class MacAddress
-  def initialize(str)
+  def initialize(str, options = {})
     @mac_str = str.strip.dequote.strip
+
+    if options[:strict] && !MacAddress.validate_strict(@mac_str)
+      raise_argument_error(@mac_str)
+    end
+
     n = @mac_str.index(':')
     if not n.nil? and n >= 12
       @mac_str = @mac_str.split(':')[0]
@@ -25,24 +30,30 @@ class MacAddress
     !!(mac =~ /^([0-9a-fA-F]{2}[:-]){5}[0-9a-fA-F]{2}$/i)
   end
 
-  def self.validate(mac)
-    MacAddress.new(mac).to_s
-    true
+  def self.validate(mac, options = {})
+    if options[:strict]
+      MacAddress.validate_strict(mac)
+    else
+      MacAddress.new(mac).to_s
+      true
+    end
   rescue ArgumentError
     false
   end
+
+private
+
+  def raise_argument_error(mac_str, error_str = nil)
+    raise ArgumentError.new(error_str || "Invalid MAC address: #{mac_str}")
+  end
 end
 
 class String
-  def to_mac
-    MacAddress.new(self).to_s
+  def to_mac(options = {})
+    MacAddress.new(self, options).to_s
   end
 
   def valid_mac?(options = {})
-    if options[:strict]
-      MacAddress.validate_strict(self)
-    else
-      MacAddress.validate(self)
-    end
+    MacAddress.validate(self, options)
   end
 end

data/lib/mac_address/version.rb

@@ -1,3 +1,3 @@
 class MacAddress
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/mac_address_test.rb

@@ -2,6 +2,11 @@ require 'test/unit'
 require 'mac_address'
 
 class MacAddressTest < Test::Unit::TestCase
+
+  VALID_MACS          = %w[aa:bb:cc:dd:ee:ff 00:11:22:33:44:55]
+  INVALID_MACS        = %w[invalid aabbccddeeffff aa:bb:cc:dd:ee:ff:11]
+  INVALID_MACS_STRICT = %w[aabbccddeeff aabbccddeeffxx aa:bb:cc:dd:ee:ff:xx 00:55:56:82:11::38 0011.2233.445566]
+
   def test_truth
     assert_kind_of Module, MacAddress
   end
@@ -10,21 +15,49 @@ class MacAddressTest < Test::Unit::TestCase
     assert_equal 'aabbccddeeff', 'AA-BB-CC-DD-EE-FF:hello world'.to_mac
   end
 
-  VALID_MACS          = %w[aa:bb:cc:dd:ee:ff 00:11:22:33:44:55]
-  INVALID_MACS        = %w[invalid aabbccddeeffff aa:bb:cc:dd:ee:ff:11]
-  INVALID_MACS_STRICT = %w[aabbccddeeff aabbccddeeffxx aa:bb:cc:dd:ee:ff:xx 00:55:56:82:11::38 0011.2233.445566]
+  def test_mac_strict
+    assert_equal 'aabbccddeeff', 'aa:bb:cc:dd:ee:ff'.to_mac(strict: true)
+  end
+
+  def test_error_raise_with_invalid_mac
+    assert_raise ArgumentError do
+      MacAddress.new(INVALID_MACS.first.to_mac)
+    end
+  end
 
-  def test_valid_mac?
+  def test_error_raise_with_invalid_mac_strict
+    assert_raise ArgumentError do
+      MacAddress.new(INVALID_MACS_STRICT.first.to_mac(strict: true))
+    end
+  end
+
+  def test_error_raise_with_invalid_mac_for_string
+    assert_raise ArgumentError do
+      INVALID_MACS.first.to_mac
+    end
+  end
+
+  def test_error_raise_with_invalid_mac_strict_for_string
+    assert_raise ArgumentError do
+      INVALID_MACS_STRICT.first.to_mac(strict: true)
+    end
+  end
+
+  def test_valid_mac
     VALID_MACS.each do |valid_mac|
       assert_equal valid_mac.valid_mac?, true
       assert_equal valid_mac.valid_mac?(strict: true), true
     end
+  end
 
+  def test_invalid_macs
     INVALID_MACS.each do |invalid_mac|
       assert_equal invalid_mac.valid_mac?, false
       assert_equal invalid_mac.valid_mac?(strict: true), false
     end
+  end
 
+  def test_invalid_macs_strict
     INVALID_MACS_STRICT.each do |invalid_mac|
       assert_equal invalid_mac.valid_mac?(strict: true), false
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mac_address
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Doug Wiegley