potassium 6.0.0 → 6.4.0

data/lib/potassium/newest_version_ensurer.rb

@@ -1,51 +1,34 @@
-require "term/ansicolor"
-require "gems"
-require "semantic"
-require "potassium/text_spinner"
+require 'gems'
+require 'semantic'
+require 'potassium/text_spinner'
+
+class VersionError < StandardError
+end
 
 module Potassium
   class NewestVersionEnsurer
-    include Term::ANSIColor
-
-    def initialize(current_version = Potassium::VERSION)
-      self.current_version = Semantic::Version.new(current_version)
+    def initialize
+      self.installed_version = Semantic::Version.new(Potassium::VERSION)
       self.text_spinner = Potassium::TextSpinner.new
     end
 
-    def ensure(&success_block)
-      spin_text("Checking your Potassium installation") { latest_version }
+    def ensure!
+      spin_text('Checking your Potassium installation') { published_version }
 
-      self.latest_version = Semantic::Version.new(
-        Gems.versions("potassium").first["number"]
-      )
-
-      if latest_version <= current_version
-        up_to_date
-        success_block.call
-      else
-        please_update
-      end
+      self.published_version = Semantic::Version.new(Gems.versions('potassium').first['number'])
+      raise VersionError.new(update_message) if published_version > installed_version
     end
 
     private
 
-    attr_accessor :latest_version, :current_version, :text_spinner
-
-    def up_to_date
-      puts green("\nYour Potassium installation is up to date.")
-    end
+    attr_accessor :published_version, :installed_version, :text_spinner
 
-    def please_update
-      puts red("\nYour Potassium installation is not up to date.")
-      puts red("Found: #{current_version}")
-      puts red("Expected: #{latest_version}\n")
-      print white("Please run: ")
-      print green("gem update potassium ")
-      print white("to upgrade your potassium installation.\n\n")
-      print white("If you really need to run this outdated version of potassium anyway, ")
-      print white("re-run this command with the ")
-      print black("--no-version-check")
-      puts white(" flag.")
+    def update_message
+      <<~HERE
+        Your potassium installation is not up to date.
+        The last available version is #{published_version} while the running version is #{installed_version}.
+        If you really need to run this outdated version of potassium, re-run this command with the `--no-version-check` flag.
+      HERE
     end
 
     def spin_text(message, &block)

data/lib/potassium/node_version_ensurer.rb

@@ -0,0 +1,30 @@
+module Potassium
+  class NodeVersionEnsurer
+    def ensure!
+      raise VersionError.new(install_message) if installed_node_version.nil?
+      raise VersionError.new(update_message) if Potassium::NODE_VERSION != installed_node_version
+    end
+
+    private
+
+    def installed_node_version
+      node_version = `node -v 2>&1`
+      return node_version.delete('^[0-9\.]').split('.').first if $?.success?
+    end
+
+    def install_message
+      <<~HERE
+        Node doesn't appear to be installed.
+        Please make sure you have node #{Potassium::NODE_VERSION} installed.
+      HERE
+    end
+
+    def update_message
+      <<~HERE
+        An unsupported version of node was found.
+        Please make sure you have node #{Potassium::NODE_VERSION} installed. Newer versions may work but potassium only supports that one.
+        If you really need to run potassium with a different version of node, re-run this command with the `--no-node-version-check` flag.
+      HERE
+    end
+  end
+end

data/lib/potassium/recipes/admin.rb

@@ -34,10 +34,9 @@ class Recipes::Admin < Rails::AppBuilder
   def add_active_admin
     gather_gem 'activeadmin', '~> 2.6'
     gather_gem 'activeadmin_addons'
-    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"
+      generate "active_admin:install --use_webpacker"
       line = "ActiveAdmin.setup do |config|"
       initializer = "config/initializers/active_admin.rb"
       gsub_file initializer, /(#{Regexp.escape(line)})/mi do |_match|
@@ -50,26 +49,37 @@ class Recipes::Admin < Rails::AppBuilder
           end\n
           ActiveAdmin.setup do |config|
             config.view_factory.footer = CustomFooter
+            meta_tags_options = { viewport: 'width=device-width, initial-scale=1' }
+            config.meta_tags = meta_tags_options
+            config.meta_tags_for_logged_out_pages = meta_tags_options
         HERE
       end
 
-      line = "@import \"active_admin/base\";"
-      style = "app/assets/stylesheets/active_admin.css.scss"
-      style = File.exist?(style) ? style : "app/assets/stylesheets/active_admin.scss"
+      generate "activeadmin_addons:install"
 
-      gsub_file style, /(#{Regexp.escape(line)})/mi do |_match|
-        <<~HERE
-          #{line}
-          $skinActiveColor: #001CEE;
-          $skinHeaderBck: #002744;
-          $panelHeaderBck: #002744;
-          //$skinLogo: $skinHeaderBck image-url("logo_admin.png") no-repeat center center;
+      run "bin/yarn add arctic_admin @fortawesome/fontawesome-free"
 
-          @import "active_skin";
-        HERE
-      end
+      aa_style = "app/javascript/stylesheets/active_admin.scss"
 
-      generate "activeadmin_addons:install"
+      gsub_file(
+        aa_style,
+        "@import \"~@activeadmin/activeadmin/src/scss/mixins\";\n" +
+        "@import \"~@activeadmin/activeadmin/src/scss/base\";",
+        "@import '~arctic_admin/src/scss/main'; \n"
+      )
+
+      aa_js = "app/javascript/packs/active_admin.js"
+      js_line = "import \"@activeadmin/activeadmin\";\n"
+
+      gsub_file(
+        aa_js,
+        js_line,
+        <<~HERE
+          #{js_line}
+          import '@fortawesome/fontawesome-free/css/all.css';
+          import 'arctic_admin';
+        HERE
+      )
     end
   end
 end

data/lib/potassium/recipes/api.rb

@@ -1,51 +1,116 @@
 class Recipes::Api < Rails::AppBuilder
   def ask
-    api_support = answer(:api) { Ask.confirm("Do you want to enable API support?") }
-    set(:api_support, api_support)
+    api_interfaces = {
+      rest: "REST (with Power API)",
+      graphql: "GraphQL (beta)",
+      none: "None, thanks"
+    }
+    api_interface = answer(:api) do
+      api_interfaces.keys[Ask.list("Which API interface are you using?", api_interfaces.values)]
+    end
+    set :api, api_interface.to_sym
   end
 
   def create
-    add_api if get(:api_support)
+    if get(:api) == :graphql
+      add_graphql
+    elsif get(:api) == :rest
+      add_power_api
+    end
   end
 
   def install
-    add_api
+    ask
+    create
   end
 
   def installed?
-    gem_exists?(/versionist/)
+    gem_exists?(/power_api/) || gem_exists?(/graphql/)
   end
 
   private
 
-  def add_api
-    gather_gem 'versionist'
-    gather_gem 'responders'
-    gather_gem 'active_model_serializers', '~> 0.9.3'
-    gather_gem 'simple_token_authentication', '~> 1.0'
+  def add_power_api
+    gather_gem 'power_api'
+
+    gather_gems(:development, :test) do
+      gather_gem 'rswag-specs'
+    end
+
+    add_readme_section :internal_dependencies, :power_api
+    append_to_file('.rubocop.yml', "RSpec:\n  Includes:\n    Examples:\n      - run_test!")
 
     after(:gem_install) do
-      line = "Rails.application.routes.draw do\n"
-      insert_into_file "config/routes.rb", after: line do
-        <<-HERE.gsub(/^ {8}/, '')
-          scope path: '/api' do
-            api_version(module: "Api::V1", path: { value: "v1" }, defaults: { format: 'json' }) do
-            end
-          end
-        HERE
-      end
+      generate "power_api:install"
+    end
+  end
 
-      api_error_concern_path = 'app/controllers/concerns/api_error_concern.rb'
+  def add_graphql
+    gather_gem 'graphql'
+    if get(:authentication)
+      gather_gem 'jwt'
+    end
+    gather_gems(:development, :test) do
+      gather_gem 'graphql_playground-rails'
+    end
 
-      copy_file '../assets/api/base_controller.rb', 'app/controllers/api/v1/base_controller.rb'
-      copy_file '../assets/api/api_error_concern.rb', api_error_concern_path
-      copy_file '../assets/api/responder.rb', 'app/responders/api_responder.rb'
+    after(:gem_install) do
+      generate "graphql:install --skip_graphiql"
+      playground_route = <<~HEREDOC
+      \n
+        if Rails.env.development?
+          mount GraphqlPlayground::Rails::Engine, at: "/graphiql", graphql_path: "/graphql"
+        end
+      HEREDOC
+      inject_into_file(
+        'config/routes.rb',
+        playground_route,
+        after: 'post "/graphql", to: "graphql#execute"'
+      )
+      copy_file(
+        "../assets/config/graphql_playground.rb",
+        "config/initializers/graphql_playground.rb"
+      )
+      remove_dir 'app/graphql/types'
+      directory '../assets/app/graphql/types', 'app/graphql/types'
+      gsub_file 'app/graphql/mutations/base_mutation.rb', 'Types::Base', 'Types::Base::Base'
+      directory '../assets/app/graphql/queries', 'app/graphql/queries'
+      gsub_file 'app/graphql/mutations/base_mutation.rb', 'RelayClassic', ''
+      gsub_file(
+        'app/graphql/mutations/base_mutation.rb',
+        "    input_object_class Types::Base::BaseInputObject\n", ''
+      )
 
-      if selected?(:report_error)
-        previous_line = 'logger.error exception.backtrace.join("\n")'
-        new_line = "\n      Raven.capture_exception(exception)"
-        insert_into_file api_error_concern_path, new_line, after: previous_line
+      if get(:authentication)
+        copy_file(
+          '../assets/app/graphql/graphql_controller.rb',
+          'app/controllers/graphql_controller.rb',
+          force: true
+        )
+        gsub_file(
+          'app/controllers/graphql_controller.rb',
+          'GqlSampleSchema',
+          "#{get(:titleized_app_name).delete(' ')}Schema"
+        )
+        copy_file(
+          '../assets/app/graphql/mutations/login_mutation.rb',
+          'app/graphql/mutations/login_mutation.rb'
+        )
+        inject_into_file(
+          'app/graphql/types/mutation_type.rb',
+          "\n    field :login, mutation: Mutations::LoginMutation",
+          after: 'class MutationType < Types::Base::BaseObject'
+        )
+        append_to_file(".env.development", "HMAC_SECRET=\n")
       end
+
+      inject_into_file(
+        'app/controllers/graphql_controller.rb',
+        "\n\n  skip_before_action :verify_authenticity_token",
+        after: '# protect_from_forgery with: :null_session'
+      )
+
+      add_readme_section :internal_dependencies, :graphql
     end
   end
 end

data/lib/potassium/recipes/background_processor.rb

@@ -1,18 +1,22 @@
 class Recipes::BackgroundProcessor < Rails::AppBuilder
   def ask
-    response = if selected?(:email_service, :none)
+    response = if enabled_mailer?
+                 info "Note: Emails should be sent on background jobs. We'll install sidekiq"
+                 true
+               else
                  answer(:background_processor) do
                    Ask.confirm("Do you want to use Sidekiq for background job processing?")
                  end
-               else
-                 info "Note: Emails should be sent on background jobs. We'll install sidekiq"
-                 true
                end
     set(:background_processor, response)
   end
 
   def create
-    add_sidekiq if get(:background_processor)
+    if get(:background_processor)
+      add_sidekiq
+      add_docker_compose_redis_config
+      set_redis_dot_env
+    end
   end
 
   def install
@@ -27,19 +31,17 @@ class Recipes::BackgroundProcessor < Rails::AppBuilder
   end
 
   def add_sidekiq
-    gather_gem("sidekiq")
-    add_adapters("sidekiq")
-    add_readme_section :internal_dependencies, :sidekiq
-    edit_procfile("bundle exec sidekiq")
-    append_to_file(".env.development", "DB_POOL=25\n")
-    template("../assets/sidekiq.rb.erb", "config/initializers/sidekiq.rb", force: true)
-    copy_file("../assets/sidekiq.yml", "config/sidekiq.yml", force: true)
-    copy_file("../assets/redis.yml", "config/redis.yml", force: true)
-
-    insert_into_file "config/routes.rb", after: "Rails.application.routes.draw do\n" do
-      <<-HERE.gsub(/^ {6}/, '')
-        mount Sidekiq::Web => '/queue'
-      HERE
+    recipe = self
+    run_action(:install_sidekiq) do
+      gather_gem("sidekiq")
+      recipe.add_adapters("sidekiq")
+      add_readme_section :internal_dependencies, :sidekiq
+      recipe.edit_procfile("bundle exec sidekiq")
+      append_to_file(".env.development", "DB_POOL=25\n")
+      template("../assets/sidekiq.rb.erb", "config/initializers/sidekiq.rb", force: true)
+      copy_file("../assets/sidekiq.yml", "config/sidekiq.yml", force: true)
+      copy_file("../assets/redis.yml", "config/redis.yml", force: true)
+      recipe.mount_sidekiq_routes
     end
   end
 
@@ -55,4 +57,46 @@ class Recipes::BackgroundProcessor < Rails::AppBuilder
     application "config.active_job.queue_adapter = :async", env: "development"
     application "config.active_job.queue_adapter = :test", env: "test"
   end
+
+  def mount_sidekiq_routes
+    insert_into_file "config/routes.rb", after: "Rails.application.routes.draw do\n" do
+      <<-HERE.gsub(/^ {6}/, '')
+        mount Sidekiq::Web => '/queue'
+      HERE
+    end
+  end
+
+  private
+
+  def add_docker_compose_redis_config
+    compose = DockerHelpers.new('docker-compose.yml')
+
+    service_definition =
+      <<~YAML
+        image: redis
+        ports:
+          - 6379
+        volumes:
+          - redis_data:/data
+      YAML
+
+    compose.add_service('redis', service_definition)
+    compose.add_volume('redis_data')
+  end
+
+  def set_redis_dot_env
+    append_to_file(
+      '.env.development',
+      <<~TEXT
+        REDIS_HOST=127.0.0.1
+        REDIS_PORT=$(make services-port SERVICE=redis PORT=6379)
+        REDIS_URL=redis://${REDIS_HOST}:${REDIS_PORT}/1
+      TEXT
+    )
+  end
+
+  def enabled_mailer?
+    mailer_answer = get(:email_service)
+    mailer_answer && ![:none, :None].include?(mailer_answer.to_sym)
+  end
 end

data/lib/potassium/recipes/ci.rb

@@ -1,50 +1,20 @@
 class Recipes::Ci < Rails::AppBuilder
   def create
-    copy_file '../assets/Dockerfile.ci', 'Dockerfile.ci'
     template '../assets/.circleci/config.yml.erb', '.circleci/config.yml'
 
-    template '../assets/bin/cibuild.erb', 'bin/cibuild'
-    run "chmod a+x bin/cibuild"
-
-    copy_file '../assets/docker-compose.ci.yml', 'docker-compose.ci.yml'
-
     gather_gems(:test) do
-      gather_gem 'rspec_junit_formatter', '0.2.2'
-    end
-
-    compose = DockerHelpers.new('docker-compose.ci.yml')
-
-    if selected?(:database, :mysql)
-      srv =
-        <<~YAML
-          image: mysql:#{Potassium::MYSQL_VERSION}
-          environment:
-            MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
-        YAML
-      compose.add_service("mysql", srv)
-      compose.add_link('test', 'mysql')
-      compose.add_env('test', 'MYSQL_HOST', 'mysql')
-      compose.add_env('test', 'MYSQL_PORT', '3306')
-
-    elsif selected?(:database, :postgresql)
-      srv =
-        <<~YAML
-          image: "postgres:#{Potassium::POSTGRES_VERSION}"
-          environment:
-            POSTGRES_USER: postgres
-            POSTGRES_PASSWORD: ''
-        YAML
-      compose.add_service("postgresql", srv)
-      compose.add_link('test', 'postgresql')
-      compose.add_env('test', 'DB_USER', 'postgres')
-      compose.add_env('test', 'DB_HOST', 'postgresql')
-      compose.add_env('test', 'DB_PORT', '5432')
+      gather_gem 'rspec_junit_formatter', '~> 0.4'
     end
 
-    compose.add_volume('test_data')
-
     add_readme_header :ci
-
     application 'config.assets.js_compressor = :uglifier', env: 'test'
   end
+
+  def install
+    create
+  end
+
+  def installed?
+    file_exist?('.circleci/config.yml')
+  end
 end