dopstick 0.0.3 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845c70abf80cfc35d701755ccb884541712a51932992335a029262259acb3224
-  data.tar.gz: f99884fb97532ab7c311bca815686138c1b8076e6707188ada8d65afc368cca0
+  metadata.gz: 32408bef26c9cac4f69fd929fa86a84c0ad7eab9528573f649c720d57c1b7e7d
+  data.tar.gz: e412045ce7e9ea82ecd9bdbd74fa7863be86a62aac87ebdf397104e34c85a0b5
 SHA512:
-  metadata.gz: 52673c29a2ff5cb40cf8d188234e469657c7dc7715ca43deac9ac6d0f3a8d67d2b26c501396f510c38b782052940cc4acf8ba64f34ce82af48171fa30d925183
-  data.tar.gz: ff3d572d6c593bc6b1a38e48f6d3e830f408a8ec32c06e6e8eb6ba3406abb0003375ae335c4cb2eea43b2aafa756ebe39e0f82ef5d28de54d89bc653828d3a79
+  metadata.gz: 90f33a149c994f693d5fce46ee19de6f7656d28378bd1147fc572010f630ec8b9ca06c2f4bdc8c34163525a5ad58760de72e00c06b9337f56d646ae7139b9b76
+  data.tar.gz: aeca3ecf5d6324b50139f1461b760769ae11015430078d8c72ff25e8f3a3436ea7ffdb3fe952b7d29ef097b6b6788c5ce7f093978cea3be0fcb4f875fe28b50d

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# You can read more about CODEOWNERS at
+# https://help.github.com/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+* @fnando

data/.github/FUNDING.yml

@@ -1,4 +1,4 @@
 # These are supported funding model platforms
-
+---
 github: [fnando]
 custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+# Documentation:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/tests.yml

@@ -1,15 +1,11 @@
+---
 name: Tests
 
 on:
   pull_request:
-    branches:
-      - main
   push:
-    branches:
-      - main
-
-  schedule:
-    - cron: "0 10 * * *"
+  workflow_dispatch:
+    inputs: {}
 
 jobs:
   build:
@@ -18,23 +14,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6.x, 2.7.x]
+        ruby: ["2.7", "3.0"]
         gemfile:
           - Gemfile
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2.4.0
 
       - uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: >
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
           restore-keys: >
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
 
       - name: Set up Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
 

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   NewCops: enable
   Exclude:
     - tmp/**/*
@@ -11,11 +11,16 @@ AllCops:
     - vendor/**/*
 
 Metrics/BlockLength:
-  Exclude:
-    - test/**/*
-    - "**/*.gemspec"
+  Enabled: false
 
 Metrics/ClassLength:
-  Exclude:
-    - test/**/*
-    - "**/*.gemspec"
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false

data/CHANGELOG.md

@@ -11,6 +11,32 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## v0.0.7 - 2021-12-04
+
+- [Fixed] Set proper package ecosystem on dependabot's config file.
+- [Changed] Update ruby default versions to 2.7 and 3.0.
+- [Changed] Update node default versions to 16 and 17.
+
+## v0.0.6 - 2020-12-09
+
+- [Fixed] Babel loader's order is backwards, so TypeScript first, then
+  JavaScript.
+
+## v0.0.5 - 2020-11-14
+
+- [Fixed] Jest configuration wasn't considering the full import path.
+
+## v0.0.4 - 2020-11-14
+
+- [Added] Generate
+  [dependabot](https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates)
+  configuration.
+- [Changed] Add Postgres env vars so tests can run smoothly.
+- [Added] Add helper method to create migration classes with `--active-record`.
+- [Added] Generate `.github/CODEOWNERS` template.
+- [Changed] Generate Ruby packages with `--type gem`
+- [Added] Generate NPM packages with `--type npm`.
+
 ## v0.0.3 - 2020-11-03
 
 - [Changed] Remove unused `--repository` switch.

data/CONTRIBUTING.md

@@ -38,7 +38,7 @@ your contribution is according to how this project works.
    "Unreleased" section. If this section is not available, create one right
    before the last version.
 5. Push to your branch - `git push origin my_branch`
-6. [Create a pull request](https://docs.github.com/articles/creating-a-pull-request)
+6. [Create a pull request](https://help.github.com/articles/creating-a-pull-request)
 7. That's it!
 
 ## Styleguides

data/README.md

@@ -5,7 +5,7 @@
 </p>
 
 <p align="center">
-  Generate a project skeleton for creating a rubygem.
+  Generate a project skeleton for creating a Ruby/Node package.
 </p>
 
 <p align="center">
@@ -21,8 +21,11 @@ Features:
 
 - Github templates
 - Changelog
-- ActiveRecord setup (via `--active-record`)
-- CLI setup (via `--bin NAME`)
+- Generate Ruby packages
+  + ActiveRecord setup (via `--active-record`)
+  + CLI setup (via `--bin NAME`)
+- Generate NPM packages
+  + Setup TypeScript, Jest, and more!
 
 ## Installation
 

data/dopstick.gemspec

@@ -7,11 +7,13 @@ Gem::Specification.new do |spec|
   spec.version = Dopstick::VERSION
   spec.authors = ["Nando Vieira"]
   spec.email   = ["me@fnando.com"]
+  spec.metadata = {"rubygems_mfa_required" => "true"}
 
-  spec.summary     = "Generate a project skeleton for creating a rubygem"
+  spec.summary     = "Generate a project skeleton for creating a Ruby/NPM " \
+                     "package."
   spec.description = spec.summary
   spec.license     = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   github_url = "https://github.com/fnando/dopstick"
   github_tree_url = "#{github_url}/tree/v#{spec.version}"

data/lib/dopstick/cli.rb

@@ -9,10 +9,14 @@ module Dopstick
       true
     end
 
-    desc "new PATH", "Create a new gem"
+    desc "new PATH", "Create a new package"
+    option :type,
+           default: "",
+           desc: "Set the package type you want to create. Must be one of " \
+                 "#{Generator.registered.keys.inspect}."
     option :name,
            default: "",
-           desc: "Set the gem name. Defaults to path's basename."
+           desc: "Set the package name. Defaults to path's basename."
     option :active_record,
            default: false,
            type: :boolean,
@@ -31,8 +35,8 @@ module Dopstick
            desc: "Set Paypal account for donations. Defaults to " \
                  "`git config user.paypal`."
     option :description,
-           default: "",
-           desc: "Set gem description."
+           default: "TODO: add a description",
+           desc: "Set package description."
     option :version,
            default: "0.0.0",
            desc: "Set package initial version."
@@ -44,10 +48,19 @@ module Dopstick
            desc: "Set the codebase namespace. By default, it's inferred from " \
                  "the gem name."
     option :ruby_versions,
-           default: %w[2.6 2.7],
+           default: %w[2.7 3.0],
            type: :array,
            desc: "Set Ruby versions that are officially supported. Multiple " \
                  "versions must separated by space."
+    option :node_versions,
+           default: %w[16.x 17.x],
+           type: :array,
+           desc: "Set Node versions that are officially supported. Multiple " \
+                 "versions must separated by space."
+    option :skip_install,
+           default: false,
+           type: :boolean,
+           desc: "Skip `bundle install` (gem) and `yarn install` (npm)"
     option :help,
            aliases: "-h",
            type: :boolean,
@@ -55,14 +68,25 @@ module Dopstick
     def new(path = nil)
       interrupt_with_help(:new) if options[:help] || path.to_s.strip.empty?
 
-      gem_name, namespace = expand_gem_name_and_namespace(path)
+      unless Generator.registered.include?(options[:type])
+        interrupt_with_error(
+          "--type must be one of #{Generator.registered.keys.inspect}"
+        )
+      end
+
+      package_name, namespace = expand_gem_name_and_namespace(path)
 
-      generator = Generator.new
+      generator_module = Generator.registered[options[:type]]
+      generator_class = generator_module.const_get(:Generator)
+      options_class = generator_module.const_get(:Options)
+      generator = generator_class.new
       generator.destination_root = File.expand_path(path)
-      generator.options = dup_options.merge(
-        gem_name: gem_name,
-        namespace: namespace,
-        entry_path: namespace.underscore("/")
+      generator.options = options_class.new(
+        dup_options.merge(
+          package_name: package_name,
+          namespace: namespace,
+          entry_path: namespace.underscore("/")
+        )
       )
 
       generator.invoke_all
@@ -74,13 +98,18 @@ module Dopstick
         exit
       end
 
+      private def interrupt_with_error(message)
+        shell.say "ERROR: #{message}", :red
+        exit 1
+      end
+
       private def dup_options
         options.each_with_object({}) do |(key, value), buffer|
           buffer[key.to_sym] = value
         end
       end
 
-      private def expand_gem_name_and_namespace(path) # rubocop:disable Metrics/AbcSize
+      private def expand_gem_name_and_namespace(path)
         if options[:name].presence && options[:namespace].presence
           [options[:name], options[:namespace]]
         elsif options[:name].presence

data/lib/dopstick/{templates → generator/base/templates}/bug_report.erb

@@ -9,7 +9,7 @@ labels: 'Status: Unconfirmed'
 <!--
   - Please provide a clear and concise description of what the bug is.
   - If possible, add an example reproducing your issue.
-  - Please test using the latest version of <%= gem_name %>
+  - Please test using the latest version of <%= options.package_name %>
     to make sure your issue has not already been fixed.
 -->
 

data/lib/dopstick/{templates → generator/base/templates}/coc.erb

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at <%= user_email %>. All
+reported by contacting the project team at <%= options.user_email %>. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/lib/dopstick/generator/base/templates/codeowners.erb

@@ -0,0 +1,4 @@
+# You can read more about CODEOWNERS at
+# https://help.github.com/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+* @<%= options.github_user %>

data/lib/dopstick/{templates → generator/base/templates}/contributing.erb

@@ -1,4 +1,4 @@
-# Contributing to <%= gem_name %>
+# Contributing to <%= options.package_name %>
 
 👍🎉 First off, thanks for taking the time to contribute! 🎉👍
 
@@ -9,7 +9,7 @@ changes to this document in a pull request.
 ## Code of Conduct
 
 Everyone interacting in this project's codebases, issue trackers, chat rooms and
-mailing lists is expected to follow the [code of conduct](<%= github_url
+mailing lists is expected to follow the [code of conduct](<%= options.github_url
 %>/blob/main/CODE_OF_CONDUCT.md).
 
 ## Reporting bugs
@@ -27,19 +27,19 @@ the behavior, and find related reports.
 ## Contributing with code
 
 Before making any radicals changes, please make sure you discuss your intention
-by [opening an issue on Github](<%= github_url %>/issues).
+by [opening an issue on Github](<%= options.github_url %>/issues).
 
 When you're ready to make your pull request, follow checklist below to make sure
 your contribution is according to how this project works.
 
-1. [Fork](https://help.github.com/forking/) <%= gem_name %>
+1. [Fork](https://help.github.com/forking/) <%= options.package_name %>
 2. Create a topic branch - `git checkout -b my_branch`
 3. Make your changes using [descriptive commit messages](#commit-messages)
 4. Update CHANGELOG.md describing your changes by adding an entry to the
    "Unreleased" section. If this section is not available, create one right
    before the last version.
 5. Push to your branch - `git push origin my_branch`
-6. [Create a pull request](https://docs.github.com/articles/creating-a-pull-request)
+6. [Create a pull request](https://help.github.com/articles/creating-a-pull-request)
 7. That's it!
 
 ## Styleguides

data/lib/dopstick/generator/base/templates/dependabot.erb

@@ -0,0 +1,15 @@
+---
+# Documentation:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: <%= dependabot_package_ecosystem %>
+    directory: "/"
+    schedule:
+      interval: "daily"

data/lib/dopstick/generator/base/templates/funding.erb

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [<%= options.github_user %>]
+custom: ["https://paypal.me/<%= options.paypal_user %>/🍕"]

data/lib/dopstick/{templates → generator/base/templates}/license.erb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright (c) <%= Date.today.year %> <%= user_name %>
+Copyright (c) <%= Date.today.year %> <%= options.user_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

data/lib/dopstick/generator/gem/generator.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module Dopstick
+  module Generator
+    module Gem
+      Generator.registered["gem"] = self
+
+      class Generator < Thor::Group
+        using Dopstick::Refinements
+        include Thor::Actions
+
+        attr_accessor :options
+
+        desc "Generate a new gem folder structure"
+
+        def self.exit_on_failure?
+          true
+        end
+
+        def self.source_paths
+          [
+            source_root,
+            File.join(__dir__, "../base/templates")
+          ]
+        end
+
+        def self.source_root
+          File.join(__dir__, "templates")
+        end
+
+        def copy_ruby_templates
+          template "gemspec.erb", "#{options.package_name}.gemspec"
+          template "rakefile.erb", "Rakefile"
+          template "rubocop.erb", ".rubocop.yml"
+          template "gemfile.erb", "Gemfile"
+          template "tests_workflow.erb", ".github/workflows/ruby-tests.yml"
+        end
+
+        def copy_generic_templates
+          template "license.erb", "LICENSE.md"
+          template "coc.erb", "CODE_OF_CONDUCT.md"
+          template "readme.erb", "README.md"
+          template "changelog.erb", "CHANGELOG.md"
+          template "contributing.erb", "CONTRIBUTING.md"
+          template "gitignore.erb", ".gitignore"
+        end
+
+        def copy_github_templates
+          template "funding.erb", ".github/FUNDING.yml"
+          template "bug_report.erb", ".github/ISSUE_TEMPLATE/bug_report.md"
+          template "feature_request.erb",
+                   ".github/ISSUE_TEMPLATE/feature_request.md"
+          template "pull_request.erb", ".github/PULL_REQUEST_TEMPLATE.md"
+          template "dependabot.erb", ".github/dependabot.yml"
+          template "codeowners.erb", ".github/CODEOWNERS"
+        end
+
+        def copy_bins
+          template "console.erb", "bin/console"
+          template "setup.erb", "bin/setup"
+          in_root { run "chmod +x bin/*" }
+        end
+
+        def create_entry_file
+          if options.entry_path.include?("/")
+            template "gem_entry_file.erb", "lib/#{options.package_name}.rb"
+          end
+
+          template "entry_file.erb", "lib/#{options.entry_path}.rb"
+        end
+
+        def create_version_file
+          template "version.erb", "lib/#{options.entry_path}/version.rb"
+        end
+
+        def copy_test_files
+          template "test_helper.erb", "test/test_helper.rb"
+          template "test_file.erb", "test/#{options.entry_path}_test.rb"
+        end
+
+        def copy_binary_files
+          return unless options.bin?
+
+          template "cli.erb", "lib/#{options.entry_path}/cli.rb"
+          template "generator.erb", "lib/#{options.entry_path}/generator.rb"
+          template "bin.erb", "exe/#{options.bin}"
+          create_file "lib/#{options.entry_path}/templates/.keep"
+          in_root { run "chmod +x exe/*" }
+        end
+
+        def copy_active_record_files
+          return unless options[:active_record]
+
+          template "active_record.erb", "test/support/active_record.rb"
+        end
+
+        def bundle_install
+          return if options.skip_install?
+
+          in_root do
+            run "bundle install"
+          end
+        end
+
+        def initialize_repo
+          in_root do
+            run "git init --initial-branch=main", capture: true
+            run "git add bin --force", capture: true
+            run "git add .", capture: true
+          end
+        end
+
+        no_commands do
+          def render_tree(skip_content_spaces = false)
+            content = []
+
+            options.namespace_names.each_with_index do |name, count|
+              content << (("  " * count) + "module #{name}")
+            end
+
+            spacer = skip_content_spaces ? "" : "  "
+
+            content << ((spacer * options.namespace_size) + yield)
+
+            (options.namespace_size - 1).downto(0) do |count|
+              content << "#{'  ' * count}end"
+            end
+
+            content.join("\n")
+          end
+
+          def render_cli
+            cli_class = erb("cli_class.erb")
+                        .chomp
+                        .gsub(/^(.)/m, "#{'  ' * options.namespace_size}\\1")
+
+            render_tree(true) { cli_class }
+          end
+
+          def render_generator
+            generator_class = erb("generator_class.erb")
+                              .chomp
+                              .gsub(
+                                /^(.)/m,
+                                "#{'  ' * options.namespace_size}\\1"
+                              )
+
+            render_tree(true) { generator_class }
+          end
+
+          def erb(file)
+            ERB.new(
+              File.read("#{self.class.source_root}/#{file}")
+            ).result(binding)
+          end
+
+          def dependabot_package_ecosystem
+            "bundler"
+          end
+
+          def ruby_versions_for_workflow
+            options.ruby_versions.map do |v|
+              canonical_segments = ::Gem::Version.new(v).canonical_segments
+              canonical_segments << 0 if canonical_segments.size < 2
+
+              canonical_segments.join(".").inspect
+            end.join(", ")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dopstick/generator/gem/options.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Dopstick
+  module Generator
+    module Gem
+      class Options < Generator::Options
+        def bin?
+          !@options[:bin].empty?
+        end
+
+        def active_record?
+          @options[:active_record]
+        end
+
+        def namespace_names
+          @namespace_names ||= @options[:namespace].split("::")
+        end
+
+        def namespace_size
+          @namespace_size ||= namespace_names.size
+        end
+
+        def oldest_ruby_version
+          version = ruby_versions
+                    .map {|v| ::Gem::Version.new(v) }
+                    .min
+                    .canonical_segments
+
+          [*version, 0].take(3).join(".")
+        end
+      end
+    end
+  end
+end

data/lib/dopstick/{templates → generator/gem/templates}/active_record.erb

@@ -21,3 +21,28 @@ ActiveRecord::Base.logger = nil
 def schema(&block)
   ActiveRecord::Schema.define(version: 0, &block)
 end
+
+# Create a new migration, which can be executed up and down.
+#
+#   test "do something" do
+#     migration = with_migration do
+#       def up
+#         # do something
+#       end
+#
+#       def down
+#         # undo something
+#       end
+#     end
+#
+#     migration.up
+#     migration.down
+#   end
+#
+def with_migration(&block)
+  migration_class = ActiveRecord::Migration[
+    ActiveRecord::Migration.current_version
+  ]
+
+  Class.new(migration_class, &block).new
+end

data/lib/dopstick/generator/gem/templates/bin.erb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/<%= options.package_name %>"
+<%= options.namespace %>::CLI.start