potassium 5.2.1 → 6.2.0

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,88 @@
+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
+
+  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
+
+    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
+  end
+end

data/spec/features/github_spec.rb

@@ -1,22 +1,67 @@
 require "spec_helper"
 
 RSpec.describe "GitHub" do
+  let(:org_name) { "platanus" }
+  let(:repo_name) { PotassiumTestHelpers::APP_NAME.dasherize }
+  let(:access_token) { "1234" }
+  let(:pr_template_file) { IO.read("#{project_path}/.github/pull_request_template.md") }
+
   before do
     drop_dummy_database
     remove_project_directory
   end
 
-  it "create a the github repository" do
-    create_dummy_project("github" => true)
-    app_name = PotassiumTestHelpers::APP_NAME.dasherize
+  it "creates the github repository" do
+    create_dummy_project(
+      "github" => true,
+      "github_private" => false,
+      "github_has_org" => false,
+      "github_name" => repo_name,
+      "github_access_token" => access_token
+    )
+
+    expect(FakeOctokit).to have_created_repo(repo_name)
+    expect(pr_template_file).to include('Contexto')
+  end
+
+  it "creates the private github repository" do
+    create_dummy_project(
+      "github" => true,
+      "github_private" => true,
+      "github_has_org" => false,
+      "github_name" => repo_name,
+      "github_access_token" => access_token
+    )
+
+    expect(FakeOctokit).to have_created_private_repo(repo_name)
+    expect(pr_template_file).to include('Contexto')
+  end
+
+  it "creates the github repository for the organization" do
+    create_dummy_project(
+      "github" => true,
+      "github_private" => false,
+      "github_has_org" => true,
+      "github_org" => org_name,
+      "github_name" => repo_name,
+      "github_access_token" => access_token
+    )
 
-    expect(FakeGithub).to have_created_repo("platanus/#{app_name}")
+    expect(FakeOctokit).to have_created_repo_for_org(repo_name, org_name)
+    expect(pr_template_file).to include('Contexto')
   end
 
-  it "create a the github private repository" do
-    create_dummy_project("github" => true, "github-private" => true)
-    app_name = PotassiumTestHelpers::APP_NAME.dasherize
+  it "creates the private github repository for the organization" do
+    create_dummy_project(
+      "github" => true,
+      "github_private" => true,
+      "github_has_org" => true,
+      "github_org" => org_name,
+      "github_name" => repo_name,
+      "github_access_token" => access_token
+    )
 
-    expect(FakeGithub).to have_created_private_repo("platanus/#{app_name}")
+    expect(FakeOctokit).to have_created_private_repo_for_org(repo_name, org_name)
+    expect(pr_template_file).to include('Contexto')
   end
 end

data/spec/features/google_tag_manager_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+RSpec.describe "Google Tag Manager" do
+  before :all do
+    remove_project_directory
+    create_dummy_project('google_tag_manager' => true)
+  end
+
+  let(:gtm_head_file_path) do
+    "#{project_path}/app/views/shared/_gtm_head.html.erb"
+  end
+  let(:gtm_body_file_path) do
+    "#{project_path}/app/views/shared/_gtm_body.html.erb"
+  end
+  let(:content_security_policy_file_path) do
+    "#{project_path}/config/initializers/content_security_policy.rb"
+  end
+  let(:application_layout_file) do
+    IO.read("#{project_path}/app/views/layouts/application.html.erb")
+  end
+  let(:content_security_policy_file) do
+    IO.read(content_security_policy_file_path)
+  end
+
+  it 'adds google tag manager script' do
+    expect(File).to be_file(gtm_head_file_path)
+    expect(File).to be_file(gtm_body_file_path)
+    expect(application_layout_file).to include('shared/gtm_head')
+    expect(application_layout_file).to include('shared/gtm_body')
+  end
+
+  it 'add content security policy' do
+    expect(content_security_policy_file)
+      .to include(content_security_policy_code)
+  end
+
+  def content_security_policy_code
+    <<~HERE
+      Rails.application.config.content_security_policy do |policy|
+        if Rails.env.development?
+          policy.connect_src :self, :https, 'http://localhost:3035', 'ws://localhost:3035'
+          policy.script_src :self, :https, :unsafe_eval
+        else
+          policy.script_src :self, :https
+          # google tag manager requires to enable unsafe inline:
+          # https://developers.google.com/tag-manager/web/csp
+          policy.connect_src :self, :https, 'https://www.google-analytics.com'
+          policy.script_src :self,
+            :https,
+            :unsafe_inline,
+            'https://www.googletagmanager.com',
+            'https://www.google-analytics.com',
+            'https://ssl.google-analytics.com'
+          policy.img_src :self, :https, 'https://www.googletagmanager.com', 'https://www.google-analytics.com'
+        end
+      end
+    HERE
+  end
+end

data/spec/features/graphql_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+RSpec.describe "GraphQL" do
+  context 'when using only graphql' do
+    before :all do
+      drop_dummy_database
+      remove_project_directory
+      create_dummy_project("api" => :graphql)
+    end
+
+    it "adds graphql related gems to Gemfile" do
+      gemfile_content = IO.read("#{project_path}/Gemfile")
+      expect(gemfile_content).to include("gem 'graphql'")
+      expect(gemfile_content).to include("gem 'graphql_playground-rails'")
+      expect(gemfile_content).not_to include("gem 'graphiql'")
+    end
+
+    it 'installs and sets up graphql' do
+      schema = IO.read(
+        "#{project_path}/app/graphql/#{PotassiumTestHelpers::APP_NAME.dasherize.tr('-', '_')}_schema.rb"
+      )
+      expect(schema).to include(
+        "class #{PotassiumTestHelpers::APP_NAME.titleize.delete(' ')}Schema < GraphQL::Schema"
+      )
+
+      base_mutation = IO.read("#{project_path}/app/graphql/mutations/base_mutation.rb")
+      expect(base_mutation).to include('Types::Base::Base')
+      expect(base_mutation).not_to include('input_object_class')
+      expect(base_mutation).not_to include('RelayClassic')
+
+      controller = IO.read("#{project_path}/app/controllers/graphql_controller.rb")
+      expect(controller).to include('skip_before_action :verify_authenticity_token')
+    end
+
+    it 'sets up graphql playground' do
+      routes = IO.read("#{project_path}/config/routes.rb")
+      expect(routes).to include(
+        'mount GraphqlPlayground::Rails::Engine, at: "/graphiql", graphql_path: "/graphql"'
+      )
+      config = IO.read("#{project_path}/config/initializers/graphql_playground.rb")
+      expect(config).to include('GraphqlPlayground::Rails.configure do |config|')
+    end
+  end
+
+  context 'when using authentication' do
+    before :all do
+      drop_dummy_database
+      remove_project_directory
+      create_dummy_project("api" => :graphql, "devise": true)
+    end
+
+    it 'gathers jwt gem' do
+      gemfile_content = IO.read("#{project_path}/Gemfile")
+      expect(gemfile_content).to include("gem 'jwt'")
+    end
+
+    it 'Adds auth related mutation and controller' do
+      controller = IO.read("#{project_path}/app/controllers/graphql_controller.rb")
+      expect(controller).to include('get_current_user')
+      expect(controller).to include(
+        "#{PotassiumTestHelpers::APP_NAME.titleize.delete(' ')}Schema.execute"
+      )
+
+      mutation_type = IO.read("#{project_path}/app/graphql/types/mutation_type.rb")
+      expect(mutation_type).to include('field :login, mutation: Mutations::LoginMutation')
+
+      login_mutation = IO.read("#{project_path}/app/graphql/mutations/login_mutation.rb")
+      expect(login_mutation).to include('class Mutations::LoginMutation < Mutations::BaseMutation')
+    end
+  end
+end

data/spec/features/heroku_spec.rb

@@ -18,6 +18,7 @@ RSpec.describe "Heroku" do
     procfile = IO.read(procfile_path)
 
     expect(procfile).to include("web: bundle exec puma -C ./config/puma.rb")
+    expect(procfile).to include("release: bin/release")
 
     buildpacks_path = "#{project_path}/.buildpacks"
     buildpacks = IO.read(buildpacks_path)
@@ -25,20 +26,15 @@ RSpec.describe "Heroku" do
     expect(buildpacks).to include("https://github.com/heroku/heroku-buildpack-nodejs")
     expect(buildpacks).to include("https://github.com/platanus/heroku-buildpack-ruby-version.git")
     expect(buildpacks).to include("https://github.com/heroku/heroku-buildpack-ruby.git")
-    expect(buildpacks).to(
-      include("https://github.com/gunpowderlabs/buildpack-ruby-rake-deploy-tasks.git")
-    )
 
     expect(FakeHeroku).to have_created_app_for("staging")
     expect(FakeHeroku).to have_created_app_for("production")
 
     expect(FakeHeroku).to have_configured_vars("staging", "SECRET_KEY_BASE")
     expect(FakeHeroku).to have_configured_vars("staging", "RACK_ENV")
-    expect(FakeHeroku).to have_configured_vars("staging", "DEPLOY_TASKS")
 
     expect(FakeHeroku).to have_configured_vars("production", "SECRET_KEY_BASE")
     expect(FakeHeroku).to have_configured_vars("production", "RACK_ENV")
-    expect(FakeHeroku).to have_configured_vars("production", "DEPLOY_TASKS")
 
     expect(FakeHeroku).to have_created_pipeline_for("staging")
     expect(FakeHeroku).to have_add_pipeline_for("production")
@@ -55,5 +51,12 @@ RSpec.describe "Heroku" do
     expect(bin_setup_heroku).to include("heroku apps:info --app pl-#{app_name}-production")
     expect(bin_setup_heroku).to include("git config heroku.remote staging")
     expect(File.stat(bin_setup_path)).to be_executable
+
+    bin_release_path = "#{project_path}/bin/release"
+    bin_release = IO.read(bin_release_path)
+
+    expect(bin_release).to include('set -e')
+    expect(bin_release).to include('bundle exec rails db:migrate:with_data')
+    expect(File.stat(bin_release_path)).to be_executable
   end
 end

data/spec/features/mailer_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+RSpec.describe "Mailer" do
+  let(:gemfile) { IO.read("#{project_path}/Gemfile") }
+  let(:mailer_config) { IO.read("#{project_path}/config/mailer.rb") }
+  let(:dev_config) { IO.read("#{project_path}/config/environments/development.rb") }
+  let(:sidekiq_config) { IO.read("#{project_path}/config/sidekiq.yml") }
+
+  before(:all) { drop_dummy_database }
+
+  context "when selecting sendgrid as mailer" do
+    before(:all) do
+      remove_project_directory
+      create_dummy_project("email_service" => "sendgrid")
+    end
+
+    it { expect(gemfile).to include("send_grid_mailer") }
+
+    it "adds configuration to mailer.rb" do
+      expect(mailer_config).to include("delivery_method = :sendgrid")
+      expect(mailer_config).to include("sendgrid_settings = {")
+      expect(mailer_config).to include("api_key: ENV['SENDGRID_API_KEY']")
+    end
+
+    it "adds configuration to development.rb" do
+      expect(dev_config).to include("delivery_method = :sendgrid_dev")
+      expect(dev_config).to include("sendgrid_dev_settings = {")
+      expect(dev_config).to include("api_key: ENV['SENDGRID_API_KEY']")
+    end
+
+    it { expect(sidekiq_config).to include("- mailers") }
+  end
+
+  context "when selecting aws_ses as mailer" do
+    before(:all) do
+      remove_project_directory
+      create_dummy_project("email_service" => "aws_ses")
+    end
+
+    it { expect(gemfile).to include("aws-sdk-rails") }
+    it { expect(gemfile).to include("letter_opener") }
+    it { expect(mailer_config).to include("delivery_method = :aws_sdk") }
+    it { expect(dev_config).to include("delivery_method = :letter_opener") }
+    it { expect(sidekiq_config).to include("- mailers") }
+  end
+
+  context "when selecting a mailer and sidekiq" do
+    before :all do
+      drop_dummy_database
+      remove_project_directory
+      create_dummy_project(
+        "background_processor" => true, "email_service" => 'sendgrid'
+      )
+    end
+
+    it { expect(sidekiq_config).to include("- mailers") }
+  end
+end