potassium 5.2.3 → 6.0.0

data/lib/potassium/recipes/schedule.rb

@@ -8,7 +8,7 @@ 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
     end
     template '../assets/sidekiq_scheduler.yml', 'config/sidekiq.yml', force: true

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', '~> 0.82.0'
+      gather_gem 'rubocop-performance'
+      gather_gem 'rubocop-rails'
+      gather_gem 'rubocop-rspec'
+    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
@@ -20,7 +21,7 @@ run_action(:asking) do
   ask :devise
   ask :admin
   ask :front_end
-  ask :angular_admin
+  ask :vue_admin
   ask :mailer
   ask :background_processor
   ask :schedule
@@ -47,6 +48,7 @@ run_action(:recipe_loading) do
   create :annotate
   create :data_migrate
   create :listen
+  create :node
   create :ruby
   create :yarn
   create :editorconfig
@@ -58,7 +60,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

data/lib/potassium/version.rb

@@ -1,8 +1,9 @@
 module Potassium
-  VERSION = "5.2.3"
-  RUBY_VERSION = "2.5.5"
-  RAILS_VERSION = "~> 5.2.1"
+  VERSION = "6.0.0"
+  RUBY_VERSION = "2.7.0"
+  RAILS_VERSION = "~> 6.0.2"
   RUBOCOP_VERSION = "~> 0.65.0"
   POSTGRES_VERSION = "11.3"
   MYSQL_VERSION = "5.7"
+  NODE_VERSION = "12"
 end

data/potassium.gemspec

@@ -18,16 +18,17 @@ 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 "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.4.0"
-  spec.add_development_dependency "pry", "~> 0.10.3"
+  spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "rubocop", Potassium::RUBOCOP_VERSION
   spec.add_development_dependency "rubocop-rspec"
-  spec.add_runtime_dependency "rails", Potassium::RAILS_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 "rails", Potassium::RAILS_VERSION
+  spec.add_runtime_dependency "semantic", "~> 1.4"
 end

data/spec/features/database_container_spec.rb

@@ -28,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/file_storage_spec.rb

@@ -34,39 +34,35 @@ RSpec.describe "File Storage" do
     end
   end
 
-  context "when selecting paperclip" do
+  context "when selecting shrine" do
     before :all do
       drop_dummy_database
       remove_project_directory
-      create_dummy_project(storage: :paperclip)
+      create_dummy_project(storage: :shrine)
     end
 
-    it "adds the Paperclip gem to Gemfile" do
-      gemfile_content = IO.read("#{project_path}/Gemfile")
-      expect(gemfile_content).to include("gem 'paperclip'")
-    end
-
-    it "adds the aws-sdk-s3 gem to Gemfile" do
+    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("Paperclip")
+      expect(content).to include("Shrine")
     end
 
-    it "adds local file storage path to gitignore" do
-      content = IO.read("#{project_path}/.gitignore")
-      expect(content).to include("/public/system/*")
+    it "adds shrine initializer" do
+      expect(File.exist?("#{project_path}/config/initializers/shrine.rb")).to be true
     end
 
-    it "adds paperclip_defaults config to production" do
-      content = IO.read("#{project_path}/config/environments/production.rb")
-      expect(content).to include("config.paperclip_defaults")
+    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 var" do
+    it "adds S3 bucket ENV vars" do
       content = IO.read("#{project_path}/.env.development")
       expect(content).to include("S3_BUCKET=")
     end

data/spec/features/front_end_spec.rb

@@ -0,0 +1,74 @@
+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
+  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/new_project_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe "A new project" do
   it "configures the correct ruby version" do
     ruby_version_file = IO.read("#{project_path}/.ruby-version")
 
-    expect(ruby_version_file).to eq("2.5")
+    expect(ruby_version_file).to eq("2.7")
   end
 
   it "setup ssl" do

data/spec/features/node_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+RSpec.describe "Node" do
+  let(:version) { "12" }
+
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    create_dummy_project
+  end
+
+  it "adds engine with node version to package.json" do
+    package_json_path = "#{project_path}/package.json"
+    expect(File).to be_file(package_json_path)
+    json_file = File.read(package_json_path)
+    js_package = JSON.parse(json_file)
+    expect(js_package).to have_key("engines")
+    expect(js_package["engines"]).to have_key("node")
+    expect(js_package["engines"]["node"]).to eq("#{version}.x")
+  end
+
+  it "adds .node-version with correct version" do
+    node_version_path = "#{project_path}/.node-version"
+    expect(File).to be_file(node_version_path)
+    node_version_file = File.read(node_version_path)
+    expect(node_version_file).to eq(version)
+  end
+end

data/spec/features/power_types_spec.rb

@@ -17,21 +17,10 @@ RSpec.describe "PowerTypes" do
     expect(readme).to include("Power-Types")
   end
 
-  it "adds commands directory" do
-    commands_directory = "#{project_path}/app/commands"
-    expect(File.directory?(commands_directory)).to eq(true)
-  end
-
-  it "adds services directory" do
-    services_directory = "#{project_path}/app/services"
-    expect(File.directory?(services_directory)).to eq(true)
-  end
-  it "adds utils directory" do
-    utils_directory = "#{project_path}/app/utils"
-    expect(File.directory?(utils_directory)).to eq(true)
-  end
-  it "adds values directory" do
-    values_directory = "#{project_path}/app/values"
-    expect(File.directory?(values_directory)).to eq(true)
+  it "adds every power type directory" do
+    [:commands, :services, :observers, :utils, :values].each do |type|
+      commands_directory = "#{project_path}/app/#{type}"
+      expect(File.directory?(commands_directory)).to eq(true)
+    end
   end
 end

data/spec/features/vue_admin_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+require "pry"
+RSpec.describe "VueAdmin" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    create_dummy_project(:vue_admin => true, "admin" => true, "devise" => true)
+  end
+
+  it "adds component integration to active admin initializer" do
+    admin_initializer_path = "#{project_path}/config/initializers/active_admin.rb"
+    expect(File).to be_file(admin_initializer_path)
+    initializer_file = File.read(admin_initializer_path)
+    expect(initializer_file).to include("AUTO_BUILD_ELEMENTS")
+  end
+
+  it "adds layout tags to active admin layout initializer" do
+    initializer_path = "#{project_path}/config/initializers/init_activeadmin_vue.rb"
+    expect(File).to be_file(initializer_path)
+  end
+
+  it "adds vue_component to library" do
+    vue_component_lib_path = "#{project_path}/lib/vue_component.rb"
+    expect(File).to be_file(vue_component_lib_path)
+    vue_component_lib = File.read(vue_component_lib_path)
+    expect(vue_component_lib).to include("VueComponent")
+  end
+
+  it "adds admin_application pack to packs" do
+    application_pack_path = "#{project_path}/app/javascript/packs/admin_application.js"
+    expect(File).to be_file(application_pack_path)
+  end
+
+  it "adds admin_component to vue components" do
+    application_pack_path = "#{project_path}/app/javascript/components/admin-component.vue"
+    expect(File).to be_file(application_pack_path)
+  end
+
+  it "installs vue to project" do
+    package_json_path = "#{project_path}/package.json"
+    expect(File).to be_file(package_json_path)
+    json_file = File.read(package_json_path)
+    js_package = JSON.parse(json_file)
+    expect(js_package).to have_key("dependencies")
+    expect(js_package["dependencies"]).to have_key("vue")
+  end
+end