dopstick 0.0.3 → 0.0.4

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: "bundler"
+    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,160 @@
+# 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, &block)
+            content = []
+
+            options.namespace_names.each_with_index do |name, count|
+              content << ("  " * count) + "module #{name}"
+            end
+
+            spacer = skip_content_spaces ? "" : "  "
+
+            content << (spacer * options.namespace_size) + block.call
+
+            (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
+        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

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,20 +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.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_tree_url = "#{github_url}/tree/v#{spec.version}"
+  github_url = <%= options.github_url.inspect %>
+  github_tree_url = "#{options.github_url}/tree/v#{spec.version}"
 
   spec.homepage = github_url
   spec.metadata["homepage_uri"] = spec.homepage
@@ -34,20 +34,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).