gemaker 0.6.0 → 1.0.0

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### 1.0.0
+##### Changed
+
+- Generate gems with Circle CI instead of Travis.
+- Generate dummy app with Rails 6.
+- Use Review Dog instead of Hound.
+- Always create mountable engines.
+- Move specs out of dummy app.
+
 ### 0.6.0
 
 ##### Changed

data/README.md

@@ -28,6 +28,16 @@ gemaker new my_gem
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Publishing
+
+On master/main branch...
+
+1. Change `VERSION` in `lib/gemaker/version.rb`.
+2. Change `Unreleased` title to current version in `CHANGELOG.md`.
+3. Commit new release. For example: `Releasing v0.1.0`.
+4. Create tag. For example: `git tag v0.1.0`.
+5. Push tag. For example: `git push origin v0.1.0`.
+
 ## Credits
 
 Thank you [contributors](https://github.com/platanus/gemaker/graphs/contributors)!

data/gemaker.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gemaker/version'
@@ -18,16 +17,16 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "power-types"
-  spec.add_dependency "commander"
   spec.add_dependency "activesupport"
-  spec.add_dependency "colorize", "~> 0.7", ">= 0.7.7"
   spec.add_dependency "artii", "~> 2.1", ">= 2.1.1"
+  spec.add_dependency "colorize", "~> 0.7", ">= 0.7.7"
+  spec.add_dependency "commander"
+  spec.add_dependency "power-types"
 
   spec.add_development_dependency "bundler", "~> 2.2.15"
+  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter"
-  spec.add_development_dependency "rubocop", "~> 0.65.0"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rubocop", "~> 1.9"
 end

data/lib/gemaker.rb

@@ -10,6 +10,7 @@ require "gemaker/commands/base"
 require "gemaker/commands/create_gem"
 require "gemaker/commands/add_readme"
 require "gemaker/commands/add_changelog"
+require "gemaker/commands/configure_editor_config"
 require "gemaker/commands/customize_gemspec"
 require "gemaker/commands/add_license"
 require "gemaker/commands/add_cli_structure"
@@ -20,8 +21,7 @@ require "gemaker/commands/customize_engine"
 require "gemaker/commands/customize_rakefile"
 require "gemaker/commands/customize_main_lib_file"
 require "gemaker/commands/add_install_generator"
-require "gemaker/commands/add_hound_rules"
-require "gemaker/commands/configure_travis"
+require "gemaker/commands/configure_continuous_integration"
 
 module Gemaker
 end

data/lib/gemaker/cli.rb

@@ -25,7 +25,7 @@ module Gemaker
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def fill_config(gem_name, config)
       config.gem_name = gem_name
 
@@ -48,13 +48,12 @@ module Gemaker
       config.engine = agree("Is the gem a Rails engine?")
 
       if config.engine?
-        config.mountable = agree("Is the engine mountable?")
         config.installable = agree("Need an installer?")
       else
         config.cli = agree("Is it a CLI (Command-line interface)?")
       end
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def draw_artii(text)
       a = Artii::Base.new font: 'slant'

data/lib/gemaker/commands/add_cli_structure.rb

@@ -3,6 +3,7 @@ module Gemaker
     class AddCliStructure < Gemaker::Cmd::Base
       def perform
         return unless @config.cli?
+
         copy_template("exe", "exe/#{@config.gem_name}", config: @config)
         copy_template("cli.rb", "lib/#{@config.gem_name}/cli.rb", config: @config)
         info "Add CLI structure"

data/lib/gemaker/commands/add_install_generator.rb

@@ -3,14 +3,38 @@ module Gemaker
     class AddInstallGenerator < Gemaker::Cmd::Base
       def in_engine_context
         return unless @config.installable?
-        copy_template("engine/initializer.rb",
-          "lib/generators/#{@config.gem_name}/install/templates/initializer.rb", config: @config)
-        copy_template("engine/install_generator.rb",
-          "lib/generators/#{@config.gem_name}/install/install_generator.rb", config: @config)
-        copy_template("engine/install_usage",
-          "lib/generators/#{@config.gem_name}/install/USAGE", config: @config)
+
+        copy_initializer
+        copy_install_generator
+        copy_install_usage_file
         info "Add Installer"
       end
+
+      private
+
+      def copy_initializer
+        copy_template(
+          "engine/initializer.rb",
+          "lib/generators/#{@config.gem_name}/install/templates/initializer.rb",
+          config: @config
+        )
+      end
+
+      def copy_install_generator
+        copy_template(
+          "engine/install_generator.rb",
+          "lib/generators/#{@config.gem_name}/install/install_generator.rb",
+          config: @config
+        )
+      end
+
+      def copy_install_usage_file
+        copy_template(
+          "engine/install_usage",
+          "lib/generators/#{@config.gem_name}/install/USAGE",
+          config: @config
+        )
+      end
     end
   end
 end

data/lib/gemaker/commands/configure_continuous_integration.rb

@@ -0,0 +1,23 @@
+module Gemaker
+  module Cmd
+    class ConfigureContinuousIntegration < Gemaker::Cmd::Base
+      def in_normal_context
+        configure_ci("normal")
+      end
+
+      def in_engine_context
+        configure_ci("engine")
+      end
+
+      private
+
+      def configure_ci(tpl_dir)
+        copy_template("#{tpl_dir}/rubocop.yml", ".rubocop.yml", config: @config)
+        create_dir(".circleci")
+        copy_template("circle_config.yml", ".circleci/config.yml", config: @config)
+        copy_file("circleci-setup-script.sh", ".circleci/setup-rubygems.sh")
+        info "Configure CricleCI"
+      end
+    end
+  end
+end

data/lib/gemaker/commands/configure_editor_config.rb

@@ -0,0 +1,10 @@
+module Gemaker
+  module Cmd
+    class ConfigureEditorConfig < Gemaker::Cmd::Base
+      def perform
+        copy_file("editorconfig", ".editorconfig")
+        info "Configure editorconfig"
+      end
+    end
+  end
+end

data/lib/gemaker/commands/configure_test_env.rb

@@ -4,7 +4,6 @@ module Gemaker
       def in_normal_context
         copy_template("normal/spec_helper.rb", "spec/spec_helper.rb", config: @config)
         copy_file("test_helpers.rb", "spec/support/test_helpers.rb")
-        copy_file("coveralls.yml", ".coveralls.yml")
         copy_template("normal/test_example.rb", "spec/#{@config.gem_name}_spec.rb", config: @config)
         copy_file("normal/Guardfile", "Guardfile")
         info "Configure Rspec"
@@ -13,13 +12,15 @@ module Gemaker
       def in_engine_context
         copy_template("engine/spec_helper.rb", "spec/spec_helper.rb", config: @config)
         copy_template("engine/rails_helper.rb", "spec/rails_helper.rb", config: @config)
-        copy_template("engine/test_example.rb",
-          "spec/dummy/spec/#{@config.gem_name}_spec.rb", config: @config)
-        create_dir("spec/dummy/spec/factories")
-        copy_file("test_helpers.rb", "spec/dummy/spec/support/test_helpers.rb")
-        copy_file("coveralls.yml", ".coveralls.yml")
-        copy_file("image.png", "spec/dummy/spec/assets/image.png")
-        copy_file("video.mp4", "spec/dummy/spec/assets/video.mp4")
+        copy_template(
+          "engine/test_example.rb",
+          "spec/#{@config.gem_name}_spec.rb",
+          config: @config
+        )
+        create_dir("spec/factories")
+        copy_file("test_helpers.rb", "spec/support/test_helpers.rb")
+        copy_file("image.png", "spec/fixtures/files/image.png")
+        copy_file("video.mp4", "spec/fixtures/files/video.mp4")
         copy_file("engine/rspec", ".rspec")
         copy_file("engine/Guardfile", "Guardfile")
         info "Configure Rspec"

data/lib/gemaker/commands/create_gem.rb

@@ -2,13 +2,11 @@ module Gemaker
   module Cmd
     class CreateGem < Gemaker::Cmd::Base
       def in_engine_context
-        mountable_opt = "--mountable" if @config.mountable?
-
         commands = [
           "echo \"source 'https://rubygems.org'\" > GemakerGemfile",
           "echo \"gem 'rails', '~> #{Gemaker::RAILS_VERSION}'\" > GemakerGemfile",
           "BUNDLE_GEMFILE=GemakerGemfile bundle install",
-          "BUNDLE_GEMFILE=GemakerGemfile bundle exec rails plugin new #{@config.gem_name} -T #{mountable_opt} --dummy-path=spec/dummy", # rubocop:disable Metrics/LineLength
+          "BUNDLE_GEMFILE=GemakerGemfile bundle exec rails plugin new #{@config.gem_name} -T --mountable --dummy-path=spec/dummy", # rubocop:disable Metrics/LineLength
           "rm -f GemakerGemfile GemakerGemfile.lock"
         ]
 
@@ -21,11 +19,11 @@ module Gemaker
 
       private
 
-      # rubocop:disable Metrics/MethodLength
       def create_customized_gem(cmd)
         execute(cmd)
         Gemaker::Cmd::AddReadme.for(config: @config)
         Gemaker::Cmd::AddChangelog.for(config: @config)
+        Gemaker::Cmd::ConfigureEditorConfig.for(config: @config)
         Gemaker::Cmd::CustomizeGemspec.for(config: @config)
         Gemaker::Cmd::AddLicense.for(config: @config)
         Gemaker::Cmd::AddCliStructure.for(config: @config)
@@ -35,8 +33,7 @@ module Gemaker
         Gemaker::Cmd::CustomizeRakefile.for(config: @config)
         Gemaker::Cmd::CustomizeMainLibFile.for(config: @config)
         Gemaker::Cmd::AddInstallGenerator.for(config: @config)
-        Gemaker::Cmd::AddHoundRules.for(config: @config)
-        Gemaker::Cmd::ConfigureTravis.for(config: @config)
+        Gemaker::Cmd::ConfigureContinuousIntegration.for(config: @config)
         Gemaker::Cmd::ConfigureGit.for(config: @config)
         info("Done!")
       end

data/lib/gemaker/commands/customize_engine.rb

@@ -2,12 +2,39 @@ module Gemaker
   module Cmd
     class CustomizeEngine < Gemaker::Cmd::Base
       def in_engine_context
-        copy_template("engine/engine.rb",
-          "lib/#{@config.gem_name}/engine.rb", config: @config)
-        copy_template("engine/example_class.rb",
-          "lib/#{@config.gem_name}/example_class.rb", config: @config)
+        replace_development_file
+        replace_engine_file
+        add_example_class
+
         info "Customize engine.rb"
       end
+
+      private
+
+      def replace_development_file
+        remove_in_gem("spec/dummy/config/environments/development.rb")
+        copy_template(
+          "engine/development.rb",
+          "spec/dummy/config/environments/development.rb",
+          config: @config
+        )
+      end
+
+      def replace_engine_file
+        copy_template(
+          "engine/engine.rb",
+          "lib/#{@config.gem_name}/engine.rb",
+          config: @config
+        )
+      end
+
+      def add_example_class
+        copy_template(
+          "engine/example_class.rb",
+          "lib/#{@config.gem_name}/example_class.rb",
+          config: @config
+        )
+      end
     end
   end
 end

data/lib/gemaker/config.rb

@@ -2,7 +2,7 @@ module Gemaker
   class Config
     RUBY_VERSION = 2.3
 
-    attr_accessor :gem_name, :summary, :engine, :cli, :mountable, :installable
+    attr_accessor :gem_name, :summary, :engine, :cli, :installable
     attr_reader :authors, :emails
     attr_writer :human_gem_name, :description, :homepage
 
@@ -45,18 +45,10 @@ module Gemaker
       !!cli
     end
 
-    def mountable?
-      !!mountable
-    end
-
     def installable?
       !!installable
     end
 
-    def ruby_version
-      RUBY_VERSION
-    end
-
     private
 
     def string_to_array(value)

data/lib/gemaker/templates/circle_config.yml.erb

@@ -0,0 +1,103 @@
+version: 2.1
+
+env-vars: &env-vars
+  RAILS_ENV: test
+  NODE_ENV: test
+  BUNDLE_PATH: vendor/bundle
+
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+executors:
+  main-executor:
+    parameters:
+      ruby-version:
+        description: "Ruby version"
+        default: "<%= Gemaker::RUBY_VERSION %>"
+        type: string
+    docker:
+      - image: circleci/ruby:<<parameters.ruby-version>>-node
+        environment: *env-vars
+
+commands:
+  setup:
+    description: checkout code and install dependencies
+    steps:
+      - checkout
+      - run:
+          name: Install bundle dependencies
+          command: |
+            BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")
+            gem install bundler:$BUNDLER_VERSION
+            bundle _$(echo $BUNDLER_VERSION)_ install
+
+jobs:
+  lint:
+    executor: main-executor
+    steps:
+      - setup
+      - run:
+          name: Install reviewdog
+          command: |
+            curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b ./bin
+      - run:
+          name: Get files to lint
+          command: |
+            mkdir tmp
+            git diff origin/master --name-only --diff-filter=d > tmp/files_to_lint
+      - run:
+          name: Run rubocop
+          shell: /bin/bash
+          command: |
+            cat tmp/files_to_lint | grep -E '.+\.(rb)$' | xargs bundle exec rubocop --force-exclusion \
+            | ./bin/reviewdog -reporter=github-pr-review -f=rubocop
+  test:
+    parameters:
+      ruby-version:
+        description: "Ruby version"
+        default: "<%= Gemaker::RUBY_VERSION %>"
+        type: string
+    executor:
+      name: main-executor
+      ruby-version: <<parameters.ruby-version>>
+    steps:
+      - setup
+      - run:
+          name: Run Tests
+          command: |
+            RSPEC_JUNIT_ARGS="-r rspec_junit_formatter -f RspecJunitFormatter -o test_results/rspec.xml"
+            RSPEC_FORMAT_ARGS="-f progress --no-color -p 10"
+            bundle exec rspec ./spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
+      - store_test_results:
+          path: test_results
+  deploy:
+    executor: main-executor
+    steps:
+      - setup
+      - run:
+          name: Setup rubygems
+          command: bash .circleci/setup-rubygems.sh
+      - run:
+          name: Publish to rubygems
+          command: |
+            gem build active_job_log.gemspec
+            version_tag=$(git describe --tags)
+            gem push active_job_log-${version_tag#v}.gem
+
+workflows:
+  version: 2
+  main:
+    jobs:
+      - lint:
+          context: org-global
+      - test:
+          matrix:
+            parameters:
+              ruby-version: <%= Gemaker::RUBY_VERSIONS %>
+      - deploy:
+          context: org-global
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              ignore: /.*/

data/lib/gemaker/templates/circleci-setup-script.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem
+echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 /home/circleci/.gem/credentials