check_names 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cb09b3fed90bd9fa021f047530c0caa584f03b077c73a048dfd60fe6e059a97
-  data.tar.gz: d90ea5f678f36bd1e6144fba95cfcb9a5136dcd7f63b3ef31a60fbe8e89ab74b
+  metadata.gz: 6bab692e352dc013e789d94d727cdc70520b1bf58a6ec2547dc770f94956e086
+  data.tar.gz: 8f753e604b1ceca688e5205ef9b4c55e17bbead39f3b2c3484038ae38fcd9b30
 SHA512:
-  metadata.gz: 8b4baf708e2ef476305f901103ec360809a4ca79c299a81ed6b4d241c19649d6e0600ee8eba41820f506a9329cf1d230ab1a11cd16845748f0615e74bdb25918
-  data.tar.gz: 730e74250b8f7c7ddb87fcc42fb683edc60e80fb1b25001e6c399b9705d95643c5798e20daa2170772b4cb3117b590b9a4e58f248c6ef400aeebf52b491a123e
+  metadata.gz: f6eba30abc087cbf322224c1d689df2b3ed234252b3ac7e239b66046f20c45c62d9736961c6ba257ab054e49fc74c6c1ac7581de3aef23075ba8bc6bd2f89d5d
+  data.tar.gz: 51318e1543af9c775d589a6b5bdb401eb8383a3e74b8a4413a6d2ba073fe093403de878adde1627ce86e4ac415024279573bfb625f888d9ce2e36fdc2bf2869f

data/exe/check_names

@@ -11,75 +11,76 @@
 # 4. Does an alias with this name already exist?
 # 5. Does a function with this name already exist?
 
+require 'optimist'
 require_relative '../lib/check_names/version'
 require_relative '../lib/check_names'
 
-def show_help
-  puts <<-HELP
-check_names: Check whether a proposed gem name already exists
-Version #{CheckNames.version}
+BANNER = <<-BANNER_TEXT
+#{File.basename(__FILE__)}:
+ersion #{CheckNames.version}
+
+Check whether a proposed gem name already exists
 
 Usage:
-  check_names [OPTIONS]... [names]...
+  #{File.basename(__FILE__)} OPTIONS NAME...
 
-check_names exits with a zero return code (success) if no conflicting gem
-name exists. Otherwise it exits with a non-zero return code, with one 
-of the following meanings:
 
-1  A gem exists on Rubygems with this name
-2  You have a github repository of this name
-3  You have an executable (reachable via \$PATH) with this name
-4  You have a shell function with this name
-5  You have an alias with this name
-6  This name is used by a Ruby standard class
+check_names looks to see whether the names provided are already in use.
+It outputs the usage (if any) of each name on $STDOUT. It exits with a 
+zero return code if none of the names are already in use. Otherwise it 
+exits with return code 1. 
 
-If more than one name was given, the return code is the maximum return code
-received for any name.
+check_names checks for each of the following uses:
 
-The following options are available:
+-  The name of a Ruby standard class
+-  The name of a gem on RubyGems
+-  The name of one of your Github repositories
+-  The name of a sehll alias
+-  The name of a shell function
+-  The name of an executable (reachable via \$PATH)
 
---help  -h  Print this help information
---quiet -q  Suppress messages about the status of the name check
---all   -a  Normally, check_names stops at the first use it finds.
-            With --all, it checks and reports every use
-  HELP
-end
+The following options are allowed:
+BANNER_TEXT
+
+def main
+  opts = Optimist.options do
+    version CheckNames.version
+    banner BANNER
+    opt :all, "Check for all possible uses. (Default is to stop at the first one found.)", default: false
+    educate_on_error
+  end
 
-def main(args)
+  all = opts[:all]
+  args = ARGV
   args = args.map { |arg| arg.downcase }
-  quiet = args.index { |arg| %w{-q --quiet}.include?(arg) }
-  args.delete_at(quiet) if quiet
-  all = args.index { |arg| %w{-a --all}.include?(arg) }
-  args.delete_at(all) if all
-  if args.size == 0 || %w{-h --help help}.include?(args.first)
-    show_help
+
+  if args.size == 0
+    Optimist.educate
     exit
   end
 
-  if all
-    results = GemName.check_names_all(*args)
-  else
-    results = GemName.check_names(*args)
-  end
-  
   rc = 0
-
-  types = []
-  results.each.with_index(1) do |result, count|
-    types << result[:description] if result[:result]
-    rc = result[:check] if result[:check] > rc
-    if count >= results.size || results[count][:name] != result[:name]
-      unless quiet
-        types << "Unused" if types.size == 0
-        puts "#{result[:name]}: #{types.join(', ')}"
+  args.each.with_index(0) do |arg, i|
+    print "#{arg}: "
+    checks_printed_count = 0
+    (1...(CheckNames.check_methods.size)).each do |check|
+      result = CheckNames.check_name(check, arg)
+      if result[:result]
+        print ", " if checks_printed_count > 0
+        print result[:description]
+        checks_printed_count += 1
+      end
+      if checks_printed_count > 0
+        rc = 1
+        break unless all
       end
-      types = []
     end
+    print CheckNames.check_method(0)[:description] unless checks_printed_count > 0
+    puts
   end
-  rc = 1 if rc > 0 && (all || args.size > 1)
   exit(rc)
 end
 
 if __FILE__ == $0
-  main(ARGV)
+  main
 end

data/lib/check_names/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module CheckNames
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 
   def self.version
     VERSION

data/lib/check_names.rb

@@ -4,7 +4,7 @@ require_relative "check_names/version"
 require 'shellwords'
 require 'httparty'
 
-module GemName
+module CheckNames
   class Error < StandardError; end
 
   def self.ruby_gem_exists?(name)
@@ -48,24 +48,38 @@ module GemName
 
   def self.standard_class_exists?(name)
     class_name = name.split('_').map(&:capitalize).join
-    Module.const_defined?(class_name)
+    # Do it this way so the Class space isn't polluted with the classes of this script
+    command = "ruby -e \"puts Module.const_defined?(\\\"#{class_name}\\\").inspect\""
+    begin
+      eval(`#{command}`.chomp)
+    rescue
+      false
+    end
   end
 
   CHECK_METHODS = [
-    {method: nil, description: "Unused"}, # 0
-    {method: :ruby_gem_exists?, description: "RubyGem"}, # 1
-    {method: :github_repository_exists?, description: "Github repository"}, # 2
-    {method: :executable_exists?, description: "Executable"}, # 3
-    {method: :function_exists?, description: "Function"}, # 4
-    {method: :alias_exists?, description: "Alias"}, # 5
-    {method: :standard_class_exists?, description: "Class"} # 6
+    {method: nil, description: "Unused"},
+    {method: :standard_class_exists?, description: "Class"},
+    {method: :ruby_gem_exists?, description: "RubyGem"},
+    {method: :github_repository_exists?, description: "Github repository"},
+    {method: :alias_exists?, description: "Alias"},
+    {method: :function_exists?, description: "Function"},
+    {method: :executable_exists?, description: "Executable"}
   ]
 
+  def self.check_methods
+    CHECK_METHODS
+  end
+
+  def self.check_method(i)
+    CHECK_METHODS[i]
+  end
+
   def self.unused_result
     {check: 0, description: CHECK_METHODS[0][:description], result: true}
   end
 
-  def self.check_name_once(check, name)
+  def self.check_name(check, name)
     method = CHECK_METHODS[check] && CHECK_METHODS[check][:method]
     if method
       result = {check: check, description: CHECK_METHODS[check][:description], result: send(method, name)}
@@ -75,40 +89,4 @@ module GemName
     result[:name] = name
     result
   end
-
-  def self.check_name(name)
-    name = name.downcase
-    result = unused_result.dup
-    (1...(CHECK_METHODS.size)).each do |check|
-      res = check_name_once(check, name)
-      if res[:result]
-        result = res
-        break
-      end
-    end
-    result[:name] = name
-    result
-  end
-
-  def self.check_name_all(name)
-    (1...(CHECK_METHODS.size)).map do |check|
-      check_name_once(check, name)
-    end
-  end
-
-  def self.check_names(*names)
-    results = []
-    names.each do |name|
-      results << check_name(name)
-    end
-    results
-  end
-
-  def self.check_names_all(*names)
-    results = []
-    names.each do |name|
-      results += check_name_all(name)
-    end
-    results
-  end
 end

data/sig/check_names.rbs

@@ -1,4 +1,4 @@
-module GemName
+module CheckNames
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: check_names
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Richard LeBer