mac-wifi 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ad551f63f23b9370fc52e8206e4b7314efd99e3
-  data.tar.gz: b2d4b85d37dc5e964f2dd7fe054233fcd54f66c6
+  metadata.gz: 6a58d1685f69fd21d35c2e06e323a7d932e5c82f
+  data.tar.gz: 9b129f36832db299389950a7fb9d8561dedb1a07
 SHA512:
-  metadata.gz: ef70403c2cbd5731e2835a79ea6334278c34746c06970cf074e3a6006e520d343d90d91db070007b7cfd7c96b065ee9e942b3f495c308cb3f56dbeee24bb7a47
-  data.tar.gz: 5a8ccde48e2cf1e28b9f4cdaaaa02f97ef39b4657988fd318e3f9fbc75a67e0e0f824e189eaba72de2c608c53aa65d5733c3f2d00f3bc178433608d8768fc7b4
+  metadata.gz: 0a34b48bf98052309743cd068ebe3b32612ace5577fd6b00449e0c55a0bf9f5037c6a8c16483a667887b89692160e021a22cdaa5f2ef229b1a84faeee2d51204
+  data.tar.gz: 82ad9b39c6c17632bcea897b4b9f7592dbe0e063ef5c0294ba4b043122ea1c788609248de690495e1ffc914ce7940e3ce33439eb8135049d70338e904e4393a3

data/README.md

@@ -1,6 +1,6 @@
 # mac-wifi
 
-The script installed by this gem (or otherwise copied) enables the query and management of wifi configuration and environment on a Mac.
+The `mac-wifi` script installed by this gem (or otherwise copied) enables the query and management of wifi configuration and environment on a Mac.
 The code encapsulates the Mac OS specific logic in a minimal class to more easily add support for other operating systems,
 but as of now, only Mac OS is supported. (Feel free to add an OS!)
 

data/RELEASE_NOTES.md

@@ -0,0 +1,12 @@
+## v1.1.0
+
+* Sort available networks alphabetically, left justify ssid's.
+* to_s is called on parameters so that symbols can be specified in interactive shell for easier typing
+
+
+## v1.0.0
+
+* First versioned release.
+
+
+

data/bin/mac-wifi

@@ -26,7 +26,7 @@ require 'tempfile'
 module MacWifi
 
 # This version must be kept in sync with the version in the gemspec file.
-VERSION = '1.0.0'
+VERSION = '1.1.0'
 
 
 class BaseModel
@@ -127,6 +127,10 @@ class BaseModel
   # Turns wifi on first, in case it was turned off.
   # Relies on subclass implementation of simple_connect().
   def connect(network_name, password = nil)
+    # Allow symbols and anything responding to to_s for user convenience
+    network_name = network_name.to_s if network_name
+    password     = password.to_s     if password
+
     if network_name.nil? || network_name.empty?
       raise "A network name is required but was not provided."
     end
@@ -163,6 +167,7 @@ class BaseModel
 
 
   def preferred_network_password(preferred_network_name)
+    preferred_network_name = preferred_network_name.to_s
     if preferred_networks.include?(preferred_network_name)
       simple_preferred_network_password(preferred_network_name)
     else
@@ -179,17 +184,17 @@ class BaseModel
 
     wait_interval_in_secs ||= 0.5
 
-    exit_when = case status
-      when :conn
-        -> { connected_to_internet? }
-      when :disc
-        -> { ! connected_to_internet? }
-      when :on
-        -> { wifi_on? }
-      when :off
-        -> { ! wifi_on? }
-    else
-        raise ArgumentError.new("Option must be one of [:conn, :disc, :off, :on]. Was: #{status.inspect}")
+    actions = {
+        conn: -> { connected_to_internet? },
+        disc: -> { ! connected_to_internet? },
+        on:   -> { wifi_on? },
+        off:  -> { ! wifi_on? }
+    }
+
+    exit_when = actions[status]
+
+    if exit_when.nil?
+      raise ArgumentError.new("Option must be one of [#{actions.keys.map(&:inspect).join(', ')}]. Was: #{status.inspect}")
     end
 
     loop do
@@ -197,7 +202,6 @@ class BaseModel
       sleep(wait_interval_in_secs)
     end
   end
-
 end
 
 
@@ -243,14 +247,30 @@ class MacOsModel < BaseModel
 
   # Returns data pertaining to available wireless networks.
   # For some reason, this often returns no results, so I've put the operation in a loop.
+  # I was unable to detect a sort strategy in the airport utility's output, so I sort
+  # the lines alphabetically, to show duplicates and for easier lookup.
   def available_network_info
     return nil unless wifi_on? # no need to try
     command = "#{AIRPORT_CMD} -s"
     max_attempts = 50
+
+    reformat_line = ->(line) do
+      ssid = line[0..31].strip
+      "%-32.32s%s" % [ssid, line[32..-1]]
+    end
+
     max_attempts.times do
       output = run_os_command(command)
       if output.size > 0
-        return output.split("\n")
+        lines = output.split("\n")
+        header_line = lines[0]
+        data_lines = lines[1..-1]
+        data_lines.map! do |line|
+          # Reformat the line so that the name is left instead of right justified
+          reformat_line.(line)
+        end
+        data_lines.sort!
+        return [reformat_line.(header_line)] + data_lines
       end
     end
     raise "Unable to get available network information after #{max_attempts} attempts."
@@ -345,6 +365,7 @@ class MacOsModel < BaseModel
 
 
   def remove_preferred_network(network_name)
+    network_name = network_name.to_s
     run_os_command("sudo networksetup -removepreferredwirelessnetwork " +
         "#{wifi_hardware_port} #{Shellwords.shellescape(network_name)}")
   end
@@ -767,13 +788,30 @@ end
 #
 # 1) by loading this file directly, or
 # 2) by running as a gem executable's binstub, in (relatively) '../../../bin'
+#
+# For example, I get this when running this file as a gem:
+# __FILE__ = /Users/kbennett/.rvm/gems/ruby-2.4.0/gems/mac-wifi-1.0.0/bin/mac-wifi
+# $0 =       /Users/kbennett/.rvm/gems/ruby-2.4.0/bin/mac-wifi
+# GEM_PATH = /Users/kbennett/.rvm/gems/ruby-2.4.0:/Users/kbennett/.rvm/gems/ruby-2.4.0@global
 
 def running_as_script?
+
+  # Please enable this code and report its output if you report any issues with this method:
+  # puts "__FILE__ = #{__FILE__}"
+  # puts "$0 =       #{$0}"
+  # puts "GEM_PATH = #{ENV['GEM_PATH']}"
+
   return true if __FILE__ == $0
   return false if File.basename(__FILE__) != File.basename($0)
 
-  binstub_spec = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'bin', File.basename(__FILE__)))
-  $0 == binstub_spec
+  # If here, then filespecs are different but have the same basename.
+  gem_paths = ENV['GEM_PATH'].split(File::PATH_SEPARATOR)
+  basename = File.basename($0)
+  gem_paths.any? do |path|
+    path_plus_bin_basename = File.join(path, 'bin', basename)
+    __file__up_4 = File.expand_path(File.join(__FILE__, '..', '..', '..', '..'))
+    ($0 == path_plus_bin_basename) && (path == __file__up_4)
+  end
 end
 
 

data/mac-wifi.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
-VERSION = '1.0.0'
+# This version must be kept in sync with the version in the mac-wifi file.
+VERSION = '1.1.0'
 
 Gem::Specification.new do |spec|
   spec.name          = "mac-wifi"
@@ -11,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/keithrbennett/mac-wifi"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/) - ['teaching_outline.md']
+  spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mac-wifi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Keith Bennett
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-24 00:00:00.000000000 Z
+date: 2017-10-01 00:00:00.000000000 Z
 dependencies: []
 description: A command line interface for managing wifi on a Mac.
 email:
@@ -22,6 +22,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASE_NOTES.md
 - bin/mac-wifi
 - mac-wifi.gemspec
 - spec/mac-wifi_spec.rb
@@ -29,7 +30,7 @@ homepage: https://github.com/keithrbennett/mac-wifi
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -44,9 +45,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
+rubyforge_project: 
 rubygems_version: 2.6.13
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Mac wifi utility
 test_files: