potassium 5.2.0 → 6.1.0

data/lib/potassium/assets/app/uploaders/base_uploader.rb

@@ -0,0 +1,11 @@
+class BaseUploader < Shrine
+  plugin :validation_helpers
+
+  Attacher.validate do
+    validate_mime_type store.allowed_types
+  end
+
+  def allowed_types
+    raise NotImplementedError
+  end
+end

data/lib/potassium/assets/app/uploaders/image_uploader.rb

@@ -0,0 +1,5 @@
+class ImageUploader < BaseUploader
+  def allowed_types
+    @allowed_types ||= %w[image/jpeg image/jpg image/png image/svg+xml image/gif].freeze
+  end
+end

data/lib/potassium/assets/bin/cibuild.erb

@@ -15,14 +15,14 @@ build(){
 # Wait services to be ready
 wait_services(){
   function test_service {
-    docker-compose $DOCKER_COMPOSE_ARGS run test sh -c "nc -z $1 $2"
+    docker-compose $DOCKER_COMPOSE_ARGS run --rm test sh -c "nc -z $1 $2"
   }
 
   count=0
   # Chain tests together by using &&
   until (
   <% if(selected?(:database, :mysql) || selected?(:database, :postgresql))-%>
-  test_service '$<%=get(:database).to_s.upcase%>_HOST' '$<%=get(:database).to_s.upcase%>_PORT' && \
+  test_service '$DB_HOST' '$DB_PORT' && \
   <% end-%>
   echo "Services ready"
   )
@@ -41,16 +41,22 @@ wait_services(){
 
 # Prepare dependencies
 dependencies(){
-  docker-compose $DOCKER_COMPOSE_ARGS run test bundle install
+  docker-compose $DOCKER_COMPOSE_ARGS run --rm test bundle install
 }
 
+<% if selected?(:front_end, :vue) %>
+yarn_dependencies(){
+  docker-compose $DOCKER_COMPOSE_ARGS run --rm test yarn install
+}
+<% end %>
+
 assets() {
-  docker-compose $DOCKER_COMPOSE_ARGS run test /bin/bash -c "bin/setup && bundle exec rake assets:precompile"
+  docker-compose $DOCKER_COMPOSE_ARGS run --rm test /bin/bash -c "bin/setup && bundle exec rake assets:precompile"
 }
 
 # Prepare database
 database(){
-  docker-compose $DOCKER_COMPOSE_ARGS run test bundle exec rake db:create db:schema:load
+  docker-compose $DOCKER_COMPOSE_ARGS run --rm test bundle exec rake db:create db:schema:load
 }
 
 # Run the specs
@@ -59,9 +65,15 @@ tests(){
     RSPEC_JUNIT_ARGS="-r rspec_junit_formatter --format RspecJunitFormatter -o $HOME/.rspec_reports/junit.xml"
     RSPEC_FORMAT_ARGS="--format progress --no-color"
   }
-  docker-compose $DOCKER_COMPOSE_ARGS run test bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
+  docker-compose $DOCKER_COMPOSE_ARGS run --rm test bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
 }
 
+<% if selected?(:front_end, :vue) %>
+js_tests(){
+  docker-compose $DOCKER_COMPOSE_ARGS run --rm test yarn run test
+}
+<% end %>
+
 # Run the complete ci build
 no_ci(){
   build
@@ -80,7 +92,7 @@ case "$1" in
     wait_services
     ;;
   "deps"|"dependencies")
-    dependencies
+    dependencies <% if selected?(:front_end, :vue) %>&& yarn_dependencies<% end %>
     ;;
   "assets")
     assets
@@ -88,6 +100,11 @@ case "$1" in
   "db"|"database")
     database
     ;;
+<% if selected?(:front_end, :vue) %>
+  "js_tests")
+    js_tests
+    ;;
+<% end %>
   "specs"|"tests")
     tests
     ;;

data/lib/potassium/assets/bin/release

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -e
+
+echo 'Release Phase...'
+
+bundle exec rails db:migrate:with_data
+
+echo 'Release Phase: OK'

data/lib/potassium/assets/bin/setup.erb

@@ -13,6 +13,9 @@ bundle check || bundle install
 # Install javascript dependencies
 bin/yarn install
 
+# Set up required services
+docker-compose up -d
+
 # Set up database
 bin/rails db:setup
 

data/lib/potassium/assets/config/database_mysql.yml.erb

@@ -1,10 +1,10 @@
 development: &default
   adapter: mysql2
-  database: <%= get(:underscorized_app_name) %>_development
+  database: <%= get(:dasherized_app_name) %>_development
   encoding: utf8
-  username: root
-  host: <%%= ENV["BOXEN_MYSQL_HOST"] || ENV["MYSQL_HOST"] || "127.0.0.1" %>
-  port: <%%= ENV["BOXEN_MYSQL_PORT"] || ENV["MYSQL_PORT"] || 3306 %>
+  host: <%%= ENV["DB_HOST"] || "127.0.0.1" %>
+  port: <%%= ENV["DB_PORT"] || 3306 %>
+  username: <%%= ENV["DB_USER"] || "root" %>
   min_messages: warning
   pool: <%%= Integer(ENV.fetch("DB_POOL", 5)) %>
   reaping_frequency: <%%= Integer(ENV.fetch("DB_REAPING_FREQUENCY", 10)) %>
@@ -12,7 +12,7 @@ development: &default
 
 test:
   <<: *default
-  database: <%= get(:underscorized_app_name) %>_test
+  database: <%= get(:dasherized_app_name) %>_test
 
 production: &deploy
   encoding: utf8

data/lib/potassium/assets/config/database_postgresql.yml.erb

@@ -1,10 +1,10 @@
 development: &default
   adapter: postgresql
-  database: <%= get(:underscorized_app_name) %>_development
+  database: <%= get(:dasherized_app_name) %>_development
   encoding: utf8
-  host: <%%= ENV["BOXEN_POSTGRESQL_HOST"] || ENV["POSTGRESQL_HOST"] || "127.0.0.1" %>
-  port: <%%= ENV["BOXEN_POSTGRESQL_PORT"] || ENV["POSTGRESQL_PORT"] || 5432 %>
-  username: <%%= ENV["POSTGRESQL_USER"] %>
+  host: <%%= ENV["DB_HOST"] || "127.0.0.1" %>
+  port: <%%= ENV["DB_PORT"] || 5432 %>
+  username: <%%= ENV["DB_USER"] || 'postgres' %>
   min_messages: warning
   pool: <%%= Integer(ENV.fetch("DB_POOL", 5)) %>
   reaping_frequency: <%%= Integer(ENV.fetch("DB_REAPING_FREQUENCY", 10)) %>
@@ -12,7 +12,7 @@ development: &default
 
 test:
   <<: *default
-  database: <%= get(:underscorized_app_name) %>_test
+  database: <%= get(:dasherized_app_name) %>_test
 
 production: &deploy
   encoding: utf8

data/lib/potassium/assets/config/graphql_playground.rb

@@ -0,0 +1,20 @@
+# config/initializers/graphql_playground.rb
+# All config options have a default that should work out of the box
+if Rails.env.development?
+  GraphqlPlayground::Rails.configure do |config|
+    # config.headers = {
+    #   'X-Auth-Header' => ->(view_context) { "123" }
+    # }
+    # config.title = "Playground"
+    # config.csrf = true
+    # config.playground_version = "latest"
+    # # Ideally the assets would be added to your projects `vendor/assets` directories
+    # config.favicon = "/assets/playground.ico"
+    # config.playground_js_url = "/assets/playground.js"
+    # config.playground_css_url = "/assets/playground.css"
+    # # see: https://github.com/prisma-labs/graphql-playground#settings
+    config.settings = {
+      "schema.polling.enable": false
+    }
+  end
+end

data/lib/potassium/assets/config/puma.rb

@@ -20,7 +20,11 @@ preload_app!
 
 rackup DefaultRackup
 port ENV.fetch('PORT', 3000)
-environment ENV.fetch("RACK_ENV", "development")
+rack_env = ENV.fetch("RACK_ENV", "development")
+environment rack_env
+
+# Set 1 day timeout for workers while developing
+worker_timeout 24 * 60 * 60 if rack_env == "development"
 
 on_worker_boot do
   # Worker specific setup for Rails 4.1+

data/lib/potassium/assets/config/shrine.rb

@@ -0,0 +1,36 @@
+require 'shrine'
+
+if Rails.env.development?
+  require 'shrine/storage/file_system'
+
+  Shrine.storages = {
+    cache: Shrine::Storage::FileSystem.new('public', prefix: 'uploads/cache'),
+    store: Shrine::Storage::FileSystem.new('public', prefix: 'uploads')
+  }
+elsif Rails.env.production?
+  require 'shrine/storage/s3'
+
+  s3_options = {
+    bucket: ENV.fetch('S3_BUCKET'),
+    region: ENV.fetch('AWS_REGION'),
+    access_key_id: ENV.fetch('AWS_ACCESS_KEY_ID'),
+    secret_access_key: ENV.fetch('AWS_SECRET_ACCESS_KEY')
+  }
+
+  Shrine.storages = {
+    cache: Shrine::Storage::S3.new(prefix: 'cache', **s3_options),
+    store: Shrine::Storage::S3.new(**s3_options)
+  }
+else
+  require 'shrine/storage/memory'
+
+  Shrine.storages = {
+    cache: Shrine::Storage::Memory.new,
+    store: Shrine::Storage::Memory.new
+  }
+end
+
+Shrine.plugin :activerecord
+Shrine.plugin :cached_attachment_data
+Shrine.plugin :restore_cached_data
+Shrine.plugin :determine_mime_type, analyzer: :marcel

data/lib/potassium/assets/docker-compose.ci.yml

@@ -6,6 +6,7 @@ services:
       context: "."
       dockerfile: Dockerfile.ci
     volumes:
-    - "./vendor/bundle:/usr/local/bundle"
+    - "test_data:/usr/local/bundle"
+    - "./node_modules:/app/node_modules"
     environment:
       RACK_ENV: test

data/lib/potassium/assets/docker-compose.yml

@@ -0,0 +1,6 @@
+---
+version: '3'
+
+services:
+
+volumes:

data/lib/potassium/assets/lib/tasks/auto_annotate_models.rake

@@ -3,40 +3,41 @@ if Rails.env.development?
     # You can override any of these by setting an environment variable of the
     # same name.
     Annotate.set_defaults(
-      'routes'                  => 'false',
-      'position_in_routes'      => 'after',
-      'position_in_class'       => 'after',
-      'position_in_test'        => 'after',
-      'position_in_fixture'     => 'after',
-      'position_in_factory'     => 'after',
-      'position_in_serializer'  => 'after',
-      'show_foreign_keys'       => 'true',
-      'show_indexes'            => 'true',
-      'simple_indexes'          => 'false',
-      'model_dir'               => 'app/models',
-      'root_dir'                => '',
-      'include_version'         => 'false',
-      'require'                 => '',
-      'exclude_tests'           => 'true',
-      'exclude_fixtures'        => 'true',
-      'exclude_factories'       => 'true',
-      'exclude_serializers'     => 'true',
-      'exclude_scaffolds'       => 'true',
-      'exclude_controllers'     => 'true',
-      'exclude_helpers'         => 'false',
-      'ignore_model_sub_dir'    => 'false',
-      'ignore_columns'          => nil,
-      'ignore_unknown_models'   => 'false',
+      'routes' => 'false',
+      'position_in_routes' => 'after',
+      'position_in_class' => 'after',
+      'position_in_test' => 'after',
+      'position_in_fixture' => 'after',
+      'position_in_factory' => 'after',
+      'position_in_serializer' => 'after',
+      'show_foreign_keys' => 'true',
+      'show_indexes' => 'true',
+      'simple_indexes' => 'false',
+      'model_dir' => 'app/models',
+      'root_dir' => '',
+      'include_version' => 'false',
+      'require' => '',
+      'exclude_tests' => 'true',
+      'exclude_fixtures' => 'true',
+      'exclude_factories' => 'true',
+      'exclude_serializers' => 'true',
+      'exclude_scaffolds' => 'true',
+      'exclude_controllers' => 'true',
+      'exclude_helpers' => 'false',
+      'ignore_model_sub_dir' => 'false',
+      'ignore_columns' => nil,
+      'ignore_unknown_models' => 'false',
       'hide_limit_column_types' => 'integer,boolean',
-      'skip_on_db_migrate'      => 'false',
-      'format_bare'             => 'true',
-      'format_rdoc'             => 'false',
-      'format_markdown'         => 'false',
-      'sort'                    => 'false',
-      'force'                   => 'false',
-      'trace'                   => 'false',
-      'wrapper_open'            => nil,
-      'wrapper_close'           => nil
+      'skip_on_db_migrate' => 'false',
+      'format_bare' => 'true',
+      'format_rdoc' => 'false',
+      'format_markdown' => 'false',
+      'sort' => 'false',
+      'force' => 'false',
+      'trace' => 'false',
+      'wrapper_open' => nil,
+      'wrapper_close' => nil,
+      'models' => true
     )
   end
 

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/assets/redis.yml

@@ -1,6 +1,5 @@
 development: &default
-  host: <%= ENV["BOXEN_REDIS_HOST"] || ENV["REDIS_HOST"] || "127.0.0.1" %>
-  port: <%= ENV["BOXEN_REDIS_PORT"] || ENV["REDIS_PORT"] || 6379 %>
+  url: <%= ENV.fetch("REDIS_URL") %>
 
 test:
   <<: *default

data/lib/potassium/assets/sidekiq_scheduler.yml

@@ -2,7 +2,7 @@ production:
   :concurrency: 5
 :queues:
   - default
-:schedule:
+# :schedule:
   #  an_scheduled_task:
   #    cron: '0 * * * * *'  # Runs once per minute
   #    class: ExampleJob

data/lib/potassium/assets/testing/rails_helper.rb

@@ -1,6 +1,6 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 ENV['RACK_ENV'] ||= 'test'
-require File.expand_path('../../config/environment', __FILE__)
+require File.expand_path('../config/environment', __dir__)
 require 'rspec/rails'
 require 'spec_helper'
 require 'shoulda/matchers'
@@ -20,12 +20,14 @@ require 'faker'
 # directory. Alternatively, in the individual `*_spec.rb` files, manually
 # require only the support files necessary.
 #
-Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
 
 # Checks for pending migrations before tests are run.
 # If you are not using ActiveRecord, you can remove this line.
 ActiveRecord::Migration.maintain_test_schema!
 
+PowerTypes::Observable.observable_disabled = true
+
 RSpec.configure do |config|
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false

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

@@ -3,36 +3,29 @@ require 'potassium/cli_options'
 module Potassium::CLI
   extend Potassium::CliOptions
 
-  desc "Create a new Potassium Rails project."
+  desc 'Create a new Potassium Rails project.'
   arg 'app_path'
   command :create do |c|
-    c.default_desc "Create a new project."
-    c.switch "version-check",
-      default_value: true,
-      desc: "Performs a version check before running.",
-      negatable: true
-
+    c.default_desc 'Create a new project.'
     create_options.each { |opts| c.send(opts.delete(:type), opts.delete(:name), opts) }
 
     c.action do |_global_options, options, _args|
-      require "potassium/newest_version_ensurer"
-
-      begin_creation = -> do
-        require "potassium/generators/application"
-        require "potassium/template_finder"
+      require 'potassium/newest_version_ensurer'
+      require 'potassium/node_version_ensurer'
+      require 'potassium/generators/application'
+      require 'potassium/template_finder'
 
+      begin
+        Potassium::NewestVersionEnsurer.new.ensure! if options['version-check']
+        Potassium::NodeVersionEnsurer.new.ensure! if options['node-version-check']
         template_finder = Potassium::TemplateFinder.new
         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
-
-      if options["version-check"]
-        ensurer = Potassium::NewestVersionEnsurer.new
-        ensurer.ensure(&begin_creation)
-      else
-        begin_creation.call
+      rescue VersionError => e
+        print "\nError: #{e.message}" # rubocop:disable Rails/Output
       end
     end
   end

data/lib/potassium/cli_options.rb

@@ -1,5 +1,21 @@
 module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
   CREATE_OPTIONS = [
+    {
+      type: :switch,
+      name: 'version-check',
+      desc: 'Performs a version check before running.',
+      negatable: true,
+      default_value: true,
+      default_test_value: true
+    },
+    {
+      type: :switch,
+      name: 'node-version-check',
+      desc: 'Performs a node version check before running.',
+      negatable: true,
+      default_value: true,
+      default_test_value: true
+    },
     {
       type: :flag,
       name: [:db, :database],
@@ -16,7 +32,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 +60,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
@@ -59,28 +75,18 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       default_test_value: false
     },
     {
-      type: :switch,
+      type: :flag,
       name: "api",
-      desc: "Whether to apply the API mode or not",
-      negatable: true,
-      default_value: "none",
-      default_test_value: false
-    },
-    {
-      type: :switch,
-      name: "paperclip",
-      desc: "Whether to include Paperclip as dependency",
-      negatable: true,
+      desc: "Which API interface to use",
       default_value: "none",
-      default_test_value: false
+      default_test_value: "None"
     },
     {
-      type: :switch,
-      name: "active_storage",
-      desc: "Whether to include Active Storage as dependency",
-      negatable: true,
+      type: :flag,
+      name: "storage",
+      desc: "Decides which file storage to use. Available: active_storage, shrine, none",
       default_value: "none",
-      default_test_value: false
+      default_test_value: "None"
     },
     {
       type: :switch,
@@ -94,7 +100,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,
@@ -114,12 +120,41 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
     },
     {
       type: :switch,
-      name: "github-private",
-      desc: "Whether to the github repository is private",
+      name: "github_private",
+      desc: "Whether the github repository is private or not",
       negatable: true,
-      default_value: false,
+      default_value: "none",
       default_test_value: false
     },
+    {
+      type: :switch,
+      name: "github_has_org",
+      desc: "Whether the github repository should belong to an organization",
+      negatable: true,
+      default_value: "none",
+      default_test_value: false
+    },
+    {
+      type: :flag,
+      name: "github_org",
+      desc: "The github organization where the repository will be created",
+      default_value: "none",
+      default_test_value: "none"
+    },
+    {
+      type: :flag,
+      name: "github_name",
+      desc: "The github repository name",
+      default_value: "none",
+      default_test_value: "none"
+    },
+    {
+      type: :flag,
+      name: "github_access_token",
+      desc: "Github personal access token used to auth to Github API",
+      default_value: "none",
+      default_test_value: "none"
+    },
     {
       type: :switch,
       name: "schedule",
@@ -141,6 +176,14 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       name: :front_end,
       desc: "Decides which front-end framework to use. Available: Vue, Angular 2, None",
       default_test_value: "None"
+    },
+    {
+      type: :switch,
+      name: "test",
+      desc: "Whether or not it is a test project creation",
+      negatable: true,
+      default_value: false,
+      default_test_value: true
     }
   ]