foobara-empty-ruby-project-generator 0.0.1

data/src/manifests/project_config.rb

@@ -0,0 +1,138 @@
+require "English"
+
+module Foobara
+  module Generators
+    module EmptyRubyProjectGenerator
+      class ProjectConfig < Foobara::Model
+        attributes do
+          name :string, "Name can be the directory to create or optionally org/directory. " \
+                        "The org will be used as the github org and " \
+                        "the directory will be used as the github repository." \
+                        "For example, `some-org-on-github/some-repository-name` would create " \
+                        "a project modules of `SomeOrgOnGithub::SomeRepositoryName` " \
+                        "(unless you override the module name.)"
+          # This specifies the module nesting for generated files for this project. It might have prefixes left out of
+          # the project_name. It will default to Org::Project
+          full_module_name :string, "If you want a different module name than the one inferred from the name input " \
+                                    "then specify it with this option."
+          description :string, default: "No description. Add one."
+          author_names [:string]
+          author_emails [:string]
+          homepage_url :string
+          # Probably need a better default such as not licensed.
+          license :string, default: "None specified yet"
+        end
+
+        def kebab_case_project_name
+          Util.kebab_case(project_module_path.join)
+        end
+
+        def kebab_case_full_project_name
+          Util.kebab_case(full_project_path.join)
+        end
+
+        def org_slash_project_kebab(organization_name = self.organization_name, project_name = self.project_name)
+          org_part = Util.kebab_case(organization_name)&.gsub("::", "-")
+          project_part = Util.kebab_case(project_name).gsub("::", "-")
+
+          if org_part.nil? || org_part.empty?
+            project_part
+          else
+            "#{org_part}/#{project_part}"
+          end
+        end
+
+        def org_slash_project_underscore
+          org_slash_project_kebab.gsub("-", "_")
+        end
+
+        def project_lib_file_path
+          full_project_path.map { |part| Util.underscore(part) }.join("/")
+        end
+
+        def organization_name
+          @organization_name ||= begin
+            org_and_project = name.split("/")
+
+            if org_and_project.size == 2
+              org_and_project.first
+            end
+          end
+        end
+
+        def project_name
+          @project_name ||= name.split("/").last
+        end
+
+        def project_module_path
+          @project_module_path ||= kebab_to_module_path(project_name)
+        end
+
+        def project_module_name
+          @project_module_name ||= project_module_path.join("::")
+        end
+
+        def organization_module_path
+          @organization_module_path ||= kebab_to_module_path(organization_name)
+        end
+
+        def organization_module_name
+          @organization_module_name ||= organization_module_path.join("::")
+        end
+
+        # TODO: These two are not great names. Should have the word "module" in them.
+        def full_project_path
+          @full_project_path ||= full_module_name&.split("::") || [*organization_module_path, *project_module_path]
+        end
+
+        def full_project_name
+          @full_project_name ||= [organization_module_name, project_module_name].compact.join("::")
+        end
+
+        def author_names
+          # TODO: implement #[] or move it up to Model from Entity if it exists there.
+          @author_names ||= read_attribute(:author_names) || begin
+            # TODO: dump a git config file in CI so we don't have to skip this
+            # :nocov:
+            name = `git config --get user.name`
+
+            if $CHILD_STATUS.exitstatus == 0
+              [name.strip]
+            else
+              raise "Must set author_names because we can't get it from git for some reason"
+            end
+            # :nocov:
+          end
+        end
+
+        def author_emails
+          @author_emails ||= read_attribute(:author_emails) || begin
+            # :nocov:
+            email = `git config --get user.email`
+
+            if $CHILD_STATUS.exitstatus == 0
+              [email.strip]
+            else
+              raise "Must set author_emails because we can't get it from git for some reason"
+            end
+            # :nocov:
+          end
+        end
+
+        def homepage_url
+          @homepage_url ||= "https://github.com/#{org_slash_project_kebab(organization_name, project_module_name)}"
+        end
+
+        private
+
+        def kebab_to_module_path(kebab)
+          if kebab
+            kebab.split("_").map { |part| Util.classify(part.gsub("-", "_")) }
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/src/write_empty_ruby_project_to_disk.rb

@@ -0,0 +1,192 @@
+require_relative "generate_empty_ruby_project"
+
+module Foobara
+  module Generators
+    module EmptyRubyProjectGenerator
+      class WriteEmptyRubyProjectToDisk < Foobara::Generators::WriteGeneratedFilesToDisk
+        class << self
+          def generator_key
+            "ruby-project"
+          end
+        end
+
+        depends_on GenerateEmptyRubyProject
+
+        inputs do
+          project_config ProjectConfig, :required
+          # TODO: should be able to delete this and inherit it
+          output_directory :string
+        end
+
+        def execute
+          generate_file_contents
+          write_all_files_to_disk
+          run_post_generation_tasks
+
+          output
+        end
+
+        def output_directory
+          inputs[:output_directory] || default_output_directory
+        end
+
+        def default_output_directory
+          project_config.org_slash_project_kebab
+        end
+
+        def generate_file_contents
+          puts "generating..."
+          # TODO: just pass this in as the inputs instead of the command??
+          self.paths_to_source_code = run_subcommand!(GenerateEmptyRubyProject, project_config.attributes)
+        end
+
+        def run_post_generation_tasks
+          Dir.chdir output_directory do
+            bundle_install
+            make_bin_files_executable
+            rubocop_autocorrect
+            git_init
+            git_add_all
+            git_commit
+            github_create_repo
+            git_add_remote_origin
+            git_branch_main
+            push_to_github
+            rbenv_bundler_on
+          end
+        end
+
+        def bundle_install
+          puts "bundling..."
+          Bundler.with_unbundled_env do
+            Open3.popen3("bundle install") do |_stdin, _stdout, stderr, wait_thr|
+              exit_status = wait_thr.value
+              unless exit_status.success?
+                # :nocov:
+                raise "could not bundle install. #{stderr.read}"
+                # :nocov:
+              end
+            end
+          end
+        end
+
+        def rubocop_autocorrect
+          puts "linting..."
+          Open3.popen3("bundle exec rubocop --no-server -A") do |_stdin, _stdout, stderr, wait_thr|
+            exit_status = wait_thr.value
+            unless exit_status.success?
+              # :nocov:
+              raise "could not bundle exec rubocop -A. #{stderr.read}"
+              # :nocov:
+            end
+          end
+        end
+
+        def make_bin_files_executable
+          Dir["bin/*"].each do |file|
+            if File.file?(file)
+              system("chmod u+x #{file}")
+            end
+          end
+        end
+
+        def git_init
+          cmd = "git init"
+
+          Open3.popen3(cmd) do |_stdin, _stdout, stderr, wait_thr|
+            exit_status = wait_thr.value
+            unless exit_status.success?
+              # :nocov:
+              raise "could not #{cmd}\n#{stderr.read}"
+              # :nocov:
+            end
+          end
+        end
+
+        def git_add_all
+          unless system("git add .")
+            # :nocov:
+            raise "could not git add ."
+            # :nocov:
+          end
+        end
+
+        def git_commit
+          # TODO: set author/name with git config in CI so we don't have to skip this
+          # :nocov:
+          Open3.popen3("git commit -m 'Initial commit'") do |_stdin, _stdout, stderr, wait_thr|
+            exit_status = wait_thr.value
+            unless exit_status.success?
+              raise "could not git commit -m 'Initial commit'. #{stderr.read}"
+            end
+          end
+          # :nocov:
+        end
+
+        attr_accessor :origin_set, :pushed
+
+        def github_create_repo
+          puts "pushing to github..."
+
+          cmd = "gh repo create --public --push --source=. #{project_config.org_slash_project_kebab}"
+
+          Open3.popen3(cmd) do |_stdin, _stdout, _stderr, wait_thr|
+            exit_status = wait_thr.value
+            if exit_status.success?
+              # :nocov:
+              self.origin_set = true
+              self.pushed = true
+              # :nocov:
+            else
+              warn "WARNING: could not #{cmd}"
+            end
+          end
+        end
+
+        def git_add_remote_origin
+          return if origin_set
+
+          unless system("git remote add origin git@github.com:#{project_config.org_slash_project_kebab}.git")
+            # :nocov:
+            raise "could not git remote add origin git@github.com:#{project_config.org_slash_project_kebab}.git"
+            # :nocov:
+          end
+        end
+
+        def git_branch_main
+          unless system("git branch -M main")
+            # :nocov:
+            raise "could not git branch -M main"
+            # :nocov:
+          end
+        end
+
+        def push_to_github
+          return if pushed
+
+          Open3.popen3("git push -u origin main") do |_stdin, _stdout, stderr, wait_thr|
+            exit_status = wait_thr.value
+            unless exit_status.success?
+              warn "WARNING: could not git push -u origin main \n #{stderr.read}"
+            end
+          end
+        end
+
+        def rbenv_bundler_on
+          # :nocov:
+          Open3.popen3("rbenv bundler on") do |_stdin, _stdout, stderr, wait_thr|
+            exit_status = wait_thr.value
+            unless exit_status.success?
+              warn "WARNING: could not rbenv bundler on \n #{stderr.read}"
+            end
+          end
+          # :nocov:
+        end
+
+        def output
+          "\nDone. #{stats}"
+        end
+      end
+    end
+  end
+end

data/templates/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_DISABLE_LOCAL_BRANCH_CHECK: "true"

data/templates/.github/workflows/ci.yml.erb

@@ -0,0 +1,87 @@
+name: RSpec and Rubocop
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    name: RSpec and Rubocop
+    timeout-minutes: 3
+    steps:
+      - uses: actions/checkout@v3
+      - name: setup ruby version and foobara branch and sha1
+        run: |
+          foobara_entry=`grep -A2 -m 1 '  remote: foobara$' Gemfile.lock`
+          regex="revision: ([0-9a-f]+)\s+branch: ([-_[:alnum:]]+)$"
+
+          if [[ $foobara_entry =~ $regex ]]; then
+            foobara_sha1="${BASH_REMATCH[1]}"
+            foobara_branch="${BASH_REMATCH[2]}"
+
+            echo foobara_sha1=$foobara_sha1 >> "$GITHUB_ENV"
+            echo foobara_branch=$foobara_branch >> "$GITHUB_ENV"
+          else
+            echo "$foobara_entry doesn't match $regex" >&2
+          fi
+
+          echo ruby_version=`cat .ruby-version` >> "$GITHUB_ENV"
+      - name: cache foobara
+        id: cache-foobara
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-foobara
+        with:
+          path: ~/work/<%= kebab_case_project_name %>/foobara
+          key: ${{ env.cache-name }}-${{ env.foobara_branch }}-${{ env.foobara_sha1 }}
+          restore-keys: |
+            ${{ env.cache-name }}-${{ env.foobara_branch }}-
+            ${{ env.cache-name }}-
+      - if: ${{ steps.cache-foobara.outputs.cache-hit != 'true' }}
+        name: clone or pull foobara
+        run: |
+          set -e
+          cd ..
+          if [ -d foobara ]; then
+            echo pulling
+            cd foobara
+            ssh-agent sh -c 'echo "${{ secrets.FOOBARA_KEY }}" | ssh-add - &&
+              git fetch --depth=1 origin $foobara_sha1 &&
+              if git rev-parse --verify -q $foobara_branch; then
+                git checkout -q $foobara_branch
+                git reset --hard $foobara_sha1
+              else
+                git branch $foobara_branch $foobara_sha1
+                git checkout -q $foobara_branch
+              fi'
+          else
+            echo cloning
+            ssh-agent sh -c 'echo "${{ secrets.FOOBARA_KEY }}" | ssh-add - &&
+              git clone -b $foobara_branch --depth=1 git@github.com:foobara/foobara.git'
+          fi
+      - name: symlink foobara and point bundler at it
+        run: |
+          set -e
+          mkdir -p .bundle
+          echo -e "---\nBUNDLE_LOCAL__FOOBARA: '/home/runner/work/<%= kebab_case_project_name %>/foobara'" > .bundle/config
+          mkdir ../../foobara
+          ln -s  ../../<%= kebab_case_project_name %>/foobara ../../foobara/foobara
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.ruby_version }}
+          bundler-cache: true
+      - name: Run rspec
+        run: bundle exec rspec
+      - name: Run rubocop
+        run: bundle exec rubocop
+#      - name: Upload coverage directory
+#        if: always()
+#        uses: actions/upload-artifact@v2
+#        with:
+#          name: coverage-report
+#          path: coverage/

data/templates/.gitignore.erb

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.rspec_status
+/.byebug_history
+
+/.idea/
+/.env.*.local
+/.env.local

data/templates/.rspec

@@ -0,0 +1,4 @@
+--format progress
+--color
+--require spec_helper
+--seed 0

data/templates/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+
+inherit_gem:
+  foobara-rubocop-rules:
+    - rules/*
+
+Naming/FileName:
+  inherit_mode:
+    merge:
+      - Exclude

data/templates/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/templates/CHANGELOG.md.erb

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - <%= Time.now.strftime("%Y-%m-%d") %>
+
+- Initial release

data/templates/Gemfile

@@ -0,0 +1,38 @@
+source "https://rubygems.org"
+ruby File.read("#{__dir__}/.ruby-version")
+
+gemspec
+
+gem "foobara-dotenv-loader", github: "foobara/dotenv-loader"
+
+gem "rake"
+
+group :development do
+  gem "foobara-command-generator", github: "foobara/command-generator"
+  gem "foobara-domain-generator", github: "foobara/domain-generator"
+  gem "foobara-empty-ruby-project-generator", github: "foobara/empty-ruby-project-generator"
+  gem "foobara-files-generator", github: "foobara/files-generator"
+  # TODO: only need this one once everything is published gems and we can use .gemspec for this
+  gem "foob"
+  gem "foobara-organization-generator", github: "foobara/organization-generator"
+  gem "foobara-rubocop-rules"
+  gem "foobara-sh-cli-connector", github: "foobara/sh-cli-connector"
+  gem "guard-rspec"
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
+end
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug"
+end
+
+group :test do
+  gem "foobara-spec-helpers"
+  gem "rspec"
+  gem "rspec-its"
+  gem "ruby-prof"
+  gem "simplecov"
+  gem "vcr"
+  gem "webmock"
+end

data/templates/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, all_after_pass: true, all_on_start: true, cmd: "bundle exec rspec", failed_mode: :focus do
+  watch(%r{^spec/(.+)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { "spec/" }
+  watch(%r{^src/(.+)\.rb$}) { "spec/" }
+  watch(%r{^spec/spec_helper.rb$}) { "spec/" }
+end

data/templates/LICENSE.txt.erb

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <%= Time.now.strftime("%Y") %> <%= author_names.join(", ") %>
+
+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,49 @@
+# Foobara::EmptyRubyProjectGenerator
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library
+into a gem. Put your Ruby code in the file `lib/foobara/empty_ruby_project_generator`. To experiment with that code,
+run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it
+to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with
+instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+If using Foobara locally, then run the following (TODO: make this no-longer necessary.)
+
+```bash
+bundle config set disable_local_branch_check true
+```
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and the created tag, 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/[USERNAME]/foobara-empty_ruby_project_generator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/templates/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+task :environment do
+  require_relative "boot"
+end

data/templates/bin/console.erb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "irb"
+require_relative "../boot"
+
+IRB.setup(nil)
+
+if ENV.key?("IRB_PROMPT_PREFIX")
+  prefix = ENV["IRB_PROMPT_PREFIX"]
+  IRB.conf[:PROMPT][:DEFAULT].merge! PROMPT_I: "#{prefix}> ",
+                                     PROMPT_N: "#{prefix}> ",
+                                     PROMPT_S: "#{prefix}%l ",
+                                     PROMPT_C: "#{prefix}* "
+end
+
+IRB::Irb.new.run

data/templates/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/templates/boot/config.rb

@@ -0,0 +1,9 @@
+require "dotenv"
+
+require "foobara/load_dotenv"
+
+Dotenv.require_keys("FOOBARA_ENV")
+
+env = ENV.fetch("FOOBARA_ENV", nil)
+
+Foobara::LoadDotenv.run!(env:)

data/templates/boot/finish.rb.erb

@@ -0,0 +1,24 @@
+first = [
+  "remote.rb"
+]
+
+last = %w[
+  async.rb
+  cron.rb
+]
+
+skip = ["start.rb", "finish.rb", *first, *last]
+
+first.each { |f| require_relative f if File.exist?("#{__dir__}/#{f}") }
+
+require "<%= project_lib_file_path %>"
+
+Dir.entries(__dir__).each do |boot_file|
+  next unless boot_file.end_with?(".rb")
+  next if skip.include?(boot_file)
+  next unless File.exist?("#{__dir__}/#{boot_file}")
+
+  require_relative boot_file
+end
+
+last.each { |f| require_relative f if File.exist?("#{__dir__}/#{f}") }

data/templates/boot/start.rb

@@ -0,0 +1,10 @@
+ENV["FOOBARA_ENV"] ||= "development"
+
+require "bundler/setup"
+
+if ENV["FOOBARA_ENV"] == "development" || ENV["FOOBARA_ENV"] == "test"
+  require "pry"
+  require "pry-byebug"
+end
+
+require_relative "config"

data/templates/boot.rb

@@ -0,0 +1,2 @@
+require_relative "boot/start"
+require_relative "boot/finish"