scipio 0.6.0

data/README.md

@@ -0,0 +1,38 @@
+# Scipio
+
+A small CLI utility to:
+- set up new Ruby Gems using a configurable template
+- set up local & remote git repos
+- launch Rake tasks from anywhere
+
+Generally to help set up & run Ruby projects with less typing. Scipio. Skip IO. Geddit?
+
+## Status
+
+Early days. Development status "3 - Alpha" in Python terms.
+
+(Those Python statuses are 1 - Planning, 2 - Pre-alpha, 3 - Alpha, 4 - Beta, 5 - Production/Stable, 6 - Mature, 7 - Inactive.)
+
+## Ancient history
+
+<img src="./Scipio.png" alt="Scipio Africanus, OG" />
+
+In 2015 Scipio was a Swift package manager written in Python, but it was soon made obsolete by the growth of Apple's own package manager. Carthage was one of the other alternatives around at the time. Carthago delenda est.
+
+A little earlier, Scipio was also a Roman general & one of the authors of Carthage's defeat in the Second Punic War.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem locally, run `bundle exec rake local`.
+
+`bundle exec rake -T` to see the current options.
+
+## Contributing
+
+Bug reports and pull requests are welcome at [https://codeberg.org/kreuzer/scipio](https://codeberg.org/kreuzer/scipio). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://codeberg.org/kreuzer/scipio/src/branch/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Scipio project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://codeberg.org/kreuzer/scipio/src/branch/main/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'scipio'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/scipio

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'bundler/setup'
+require 'scipio/cli'
+
+Scipio::CLI.new.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/scipio/cli.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "yaml"
+
+require_relative "config"
+require_relative "gems"
+require_relative "git"
+require_relative "rake"
+
+module Scipio
+  # CLI handled by optparse
+  class CLI
+    def start(*_args)
+      @options = {}
+      OptionParser.new do |opts|
+        opts.banner = <<~BANNER
+          Scipio
+          Expanded help here
+
+          Commands:
+        BANNER
+        gem(opts)
+        help(opts)
+        init(opts)
+        local(opts)
+        naked_repo(opts)
+        rake(opts)
+        task(opts)
+        version(opts)
+      end.parse!
+
+      create_gem
+      create_repo
+      create_task
+    rescue OptionParser::InvalidOption
+      puts "Invalid option"
+      # don't have opts here to show help
+    end
+
+    def gem(opts)
+      opts.on("-g GEM", "--gem GEM", "Create a new ruby gem named GEM") do |opt|
+        @options[:gem] = opt
+      end
+    end
+
+    def help(opts)
+      opts.on("-h", "--help", "This help message") do
+        puts opts
+        exit
+      end
+    end
+
+    def init(opts)
+      opts.on("-i", "--initialize", "Initialize config & template files, show details if they exist") do
+        config = Scipio::Config.new
+        config.info
+        gem = Scipio::Gems.new(config:, gem_name: "")
+        gem.init
+      end
+    end
+
+    def local(opts)
+      opts.on("-l", "--local", "With a gem or repo, do not create or connect to the origin") do
+        @options[:local] = true
+      end
+    end
+
+    def naked_repo(opts)
+      opts.on("-n REPO", "--naked REPO", "Create a new naked git repo named REPO") do |opt|
+        @options[:repo] = opt
+      end
+    end
+
+    def rake(opts)
+      opts.on("-r RAKE", "--rake RAKE", "Run Rake in directory RAKE, or named RAKE in config") do |opt|
+        @options[:rake] = opt
+      end
+    end
+
+    def task(opts)
+      opts.on("-t TASK", "--task TASK", "Rake task, use -t -T to list tasks, leave off for the default task") do |opt|
+        @options[:task] = opt
+      end
+    end
+
+    def version(opts)
+      opts.on("-v", "--version", "The version") do
+        puts Scipio::VERSION
+        exit
+      end
+    end
+
+    # TODO: provide a path here to override the default
+    def create_gem
+      if @options[:gem]
+        config = Scipio::Config.new
+        repo = Scipio::Git.new(config:, repo_name: @options[:gem])
+        gem = Scipio::Gems.new(config:, gem_name: @options[:gem])
+
+        repo.create_dir
+        repo.init_before_write
+        gem.write
+        repo.init_after_write
+        unless @options[:local]
+          repo.remote
+        end
+
+        exit
+      end
+    end
+
+    def create_repo
+      if @options[:repo]
+        config = Scipio::Config.new
+        repo = Scipio::Git.new(config:, repo_name: @options[:repo])
+
+        repo.create_dir
+        repo.naked_write
+        unless @options[:local]
+          repo.remote
+        end
+
+        exit
+      end
+    end
+
+    def create_task
+      if @options[:rake]
+        config = Scipio::Config.new
+        @options[:task] ||= ""
+        rake = Scipio::Rake.new(options: @options, config:)
+        rake.run
+        exit
+      end
+
+      # no rake dir or name, but a task
+      if @options[:task]
+        puts "--task requires --rake NAME, the directory or named Rake file you're calling this task on"
+        exit
+      end
+    end
+  end
+end

data/lib/scipio/config.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Scipio
+  # Stored git repo config for Scipio
+  class Config
+    attr_reader :git_dir,
+      :git_domain,
+      :git_site,
+      :rake_dirs,
+      :user_email,
+      :user_fullname,
+      :user_name
+
+    def self.config_dir
+      File.join(Config.home_dir, ".config/scipio")
+    end
+
+    def self.config_file
+      File.join(Config.config_dir, "config.yml")
+    end
+
+    def self.home_dir
+      path = if RUBY_PLATFORM.match?(/cygwin | mswin | mingw | bccwin | wince | emx /)
+        "%userprofile%"
+      else
+        "~"
+      end
+      File.expand_path(path)
+    end
+
+    def self.template_dir
+      File.join(Config.config_dir, "template")
+    end
+
+    def initialize
+      if File.exist?(Config.config_file)
+        read_file
+      else
+        init
+      end
+    end
+
+    # TODO errors
+    # TODO read config values as defaults, with chance to overide interactively
+    #  rescue Errno::ENOENT => _e
+    #    puts "No config file present"
+    #  rescue Psych::SyntaxError => error
+    #    puts "Could not parse config: #{error.message}"
+    #  ensure
+    #    exit
+    #  end
+
+    def init
+      if File.exist?(Config.config_file)
+        return
+      end
+      ask_for_git_dir
+      parse_git_config
+      parse_berg_user_info
+      parse_berg_config
+      @git_site = "#{@git_site}/#{@user_name}"
+      FileUtils.mkdir_p(Config.template_dir)
+      save_file
+    end
+
+    def info
+      puts <<~INFO
+        Current config in - #{Config.config_file}
+
+        Git
+        local: \t#{@git_dir}
+        domain: #{@git_domain}
+        origin: #{@git_site}
+        e-mail: #{@user_email}
+        name: \t#{@user_fullname}
+        user: \t#{@user_name}
+
+        Rake
+      INFO
+      if rake_dirs
+        rake_dirs.each do |name, dir|
+          puts "#{name} - #{dir}"
+        end
+      else
+        puts "No rake directories defined"
+      end
+      # exit
+    end
+
+    def ask_for_git_dir
+      puts "What directory should local git repos be created in?"
+      dir = File.expand_path($stdin.gets.chomp.strip)
+      raise StandardError.new "#{dir} - doesn't seem to exists, enter manually in file" unless File.directory?(dir)
+    rescue => error
+      puts error.message
+      dir = ""
+    ensure
+      @git_dir = dir
+    end
+
+    def read_file
+      config = YAML.safe_load_file(Config.config_file, permitted_classes: [Hash])
+      git = config["git"]
+      @git_dir = git["git_dir"]
+      @git_domain = git["git_domain"]
+      @git_site = git["git_site"]
+      @user_email = git["user_email"]
+      @user_fullname = git["user_fullname"]
+      @user_name = git["user_name"]
+      @rake_dirs = config["rake"]
+    end
+
+    def save_file
+      config = {"git" => {
+                  "git_dir" => @git_dir,
+                  "git_domain" => @git_domain,
+                  "git_site" => @git_site,
+                  "user_email" => @user_email,
+                  "user_fullname" => @user_fullname,
+                  "user_name" => @user_name
+                },
+                "rake" => {
+                  "name" => "path"
+                }}
+      json = config.to_yaml
+      File.write(Config.config_file, json)
+    end
+
+    # ~/.Config -> @user_email, @user_fullname
+    def parse_git_config
+      git_config = File.join(Config.home_dir, ".gitconfig")
+      File.readlines(git_config, chomp: true).each do |line|
+        res = line.match(/email = (?<email>\S+)/)
+        unless res.nil?
+          @user_email = res[:email]
+        end
+        res = line.match(/name = (?<name>.+)$/)
+        unless res.nil?
+          @user_fullname = res[:name]
+        end
+      end
+    end
+
+    # berg user info -> @user_name
+    def parse_berg_user_info
+      bash = `berg user info`
+      res = bash.match(/│ Username\s+┆ (?<name>\S+)\s+│/)
+      @user_name = res[:name]
+      # TODO: could not get git user name from berg, please enter manually - #{Config.config_file}
+    end
+
+    # berg config info -> @git_site
+    def parse_berg_config
+      # ~/Library/Application Support/berg-cli/berg.toml -> git_site
+      # but would be OS specific
+      # berg_config = File.join(home_dir, "Library/Application Support/berg-cli/berg.toml")
+      # url = ""
+      # protocol = ""
+      # File.readlines(berg_config, chomp: true).each do |line|
+      #   res = line.match(/base_url = (?<url>\S+)/)
+      #   unless res.nil?
+      #     url = res[:url].tr("\"", "")
+      #   end
+      #   res = line.match(/protocol = (?<protocol>.+)$/)
+      #   unless res.nil?
+      #     protocol = res[:protocol].tr("\"", "")
+      #   end
+      # end
+      # @git_site = "#{protocol}://#{url}"
+      bash = `berg config info`
+      protocol = bash.match(/│ protocol\s+┆ ".+" ┆ (?<protocol>\S+)\s+│/)
+      url = bash.match(/│ base_url\s+┆ ".+" ┆ (?<url>\S+)\s+│/)
+      @git_domain = url[:url].tr("\"", "").tr("/", "")
+      @git_site = "#{protocol[:protocol].tr("\"", "")}://#{@git_domain}"
+    end
+  end
+end

data/lib/scipio/gems.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "date"
+require "erb"
+require "fileutils"
+require "pathname"
+
+require_relative "config"
+
+module Scipio
+  # Create the skeleton of a new Gem
+  class Gems
+    def initialize(config:, gem_name:)
+      @gem_default_templates = File.expand_path("../../template", File.dirname(__FILE__))
+
+      @config_dir = Config.config_dir
+      @gem_name = gem_name
+      @git_dir = config.git_dir
+      @template_dir = Config.template_dir
+      @vars = {gem_name: @gem_name,
+               git_site: config.git_site,
+               user_name: config.user_name,
+               user_fullname: config.user_fullname,
+               user_email: config.user_email,
+               date: DateTime.now}
+    end
+
+    def templates(dir:)
+      # except for dot files this could be... Dir[File.join(dir, "**/*")]
+      filter_types = %w[. .. .DS_Store]
+      Dir.glob(File.join(dir, "**/*"), File::FNM_DOTMATCH)
+        .select { |file| !file.end_with?(*filter_types) }
+    end
+
+    def relative_out_path(path_from:)
+      out = Pathname.new(path_from)
+        .relative_path_from(@template_dir)
+        .to_s
+        .chomp(".t")
+      out % @vars
+    end
+
+    def write
+      out_dir = File.join(@git_dir, @gem_name)
+      # create_out_dir(out_dir:)
+      templates(dir: @template_dir).each do |path_from|
+        path_to = File.join(out_dir, relative_out_path(path_from:))
+
+        if File.directory? path_from
+          FileUtils.mkdir_p path_to
+        else
+          puts path_to # TODO: unless silent
+          template = ERB.new(File.read(path_from))
+          IO.write(path_to, template.result_with_hash(@vars))
+        end
+      end
+    end
+
+    # copy the default template files for users to modify or use
+    def init
+      FileUtils.mkdir_p @template_dir
+      unless Dir.empty? @template_dir
+        puts "Templates directory not empty - #{@template_dir}"
+        exit
+      end
+      FileUtils.cp_r(@gem_default_templates, @config_dir)
+    end
+  end
+end

data/lib/scipio/git.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Scipio
+  class Git
+    def initialize(config:, repo_name:)
+      @git_domain = config.git_domain
+      @repo_name = repo_name
+      @user_name = config.user_name
+
+      @dir = File.join(config.git_dir, @repo_name)
+      # create_dir
+      ensure_main
+    end
+
+    def create_dir
+      if File.exist?(@dir)
+        puts "Directory already exists - #{@dir}"
+        exit
+      end
+      FileUtils.mkdir_p(@dir)
+    end
+
+    # TODO: call out changing git setup, and/or push name to config
+    def ensure_main
+      system "git config --global init.defaultBranch main"
+    end
+
+    def init_before_write
+      Dir.chdir(@dir) do
+        system "git init"
+      end
+    end
+
+    # alternative to writing out gem files
+    def init_write
+      Dir.chdir(@dir) do
+        system "touch README.md"
+        system "touch .gitignore"
+      end
+    end
+
+    def init_after_write
+      Dir.chdir(@dir) do
+        system "git checkout -b main"
+        system "git add ."
+        system 'git commit -m "Initial commit"'
+      end
+    end
+
+    def naked_write
+      init_before_write
+      init_write
+      init_after_write
+    end
+
+    # TODO - alt for github, etc
+    # TODO - ssh/sftp choice
+    #
+    # fatal: protocol 'git@https' is not supported
+    def remote
+      Dir.chdir(@dir) do
+        system "berg repo create --default-branch main --description 'To follow' --name #{@repo_name} --private public"
+        system "git remote add origin git@#{@git_domain}:#{@user_name}/#{@repo_name}.git"
+        system "git push -u origin main"
+      end
+    end
+  end
+end

data/lib/scipio/rake.rb

@@ -0,0 +1,45 @@
+require "bundler"
+
+module Scipio
+  # To call Rake from anywhere
+  class Rake
+    def initialize(options:, config:)
+      @rake = options[:rake]
+      @task = options[:task] # may be an empty string
+      @dir = config.rake_dirs
+    end
+
+    # if running without bundler
+    # https://mattbrictson.com/blog/run-shell-commands-in-ruby
+    def self.with_original_bundler_env(&)
+      return yield unless defined?(Bundler)
+      Bundler.with_original_env(&)
+    end
+
+    def run
+      dir = try_dir(rake: @rake)
+      Dir.chdir(dir) do
+        # Bundler.with_original_env do
+        Rake.with_original_bundler_env do
+          system("bundle exec rake #{@task} --trace", exception: true)
+        end
+      end
+    end
+
+    # try for a directory, then an entry in the config
+    # TODO: note - watch out for directories in the directory you're calling scipio from,
+    # rake will search the tree upwards from any directory it uses
+    def try_dir(rake:)
+      dir =
+        if File.directory?(File.expand_path(rake))
+          rake
+        elsif @dir.key?(rake) && File.directory?(File.expand_path(@dir[rake]))
+          @dir[rake]
+        else
+          p "Don't know directory or config entry - #{rake}"
+          exit
+        end
+      File.expand_path(dir)
+    end
+  end
+end

data/lib/scipio/version.rb

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

data/lib/scipio.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "scipio/version"
+
+# Scipio's top level module
+module Scipio
+end

data/template/%{gem_name}.gemspec.t

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# probably no longer required
+# lib = File.expand_path("lib", __dir__)
+# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative "lib/<%= gem_name %>/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "<%= gem_name %>"
+  spec.version = <%= gem_name.capitalize %>::VERSION
+  spec.authors = ["<%= user_fullname %>"]
+  spec.email = ["<%= user_email %>"]
+
+  spec.summary = "TODO: Description"
+  spec.description = <<~DESC
+    TODO: Longer description
+  DESC
+  spec.homepage = "<%= git_site %>/<%= user_name %>/<%= gem_name %>"
+  spec.license = "AGPL-3.0-or-later"
+  spec.required_ruby_version = ">= 3.3"
+
+  spec.metadata["allowed_push_host"] = "TODO: Set to your gem server or delete line"
+
+  spec.metadata = {
+    "changelog_uri" => "#{spec.homepage}/src/branch/main/CHANGELOG.md",
+    "homepage_uri" => spec.homepage,
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => spec.homepage
+  }
+
+  spec.files = Dir.glob("{bin,lib,template}/**/*") + %w[LICENSE.txt README.md CHANGELOG.md]
+  spec.bindir = "bin"
+  spec.executables = "<%= gem_name %>"
+  spec.require_paths = ["lib"]
+
+  unless ENV.fetch("UNSIGNED_BUILD", "false") == "true"
+    spec.cert_chain = ["certs/<%= user_name %>.pem"]
+    spec.signing_key = File.expand_path("~/.ssh/gem-private_key.pem")
+  end
+
+  # spec.add_dependency "example-gem", "~> 1.0"
+end

data/template/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/template/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - <%= date.strftime("%e %B %Y") %>
+
+- Initial release