dopstick 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845c70abf80cfc35d701755ccb884541712a51932992335a029262259acb3224
-  data.tar.gz: f99884fb97532ab7c311bca815686138c1b8076e6707188ada8d65afc368cca0
+  metadata.gz: fe33ac2b2b1d210b9c5f54cf0f6039ebd8548dfc7893fdebf54e9118a6d44618
+  data.tar.gz: da37488ed41ebe8f16473376c0aad18c98da952bed00ace9b66220b6d13e46a0
 SHA512:
-  metadata.gz: 52673c29a2ff5cb40cf8d188234e469657c7dc7715ca43deac9ac6d0f3a8d67d2b26c501396f510c38b782052940cc4acf8ba64f34ce82af48171fa30d925183
-  data.tar.gz: ff3d572d6c593bc6b1a38e48f6d3e830f408a8ec32c06e6e8eb6ba3406abb0003375ae335c4cb2eea43b2aafa756ebe39e0f82ef5d28de54d89bc653828d3a79
+  metadata.gz: 66650b1b3fb60790d1c750749d250bea61c7da3b6e88e116e87b5d93142d1922492edb887e95cd9fd013dec702a89deafc2c7d52d547e9b72ca347b419552898
+  data.tar.gz: 382c93b122eebd71c54e3b255159a72b89eed321cbd63e992547bd8565dd5710e7d2a6e6e23fdefceb712ca5bb80ccaafb53e27889645d82dddd1131037bcc07

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/.rubocop.yml

@@ -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,17 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## Unreleased
+
+- [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

@@ -8,7 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Nando Vieira"]
   spec.email   = ["me@fnando.com"]
 
-  spec.summary     = "Generate a project skeleton for creating a rubygem"
+  spec.summary     = "Generate a project skeleton for creating a Ruby/Node" \
+                     "package."
   spec.description = spec.summary
   spec.license     = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")

data/lib/dopstick.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
+require "json"
 require "date"
 require "pathname"
 require "thor"
 
 module Dopstick
-  require_relative "dopstick/refinements"
   require_relative "dopstick/version"
+  require_relative "dopstick/refinements"
   require_relative "dopstick/generator"
+  require_relative "dopstick/generator/options"
+  require_relative "dopstick/generator/gem/options"
+  require_relative "dopstick/generator/gem/generator"
+  require_relative "dopstick/generator/npm/options"
+  require_relative "dopstick/generator/npm/generator"
   require_relative "dopstick/cli"
 end

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."
@@ -48,6 +52,15 @@ module Dopstick
            type: :array,
            desc: "Set Ruby versions that are officially supported. Multiple " \
                  "versions must separated by space."
+    option :node_versions,
+           default: %w[14.x 12.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/generator.rb

@@ -1,214 +1,9 @@
 # frozen_string_literal: true
 
 module Dopstick
-  class Generator < Thor::Group # rubocop:disable Metrics/ClassLength
-    using Dopstick::Refinements
-
-    include Thor::Actions
-
-    def self.exit_on_failure?
-      true
-    end
-
-    attr_accessor :options
-
-    desc "Generate a new gem folder structure"
-
-    def self.source_root
-      File.join(__dir__, "templates")
-    end
-
-    def copy_gemspec
-      template "gemspec.erb", "#{gem_name}.gemspec"
-    end
-
-    def copy_license
-      template "license.erb", "LICENSE.md"
-    end
-
-    def copy_coc
-      template "coc.erb", "CODE_OF_CONDUCT.md"
-    end
-
-    def copy_readme
-      template "readme.erb", "README.md"
-    end
-
-    def copy_changelog
-      copy_file "CHANGELOG.md"
-    end
-
-    def copy_contributing
-      template "contributing.erb", "CONTRIBUTING.md"
-    end
-
-    def copy_github_templates
-      template "funding.erb", ".github/FUNDING.yml"
-      template "tests_workflow.erb", ".github/workflows/tests.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"
-    end
-
-    def copy_rakefile
-      template "rakefile.erb", "Rakefile"
-    end
-
-    def copy_rubocop
-      template "rubocop.erb", ".rubocop.yml"
-    end
-
-    def copy_gitignore
-      template "gitignore.erb", ".gitignore"
-    end
-
-    def copy_gemfile
-      template "gemfile.erb", "Gemfile"
-    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 entry_path.include?("/")
-        template "gem_entry_file.erb", "lib/#{gem_name}.rb"
-      end
-
-      template "entry_file.erb", "lib/#{entry_path}.rb"
-    end
-
-    def create_version_file
-      template "version.erb", "lib/#{entry_path}/version.rb"
-    end
-
-    def copy_test_files
-      template "test_helper.erb", "test/test_helper.rb"
-      template "test_file.erb", "test/#{entry_path}_test.rb"
-    end
-
-    def copy_binary_files
-      return unless options[:bin].presence
-
-      template "cli.erb", "lib/#{entry_path}/cli.rb"
-      template "generator.erb", "lib/#{entry_path}/generator.rb"
-      template "bin.erb", "exe/#{options[:bin]}"
-      create_file "lib/#{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 initialize_repo
-      in_root do
-        run "git init --initial-branch=main", capture: true
-        run "git add .", capture: true
-        run "git add bin --force", capture: true
-      end
-    end
-
-    no_commands do # rubocop:disable Metrics/BlockLength
-      def gem_name
-        options[:gem_name]
-      end
-
-      def entry_path
-        options[:entry_path]
-      end
-
-      def user_name
-        @user_name ||= options[:author_name].presence ||
-                       `git config --global user.name`.chomp
-      end
-
-      def user_email
-        @user_email ||= options[:author_email].presence ||
-                        `git config --global user.email`.chomp
-      end
-
-      def github_user
-        @github_user ||= options[:author_github].presence || begin
-          user = `git config --global user.github`.chomp
-          user.empty? ? "[USER]" : user
-        end
-      end
-
-      def paypal_user
-        @paypal_user ||= options[:author_paypal].presence || begin
-          user = `git config --global user.paypal`.chomp
-          user.empty? ? "[USER]" : user
-        end
-      end
-
-      def github_url
-        "https://github.com/#{github_user}/#{gem_name}"
-      end
-
-      def ruby_versions
-        options[:ruby_versions]
-      end
-
-      def const_names
-        @const_names ||= options[:namespace].split("::")
-      end
-
-      def const_names_size
-        @const_names_size ||= const_names.size
-      end
-
-      def render_tree(skip_content_spaces = false, &block) # rubocop:disable Style/OptionalBooleanParameter
-        content = []
-
-        const_names.each_with_index do |name, count|
-          content << ("  " * count) + "module #{name}"
-        end
-
-        spacer = skip_content_spaces ? "" : "  "
-
-        content << (spacer * const_names_size) + block.call
-
-        (const_names_size - 1).downto(0) do |count|
-          content << "#{'  ' * count}end"
-        end
-
-        content.join("\n")
-      end
-
-      def erb(file)
-        ERB.new(File.read("#{__dir__}/templates/#{file}")).result binding
-      end
-
-      def render_cli
-        cli_class = erb("cli_class.erb")
-                    .chomp
-                    .gsub(/^(.)/m, "#{'  ' * const_names_size}\\1")
-
-        render_tree(true) { cli_class }
-      end
-
-      def render_generator
-        generator_class = erb("generator_class.erb")
-                          .chomp
-                          .gsub(/^(.)/m, "#{'  ' * const_names_size}\\1")
-
-        render_tree(true) { generator_class }
-      end
-
-      def oldest_ruby_version
-        version = options[:ruby_versions]
-                  .map {|v| Gem::Version.new(v) }
-                  .min
-                  .canonical_segments
-
-        [*version, 0].take(3).join(".")
-      end
+  module Generator
+    def self.registered
+      @registered ||= {}
     end
   end
 end

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.
 -->