devcheck 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4f68fcc82596c0be261a9fdd19d3a9bcf477fc3d0e452691d91b7081ecf539a
+  data.tar.gz: '0682da605f0e9bc711e56a41928da97f5314730c41fcb904eff9a56712a7e35e'
+SHA512:
+  metadata.gz: 00e56e1771ab078643422823140c935196c42b61a7bd4dbe3dc2e16ca180cec251f4a9b6396b4fccaeaca2d6aafe9e5712c384376ff543c6d64448ef0d7f52b2
+  data.tar.gz: d7423ecfe23ea4071055c8d0977c54d7d2380af943f240b86acf244448933591ecae1f70fb00ead0b694b0900088987f90711afd897297b63bfbe831f39150ff

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Louie Bloomberg
+
+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,71 @@
+# devcheck
+A tool for checking development environments.
+
+`devcheck` is a command-line tool that helps developers ensure their development environments
+are configured correctly for the project they are working on. `devcheck` provides
+an easy way to set up your development environment checking by just creating a `.devcheck.rb` file
+and populating it with the required commands and files needed for the project to function properly.
+
+## Installation
+`devcheck` can be installed by running the `gem install devcheck` command from your terminal. 
+
+Ruby is required to install and run `devcheck`. You will need Ruby version 3.0 or higher.
+macOS Users will need to install a newer version of Ruby since the version Apple ships does not
+meet the minimum Ruby version required by `devcheck`.
+
+## Usage
+`devcheck` can be run by typing `devcheck` in your terminal. All you need is to have a
+`.devcheck.rb` file in your project directory and the Ruby interpreter. This program only
+checks for commands and files. 
+
+### Example
+```bash
+devcheck
+```
+```text
+devcheck
+Checking Development Environment
+
+✓ ruby
+✓ irb
+✓ git
+
+✓ LICENSE
+✓ README.md
+
+All checks passed!
+```
+
+### Exit Codes
+This program uses exit codes to help indicate the status of the program.
+* `0`: All checks passed.
+* `1`: One or more checks failed or the `.devcheck.rb` file is missing.
+
+## Configuration
+As mentioned earlier, all you need is a `.devcheck.rb` file in your project directory. A sample
+configuration file is shown and explained below.
+
+```ruby
+command "ruby"
+command "git"
+
+file "README.md"
+file "LICENSE"
+```
+- `command "name"` refers to a specific command that might be run by the program or require you to have said command installed on your device.
+- `file "path"` refers to a specific file that might be required by the program or need to be present in the project directory for it to function properly. 
+
+## Contributing
+We welcome contributions to the project and are so excited you have chosen to contribute!
+To contribute, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix.
+3. Make your changes and commit them with descriptive commit messages.
+4. Push your changes to your forked repository.
+5. Create a pull request to the main repository.
+
+Please ensure that your code follows the existing style and conventions of the project.
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

data/devcheck

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+# devcheck
+# devcheck
+# Copyright (c) 2026 Louie Bloomberg.
+# SPDX-License-Identifier: MIT
+
+# frozen_string_literal: true
+
+# Define Global Variables
+$failures = 0
+$commands = []
+$files = []
+
+# Define Functions
+def command(name)
+  $commands << name
+end
+
+def file(name)
+  $files << name
+end
+
+
+def command_exists?(cmd)
+  # On Windows, use 'where', on Unix-like systems use 'which'
+  checker = Gem.win_platform? ? 'where' : 'which'
+
+  # Suppress output and check exit status
+  system("#{checker} #{cmd} > /dev/null 2>&1")
+  if $?.success?
+    puts "✓ #{cmd}"
+  else
+    puts "✗ #{cmd}"
+    $failures += 1
+  end
+end
+
+
+def file_exists?(file)
+  if File.exist?(file)
+    puts "✓ #{file}"
+  else
+    puts "✗ #{file}"
+    $failures += 1
+  end
+end
+
+begin
+  load ".devcheck.rb"
+rescue LoadError
+  puts "No .devcheck.rb file found"
+  exit 1
+end
+
+# Main Function
+
+puts "devcheck"
+puts "Checking Development Environment"
+puts ""
+
+if $commands.empty?
+  puts "No Commands Specified."
+else
+  $commands.each do |cmd|
+    command_exists?(cmd)
+  end
+end
+
+puts ""
+
+if $files.empty?
+  puts "No Files Specified."
+else
+  $files.each do |file|
+    file_exists?(file)
+  end
+end
+
+puts ""
+
+if $failures > 0
+  if $failures == 1
+    puts "#{$failures} check failed"
+  else
+    puts "#{$failures} checks failed"
+  end
+  exit 1
+else
+  puts "All checks passed!"
+  exit 0
+end

metadata

@@ -0,0 +1,41 @@
+--- !ruby/object:Gem::Specification
+name: devcheck
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Louie Bloomberg
+bindir: "."
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+executables:
+- devcheck
+extensions: []
+extra_rdoc_files: []
+files:
+- "./devcheck"
+- LICENSE
+- README.md
+homepage: https://github.com/Bloomy52/devcheck
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Check a project's development environment
+test_files: []