dopstick 0.0.3 → 0.0.7

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

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require <%= gem_name.inspect %>
+require <%= options.package_name.inspect %>
 
 # 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.

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+<%= render_tree { %[require "#{options.entry_path}/version"] } %>

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require <%= options.entry_path.inspect %>

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

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
-require_relative "./lib/<%= entry_path %>/version"
+require_relative "./lib/<%= options.entry_path %>/version"
 
 Gem::Specification.new do |spec|
-  spec.name    = "<%= gem_name %>"
-  spec.version = <%= options[:namespace] %>::VERSION
-  spec.authors = [<%= user_name.inspect %>]
-  spec.email   = [<%= user_email.inspect %>]
+  spec.name    = "<%= options.package_name %>"
+  spec.version = <%= options.namespace %>::VERSION
+  spec.authors = [<%= options.user_name.inspect %>]
+  spec.email   = [<%= options.user_email.inspect %>]
+  spec.metadata = {"rubygems_mfa_required" => "true"}
 
-  spec.summary     = "Add some description"
+  spec.summary     = <%= options.description.inspect %>
   spec.description = spec.summary
   spec.license     = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= <%= oldest_ruby_version %>")
+  spec.required_ruby_version = Gem::Requirement.new(">= <%= options.oldest_ruby_version %>")
 
-  github_url = <%= github_url.inspect %>
+  github_url = <%= options.github_url.inspect %>
   github_tree_url = "#{github_url}/tree/v#{spec.version}"
 
   spec.homepage = github_url
@@ -34,20 +35,20 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  <%- if options[:active_record] -%>
+  <%- if options.active_record -%>
   spec.add_dependency "activerecord"
   <%- end -%>
-  <%- unless options[:bin].empty?  -%>
+  <%- if options.bin?  -%>
   spec.add_dependency "thor"
   <%- end -%>
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-utils"
+  <%- if options.active_record? -%>
+  spec.add_development_dependency "pg"
+  <%- end -%>
   spec.add_development_dependency "pry-meta"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-fnando"
   spec.add_development_dependency "simplecov"
-  <%- if options[:active_record] -%>
-  spec.add_development_dependency "pg"
-  <%- end -%>
 end

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

@@ -0,0 +1,50 @@
+# <%= options.package_name %>
+
+[![Tests](<%= options.github_url %>/workflows/ruby-tests/badge.svg)](https://github.com/fnando/<%= options.package_name %>)
+[![Code Climate](https://codeclimate.com/github/<%= options.github_user %>/<%= options.package_name %>/badges/gpa.svg)](https://codeclimate.com/github/<%= options.github_user %>/<%= options.package_name %>)
+[![Gem](https://img.shields.io/gem/v/<%= options.package_name %>.svg)](https://rubygems.org/gems/<%= options.package_name %>)
+[![Gem](https://img.shields.io/gem/dt/<%= options.package_name %>.svg)](https://rubygems.org/gems/<%= options.package_name %>)
+
+<%= options.description %>
+
+## Installation
+
+```bash
+gem install <%= options.package_name %>
+```
+
+Or add the following line to your project's Gemfile:
+
+```ruby
+gem "<%= options.package_name %>"
+```
+
+## Usage
+
+TODO: Write gem usage
+
+## Maintainer
+
+- [<%= options.user_name %>](https://github.com/<%= options.github_user %>)
+
+## Contributors
+
+- <%= options.github_url %>/contributors
+
+## Contributing
+
+For more details about how to contribute, please read
+<%= options.github_url %>/blob/main/CONTRIBUTING.md.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at <%= options.github_url %>/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the <%= options.package_name %> project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](<%= options.github_url %>/blob/main/CODE_OF_CONDUCT.md).

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

@@ -0,0 +1,12 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: <%= options.oldest_ruby_version.split(".").take(2).join(".") %>
+  NewCops: enable
+<%- if options.package_name.include?("-") -%>
+Naming/FileName:
+  Exclude:
+    - lib/<%= options.package_name %>.rb
+<%- end -%>

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

@@ -2,7 +2,7 @@
 
 require "test_helper"
 
-class <%= const_names.last %>Test < Minitest::Test
+class <%= options.namespace_names.last %>Test < Minitest::Test
   test "passes" do
     assert true
   end

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

@@ -4,7 +4,7 @@ require "simplecov"
 SimpleCov.start
 
 require "bundler/setup"
-require <%= gem_name.inspect %>
+require <%= options.package_name.inspect %>
 
 require "minitest/utils"
 require "minitest/autorun"

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

@@ -1,15 +1,10 @@
-name: Tests
+name: ruby-tests
 
 on:
   pull_request:
-    branches:
-      - main
   push:
-    branches:
-      - main
-
-  schedule:
-    - cron: "0 10 * * *"
+  workflow_dispatch:
+    inputs: {}
 
 jobs:
   build:
@@ -18,11 +13,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [<%= ruby_versions.map {|v| [*Gem::Version.new(v).canonical_segments, "x"].take(3).join(".") }.join(", ") %>]
+        ruby: [<%= ruby_versions_for_workflow %>]
         gemfile:
           - Gemfile
 
-    <%- if options[:active_record] -%>
+    <%- if options.active_record? -%>
     services:
       postgres:
         image: postgres:11.5
@@ -44,11 +39,11 @@ jobs:
             ${{ 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 }}
 
-      <%- if options[:active_record] -%>
+      <%- if options.active_record? -%>
       - name: Install PostgreSQL client
         env:
           PGHOST: localhost
@@ -68,6 +63,8 @@ jobs:
 
       - name: Run Tests
         env:
+          PGHOST: localhost
+          PGUSER: postgres
           BUNDLE_GEMFILE: ${{ matrix.gemfile }}
         run: |
           bundle exec rake

data/lib/dopstick/generator/npm/generator.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Dopstick
+  module Generator
+    module NPM
+      Generator.registered["npm"] = self
+
+      class Generator < Thor::Group
+        using Dopstick::Refinements
+        include Thor::Actions
+
+        attr_accessor :options
+
+        desc "Generate a new npm 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_npm_templates
+          template "package.erb", "package.json"
+          template "tests_workflow.erb", ".github/workflows/js-tests.yml"
+          template "tsconfig.erb", "tsconfig.json"
+          template "prettier.erb", "prettier.config.js"
+          template "jest.erb", "jest.config.js"
+          template "eslint.erb", ".eslintrc.js"
+          template "webpack.erb", "webpack.config.js"
+          template "babel.erb", "babel.config.json"
+          template "index.erb", "src/index.ts"
+          template "index_test.erb", "src/index.test.ts"
+        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 install_dependencies
+          return if options.skip_install?
+
+          in_root do
+            %w[
+              @babel/core
+              @babel/preset-env
+              @fnando/codestyle
+              @fnando/eslint-config-codestyle
+              @typescript-eslint/eslint-plugin
+              @typescript-eslint/parser
+              babel-loader
+              babel-plugin-module-resolver
+              eslint
+              jest
+              jest-filename-transform
+              prettier
+              ts-jest
+              ts-loader
+              typescript
+              webpack
+              webpack-cli
+            ].each do |dep|
+              run "yarn add --dev #{dep}", capture: true
+            end
+          end
+        end
+
+        def initialize_repo
+          in_root do
+            run "git init --initial-branch=main", capture: true
+            run "git add .", capture: true
+          end
+        end
+
+        no_commands do
+          def dependabot_package_ecosystem
+            "npm"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Dopstick
+  module Generator
+    module NPM
+      class Options < Generator::Options
+        using Refinements
+
+        def user_name
+          `npm get init.author.name`.chomp.presence ||
+            super
+        end
+
+        def user_email
+          `npm get init.author.email`.chomp.presence ||
+            super
+        end
+
+        def user_url
+          `npm get init.author.url`.chomp.presence ||
+            "https://github.com/#{github_user}"
+        end
+      end
+    end
+  end
+end

data/lib/dopstick/generator/npm/templates/babel.erb

@@ -0,0 +1,15 @@
+{
+  "presets": ["@babel/preset-env"],
+  "plugins": [
+    [
+      "module-resolver",
+      {
+        "extensions": [".js", ".ts"],
+        "root": ["./src"],
+        "alias": {
+          "~": "./src"
+        }
+      }
+    ]
+  ]
+}

data/lib/dopstick/generator/npm/templates/eslint.erb

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: ["@fnando/codestyle/javascript", "@fnando/codestyle/typescript"]
+};

data/lib/dopstick/generator/npm/templates/index.erb

@@ -0,0 +1,12 @@
+// To import modules, you can use ~/:path, where `:path` must be reflect the
+// structure you define inside `./src`. For instance, if you have a
+// `src/utils.ts` file that exports some functions, you can import it with this:
+//
+// ```ts
+// import { func } from "~/utils";
+// ```
+//
+// To export your final bundle, use `yarn build`. This will ensure that all
+// files point to the right place, considering the `~/` alias.
+//
+export const name = "<%= options.package_name %>";

data/lib/dopstick/generator/npm/templates/index_test.erb

@@ -0,0 +1,7 @@
+import { name } from "~/index";
+
+describe("<%= options.package_name %>", () => {
+  test("passes", () => {
+    expect(name).toEqual("<%= options.package_name %>");
+  });
+});

data/lib/dopstick/generator/npm/templates/jest.erb

@@ -0,0 +1,12 @@
+const config = require("@fnando/codestyle/jest");
+
+module.exports = {
+  ...config,
+  testRegex: ".*?\\.test\\.ts",
+  roots: ["<rootDir>/src"],
+  modulePaths: ["src"],
+  moduleNameMapper: {
+    "^~/(.*?)$": "<rootDir>/src/$1",
+  },
+  testPathIgnorePatterns: ["/vendor/bundle/", "node_modules"],
+};

data/lib/dopstick/generator/npm/templates/package.erb

@@ -0,0 +1,42 @@
+<%= JSON.pretty_generate(
+  name: options.package_name,
+  version: options.version,
+  private: true,
+  description: options.description,
+  author: {
+    name: options.user_name,
+    email: options.user_email,
+    url: options.user_url,
+  },
+  homepage: options.github_url,
+  license: "MIT",
+  bugs: "#{options.github_url}/issues",
+  repository: "#{options.github_url}.git",
+  scripts: {
+    test: "jest --watch",
+    "test:ci" => "jest && yarn lint",
+    lint: "yarn lint:ts && yarn lint:eslint",
+    "lint:ts" => "tsc --noEmit",
+    "lint:eslint" => "eslint src --max-warnings 0",
+    build: "rm -rf dist && webpack"
+  },
+  devDependencies: {
+    "@babel/core" => "*",
+    "@babel/preset-env" => "*",
+    "@fnando/codestyle" => "*",
+    "@fnando/eslint-config-codestyle" => "*",
+    "@typescript-eslint/eslint-plugin" => "*",
+    "@typescript-eslint/parser" => "*",
+    "babel-loader" => "*",
+    "babel-plugin-module-resolver" => "*",
+    "eslint" => "*",
+    "jest" => "*",
+    "jest-filename-transform" => "*",
+    "prettier" => "*",
+    "ts-jest" => "*",
+    "ts-loader" => "*",
+    "typescript" => "*",
+    "webpack" => "*",
+    "webpack-cli" => "*"
+  }
+) %>

data/lib/dopstick/generator/npm/templates/prettier.erb

@@ -0,0 +1 @@
+module.exports = require("@fnando/codestyle/prettier.json");

data/lib/dopstick/generator/npm/templates/readme.erb

@@ -0,0 +1,52 @@
+# <%= options.package_name %>
+
+[![Tests](<%= options.github_url %>/workflows/node-tests/badge.svg)](https://github.com/fnando/<%= options.package_name %>)
+[![Code Climate](https://codeclimate.com/github/<%= options.github_user %>/<%= options.package_name %>/badges/gpa.svg)](https://codeclimate.com/github/<%= options.github_user %>/<%= options.package_name %>)
+[![NPM](https://img.shields.io/npm/v/<%= options.package_name %>.svg)](https://npmjs.org/packages/<%= options.package_name %>)
+[![NPM](https://img.shields.io/npm/dt/<%= options.package_name %>.svg)](https://npmjs.org/packages/<%= options.package_name %>)
+
+<%= options.description %>
+
+## Installation
+
+This package is available as a NPM package. To install it, use the following command:
+
+```bash
+npm install <%= options.package_name %> --save
+```
+
+If you're using Yarn (and you should):
+
+```bash
+yarn add <%= options.package_name %>
+```
+
+## Usage
+
+TODO: Write gem usage
+
+## Maintainer
+
+- [<%= options.user_name %>](https://github.com/<%= options.github_user %>)
+
+## Contributors
+
+- <%= options.github_url %>/contributors
+
+## Contributing
+
+For more details about how to contribute, please read
+<%= options.github_url %>/blob/main/CONTRIBUTING.md.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at <%= options.github_url %>/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the <%= options.package_name %> project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](<%= options.github_url %>/blob/main/CODE_OF_CONDUCT.md).

data/lib/dopstick/generator/npm/templates/tests_workflow.erb

@@ -0,0 +1,49 @@
+name: node-tests
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+  schedule:
+    - cron: "0 10 * * *"
+
+  workflow_dispatch:
+      inputs: {}
+
+jobs:
+  build:
+    name: Tests with Node ${{ matrix.node }}
+    runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [<%= options.node_versions.map {|v| Gem::Version.new(v).canonical_segments.first.to_s.inspect }.join(", ") %>]
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.node }}-npm-${{ hashFiles("package.json") }}
+          restore-keys: >
+            ${{ runner.os }}-${{ matrix.node }}-npm-${{ hashFiles("package.json") }}
+
+      - name: Set up Node
+        uses: actions/setup-node@v2-beta
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install npm dependencies
+        run: |
+          yarn install
+
+      - name: Run Tests
+        run: |
+          yarn test:ci
+          yarn lint

data/lib/dopstick/generator/npm/templates/tsconfig.erb

@@ -0,0 +1,14 @@
+<%= JSON.pretty_generate(
+  extends: "@fnando/codestyle",
+  include: %w[src],
+  compilerOptions: {
+    noEmit: false,
+    sourceMap: true,
+    declaration: true,
+    outDir: "dist",
+    baseUrl: ".",
+    paths: {
+      "~/*": ["src/*"]
+    }
+  }
+) %>

data/lib/dopstick/generator/npm/templates/webpack.erb

@@ -0,0 +1,33 @@
+/* eslint-env node */
+
+const path = require("path");
+
+module.exports = {
+  mode: "production",
+  entry: {
+    index: "./src/index.ts",
+  },
+  devtool: "source-map",
+  output: {
+    filename: "[name].js",
+    path: path.resolve(__dirname, "dist"),
+  },
+  module: {
+    rules: [
+      {
+        test: /\.ts$/,
+        use: [{ loader: "babel-loader" }, { loader: "ts-loader" }],
+        exclude: /node_modules/,
+      },
+      {
+        test: /\.js$/,
+        use: [{ loader: "babel-loader" }],
+        exclude: /node_modules/,
+      },
+    ],
+  },
+  resolve: {
+    alias: { "~/": path.resolve(__dirname, "src/") },
+    extensions: [".tsx", ".ts", ".js"],
+  },
+};