mac-wifi 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a58d1685f69fd21d35c2e06e323a7d932e5c82f
-  data.tar.gz: 9b129f36832db299389950a7fb9d8561dedb1a07
+  metadata.gz: 75c730b3171f9dba37b683b40cde3c4d40765001
+  data.tar.gz: 5660a6f765152ad8ac23a09f5f88084a4ec83d3b
 SHA512:
-  metadata.gz: 0a34b48bf98052309743cd068ebe3b32612ace5577fd6b00449e0c55a0bf9f5037c6a8c16483a667887b89692160e021a22cdaa5f2ef229b1a84faeee2d51204
-  data.tar.gz: 82ad9b39c6c17632bcea897b4b9f7592dbe0e063ef5c0294ba4b043122ea1c788609248de690495e1ffc914ce7940e3ce33439eb8135049d70338e904e4393a3
+  metadata.gz: 237050e6744bb80ae8c2f36053731db4a03c78cc1402b82a12479848ac6d20b16a032a48d8944e038fe026799f5c28b0991523108958182c083bde7c9e65bb4a
+  data.tar.gz: 57d380bc2392e40e2b78bc856b22be6c83ec388e70a365cc098b0b76084f1e5427dcd6fac64172dad7d300cf11b39f9883f4e67c894ad1430ca851ffaca926ba

data/README.md

@@ -19,7 +19,7 @@ output at the time of this writing:
 ```
 ➜  mac-wifi git:(master) ✗   ./mac-wifi h
 
-Available commands are:
+mac-wifi version 1.1.0 -- Available commands are:
 
 ci                      - connected to Internet (not just wifi on)?
 co[nnect] network-name  - turns wifi on, connects to network-name
@@ -36,7 +36,7 @@ pa[ssword] network-name - shows password for preferred network-name
 q[uit]                  - exits this program (interactive shell mode only)
 r[m] network-name       - removes network-name from the preferred networks list
 s[hell]                 - opens an interactive pry shell (command line only)
-t[ill]                  - (experimental!) returns when the desired Internet connection state is true. Options:
+t[ill]                  - returns when the desired Internet connection state is true. Options:
                           'on'/:on or 'off'/:off
                           wait interval, in seconds (optional, defaults to 0.5 seconds)
 w[ifion]                - is the wifi on?
@@ -67,13 +67,15 @@ This is accomplished by the following command:
 
 If you would like to see the Mac OS commands and their output, you can do so by setting the
 environment variable MAC_WIFI_OPTS to include `-v` (for _verbose_).
-This can be done in the following ways:
+This can be done in the following ways (using the `info` command as an example):
 
 ```
 export MAC_WIFI_OPTS=-v
 ./mac-wifi i
 ```
 
+...or...
+
 ```
 MAC_WIFI_OPTS=-v  ./mac-wifi i
 ```
@@ -99,6 +101,9 @@ sudo gem install pry-coolline
 
 ### Using the Shell
 
+**If the program immediately exits when you try to run the shell, try upgrading `pry` and `pry-byebug`.
+This can be done by running `gem install pry; gem install pry-byebug`.**
+
 The shell, invoked with the `s` command on the command line, provides an interactive
 session. It can be useful when:
 

data/RELEASE_NOTES.md

@@ -1,3 +1,9 @@
+## v1.2.0
+
+* Fix: protect against using command strings shorter than minimum length
+      (e.g. 'c', when more chars are necessary to disambiguate multiple commands).
+* Improvements in help text and readme.
+
 ## v1.1.0
 
 * Sort available networks alphabetically, left justify ssid's.

data/bin/mac-wifi

@@ -26,11 +26,22 @@ require 'tempfile'
 module MacWifi
 
 # This version must be kept in sync with the version in the gemspec file.
-VERSION = '1.1.0'
+VERSION = '1.2.0'
 
 
 class BaseModel
 
+  class OsCommandError < RuntimeError
+    attr_reader :exitstatus, :command, :text
+
+    def initialize(exitstatus, command, text)
+      @exitstatus = exitstatus
+      @command = command
+      @text = text
+    end
+  end
+
+
   def initialize(verbose = false)
     @verbose_mode = verbose
   end
@@ -158,11 +169,7 @@ class BaseModel
   # @return names of the networks that were removed (excludes non-preexisting networks)
   def remove_preferred_networks(*network_names)
     networks_to_remove = network_names & preferred_networks # exclude any nonexistent networks
-    networks_to_remove.each do |name|
-      run_os_command("sudo networksetup -removepreferredwirelessnetwork " +
-                         "#{wifi_hardware_port} #{Shellwords.shellescape(name)}")
-    end
-    networks_to_remove
+    networks_to_remove.each { |name| remove_preferred_network(name) }
   end
 
 
@@ -184,21 +191,21 @@ class BaseModel
 
     wait_interval_in_secs ||= 0.5
 
-    actions = {
+    finished_predicates = {
         conn: -> { connected_to_internet? },
         disc: -> { ! connected_to_internet? },
         on:   -> { wifi_on? },
         off:  -> { ! wifi_on? }
     }
 
-    exit_when = actions[status]
+    finished_predicate = finished_predicates[status]
 
-    if exit_when.nil?
-      raise ArgumentError.new("Option must be one of [#{actions.keys.map(&:inspect).join(', ')}]. Was: #{status.inspect}")
+    if finished_predicate.nil?
+      raise ArgumentError.new("Option must be one of #{finished_predicates.keys.inspect}. Was: #{status.inspect}")
     end
 
     loop do
-      return if exit_when.()
+      return if finished_predicate.()
       sleep(wait_interval_in_secs)
     end
   end
@@ -209,7 +216,7 @@ class MacOsModel < BaseModel
 
   AIRPORT_CMD = '/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport'
 
-  def initialize(verbose)
+  def initialize(verbose = false)
     super
   end
 
@@ -295,7 +302,7 @@ class MacOsModel < BaseModel
   # Returns true if wifi is on, else false.
   def wifi_on?
     lines = run_os_command("#{AIRPORT_CMD} -I").split("\n")
-    ! lines.grep("AirPort: Off").any?
+    lines.grep("AirPort: Off").none?
   end
 
 
@@ -406,17 +413,6 @@ class MacOsModel < BaseModel
   end
 
 
-  class OsCommandError < RuntimeError
-    attr_reader :exitstatus, :command, :text
-
-    def initialize(exitstatus, command, text)
-      @exitstatus = exitstatus
-      @command = command
-      @text = text
-    end
-  end
-
-
   def run_os_command(command)
     output = `#{command} 2>&1` # join stderr with stdout
     if $?.exitstatus != 0
@@ -451,6 +447,16 @@ class CommandLineInterface
 
   attr_reader :model
 
+  class Command < Struct.new(:min_string, :max_string, :action); end
+
+
+  class BadCommandError < RuntimeError
+    def initialize(error_message)
+      super
+    end
+  end
+
+
   # Help text to be used when requested by 'h' command, in case of unrecognized or nonexistent command, etc.
   HELP_TEXT = "
 mac-wifi version #{VERSION} -- Available commands are:
@@ -471,8 +477,8 @@ q[uit]                  - exits this program (interactive shell mode only)
 r[m] network-name       - removes network-name from the preferred networks list
 s[hell]                 - opens an interactive pry shell (command line only)
 t[ill]                  - returns when the desired Internet connection state is true. Options:
-                          'on'/:on or 'off'/:off
-                          wait interval, in seconds (optional, defaults to 0.5 seconds)
+                          1) 'on'/:on, 'off'/:off, 'conn'/:conn, or 'disc'/:disc
+                          2) wait interval, in seconds (optional, defaults to 0.5 seconds)
 w[ifion]                - is the wifi on?
 x[it]                   - exits this program (interactive shell mode only)
 
@@ -485,17 +491,7 @@ When in interactive shell mode:
 
   def initialize
     @model = MacOsModel.new(verbose_mode)
-    @interactive_mode = false # will be true if/when user selects shell option on command line
-  end
-
-
-  class Command < Struct.new(:min_string, :max_string, :action); end
-
-
-  class BadCommandError < RuntimeError
-    def initialize(error_message)
-      super
-    end
+    @interactive_mode = false # will be changed to true if/when user selects shell option on command line
   end
 
 
@@ -563,7 +559,8 @@ When in interactive shell mode:
     begin
       require 'pry'
     rescue LoadError
-      puts "The 'pry' gem, required for running the shell, was not found. Please `gem install pry`."
+      puts "The 'pry' gem and/or one of its prerequisites, required for running the shell, was not found." +
+               " Please `gem install pry`."
       exit(-1)
     end
 
@@ -615,7 +612,7 @@ When in interactive shell mode:
     else
       print_help
       raise BadCommandError.new(
-          "Unrecognized command. Command was #{action} and options were #{options.inspect}.")
+          %Q{Unrecognized command. Command was "#{command}" and options were #{options.inspect}.})
     end
   end
 
@@ -727,7 +724,7 @@ When in interactive shell mode:
 
   def cmd_w
     on = model.wifi_on?
-    puts "Wifi on?: #{on}" unless @interactive_mode
+    puts "Wifi on: #{on}" unless @interactive_mode
     on
   end
 
@@ -762,7 +759,12 @@ When in interactive shell mode:
 
 
   def find_command_action(command_string)
-    result = commands.detect { |cmd| cmd.max_string.start_with?(command_string) }
+    result = commands.detect do |cmd|
+        cmd.max_string.start_with?(command_string) \
+        && \
+        command_string.length >= cmd.min_string.length  # e.g. 'c' by itself should not work
+    end
+
     result ? result.action : nil
   end
 
@@ -773,7 +775,7 @@ When in interactive shell mode:
       process_command_line(ARGV[0], ARGV[1..-1])
     rescue BadCommandError => error
       separator_line = "#{'!' * 79}\n"
-      puts separator_line + "Bad command: #{ARGV[0]}\n" + separator_line + "\n"
+      puts '' << separator_line << error.to_s << "\n" << separator_line
       exit(-1)
     end
   end
@@ -796,29 +798,33 @@ end
 
 def running_as_script?
 
+  this_file = File.expand_path(__FILE__)
+  main_file = File.expand_path($0)
+
+  this_file_basename = File.basename(this_file)
+  main_file_basename = File.basename(main_file)
+
   # Please enable this code and report its output if you report any issues with this method:
-  # puts "__FILE__ = #{__FILE__}"
-  # puts "$0 =       #{$0}"
+  # puts "__FILE__ = #{this_file}"
+  # puts "$0 =       #{main_file}"
   # puts "GEM_PATH = #{ENV['GEM_PATH']}"
 
-  return true if __FILE__ == $0
-  return false if File.basename(__FILE__) != File.basename($0)
+  return true if main_file == this_file
+  return false if main_file_basename != this_file_basename
 
   # 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)
+    path_plus_basename = File.join(path, 'bin', main_file_basename)
+    __file__up_4 = File.expand_path(File.join(this_file, '..', '..', '..', '..'))
+    ($0 == path_plus_basename) && (path == __file__up_4)
   end
 end
 
 
 def assert_os_is_mac_os
-  uname = `uname`.chomp
-  unless uname == 'Darwin'
-    raise "This program currently works only on Mac OS. Platform is '#{uname}'."
+  unless /darwin/ === RbConfig::CONFIG["host_os"]  # e.g. "darwin16.4.0"
+    raise "This program currently works only on Mac OS. Platform is '#{RbConfig::CONFIG["host_os"]}'."
   end
 end
 

data/mac-wifi.gemspec

@@ -1,6 +1,6 @@
 # coding: utf-8
-# This version must be kept in sync with the version in the mac-wifi file.
-VERSION = '1.1.0'
+# When changing the version, also change the version and the help text in the README.
+VERSION = '1.2.0'
 
 Gem::Specification.new do |spec|
   spec.name          = "mac-wifi"

data/spec/mac-wifi_spec.rb

@@ -9,10 +9,10 @@ load File.join(File.dirname(__FILE__), '..', 'bin', 'mac-wifi')
 
 module MacWifi
 
-describe Model do
+describe MacOsModel do
 
 
-  subject { Model.new }
+  subject { MacOsModel.new }
 
   context 'turning wifi on and off' do
     it 'can turn wifi on' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mac-wifi
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2017-10-28 00:00:00.000000000 Z
 dependencies: []
 description: A command line interface for managing wifi on a Mac.
 email: