potassium 5.2.3 → 6.0.0

data/lib/potassium/assets/package.json

@@ -1,3 +1,6 @@
 {
-  "name": "<%= @app_name.camelcase %>"
+  "name": "<%= @app_name.camelcase %>",
+  "engines": {
+    "node": "<%= get(:node_version) %>"
+  }
 }

data/lib/potassium/cli/commands/create.rb

@@ -25,6 +25,7 @@ module Potassium::CLI
         template = template_finder.default_template
         template.cli_options = options
         template.source_paths << Rails::Generators::AppGenerator.source_root
+        ARGV.push('--skip-webpack-install', '--skip-bundle')
         template.start
       end
 

data/lib/potassium/cli_options.rb

@@ -16,7 +16,7 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       type: :flag,
       name: [:email_service, :email],
       desc: "Decides which email adapter to use. Available: aws_ses, sendgrid, none",
-      default_test_value: "aws_ses"
+      default_test_value: "None"
     },
     {
       type: :switch,
@@ -44,8 +44,8 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
     },
     {
       type: :switch,
-      name: "angular-admin",
-      desc: "Whether to use Angular within ActiveAdmin or not",
+      name: :vue_admin,
+      desc: "Whether to use Vue within ActiveAdmin or not",
       negatable: true,
       default_value: "none",
       default_test_value: false
@@ -69,9 +69,9 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
     {
       type: :flag,
       name: "storage",
-      desc: "Decides which file storage to use. Available: active_storage, paperclip, none",
+      desc: "Decides which file storage to use. Available: active_storage, shrine, none",
       default_value: "none",
-      default_test_value: "active_storage"
+      default_test_value: "None"
     },
     {
       type: :switch,
@@ -85,7 +85,7 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       type: :flag,
       name: "background_processor",
       desc: "Decides which background processor to use. Available: sidekiq, delayed_job, none",
-      default_test_value: "sidekiq"
+      default_test_value: "None"
     },
     {
       type: :switch,

data/lib/potassium/helpers/template-helpers.rb

@@ -3,6 +3,10 @@ module TemplateHelpers
     @app_name || app_name_from_file
   end
 
+  def node_version
+    "#{Potassium::NODE_VERSION}.x"
+  end
+
   def load_recipe(recipe_name)
     @recipes ||= {}
     @recipes[recipe_name] ||= get_recipe_class(recipe_name.to_sym).new(self)

data/lib/potassium/recipes/admin.rb

@@ -32,10 +32,10 @@ class Recipes::Admin < Rails::AppBuilder
   private
 
   def add_active_admin
-    gather_gem 'activeadmin', '~> 1.3.0'
+    gather_gem 'activeadmin', '~> 2.6'
     gather_gem 'activeadmin_addons'
-    gather_gem 'active_skin'
-
+    gather_gem 'active_skin', github: 'SoftwareBrothers/active_skin'
+    add_readme_section :internal_dependencies, :active_admin
     after(:gem_install, wrap_in_action: :admin_install) do
       generate "active_admin:install"
       line = "ActiveAdmin.setup do |config|"

data/lib/potassium/recipes/annotate.rb

@@ -1,7 +1,7 @@
 class Recipes::Annotate < Rails::AppBuilder
   def create
     gather_gems(:development) do
-      gather_gem('annotate')
+      gather_gem('annotate', '~> 3.0')
     end
 
     template '../assets/lib/tasks/auto_annotate_models.rake',

data/lib/potassium/recipes/ci.rb

@@ -1,7 +1,7 @@
 class Recipes::Ci < Rails::AppBuilder
   def create
     copy_file '../assets/Dockerfile.ci', 'Dockerfile.ci'
-    copy_file '../assets/.circleci/config.yml', '.circleci/config.yml'
+    template '../assets/.circleci/config.yml.erb', '.circleci/config.yml'
 
     template '../assets/bin/cibuild.erb', 'bin/cibuild'
     run "chmod a+x bin/cibuild"

data/lib/potassium/recipes/database_container.rb

@@ -28,16 +28,17 @@ class Recipes::DatabaseContainer < Rails::AppBuilder
     YAML
 
   def create
-    copy_file '../assets/docker-compose.yml', 'docker-compose.yml'
+    db_type = get(:database)
+    return if [:None, :none].include? db_type.to_sym
 
+    copy_file '../assets/docker-compose.yml', 'docker-compose.yml'
     compose = DockerHelpers.new('docker-compose.yml')
 
-    db_type = get(:database)
     compose.add_service(db_type.to_s, self.class.const_get("#{db_type}_service".upcase))
     compose.add_volume("#{db_type}_data")
     template '../assets/Makefile.erb', 'Makefile'
 
-    run 'make services-up'
+    run "docker-compose up -d"
 
     set_env(db_type, CONTAINER_VARS[db_type][:port], CONTAINER_VARS[db_type][:user])
     set_dot_env(db_type, CONTAINER_VARS[db_type][:port], CONTAINER_VARS[db_type][:user])
@@ -53,7 +54,7 @@ class Recipes::DatabaseContainer < Rails::AppBuilder
     setup_text = # setup file is templated on project creation, manual install is needed
       <<~TEXT
         # Set up required services
-        make services-up
+        docker-compose up -d
 
       TEXT
 

data/lib/potassium/recipes/draper.rb

@@ -21,7 +21,7 @@ class Recipes::Draper < Rails::AppBuilder
   end
 
   def add_draper
-    gather_gem 'draper', '3.0.1'
+    gather_gem 'draper', '~> 3.1'
     add_readme_section :internal_dependencies, :draper
     create_file 'app/decorators/.keep'
   end

data/lib/potassium/recipes/file_storage.rb

@@ -2,7 +2,7 @@ class Recipes::FileStorage < Rails::AppBuilder
   def ask
     storages = {
       active_storage: 'ActiveStorage',
-      paperclip: '[DEPRECATED] Paperclip',
+      shrine: 'Shrine',
       none: 'None, thanks'
     }
 
@@ -14,45 +14,20 @@ class Recipes::FileStorage < Rails::AppBuilder
   end
 
   def create
-    add_chosen_storage(check_rspec: false)
+    add_chosen_storage
   end
 
   def install
     ask
-    add_chosen_storage(check_rspec: true)
+    add_chosen_storage
   end
 
   def installed?
-    gem_exists?(/paperclip/) || file_exist?('config/storage.yml')
+    file_exist?('config/storage.yml')
   end
 
   private
 
-  def paperclip_config
-    @paperclip_config ||=
-      <<~RUBY
-        config.paperclip_defaults = {
-          storage: :s3,
-          s3_protocol: 'https',
-          s3_region: ENV.fetch('AWS_REGION', 'us-east-1'),
-          s3_credentials: {
-            bucket: ENV['S3_BUCKET']
-          }
-        }
-      RUBY
-  end
-
-  def config_rspec_for_paperclip
-    copy_file '../assets/testing/platanus.png', 'spec/assets/platanus.png'
-    copy_file '../assets/testing/paperclip.rb', 'spec/support/paperclip.rb'
-  end
-
-  def add_paperclip
-    gather_gem 'paperclip', '~> 6.0'
-    application paperclip_config, env: 'production'
-    append_to_file '.gitignore', "/public/system/*\n"
-  end
-
   def add_active_storage
     after(:gem_install) { run('bundle exec rails active_storage:install') }
     copy_file('../assets/config/storage.yml', 'config/storage.yml', force: true)
@@ -62,22 +37,29 @@ class Recipes::FileStorage < Rails::AppBuilder
     end
   end
 
+  def add_shrine
+    gather_gem('shrine', '~> 3.0')
+    gather_gem('marcel', '~> 0.3.3')
+    copy_file('../assets/config/shrine.rb', 'config/initializers/shrine.rb', force: true)
+    copy_file('../assets/app/uploaders/image_uploader.rb', 'app/uploaders/image_uploader.rb')
+    copy_file('../assets/app/uploaders/base_uploader.rb', 'app/uploaders/base_uploader.rb')
+  end
+
   def common_setup
     gather_gem 'aws-sdk-s3', '~> 1.0'
     add_readme_section :internal_dependencies, get(:storage)
     append_to_file '.env.development', "S3_BUCKET=\n"
   end
 
-  def add_chosen_storage(check_rspec:)
+  def add_chosen_storage
     return if [:none, :None].include? get(:storage).to_sym
 
     common_setup
     case get(:storage)
-    when :paperclip
-      add_paperclip
-      config_rspec_for_paperclip if !check_rspec || gem_exists?(/rspec-rails/)
     when :active_storage
       add_active_storage
+    when :shrine
+      add_shrine
     end
   end
 end

data/lib/potassium/recipes/front_end.rb

@@ -17,15 +17,19 @@ class Recipes::FrontEnd < Rails::AppBuilder
   def create
     return if [:none, :None].include? get(:front_end).to_sym
 
-    gather_gem 'webpacker'
-
     recipe = self
     after(:gem_install) do
       value = get(:front_end)
       run "rails webpacker:install"
       run "rails webpacker:install:#{value}" if value
 
-      recipe.setup_vue_with_compiler_build if value == :vue
+      if value == :vue
+        recipe.setup_vue_with_compiler_build
+        recipe.setup_jest
+      end
+      recipe.add_responsive_meta_tag
+      recipe.setup_tailwind
+      add_readme_header :webpack
     end
   end
 
@@ -46,9 +50,7 @@ class Recipes::FrontEnd < Rails::AppBuilder
     remove_file "app/javascript/packs/hello_vue.js"
     create_file application_js, application_js_content, force: true
 
-    js_pack_tag = "\n    <%= javascript_pack_tag 'application' %>\n"
     layout_file = "app/views/layouts/application.html.erb"
-    insert_into_file layout_file, js_pack_tag, after: "<%= csrf_meta_tags %>"
     insert_into_file(
       layout_file,
       "<div id=\"vue-app\">\n      <app></app>\n      ",
@@ -57,6 +59,30 @@ class Recipes::FrontEnd < Rails::AppBuilder
     insert_into_file layout_file, "\n    </div>", after: "<%= yield %>"
   end
 
+  def add_responsive_meta_tag
+    tag = "\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n"
+    layout_file = "app/views/layouts/application.html.erb"
+    insert_into_file layout_file, tag, after: "<%= csrf_meta_tags %>"
+  end
+
+  def setup_tailwind
+    run 'bin/yarn add tailwindcss'
+    setup_client_css
+    remove_server_css_requires
+    setup_tailwind_requirements
+  end
+
+  def setup_jest
+    run 'bin/yarn add jest vue-jest babel-jest @vue/test-utils jest-serializer-vue babel-core@^7.0.0-bridge.0 --dev'
+    json_file = File.read(Pathname.new("package.json"))
+    js_package = JSON.parse(json_file)
+    js_package = js_package.merge(jest_config)
+    json_string = JSON.pretty_generate(js_package)
+    create_file 'package.json', json_string, force: true
+
+    copy_file '../assets/app/javascript/app.spec.js', 'app/javascript/app.spec.js'
+  end
+
   private
 
   def frameworks(framework)
@@ -68,6 +94,42 @@ class Recipes::FrontEnd < Rails::AppBuilder
     frameworks[framework]
   end
 
+  def setup_client_css
+    application_css = 'app/javascript/css/application.css'
+    create_file application_css, "", force: true
+
+    stylesheet_pack_tag = "\n    <%= stylesheet_pack_tag 'application' %>\n  "
+    layout_file = "app/views/layouts/application.html.erb"
+    insert_into_file layout_file, stylesheet_pack_tag, before: "</head>"
+
+    application_js = 'app/javascript/packs/application.js'
+    if get(:front_end) != :vue
+      create_file application_js, "import '../css/application.css';\n", force: true
+    else
+      insert_into_file(
+        application_js,
+        "\nimport '../css/application.css';",
+        after: "import App from '../app.vue';"
+      )
+    end
+  end
+
+  def setup_tailwind_requirements
+    application_css = 'app/javascript/css/application.css'
+    insert_into_file application_css, tailwind_client_css
+
+    tailwind_config = 'tailwind.config.js'
+    create_file tailwind_config, tailwind_config_content, force: true
+
+    postcss_file = 'postcss.config.js'
+    insert_into_file postcss_file, postcss_require_tailwind, after: "plugins: [\n"
+  end
+
+  def remove_server_css_requires
+    assets_css_file = 'app/assets/stylesheets/application.css'
+    gsub_file(assets_css_file, " *= require_tree .\n *= require_self\n", "")
+  end
+
   def application_js_content
     <<~JS
       import Vue from 'vue/dist/vue.esm';
@@ -83,4 +145,65 @@ class Recipes::FrontEnd < Rails::AppBuilder
       });
     JS
   end
+
+  def tailwind_client_css
+    <<~CSS
+      @import 'tailwindcss/base';
+      @import 'tailwindcss/components';
+      @import 'tailwindcss/utilities';
+    CSS
+  end
+
+  def tailwind_config_content
+    <<~JS
+      /* eslint-disable no-undef */
+      module.exports = {
+        theme: {
+          extend: {},
+        },
+        variants: {},
+        plugins: [],
+      };
+    JS
+  end
+
+  def postcss_require_tailwind
+    <<-JS.gsub(/^ {4}/, '  ')
+      require('tailwindcss'),
+      require('autoprefixer'),
+    JS
+  end
+
+  def jest_config
+    {
+      "scripts": {
+        "test": "jest",
+        "test:watch": "jest --watch"
+      },
+      "jest": {
+        "roots": [
+          "app/javascript"
+        ],
+        "moduleDirectories": [
+          "node_modules",
+          "app/javascript"
+        ],
+        "moduleNameMapper": {
+          "^@/(.*)$": "app/javascript/$1"
+        },
+        "moduleFileExtensions": [
+          "js",
+          "json",
+          "vue"
+        ],
+        "transform": {
+          "^.+\\.js$": "<rootDir>/node_modules/babel-jest",
+          ".*\\.(vue)$": "<rootDir>/node_modules/vue-jest"
+        },
+        "snapshotSerializers": [
+          "<rootDir>/node_modules/jest-serializer-vue"
+        ]
+      }
+    }
+  end
 end

data/lib/potassium/recipes/mailer.rb

@@ -24,8 +24,11 @@ class Recipes::Mailer < Rails::AppBuilder
     dependencies(email_service)
     config(email_service)
 
-    background_processor = load_recipe(:background_processor)
-    background_processor.add_sidekiq unless background_processor.installed?
+    background_processor_recipe = load_recipe(:background_processor)
+    background_processor_answer = get(:background_processor)
+
+    background_processor_recipe.add_sidekiq unless background_processor_recipe.installed? ||
+      background_processor_answer
   end
 
   def install

data/lib/potassium/recipes/node.rb

@@ -0,0 +1,21 @@
+require 'net/http'
+require 'semantic'
+require 'json'
+
+class Recipes::Node < Rails::AppBuilder
+  def create
+    info "Using node version LTS #{version}"
+    create_file '.node-version', version, force: true
+    json_file = File.read(Pathname.new("package.json"))
+    js_package = JSON.parse(json_file)
+    js_package["engines"] = { "node" => "#{version}.x" }
+    json_string = JSON.pretty_generate(js_package)
+    create_file 'package.json', json_string, force: true
+  end
+
+  private
+
+  def version
+    Potassium::NODE_VERSION
+  end
+end

data/lib/potassium/recipes/rack_cors.rb

@@ -4,23 +4,26 @@ class Recipes::RackCors < Rails::AppBuilder
   end
 
   def create
-    gather_gem('rack-cors', '~> 0.4.0')
+    gather_gem('rack-cors', '~> 1.1')
+    recipe = self
     after(:gem_install) do
-      rack_cors_config =
-        <<~RUBY
-          config.middleware.insert_before 0, Rack::Cors do
-            allow do
-              origins '*'
-              resource '*',
-                headers: :any,
-                expose: ['X-Page', 'X-PageTotal'],
-                methods: [:get, :post, :delete, :put, :options]
-            end
-          end
+      application recipe.rack_cors_config
+    end
+  end
 
-        RUBY
+  def rack_cors_config
+    <<~RUBY
+      config.middleware.insert_before 0, Rack::Cors do
+        allow do
+          origins '*'
+          resource '/public/*', headers: :any, methods: :get
+          resource '/api/*',
+            headers: :any,
+            expose: ['X-Page', 'X-PageTotal'],
+            methods: [:get, :post, :patch, :put, :delete, :options]
+        end
+      end
 
-      application rack_cors_config
-    end
+    RUBY
   end
 end