potassium 5.2.2 → 6.3.0

data/lib/potassium/templates/application.rb

@@ -1,4 +1,5 @@
 set :app_name, app_name
+set :node_version, node_version
 set :titleized_app_name, get(:app_name).titleize
 set :underscorized_app_name, get(:app_name).underscore
 set :dasherized_app_name, get(:app_name).dasherize
@@ -19,8 +20,9 @@ run_action(:asking) do
   ask :database
   ask :devise
   ask :admin
+  ask :google_tag_manager
   ask :front_end
-  ask :angular_admin
+  ask :vue_admin
   ask :mailer
   ask :background_processor
   ask :schedule
@@ -29,8 +31,7 @@ run_action(:asking) do
   ask :i18n
   ask :api
   ask :draper
-  ask :active_storage
-  ask :paperclip
+  ask :file_storage
   ask :heroku
   ask :github
 end
@@ -46,20 +47,22 @@ run_action(:recipe_loading) do
   create :database_container
   create :database
   create :annotate
+  create :data_migrate
   create :listen
+  create :node
   create :ruby
   create :yarn
   create :editorconfig
-  create :aws_sdk
   create :mailer
   create :background_processor
   create :schedule
   create :i18n
   create :pry
   create :better_errors
+  create :monitoring
   create :devise
   create :admin
-  create :angular_admin
+  create :vue_admin
   create :seeds
   create :error_reporting
   create :pundit
@@ -69,13 +72,13 @@ run_action(:recipe_loading) do
   create :draper
   create :power_types
   create :rack_cors
-  create :active_storage
-  create :paperclip
+  create :file_storage
   create :tzinfo
   create :script
   create :github
   create :cleanup
   create :front_end
+  create :google_tag_manager
 end
 
 info "Gathered enough information. Applying the template. Wait a minute."

data/lib/potassium/version.rb

@@ -1,8 +1,11 @@
 module Potassium
-  VERSION = "5.2.2"
-  RUBY_VERSION = "2.5.5"
-  RAILS_VERSION = "~> 5.2.1"
-  RUBOCOP_VERSION = "~> 0.65.0"
+  VERSION = "6.3.0"
+  RUBY_VERSION = "2.7.0"
+  RAILS_VERSION = "~> 6.0.2"
+  RUBOCOP_VERSION = "~> 1.9"
+  RUBOCOP_RSPEC_VERSION = "~> 2.2"
   POSTGRES_VERSION = "11.3"
   MYSQL_VERSION = "5.7"
+  NODE_VERSION = "12"
+  TAILWINDCSS = "npm:@tailwindcss/postcss7-compat"
 end

data/potassium.gemspec

@@ -18,15 +18,20 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.4.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "pry", "~> 0.10.3"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.4.0"
+  spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "rubocop", Potassium::RUBOCOP_VERSION
-  spec.add_runtime_dependency "rails", Potassium::RAILS_VERSION
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "rubocop-rspec", Potassium::RUBOCOP_RSPEC_VERSION
+  spec.add_runtime_dependency "gems", "~> 0.8"
   spec.add_runtime_dependency "gli", "~> 2.12.2"
   spec.add_runtime_dependency "inquirer", "~> 0.2"
-  spec.add_runtime_dependency "gems", "~> 0.8"
-  spec.add_runtime_dependency "semantic", "~> 1.4"
   spec.add_runtime_dependency "levenshtein", "~> 0.2"
+  spec.add_runtime_dependency "octokit", "~> 4.18"
+  spec.add_runtime_dependency "rails", Potassium::RAILS_VERSION
+  spec.add_runtime_dependency "semantic", "~> 1.4"
 end

data/spec/features/api_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+RSpec.describe "Api" do
+  before :all do
+    drop_dummy_database
+    remove_project_directory
+    create_dummy_project("api" => :rest)
+  end
+
+  it "adds power_api related gems to Gemfile" do
+    gemfile_content = IO.read("#{project_path}/Gemfile")
+    expect(gemfile_content).to include("gem 'power_api'")
+    expect(gemfile_content).to include("gem 'rswag-specs'")
+  end
+
+  it "adds the power_api brief to README file" do
+    readme = IO.read("#{project_path}/README.md")
+    expect(readme).to include("Power API")
+  end
+
+  it "installs power_api" do
+    content = IO.read("#{project_path}/app/controllers/api/base_controller.rb")
+    expect(content).to include("Api::BaseController < PowerApi::BaseController")
+  end
+end

data/spec/features/background_processor_spec.rb

@@ -1,11 +1,12 @@
 require "spec_helper"
+require 'yaml'
 
 RSpec.describe "BackgroundProcessor" do
-  context "working with sidekiq" do
+  context "when working with sidekiq and no mailer" do
     before :all do
       drop_dummy_database
       remove_project_directory
-      create_dummy_project("background_processor" => "sidekiq", "heroku" => true)
+      create_dummy_project("background_processor" => true, "heroku" => true)
     end
 
     it "adds sidekiq gem to Gemfile" do
@@ -41,6 +42,9 @@ RSpec.describe "BackgroundProcessor" do
     it "adds ENV vars" do
       content = IO.read("#{project_path}/.env.development")
       expect(content).to include("DB_POOL=25")
+      expect(content).to include('REDIS_HOST=127.0.0.1')
+      expect(content).to include('REDIS_PORT=$(make services-port SERVICE=redis PORT=6379)')
+      expect(content).to include('REDIS_URL=redis://${REDIS_HOST}:${REDIS_PORT}/1')
     end
 
     it "adds sidekiq.rb file" do
@@ -48,19 +52,28 @@ RSpec.describe "BackgroundProcessor" do
       expect(content).to include("require 'sidekiq'")
     end
 
-    it "adds sidekiq.yml file" do
-      content = IO.read("#{project_path}/config/sidekiq.yml")
-      expect(content).to include("concurrency: 5")
+    it "adds sidekiq.yml file with no mailer queue" do
+      yml_path = "#{project_path}/config/sidekiq.yml"
+      content = IO.read(yml_path)
+      expect(File.exist?(yml_path)).to be true
+      expect(content).not_to include("- mailers")
     end
 
     it "adds redis.yml file" do
       content = IO.read("#{project_path}/config/redis.yml")
-      expect(content).to include("REDIS_HOST")
+      expect(content).to include("REDIS_URL")
     end
 
     it "mounts sidekiq app" do
       content = IO.read("#{project_path}/config/routes.rb")
       expect(content).to include("mount Sidekiq::Web => '/queue'")
     end
+
+    it 'adds redis to docker-compose' do
+      compose_file = IO.read("#{project_path}/docker-compose.yml")
+      compose_content = YAML.safe_load(compose_file, symbolize_names: true)
+
+      expect(compose_content[:services]).to include(:redis)
+    end
   end
 end

data/spec/features/ci_spec.rb

@@ -1,14 +1,17 @@
 require "spec_helper"
 require "rubocop"
 
-RSpec.describe "A new project" do
+RSpec.describe 'CI' do
   before(:all) do
     drop_dummy_database
     remove_project_directory
-    create_dummy_project("heroku" => true)
+    create_dummy_project
   end
 
-  it "correctly runs continous integration" do
-    expect { on_project { `bin/cibuild` } }.to_not output.to_stderr
+  it "correctly bundles the config file" do
+    yml_path = "#{project_path}/.circleci/config.yml"
+    content = IO.read(yml_path)
+    expect(File.exist?(yml_path)).to be true
+    expect(content).to include('circleci/ruby', 'cache', 'rspec', 'reviewdog')
   end
 end

data/spec/features/data_migrate_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+RSpec.describe 'DataMigrate' do
+  let(:gemfile) { IO.read("#{project_path}/Gemfile") }
+  let(:annotate_task) { IO.read("#{project_path}/lib/tasks/auto_annotate_models.rake") }
+
+  before(:all) do
+    remove_project_directory
+    create_dummy_project
+  end
+
+  it { expect(gemfile).to include("data_migrate") }
+  it { expect(annotate_task).to include("data_migrate_tasks") }
+end

data/spec/features/database_container_spec.rb

@@ -11,10 +11,6 @@ RSpec.describe "DatabaseContainer" do
     create_dummy_project("database" => database)
   end
 
-  after do
-    `docker-compose -f #{project_path}/docker-compose.yml down`
-  end
-
   [:postgresql, :mysql].each do |db_type|
     context "when database is #{db_type}" do
       let!(:database) { db_type }
@@ -32,7 +28,7 @@ RSpec.describe "DatabaseContainer" do
           .to include("DB_PORT=$(make services-port SERVICE=#{service_name} PORT=#{db_port})")
         expect(env_file).to include("DB_HOST=127.0.0.1")
         expect(File.exist?("#{project_path}/Makefile")).to be true
-        expect(setup_file).to include("make services-up")
+        expect(setup_file).to include("docker-compose up -d")
       end
     end
   end

data/spec/features/draper_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe "Draper" do
   before :all do
     drop_dummy_database
     remove_project_directory
-    create_dummy_project("draper" => true, "api" => true)
+    create_dummy_project("draper" => true)
   end
 
   it "adds the Draper gem to Gemfile" do
@@ -17,11 +17,6 @@ RSpec.describe "Draper" do
     expect(readme).to include("Draper")
   end
 
-  it "adds api responder to work with draper" do
-    responder_content = IO.read("#{project_path}/app/responders/api_responder.rb")
-    expect(responder_content).to include("decorated_resource")
-  end
-
   it "adds decorators directory" do
     content = IO.read("#{project_path}/app/decorators/.keep")
     expect(content).to be_empty

data/spec/features/file_storage_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+RSpec.describe "File Storage" do
+  context "when selecting active_storage" do
+    before :all do
+      drop_dummy_database
+      remove_project_directory
+      create_dummy_project(storage: :active_storage)
+    end
+
+    it "adds the aws-sdk-s3 gem to Gemfile" do
+      gemfile_content = IO.read("#{project_path}/Gemfile")
+      expect(gemfile_content).to include("gem 'aws-sdk-s3'")
+    end
+
+    it "customizes config file" do
+      content = IO.read("#{project_path}/config/storage.yml")
+      expect(content).to include("bucket: <%= ENV['S3_BUCKET'] %>")
+    end
+
+    it "adds brief to README file" do
+      content = IO.read("#{project_path}/README.md")
+      expect(content).to include("Active Storage")
+    end
+
+    it "uses amazon on production env" do
+      content = IO.read("#{project_path}/config/environments/production.rb")
+      expect(content).to include("config.active_storage.service = :amazon")
+    end
+
+    it "adds S3 bucket ENV vars" do
+      content = IO.read("#{project_path}/.env.development")
+      expect(content).to include("S3_BUCKET=")
+    end
+  end
+
+  context "when selecting shrine" do
+    before :all do
+      drop_dummy_database
+      remove_project_directory
+      create_dummy_project(storage: :shrine)
+    end
+
+    it "adds the aws-sdk-s3, shrine and marcel gems to Gemfile" do
+      gemfile_content = IO.read("#{project_path}/Gemfile")
+      expect(gemfile_content).to include("gem 'aws-sdk-s3'")
+      expect(gemfile_content).to include("gem 'shrine'")
+      expect(gemfile_content).to include("gem 'marcel'")
+    end
+
+    it "adds brief to README file" do
+      content = IO.read("#{project_path}/README.md")
+      expect(content).to include("Shrine")
+    end
+
+    it "adds shrine initializer" do
+      expect(File.exist?("#{project_path}/config/initializers/shrine.rb")).to be true
+    end
+
+    it "adds base_uploader and image_uploader" do
+      expect(File.exist?("#{project_path}/app/uploaders/base_uploader.rb")).to be true
+      expect(File.exist?("#{project_path}/app/uploaders/image_uploader.rb")).to be true
+    end
+
+    it "adds S3 bucket ENV vars" do
+      content = IO.read("#{project_path}/.env.development")
+      expect(content).to include("S3_BUCKET=")
+    end
+
+    it "adds filestorage path to gitignore" do
+      content = IO.read("#{project_path}/.gitignore")
+      expect(content).to include("/public/uploads")
+    end
+  end
+end

data/spec/features/front_end_spec.rb

@@ -0,0 +1,102 @@
+require "spec_helper"
+
+RSpec.describe "Front end" do
+  before :all do
+    drop_dummy_database
+    remove_project_directory
+  end
+
+  let(:application_css_path) { "#{project_path}/app/javascript/css/application.css" }
+  let(:gemfile) { IO.read("#{project_path}/Gemfile") }
+  let(:node_modules_file) { IO.read("#{project_path}/package.json") }
+  let(:application_js_file) { IO.read("#{project_path}/app/javascript/packs/application.js") }
+  let(:layout_file) { IO.read("#{project_path}/app/views/layouts/application.html.erb") }
+  let(:application_css_file) { IO.read(application_css_path) }
+  let(:tailwind_config_file) { IO.read("#{project_path}/tailwind.config.js") }
+  let(:rails_css_file) { IO.read("#{project_path}/app/assets/stylesheets/application.css") }
+
+  it "creates a project without a front end framework" do
+    remove_project_directory
+    create_dummy_project("front_end" => "None")
+    expect(gemfile).to include('webpacker')
+    expect(File).not_to exist(application_css_path)
+  end
+
+  def expect_to_have_tailwind_compatibility_build
+    expect(node_modules_file).to include("\"tailwindcss\": \"npm:@tailwindcss/postcss7-compat\"")
+    expect(node_modules_file).to include("\"autoprefixer\": \"^9\"")
+    expect(node_modules_file).to include("\"postcss\": \"^7\"")
+  end
+
+  context "with vue" do
+    before(:all) do
+      remove_project_directory
+      create_dummy_project("front_end" => "vue")
+    end
+
+    it "creates a project with vue in compiler mode as frontend framework" do
+      expect(gemfile).to include('webpacker')
+      expect(node_modules_file).to include("\"vue\"")
+      expect(application_js_file).to include('vue/dist/vue.esm')
+      expect(application_js_file).to include("el: '#vue-app'")
+      expect(layout_file).to include('id="vue-app"')
+    end
+
+    it "creates a project with only one js pack tag" do
+      expect(layout_file.scan("javascript_pack_tag").length).to eq(1)
+    end
+
+    it "creates a vue project with client css" do
+      expect(application_js_file).to include("import '../css/application.css';")
+      expect(layout_file).to include("<%= stylesheet_pack_tag 'application' %>")
+      expect(rails_css_file).not_to include('*= require_tree', '*= require_self')
+    end
+
+    it "creates a vue project with tailwindcss" do
+      expect(node_modules_file).to include("\"tailwindcss\"")
+      expect(application_css_file).to include(
+        "@import 'tailwindcss/base';",
+        "@import 'tailwindcss/components';"
+      )
+      expect(tailwind_config_file).to include('module.exports')
+    end
+
+    it 'includes correct packages for tailwind, postcss and autoprefixer compatibility build' do
+      expect_to_have_tailwind_compatibility_build
+    end
+
+    context "with graphql" do
+      before(:all) do
+        remove_project_directory
+        create_dummy_project("front_end" => "vue", "api" => "graphql")
+      end
+
+      it "creates a vue project with apollo" do
+        expect(node_modules_file).to include("\"vue-apollo\"")
+        expect(application_js_file).to include("import { ApolloClient } from 'apollo-client';")
+        expect(application_js_file).to include("Vue.use(VueApollo)")
+        expect(application_js_file).to include("apolloProvider,")
+      end
+    end
+  end
+
+  context "with angular" do
+    before(:all) do
+      remove_project_directory
+      create_dummy_project("front_end" => "angular")
+    end
+
+    it "creates a project without vue as front end framework" do
+      expect(gemfile).to include('webpacker')
+      expect(node_modules_file).to include("\"@angular/core\"")
+    end
+
+    it "creates application_js_file for tailwind without vue" do
+      expect(application_js_file).to include("import '../css/application.css';")
+    end
+
+    it 'includes correct packages for tailwind, postcss and autoprefixer compatibility build' do
+      expect_to_have_tailwind_compatibility_build
+    end
+  end
+end