stub_gem 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f72e4d67faf167af670866c1a64bf5a238057d3702c618da37affd337dbcdeef
+  data.tar.gz: 2536a6a972a2b25727a51b2c8f7bc02bb2ed161cb55464e33a5e76c25c3cf5bb
+SHA512:
+  metadata.gz: c97ffbced2b9dbdd9a56a092d4d00e49a0d822e089dda34c407bb16de4642c4ad5ed04ef6fd4379b72b48fa26f168527bfa18fe094634bc578c3bd89a75e56c3
+  data.tar.gz: 1940fbbc63f7d7ddab1964d1d284211f6c80283b84b076b08938a395d302ee269d449309da1dc6089457628d69ae4fa221163c8c3fded8456be5d61a239c6017

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  dc-rubocop: default.yml

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development, optional: true do
+  gem "dc-devtools"
+end

data/Guardfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+directories(%w[. lib test].select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") })
+
+guard :rake, task: "default" do
+  watch("Gemfile")
+  watch("Rakefile")
+  watch("Guardfile")
+  watch(%r{^test/helper\.rb$})
+  watch(%r{^test/test_(.*)\.rb$})
+  watch(%r{^lib/<%= @project_name %>/(.*)\.rb$})
+  watch(%r{^lib/(.*)\.rb$})
+end

data/README.md

@@ -0,0 +1,5 @@
+I wanted a program to template out a basic Ruby project, so that all the
+project setup is "just there" and I don't have to think about what parts I'm
+missing - everything is already "at hand," it's just a matter of me drumming
+something up. Project templates are nothing new, but this is my little
+contribution to the field.

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/test_*.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/stub_gem

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "stub_gem"
+
+def fail_usage(msg)
+  errormsg = <<~MSG
+    ERROR #{msg}
+    stub_gem
+    Usage:
+      stub_gem $PROJECT_NAME
+  MSG
+  abort errormsg
+end
+
+# TODO: use OptionParser or something nice like that
+proj_name = ARGV[0]
+fail_usage "Need a project name before proceeding" unless proj_name
+puts "* Project name: #{proj_name}"
+
+StubGem::RubyProject.new proj_name, "#{Dir.home}/src/#{proj_name}"

data/lib/stub_gem/version.rb

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

data/lib/stub_gem.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pathname"
+require "fileutils"
+require "date"
+require "erb"
+
+module StubGem
+  class RubyProject
+    def initialize(project_name, base_path)
+      @year = Date.today.year
+      @author = "David Crosby"
+      @project_name = project_name
+      @project_class = @project_name.capitalize
+
+      puts "* Using #{base_path}"
+      @template_dir = "#{File.dirname(Pathname.new(__FILE__).realpath)}/../templates/"
+      puts "* Template dir of #{@template_dir}"
+      fail_usage "project folder location exists at #{base_path}" if Dir.exist? base_path
+      @base_path_str = base_path
+      stub_project
+    end
+
+    def project_class
+      @project_class ||= @project_name.capitalize
+    end
+
+    def stub_project
+      Dir.mkdir @base_path_str
+      dir = Dir.new @base_path_str
+      @base_path = "#{dir.path}/"
+      puts "* Base path of: #{@base_path}"
+
+      stub_directory_structure
+      stub_project_docs
+      stub_library_mgmt
+      stub_testing
+      stub_build_infra
+      stub_linters
+      stub_code_boilerplate
+      stub_version_control
+    end
+
+    def stub_directory_structure
+      [
+        "lib/#{@project_name}",
+        ".github/workflows",
+        ".bundle",
+        "bin",
+        "test"
+      ].each do |dir|
+        FileUtils.mkdir_p("#{@base_path}/#{dir}")
+      end
+    end
+
+    def stub_project_docs
+      # TODO: stub_contributors
+      %w[
+        README.md
+        TODO.md
+        LICENSE
+      ].each do |f|
+        stub_single_file(f)
+      end
+    end
+
+    def stub_testing
+      # TODO: stub_minitest
+    end
+
+    def stub_library_mgmt
+      %w[
+        Gemfile
+      ].each do |f|
+        stub_single_file(f)
+      end
+      [
+        ["Gemfile"],
+        ["gemspec", nil, "#{@project_name}.gemspec"]
+      ].each do |name, dir, desired_name|
+        stub_single_file name, dir, desired_name
+      end
+    end
+
+    def stub_build_infra
+      [
+        ["Rakefile"],
+        ["Guardfile"],
+        ["bundle_config", ".bundle", "config"]
+      ].each do |name, dir, desired_name|
+        stub_single_file name, dir, desired_name
+      end
+    end
+
+    def stub_linters
+      %w[
+        .rubocop.yml
+      ].each do |f|
+        stub_single_file(f)
+      end
+    end
+
+    def stub_code_boilerplate
+      [
+        ["base_lib.rb.erb", "lib", "#{@project_name}.rb"],
+        ["version.rb.erb", "lib/#{@project_name}", "version.rb"]
+      ].each do |name, dir, desired_name|
+        stub_single_file name, dir, desired_name
+      end
+    end
+
+    def stub_version_control
+      [
+        [".gitignore"],
+        ["ruby_gh_workflow.yml", ".github/workflows", "main.yml"]
+      ].each do |name, dir, desired_name|
+        stub_single_file name, dir, desired_name
+      end
+      # TODO: stub_gitcommit
+      # TODO stub_github_project_templates
+    end
+
+    def stub_single_file(name, dir=nil, desired_name=nil)
+      template = ERB.new(File.read(File.join(@template_dir, name)))
+      desired_name ||= name
+      filepath = "#{@base_path}/"
+      filepath << "#{dir}/" if dir
+      filepath << desired_name
+      f = File.new(filepath, "w")
+      f.write(template.result(binding))
+      f.close
+    end
+  end
+end

data/templates/.gitignore

@@ -0,0 +1,3 @@
+vendor
+.bundle
+Gemfile.lock

data/templates/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  dc-rubocop: default.yml
+
+AllCops:
+  TargetRubyVersion: 2.5

data/templates/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development, optional: true do
+  gem "dc-devtools"
+end

data/templates/Guardfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+directories(%w[. lib test].select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") })
+
+guard :rake, task: "default" do
+  watch("Gemfile")
+  watch("Rakefile")
+  watch("Guardfile")
+  watch(%r{^test/helper\.rb$})
+  watch(%r{^test/test_(.*)\.rb$})
+  watch(%r{^lib/<%= @project_name %>/(.*)\.rb$})
+  watch(%r{^lib/(.*)\.rb$})
+end

data/templates/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <%= @year %> <%= @author %>
+
+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/templates/README.md

@@ -0,0 +1,15 @@
+# <%= @project_name %>
+
+What is this project?
+
+## Usage
+
+TODO!
+
+## Contributing
+
+TODO!
+
+## License
+
+See LICENSE file

data/templates/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/test_*.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/templates/TODO.md

@@ -0,0 +1,6 @@
+- [ ] Upload `<%= @project_name %>` to RubyGems (TODO command?)
+- [ ] Scrub git repo (TODO put command to merge commits into "initial commit")
+- [ ] Upload git repo to Github (TODO link to "create new repo")
+- [ ] Write a quick blog post
+- [ ] Post link to HN (TODO link to thing)
+- [ ] Post link to lobste.rs

data/templates/base_lib.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "<%= @project_name %>/version"
+
+module <%= @project_class %>
+  # TODO
+end

data/templates/bundle_config

@@ -0,0 +1,2 @@
+---
+BUNDLE_WITH: "development"

data/templates/gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "lib/<%= @project_name %>/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "<%= @project_name %>"
+  spec.required_ruby_version = ">= 2.5.0"
+  spec.version     = <%= @project_class %>::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ["David Crosby"]
+  spec.homepage    = "https://daveops.net"
+  spec.summary     = "A fancy new gem"
+  spec.description = "A fancy new gem generated by stub_gem"
+  spec.license     = "MIT"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test)/|\.(?:git))})
+    end
+  end
+end

data/templates/ruby_gh_workflow.yml

@@ -0,0 +1,30 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    env:
+      BUNDLE_WITH: development
+    strategy:
+      matrix:
+        ruby:
+          - '2.6'
+          - '3.0'
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/templates/version.rb.erb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module <%= @project_class %>
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: stub_gem
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Crosby
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-26 00:00:00.000000000 Z
+dependencies: []
+description: Simple program to stub out a Ruby project how I like it
+email:
+executables:
+- stub_gem
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- exe/stub_gem
+- lib/stub_gem.rb
+- lib/stub_gem/version.rb
+- templates/.gitignore
+- templates/.rubocop.yml
+- templates/Gemfile
+- templates/Guardfile
+- templates/LICENSE
+- templates/README.md
+- templates/Rakefile
+- templates/TODO.md
+- templates/base_lib.rb.erb
+- templates/bundle_config
+- templates/gemspec
+- templates/ruby_gh_workflow.yml
+- templates/version.rb.erb
+homepage: https://daveops.net
+licenses:
+- MIT
+metadata:
+  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: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Simple program to stub out a Ruby project how I like it
+test_files: []