potassium 5.2.1 → 6.2.0

data/lib/potassium/recipes/schedule.rb

@@ -8,10 +8,10 @@ class Recipes::Schedule < Rails::AppBuilder
 
   def create
     if selected?(:schedule)
-      gather_gem 'sidekiq-scheduler'
+      gather_gem 'sidekiq-scheduler', '>= 3.0.1'
       add_readme_section :internal_dependencies, :sidekiq_scheduler
+      append_schedule_section_to_yml
     end
-    template '../assets/sidekiq_scheduler.yml', 'config/sidekiq.yml', force: true
   end
 
   def install
@@ -22,4 +22,19 @@ class Recipes::Schedule < Rails::AppBuilder
   def installed?
     gem_exists?(/sidekiq-scheduler/) && file_exist?('config/sidekiq.yml')
   end
+
+  private
+
+  def append_schedule_section_to_yml
+    append_to_file(
+      'config/sidekiq.yml',
+      <<-HERE.gsub(/^ {8}/, '')
+        # :schedule:
+          #  an_scheduled_task:
+          #    cron: '0 * * * * *'  # Runs once per minute
+          #    class: ExampleJob
+          #    args: ['a', 'b']
+      HERE
+    )
+  end
 end

data/lib/potassium/recipes/style.rb

@@ -1,12 +1,30 @@
 class Recipes::Style < Rails::AppBuilder
   def create
-    append_to_file ".gitignore", ".rubocop.yml\n"
-    append_to_file ".gitignore", ".eslintrc.json\n"
-    append_to_file ".gitignore", ".sscs-lint.yml\n"
+    add_linters
+    add_config_files
     add_readme_header :style_guide
   end
 
   def install
     create
   end
+
+  private
+
+  def add_linters
+    gather_gems(:development, :test) do
+      gather_gem 'rubocop', Potassium::RUBOCOP_VERSION
+      gather_gem 'rubocop-performance'
+      gather_gem 'rubocop-rails'
+      gather_gem 'rubocop-rspec', Potassium::RUBOCOP_RSPEC_VERSION
+    end
+    run 'bin/yarn add --dev stylelint eslint eslint-plugin-import'
+    run 'bin/yarn add --dev eslint-plugin-vue' if selected?(:front_end, :vue)
+  end
+
+  def add_config_files
+    copy_file '../assets/.rubocop.yml', '.rubocop.yml'
+    copy_file '../assets/.eslintrc.json', '.eslintrc.json'
+    copy_file '../assets/.stylelintrc.json', '.stylelintrc.json'
+  end
 end

data/lib/potassium/recipes/vue_admin.rb

@@ -0,0 +1,124 @@
+class Recipes::VueAdmin < Rails::AppBuilder
+  def ask
+    if selected?(:admin_mode)
+      vue_admin = answer(:vue_admin) do
+        Ask.confirm "Do you want Vue support for ActiveAdmin?"
+      end
+      set(:vue_admin, vue_admin)
+      set(:front_end, :vue) if vue_admin
+    end
+  end
+
+  def create
+    recipe = self
+    if selected?(:vue_admin)
+      after(:admin_install) do
+        recipe.add_vue_admin
+      end
+    end
+  end
+
+  def install
+    active_admin = load_recipe(:admin)
+    if active_admin.installed?
+      add_vue_admin
+      info "VueAdmin installed"
+    else
+      info "VueAdmin can't be installed because Active Admin isn't installed."
+    end
+  end
+
+  def installed?
+    dir_exist?("app/assets/javascripts/admin")
+  end
+
+  def add_vue_admin
+    add_vue_component_library
+    add_component_integration
+    copy_file '../assets/active_admin/init_activeadmin_vue.rb',
+      'config/initializers/init_activeadmin_vue.rb'
+    copy_file '../assets/active_admin/admin_application.js',
+      'app/javascript/packs/admin_application.js',
+      force: true
+    empty_directory 'app/javascript/components'
+    copy_file '../assets/active_admin/admin-component.vue',
+      'app/javascript/components/admin-component.vue',
+      force: true
+  end
+
+  def add_component_integration
+    line = "class CustomFooter < ActiveAdmin::Component"
+    initializer = "config/initializers/active_admin.rb"
+    gsub_file initializer, /(#{Regexp.escape(line)})/mi do |_match|
+      <<~HERE
+        require "vue_component.rb"
+        AUTO_BUILD_ELEMENTS=[:admin_component, :template, :slot]
+        component_creator(AUTO_BUILD_ELEMENTS)
+
+        #{line}
+      HERE
+    end
+  end
+
+  def add_vue_component_library
+    lib_component_path = "lib/vue_component.rb"
+    class_definitions =
+      <<~HERE
+        #{vue_component}
+        #{component_builder}
+      HERE
+    File.open(lib_component_path, "w") { |file| file.write(class_definitions) }
+  end
+
+  def vue_component
+    <<~HERE
+      class VueComponent < Arbre::Component
+        builder_method :root
+        def tag_name
+          :root
+        end
+
+        def initialize(*)
+          super
+        end
+
+        def build(attributes = {})
+          super(process_attributes(attributes))
+        end
+
+        def process_attributes(attributes)
+          vue_attributes = {}
+          attributes.each do |key, value|
+            dasherized_key = key.to_s.dasherize
+            if value.is_a?(String)
+              vue_attributes[dasherized_key] = value
+            elsif !dasherized_key.index(':').nil? && dasherized_key.index(':').zero?
+              vue_attributes[dasherized_key] = value.to_json
+            else
+              vue_attributes[":" + dasherized_key] = value.to_json
+            end
+          end
+          vue_attributes
+        end
+      end
+    HERE
+  end
+
+  def component_builder
+    <<~HERE
+      def component_creator(auto_build_elements)
+        auto_build_elements.each do |element|
+          as_string=element.to_s
+          camelized_element = as_string.camelize
+          Object.const_set(camelized_element,Class.new(VueComponent))
+          Object.const_get(camelized_element).class_eval do
+            builder_method as_string.to_sym
+            def tag_name
+              self.class.to_s.underscore
+            end
+          end
+        end
+      end
+    HERE
+  end
+end

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,11 +47,12 @@ 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
@@ -59,7 +61,7 @@ run_action(:recipe_loading) do
   create :better_errors
   create :devise
   create :admin
-  create :angular_admin
+  create :vue_admin
   create :seeds
   create :error_reporting
   create :pundit
@@ -69,13 +71,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,10 @@
 module Potassium
-  VERSION = "5.2.1"
-  RUBY_VERSION = "2.5.5"
-  RAILS_VERSION = "~> 5.2.1"
-  RUBOCOP_VERSION = "~> 0.65.0"
+  VERSION = "6.2.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"
 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/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

@@ -1,4 +1,5 @@
 require "spec_helper"
+require "yaml"
 
 RSpec.describe "DatabaseContainer" do
   before(:all) do
@@ -10,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 }
@@ -31,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