maca 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 354cde56cdb070aa38ceb4cca307d0bb1d4d2698a13f9694bbff5ee4f090088c
-  data.tar.gz: 63aea21d117ec506239c76457b3ab2c0aa498b18724b63f9b26d78eceb637c11
+  metadata.gz: aee82516c71df181d561ed67d5aab2fbaf266c1e23b463692584e9920bc495a1
+  data.tar.gz: d2374172b04b9ea1f198e94b40872a3d98e4ac1a07219d08c86f642f83f19c1f
 SHA512:
-  metadata.gz: 762d2de2dbb2df24df41aa278a04dcc66d1a104ae2e5a5bac23e76491f4f991c8b645ee7977806773eef254b40833a3b1a96ef107f15930475770c446b9853f4
-  data.tar.gz: cde0e4e55056e611b5b47a57fc99012e88fd58826a88e7d53ac3669c37e8058a45a1d6f3f7757fdfa951eb7162daaf8a662ed9c5c5c99d1d4b9511f68997829b
+  metadata.gz: 24b2d90e99227d6c1ce894f625932fd561605ec4a60983353869ded49e37ff13849e13702667ba986026bb1a2eaa099e15ba90a11ffb736de9228c14d0ad994a
+  data.tar.gz: 6679b4d4f25160966aed55c642bdfd06cebf176dcdec020b1800e139e4809215bc6e5e098edc212823a6b3c90c23ce11651511d2233bd32c7c1e075ca32971d1

data/README.md

@@ -17,17 +17,30 @@ gem install maca
 ```
 
 ## Usage
+### Basic
+
+Create a new `Macaddress` object from a MAC Address in various formats.
 
 ```ruby
 require 'maca'
 
-Macaddress.new("00:00:00:00:00:00")
-=> #<Macaddress @macaddress="00:00:00:00:00:00">
+Macaddress.new("01:23:45:67:89:ab")
+=> #<Macaddress:0x000000012073db08 @macaddress="0123456789ab">
 
 Macaddress.new("01:23:45:67:89:ab").to_s
 => "01:23:45:67:89:AB"
 
-# Format normalization
+Macaddress.new("01:23:45:67:89:ab").to_i
+=> 1250999896491
+```
+
+### Format String
+
+**Format Normalization**
+
+Normalize various MAC Address notations (hyphenated, dot-separated, raw hex, etc.) into the standard colon-separated format.
+
+```ruby
 Macaddress.new("00-00-00-00-00-00").to_s
 => "00:00:00:00:00:00"
 
@@ -39,8 +52,22 @@ Macaddress.new("0000.0000.0000").to_s
 
 Macaddress.new("000000-000000").to_s
 => "00:00:00:00:00:00"
+```
 
-# Comparison
+**Format Conversion**
+
+Convert the MAC Address to a custom string format using a specified delimiter and step size.
+
+```ruby
+Macaddress.new("00-00-00-00-00-00").to_fs(delimiter: '.', step: 4)
+=> "0000.0000.0000"
+```
+
+### Comparison
+
+Compare `Macaddress` objects for equality based on their normalized form.
+
+```ruby
 Macaddress.new("00:00:00:00:00:00") == Macaddress.new("00:00:00:00:00:00")
 => true
 
@@ -48,6 +75,28 @@ Macaddress.new("00:00:00:00:00:00") == Macaddress.new("00:00:00:00:00:01")
 => false
 ```
 
+### Address type check
+
+```ruby
+Macaddress.new("00:00:00:00:00:00").unicast?
+=> true
+
+Macaddress.new("00:00:00:00:00:00").broadcast?
+=> false
+
+Macaddress.new("33:33:00:00:00:01").multicast?
+=> true
+
+Macaddress.new("02:00:00:00:00:00").locally_administered?
+=> true
+
+Macaddress.new("01:00:00:00:00:00").universally_administered?
+=> true
+
+Macaddress.new("02:00:00:00:00:00").random?
+=> true
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/maca/macaddress.rb

@@ -2,11 +2,14 @@
 
 module Maca
   class Macaddress
-    REGEXP_MACADDRESS = /^([0-9A-Fa-f]{2}[:.-]?){5}([0-9A-Fa-f]{2})$/
+    DEFAULT_DELIMITER = ':'
+    DEFAULT_STEP = 2
+    DELIMITERS = ':.-'
+    REGEXP_MACADDRESS = /^([0-9A-Fa-f]{2}[#{DELIMITERS}]?){5}([0-9A-Fa-f]{2})$/
 
     def initialize(addr)
       if Maca::Macaddress.valid?(addr)
-        @macaddress = addr
+        @macaddress = addr.downcase.delete(DELIMITERS)
       else
         raise Maca::InvalidAddressError, "Invalid MAC Address #{addr}"
       end
@@ -17,7 +20,43 @@ module Maca
     end
 
     def to_s
-      @macaddress.upcase.gsub(/[-:.]/, '').scan(/.{1,2}/).join(':')
+      to_fs
+    end
+
+    def to_fs(delimiter: DEFAULT_DELIMITER, step: DEFAULT_STEP)
+      raise RangeError, "step must be even, and between 2 and 6" unless (2..6).cover?(step) && step.even?
+
+      @macaddress.upcase.scan(/.{1,#{step}}/).join(delimiter)
+    end
+    alias_method :to_formatted_s, :to_fs
+
+    def to_i
+      @macaddress.hex
+    end
+
+    def broadcast?
+      @macaddress == 'ff' * 6
+    end
+
+    def multicast?
+      (@macaddress[0..1].hex & 0x01).positive?
+    end
+
+    def unicast?
+      !multicast?
+    end
+
+    def locally_administered?
+      return false if broadcast?
+      (@macaddress[0..1].hex & 0x02).positive?
+    end
+
+    def universally_administered?
+      !locally_administered?
+    end
+
+    def random?
+      unicast? && locally_administered?
     end
 
     def ==(other)

data/lib/maca/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Maca
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maca
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Taketo Takashima