check_names 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ae24e5c2f8e58e99a99cbc138ae6956f8bc36c3c7bbfa9b07f19e955baba5b2
+  data.tar.gz: 65d72a1e16ec15f331da734b970d0f5b02079ef615996fcebc0efe4dac93d665
+SHA512:
+  metadata.gz: 7f5e70c3081b31e1f32e0b7cbc485bcfcd86db99f300d5590b4c76890bf9a0ec107901c0e08986787ac30933699d52a42d5fdfdc28b1e1110e0d7b57d6143493
+  data.tar.gz: 496da5b5fafe22d439b89424d3a059a587906752715d8a9fbf51b8f058403f692e030a68c2466233856e1da0b60029cb61cf37e71ad58ce962734ebaa4933564

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at richard.leber@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2020 Richard LeBer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# check_names
+
+http://github.com/rleber/check_names
+
+## Description
+
+To be provided
+
+## Features
+
+* To be provided
+
+## Usage
+
+      require 'check_names'
+      ...
+  
+## Requirements
+
+* None
+
+## Installation
+
+### For an app, with bundler
+
+* Add this to your application's Gemfile:
+```ruby
+            gem 'check_names'
+```
+
+* And then execute:
+
+    $ bundle install* gem install check_names
+
+### Without bundler
+
+    $ gem install check_names
+
+## Development
+
+* Run `bin/setup` to install dependencies. 
+* Run `rake spec` (or just `rake`) to run the tests. 
+* Run `console` to experiment with the gem.
+* Run `bundle exec rake install` to install this gem on your system.
+* To release a new version, update the version number in `VERSION.txt`
+  * You may run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rleber/check_names.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+ This project is intended to be a safe, welcoming space for collaboration. Everyone interacting in the check_names project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rleber/check_names/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION.txt

@@ -0,0 +1 @@
+0.0.1

data/exe/check_names

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+# Check: Does a gem name exist
+# Usage:
+#   check_names <name>
+
+# Where to check:
+# 1. Does a Rubygem of this name already exist?
+# 2. Does a Github repository of mine with this name already exist?
+# 3. Does an executable with this name already exist?
+# 4. Does an alias with this name already exist?
+# 5. Does a function with this name already exist?
+
+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 #{GemName.version}
+
+Usage:
+  check_names [OPTIONS]... [names]...
+
+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
+
+The following options are supported:
+
+--help    -h  Print this help information
+--verbose -v  Print messages about the status of the name check
+  HELP
+end
+
+def main(args)
+  args = args.map { |arg| arg.downcase }
+  verbose = args.index { |arg| %w{-v --verbose}.include?(arg) }
+  args.delete_at(verbose) if verbose
+  if args.size == 0 || %w{-h --help help}.include?(args.first)
+    show_help
+    exit
+  end
+  verbose ||= arg.size > 1
+  rc = 0
+  args.each do |arg|
+    status = GemName.check(arg)
+    puts "#{arg}: #{status[:message]}." if verbose
+    rc = status[:rc] if status[:rc] > rc
+  end
+  exit(rc)
+end
+
+if __FILE__ == $0
+  main(ARGV)
+end

data/lib/check_names/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckNames
+  VERSION = "0.1.0"
+
+  def self.version
+    VERSION
+  end
+end

data/lib/check_names.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "check_names/version"
+require 'shellwords'
+require 'httparty'
+
+module GemName
+  class Error < StandardError; end
+
+  def self.ruby_gem_exists?(name)
+    response = HTTParty.get("https://rubygems.org/gems/#{name}")
+    response.code == 200
+  end
+
+  def self.github_repository_exists?(name)
+    github_user = `git config github.user`.chomp
+    system("git ls-remote https://github.com/#{Shellwords.escape(github_user)}/#{Shellwords.escape(name)} 2>/dev/null >/dev/null")
+  end
+
+  # Note: This method does not distinguish between executables, functions, and aliases
+  def self.is_executable?(name)
+    system("zsh -lic 'which #{Shellwords.escape(name)}' >/dev/null")
+  end
+
+  # Note: This version explicitly excludes functions and aliases
+  def self.executable_exists?(name)
+    return false if self.function_exists?(name)
+    return false if self.alias_exists?(name)
+    self.is_executable?(name)
+  end
+
+  def self.function_exists?(name)
+    test_command = <<-COMMAND
+      if typeset -f #{Shellwords.escape(name)} > /dev/null; then
+        return 0
+      else
+        return 1
+      fi  
+    COMMAND
+    test_command_lines = test_command.split("\n")
+    zsh_command = "zsh -lic '#{test_command_lines.join(';')}' >/dev/null"
+    system(zsh_command)
+  end
+
+  def self.alias_exists?(name)
+    system("zsh -lic 'alias #{Shellwords.escape(name)}' >/dev/null")
+  end
+
+  def self.check(name)
+    if ruby_gem_exists?(name)
+      return {rc: 1, message: "A Gem on RubyGems"}
+    end
+    if github_repository_exists?(name)
+      return {rc: 2, message: "A personal Github repository"}
+    end
+    if executable_exists?(name)
+      return {rc: 3, message: "An executable"}
+    end
+    if function_exists?(name)
+      return {rc: 4, message: "A function"}
+    end
+    if alias_exists?(name)
+      return {rc: 5, message: "An alias"}
+    end
+    {rc: 0, message: "Available"}
+  end
+end

data/sig/check_names.rbs

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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: check_names
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard LeBer
+bindir: exe
+cert_chain: []
+date: 2025-06-14 00:00:00.000000000 Z
+dependencies: []
+description: Check whether names are in use
+email:
+- richard.leber@gmail.com
+executables:
+- check_names
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION.txt
+- exe/check_names
+- lib/.keep
+- lib/check_names.rb
+- lib/check_names/version.rb
+- sig/check_names.rbs
+homepage: http://github.com/rleber/check_names
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/rleber/check_names
+  changelog_uri: http://github.com/rleber/check_names/blob/master/CHANGELOG.md
+rdoc_options:
+- "--charset=UTF-8"
+- "--main"
+- README.md
+- "--title"
+- rleber check_names library
+- "--line-numbers"
+- "--inline-source"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Check whether names are in use
+test_files: []