potassium 5.2.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 586c6642ed62cba7a9a9aadba36fc53ea14f3dda6bd182c1e4e66e5818a4c19f
-  data.tar.gz: 8d12fa2fbf200d8664945c8187c4d257e3a5b5285057032a95eacb03ad088be4
+  metadata.gz: 88890214b6b2c25983461ebce4351f5d988d02af8616c5b5a5dc9ff6628a9a80
+  data.tar.gz: 2bd3d019f36148439c4b271cba2a3db65d3c1d9720eab2cf0509202c2c4553c3
 SHA512:
-  metadata.gz: 60726b985ce4c24e7be3f92ecb9f8f9532b171b995768eef00e3afc8aa4ab6480d7f39a48efcb4a2b4da0d48154caa2f66a5f4eea5cf9269569c5955a7155fa3
-  data.tar.gz: 8bb3ee2bac542101adc27bc41a5ea6823cbb6a94a0a76bbcff731a3139c8d050f6b7d3d8ca8ba7b1715bb64b269999c0e393d5d712e278f745ccbbadfad24479
+  metadata.gz: 8982526dca4d0faf9a5ab380c1105c59dc7dfbb71d1c8bb63118367ea172924c4fb2d3468226d2392fb414b426c1bcc458c6b90caf12145b8997d6b6bd8ee11e
+  data.tar.gz: 9279a00b0ede0b3a1ca12e206229ff872475196cacc74231130fc1da4380357d00df8594b1c5036d8f0b59acce08483a69ffdccd28423f8a388013d71a3d511e

data/.editorconfig

@@ -22,3 +22,6 @@ indent_size = 2
 
 [*.md]
 trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Changelog
 
-## Unreleased
+## 5.2.1
+
+Features:
+  - Databases are now provided as docker containers
+
+Changes:
+  - Update postgres to 11
+  - Update mysql to 5.7
+  - Update rubocop to `~> 0.65.0`
+  - Puma worker timeout is extended to 1 day in development env
+  - Spring is loaded only in development env
+  - Remove version requirement for `pg`
+
+Fix:
+  - Update mysql2 to `~> 0.5.0` (required for rails 5+)
+  - Use `RACK_TIMEOUT` env var instead deprecated setter
 
 ## 5.2.0
 

data/README.md

@@ -42,7 +42,7 @@ Potassium Rails apps includes the following gems and technologies:
 - [EditorConfig](http://editorconfig.org) for keeping all our editor configurations the same.
 - [pry](http://pryrepl.org) and [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug) for a less painful debugging experience.
 - [RSpec](http://rspec.info) for unit and integration testing.
-- [FactoryBot](https://github.com/thoughtbot/factory_bot] for test factories.
+- [FactoryBot](https://github.com/thoughtbot/factory_bot) for test factories.
 - [Guard](http://guardgem.org) for continuous testing and other watch-related tasks.
 - [AWS-SDK](https://github.com/aws/aws-sdk-ruby) for file uploads, sdks, etc and because we use AWS.
 - [Puma](https://github.com/puma/puma) to serve HTTP requests

data/lib/potassium/assets/Makefile.erb

@@ -0,0 +1,46 @@
+PROJECT ?= <%= get(:underscorized_app_name) %>
+DOCKER_COMPOSE_FILE ?= docker-compose.yml
+
+DOCKER_COMPOSE_ARGS ?= -p $(PROJECT) -f $(DOCKER_COMPOSE_FILE)
+
+SHELL := /bin/bash
+
+run: help
+
+BOLD ?= $(shell tput bold)
+NORMAL ?= $(shell tput sgr0)
+
+help:
+	@echo Install dependencies:
+	@echo "  ${BOLD}make setup${NORMAL}"
+	@echo ""
+	@echo Runing the services like mysql:
+	@echo "  ${BOLD}make services-up${NORMAL}"
+	@echo ""
+	@echo "Reset the environment (rm mysql db):"
+	@echo "  ${BOLD}make services-down${NORMAL}"
+	@echo ""
+
+setup:
+	bin/setup
+
+services: services-up
+
+services-ps:
+	docker-compose $(DOCKER_COMPOSE_ARGS) ps
+
+services-up:
+	docker-compose $(DOCKER_COMPOSE_ARGS) up -d
+
+services-stop:
+	docker-compose $(DOCKER_COMPOSE_ARGS) stop
+
+services-down:
+	docker-compose $(DOCKER_COMPOSE_ARGS) down --volumes
+
+services-logs:
+	docker-compose $(DOCKER_COMPOSE_ARGS) logs -f
+
+services-port:
+	@set -o pipefail; \
+	docker-compose $(DOCKER_COMPOSE_ARGS) port ${SERVICE} ${PORT} 2> /dev/null | cut -d':' -f2 || echo ${PORT}

data/lib/potassium/assets/README.yml

@@ -8,12 +8,12 @@ readme:
 
             $ ./bin/setup
 
-        It assumes you have a machine equipped with Ruby, <%= get(:database).to_s.titleize %>, etc. If not, set up
-        your machine with [boxen].
+        It assumes you have a machine equipped with Ruby, Node.js, Docker and make.
 
         The script will do the following among other things:
 
         - Install the dependecies
+        - Create a docker container for your database
         - Prepare your database
         - Adds heroku remotes
 
@@ -22,7 +22,6 @@ readme:
             $ heroku local
 
         [Heroku Local]: https://devcenter.heroku.com/articles/heroku-local
-        [boxen]: http://github.com/platanus/our-boxen
     ci:
       title: "Continuous Integrations"
       body: |

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
+make services-up
+
 # Set up database
 bin/rails db:setup
 

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

@@ -2,9 +2,9 @@ development: &default
   adapter: mysql2
   database: <%= get(:underscorized_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)) %>

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

@@ -2,9 +2,9 @@ development: &default
   adapter: postgresql
   database: <%= get(:underscorized_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)) %>

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 1.day.seconds.to_i if rack_env == "development"
 
 on_worker_boot do
   # Worker specific setup for Rails 4.1+

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

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

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

@@ -1,7 +1,7 @@
 class DockerHelpers
   def initialize(compose_path)
     @compose_path = compose_path
-    @compose = YAML.load(File.read(compose_path))
+    @compose = YAML.safe_load(File.read(compose_path))
   end
 
   def add_link(target_service, linked_service)
@@ -23,14 +23,23 @@ class DockerHelpers
   end
 
   def add_service(name, definition)
-    service = {}
-    service[name] = YAML.load(definition)
-    @compose['services'].merge!(service)
-    save
+    add_leaf('services', name, definition)
+  end
+
+  def add_volume(name, definition = '')
+    add_leaf('volumes', name, definition)
   end
 
   private
 
+  def add_leaf(root_name, leaf_name, definition)
+    leaf = {}
+    leaf[leaf_name] = YAML.safe_load(definition)
+    @compose[root_name] = {} unless @compose[root_name].is_a? Hash
+    @compose[root_name].merge!(leaf)
+    save
+  end
+
   def save
     File.open(@compose_path, 'w') { |f| f.write @compose.to_yaml }
   end

data/lib/potassium/recipes/ci.rb

@@ -17,7 +17,7 @@ class Recipes::Ci < Rails::AppBuilder
     if selected?(:database, :mysql)
       srv =
         <<~YAML
-          image: "mysql:5.6.23"
+          image: mysql:#{Potassium::MYSQL_VERSION}
           environment:
             MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
         YAML
@@ -29,7 +29,7 @@ class Recipes::Ci < Rails::AppBuilder
     elsif selected?(:database, :postgresql)
       srv =
         <<~YAML
-          image: "postgres:9.4.5"
+          image: "postgres:#{Potassium::POSTGRES_VERSION}"
           environment:
             POSTGRES_USER: postgres
             POSTGRES_PASSWORD: ''

data/lib/potassium/recipes/database.rb

@@ -30,8 +30,8 @@ class Recipes::Database < Rails::AppBuilder
 
   def databases(database)
     databases = {
-      postgresql: { name: 'postgresql', gem_name: 'pg', version: '~> 0.21', relational: true },
-      mysql: { name: 'mysql', gem_name: 'mysql2', version: '~> 0.3.18', relational: true }
+      postgresql: { name: 'postgresql', gem_name: 'pg', relational: true },
+      mysql: { name: 'mysql', gem_name: 'mysql2', version: '~> 0.5.0', relational: true }
     }
     databases[database]
   end

data/lib/potassium/recipes/database_container.rb

@@ -0,0 +1,88 @@
+class Recipes::DatabaseContainer < Rails::AppBuilder
+  CONTAINER_VARS = {
+    postgresql: { port: 5432, user: 'postgres' },
+    mysql: { port: 3306, user: 'root' }
+  }
+
+  POSTGRESQL_SERVICE =
+    <<~YAML
+      image: postgres:#{Potassium::POSTGRES_VERSION}
+      ports:
+        - #{CONTAINER_VARS[:postgresql][:port]}
+      environment:
+        POSTGRES_USER: #{CONTAINER_VARS[:postgresql][:user]}
+        POSTGRES_PASSWORD: ''
+      volumes:
+        - postgresql_data:/var/lib/postgresql/data
+    YAML
+
+  MYSQL_SERVICE =
+    <<~YAML
+      image: "mysql:#{Potassium::MYSQL_VERSION}"
+      ports:
+        - #{CONTAINER_VARS[:mysql][:port]}
+      environment:
+        MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
+      volumes:
+       - mysql_data:/var/lib/mysql
+    YAML
+
+  def create
+    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'
+
+    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])
+  end
+
+  def install
+    database_config = YAML.safe_load(IO.read('config/database.yml'), [], [], true)
+    database = database_config['development']['adapter'].gsub(/\d+/, '').to_sym
+    set :database, database
+
+    template "../assets/config/database_#{database}.yml.erb", 'config/database.yml'
+
+    setup_text = # setup file is templated on project creation, manual install is needed
+      <<~TEXT
+        # Set up required services
+        make services-up
+
+      TEXT
+
+    insert_into_file 'bin/setup', setup_text, before: "# Set up database"
+    run 'bin/setup'
+    info "A new container with a #{get(:database)} database has been created."
+  end
+
+  def installed?
+    file_exist?("docker-compose.yml")
+  end
+
+  private
+
+  def set_env(_service_name, _port, _user)
+    ENV["DB_PORT"] = `make services-port SERVICE=#{_service_name} PORT=#{_port}`.squish
+    ENV["DB_USER"] = _user
+  end
+
+  def set_dot_env(_service_name, _port, _user)
+    env_text =
+      <<~TEXT
+
+        # Database
+        DB_HOST=127.0.0.1
+        DB_PORT=$(make services-port SERVICE=#{_service_name} PORT=#{_port})
+        DB_USER=#{_user}
+
+      TEXT
+    insert_into_file '.env.development', env_text, after: "WEB_CONCURRENCY=1\n"
+  end
+end

data/lib/potassium/recipes/listen.rb

@@ -0,0 +1,7 @@
+class Recipes::Listen < Rails::AppBuilder
+  def create
+    gather_gems(:development) do
+      gather_gem('listen')
+    end
+  end
+end

data/lib/potassium/recipes/puma.rb

@@ -5,8 +5,5 @@ class Recipes::Puma < Rails::AppBuilder
     end
 
     copy_file '../assets/config/puma.rb', 'config/puma.rb', force: true
-
-    # Configure rack-timout
-    application "Rack::Timeout.timeout = (ENV[\"RACK_TIMEOUT\"] || 10).to_i", env: "production"
   end
 end

data/lib/potassium/recipes/rails.rb

@@ -1,9 +1,15 @@
 class Recipes::Rails < Rails::AppBuilder
   def create
     gather_gem("bootsnap", require: false)
+    gather_gems(:development) do
+      gather_gem("spring")
+    end
 
     environment 'config.force_ssl = true', env: 'production'
+    disable_automatic_nonce_generation
+  end
 
+  def disable_automatic_nonce_generation
     line = "Rails.application.config.content_security_policy_nonce_generator = \
 -> request { SecureRandom.base64(16) }"
     initializer = "config/initializers/content_security_policy.rb"

data/lib/potassium/templates/application.rb

@@ -9,7 +9,6 @@ end
 
 run_action(:cleaning) do
   clean_gemfile
-  gather_gem("spring")
 end
 
 run_action(:add_utils) do
@@ -43,10 +42,12 @@ run_action(:recipe_loading) do
   create :ci
   create :style
   create :puma
+  create :env
+  create :database_container
   create :database
   create :annotate
+  create :listen
   create :ruby
-  create :env
   create :yarn
   create :editorconfig
   create :aws_sdk

data/lib/potassium/version.rb

@@ -1,6 +1,8 @@
 module Potassium
-  VERSION = "5.2.0"
-  RUBY_VERSION = "2.5.1"
+  VERSION = "5.2.1"
+  RUBY_VERSION = "2.5.5"
   RAILS_VERSION = "~> 5.2.1"
-  RUBOCOP_VERSION = "~> 0.49.1"
+  RUBOCOP_VERSION = "~> 0.65.0"
+  POSTGRES_VERSION = "11.3"
+  MYSQL_VERSION = "5.7"
 end

data/spec/features/database_container_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+RSpec.describe "DatabaseContainer" do
+  before(:all) do
+    drop_dummy_database
+  end
+
+  before do
+    remove_project_directory
+    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 }
+
+      it "creates a #{db_type} database container" do
+        env_file = IO.read("#{project_path}/.env.development")
+        compose_file = IO.read("#{project_path}/docker-compose.yml")
+        compose_content = YAML.safe_load(compose_file, symbolize_names: true)
+        setup_file = IO.read("#{project_path}/bin/setup")
+
+        service_name = compose_content[:services].keys.first
+        db_port = compose_content[:services][service_name][:ports].first
+
+        expect(env_file)
+          .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")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potassium
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.2.1
 platform: ruby
 authors:
 - juliogarciag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-07 00:00:00.000000000 Z
+date: 2019-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.65.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +195,7 @@ files:
 - lib/potassium/assets/.env.development.erb
 - lib/potassium/assets/.pryrc
 - lib/potassium/assets/Dockerfile.ci
+- lib/potassium/assets/Makefile.erb
 - lib/potassium/assets/Procfile
 - lib/potassium/assets/README.md.erb
 - lib/potassium/assets/README.yml
@@ -221,6 +222,7 @@ files:
 - lib/potassium/assets/config/sentry.rb.erb
 - lib/potassium/assets/config/storage.yml
 - lib/potassium/assets/docker-compose.ci.yml
+- lib/potassium/assets/docker-compose.yml
 - lib/potassium/assets/es-CL.yml
 - lib/potassium/assets/lib/tasks/auto_annotate_models.rake
 - lib/potassium/assets/package.json
@@ -266,6 +268,7 @@ files:
 - lib/potassium/recipes/ci.rb
 - lib/potassium/recipes/cleanup.rb
 - lib/potassium/recipes/database.rb
+- lib/potassium/recipes/database_container.rb
 - lib/potassium/recipes/devise.rb
 - lib/potassium/recipes/draper.rb
 - lib/potassium/recipes/editorconfig.rb
@@ -275,6 +278,7 @@ files:
 - lib/potassium/recipes/github.rb
 - lib/potassium/recipes/heroku.rb
 - lib/potassium/recipes/i18n.rb
+- lib/potassium/recipes/listen.rb
 - lib/potassium/recipes/mailer.rb
 - lib/potassium/recipes/paperclip.rb
 - lib/potassium/recipes/power_types.rb
@@ -305,6 +309,7 @@ files:
 - spec/features/active_storage_spec.rb
 - spec/features/background_processor_spec.rb
 - spec/features/ci_spec.rb
+- spec/features/database_container_spec.rb
 - spec/features/database_spec.rb
 - spec/features/draper_spec.rb
 - spec/features/error_reporting_spec.rb
@@ -339,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: An application generator from Platanus
@@ -349,6 +354,7 @@ test_files:
 - spec/features/active_storage_spec.rb
 - spec/features/background_processor_spec.rb
 - spec/features/ci_spec.rb
+- spec/features/database_container_spec.rb
 - spec/features/database_spec.rb
 - spec/features/draper_spec.rb
 - spec/features/error_reporting_spec.rb