mk.rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23dd64ef436e3a4d9dc32072fc4584bd62573ebe8a73c096f25b01340fe7d441
+  data.tar.gz: a32bf87baf298c11590c504f2780b8468bc68d3c44eb5f18b26851f0d8902593
+SHA512:
+  metadata.gz: 1fbad341e01332ca7756624cd272b7de016a4a13b4869837f11a3df6726434a4b330fd799da9c6c4ad104d8c9429003768b1dd76aa5a024e7c64495ddc989206
+  data.tar.gz: c7fc9482ab8e648aca71114d9f3aadfad91aad7c0e45878386773be0d1cf83d30cb5ac51b06f3683529cfc8ba2c4924d16a320ea12fcd66bb955f2858a6e965b

data/.github/workflows/gem-push.yml

@@ -0,0 +1,47 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+
+      - name: Build gem
+        run: gem build *.gemspec
+
+      - name: Publish to GPR
+        if: github.event_name == 'push'
+        run: |
+          mkdir -p $HOME/.gem
+          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          gem push --key github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{ secrets.GITHUB_TOKEN }}"
+          OWNER: ${{ github.repository_owner }}
+
+      - name: Publish to RubyGems
+        if: github.event_name == 'push'
+        run: |
+          mkdir -p $HOME/.gem
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_AUTH_TOKEN }}"

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  #gem "minitest", "~> 5.0"
+  #gem "rake", "~> 13.0"
+  #gem "rubocop", "~> 1.21"
+  #gem "yard", "~> 0.9"
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    mirrorfile (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    minitest (5.27.0)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.7.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rubocop (1.82.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    yard (0.9.38)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  mirrorfile!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.7.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Your Name
+
+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,93 @@
+# mk
+
+A CLI tool to create new projects from templates.
+
+## Install
+
+```bash
+gem install mk
+```
+
+## Usage
+
+```bash
+mk <template_name> <project_name>
+```
+
+This will:
+1. Copy the template to `./<project_name>`
+2. Replace `ExampleGem` with your project's constant name (e.g., `MyProject`)
+3. Replace `examplegem` with your project name (e.g., `my_project`)
+4. Rename any files containing these placeholders
+
+### Example
+
+```bash
+mk ruby my_awesome_gem
+```
+
+Creates a new directory `my_awesome_gem` from the `ruby` template with all placeholders replaced.
+
+## Templates
+
+Templates are searched in this order:
+
+1. `~/templates/<template_name>` - Your local templates (takes priority)
+2. Bundled templates included with the gem
+
+To override a bundled template, create one with the same name in `~/templates/`.
+
+### Creating Templates
+
+Templates are regular directories containing your project boilerplate. Use these placeholders:
+
+- `ExampleGem` - Replaced with the constant name (e.g., `MyAwesomeGem`)
+- `examplegem` - Replaced with the project name (e.g., `my_awesome_gem`)
+
+Placeholders work in both file contents and file/directory names.
+
+#### Example
+
+```bash
+mk ruby my_gem
+```
+
+Template file `~/templates/ruby/lib/examplegem.rb`:
+
+```ruby
+class ExampleGem
+  VERSION = "0.1.0"
+end
+```
+
+Output file `my_gem/lib/my_gem.rb`:
+
+```ruby
+class MyGem
+  VERSION = "0.1.0"
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## Development
+
+After checking out the repo:
+
+```bash
+bin/setup
+bundle exec rake test
+```
+
+Generate documentation:
+
+```bash
+bundle exec yard doc
+bundle exec yard server  # Browse at http://localhost:8808
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#require "bundler/gem_tasks"
+#require "rake/testtask"
+#require "yard"
+#
+#Rake::TestTask.new(:test) do |t|
+#  t.libs << "test"
+#  t.libs << "lib"
+#  t.test_files = FileList["test/**/*_test.rb"]
+#end
+#
+#YARD::Rake::YardocTask.new do |t|
+#  t.files = ["lib/**/*.rb"]
+#  t.options = ["--markup", "markdown"]
+#end
+#
+#task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mk"
+require "irb"
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/exe/mk

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/mk"
+
+exit Mk::CLI.new.call(ARGV)

data/lib/mk/cli.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Mk
+  class CLI
+    def call(args)
+      if args.length < 2
+        puts "Usage: mk <template_name> <project_name>"
+        return 1
+      end
+
+      template_name = args[0]
+      folder_name = args[1]
+      project_name = folder_name.sub(/\..*\z/, "")
+      constant_name = project_name.downcase.split(/[-_]/).map(&:capitalize).join
+
+      template_path = find_template(template_name)
+      unless template_path
+        puts "Template not found: #{template_name}"
+        return 1
+      end
+
+      system("cp", "-r", template_path, "./#{folder_name}")
+
+      replace_in_files(folder_name, project_name, constant_name)
+      rename_files(folder_name, project_name, constant_name)
+
+      puts "Created #{folder_name} from #{template_name} template"
+      0
+    end
+
+    private
+
+    def find_template(template_name)
+      user_path = File.expand_path("~/templates/#{template_name}")
+      return user_path if Dir.exist?(user_path)
+
+      gem_path = File.expand_path("../../templates/#{template_name}", __dir__)
+      return gem_path if Dir.exist?(gem_path)
+
+      nil
+    end
+
+    def replace_in_files(folder_name, project_name, constant_name)
+      Dir.glob("#{folder_name}/**/*", File::FNM_DOTMATCH).lazy
+        .reject { |path| File.directory?(path) }
+        .each do |file_path|
+          content = File.read(file_path)
+          updated_content = content
+            .gsub("ExampleGem", constant_name)
+            .gsub("examplegem", project_name)
+
+          File.write(file_path, updated_content)
+        end
+    end
+
+    def rename_files(folder_name, project_name, constant_name)
+      loop do
+        found_file = Dir.glob("#{folder_name}/**/*", File::FNM_DOTMATCH)
+          .lazy
+          .select { |path| path.match?(/examplegem|ExampleGem/) }
+          .first
+
+        if found_file
+          new_path = found_file
+            .gsub("ExampleGem", constant_name)
+            .gsub("examplegem", project_name)
+
+          File.rename(found_file, new_path)
+        else
+          break
+        end
+      end
+    end
+  end
+end

data/lib/mk/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mk
+  VERSION = "1.0.0"
+end

data/lib/mk.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "mk/version"
+require_relative "mk/cli"
+
+module Mk
+end

data/mk.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/mk/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mk.rb"
+  spec.version = Mk::VERSION
+  spec.authors = ["Nathan Kidd"]
+  spec.email = ["nathankidd@hey.com"]
+
+  spec.summary = "Create new projects from templates"
+
+  spec.description = <<~DESC
+    A CLI tool to create new projects from templates stored in ~/templates.
+  DESC
+
+  spec.homepage = "https://github.com/n-at-han-k/mk.rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["documentation_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|data)/}) }
+  spec.bindir = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: mk.rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathan Kidd
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 'A CLI tool to create new projects from templates stored in ~/templates.
+
+  '
+email:
+- nathankidd@hey.com
+executables:
+- mk
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/mk
+- lib/mk.rb
+- lib/mk/cli.rb
+- lib/mk/version.rb
+- mk.gemspec
+- templates/.gitkeep
+homepage: https://github.com/n-at-han-k/mk.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/n-at-han-k/mk.rb
+  source_code_uri: https://github.com/n-at-han-k/mk.rb
+  documentation_uri: https://github.com/n-at-han-k/mk.rb
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Create new projects from templates
+test_files: []