potassium 1.3.5 → 2.0.0

data/lib/potassium/assets/.buildpacks

@@ -0,0 +1,3 @@
+https://github.com/platanus/heroku-buildpack-ruby-version.git
+https://github.com/heroku/heroku-buildpack-ruby.git
+https://github.com/gunpowderlabs/buildpack-ruby-rake-deploy-tasks.git

data/lib/potassium/assets/.env.example.erb

@@ -0,0 +1,8 @@
+APPLICATION_HOST=localhost:3000
+ASSET_HOST=localhost:3000
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+DEFAULT_EMAIL_ADDRESS=
+EXECJS_RUNTIME=Node
+SECRET_KEY_BASE=development_secret
+WEB_CONCURRENCY=1

data/lib/potassium/assets/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .ruby_style.yml

data/lib/potassium/assets/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - https://raw.githubusercontent.com/platanus/hound/platanus/config/style_guides/platanus/ruby.yml
+  - .ruby_style.yml

data/lib/potassium/assets/Dockerfile.ci

@@ -0,0 +1,4 @@
+FROM platanus/buildstep
+EXPOSE 3000
+
+RUN /exec bundle install --with test

data/lib/potassium/assets/Procfile

@@ -0,0 +1 @@
+web: bundle exec puma -C ./config/puma.rb

data/lib/potassium/assets/README.md.erb

@@ -0,0 +1,2 @@
+# <%= get(:titleized_app_name) %> <% if selected?(:heroku) %>[![Circle CI](https://circleci.com/gh/platanus/<%= get(:dasherized_app_name)%>.svg?style=svg)](https://circleci.com/gh/platanus/<%= get(:dasherized_app_name)%>)<% end-%>
+This is a Rails application, initially generated using [Potassium](https://github.com/platanus/potassium) by Platanus.

data/lib/potassium/assets/README.yml

@@ -0,0 +1,83 @@
+readme:
+  headers:
+    installation:
+      title: "Local installation"
+      body: |
+        Assuming you've just cloned the repo, run this script to setup the project in your
+        machine:
+
+            $ ./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].
+
+        The script will do the following among other things:
+
+        - Install the dependecies
+        - Prepare your database
+        - Adds heroku remotes
+
+        After the app setup is done you can run it with [Heroku Local]
+
+            $ heroku local
+
+        [Heroku Local]: https://devcenter.heroku.com/articles/heroku-local
+        [boxen]: http://github.com/platanus/our-boxen
+    ci:
+      title: "Continuous Integrations"
+      body: |
+        The project is setup to run tests
+        in [CircleCI](https://circleci.com/gh/platanus/<%= get(:dasherized_app_name) %>/tree/master)
+
+        You can also run the test locally simulating the production environment using docker.
+        Just make sure you have docker installed and run:
+
+            bin/cibuild
+    deployment:
+      title: "Deployment"
+      body: |
+        This project is pre-configured to be (easily) deployed to Heroku servers, but needs you to have the Potassium binary installed. If you don't, then run:
+
+            $ gem install potassium
+
+        Then, make sure you are logged in to the Heroku account where you want to create the app and run
+
+            $ potassium install heroku --force
+
+        this will create the app on heroku, create a pipeline and link the app to the pipeline.
+
+        You'll still have to manually log in to the heroku dahsboard, go to the new pipeline and 'configure automatic deploys' using Github
+        You can run the following command to open the dashboard in the pipeline page
+
+            $ heroku pipelines:open
+
+        ![Hint](https://cloud.githubusercontent.com/assets/313750/13019759/fa86c8ca-d1af-11e5-8869-cd2efb5513fa.png)
+
+        Remember to connect each stage to the corresponding branch:
+
+        1. Staging -> Master
+        2. Production -> Production
+
+        That's it. You should already have a running app and each time you push to the corresponding branch, the system will (hopefully) update accordingly.
+    style_guide:
+      title: "Style Guides"
+      body: |
+        The style guides are enforced through a self hosted version of [Hound CI](http://monkyeci.platan.us). The style configuration can also be used locally
+        in development runing `rubocop` or just using the rubocop integration for your text editor of choice.
+
+        You can add custom rules to this project just adding them to the `.ruby-style.yml` file.
+    internal_dependencies:
+      title: "Internal dependencies"
+      sections:
+        devise:
+          title: "Authentication"
+          body: "We are using the great [Devise](https://github.com/plataformatec/devise) library by [PlataformaTec](http://plataformatec.com.br/)"
+        paperclip:
+          title: "Uploads"
+          body: "For managing uploads, this project uses [Paperclip](https://github.com/thoughtbot/paperclip), a gem made by the awesome [Thoughbot](https://thoughtbot.com/) team."
+        pundit:
+          title: "Authorization"
+          body: "For defining which parts of the system each user has access to, we have chosen to include the [Pundit](https://github.com/elabs/pundit) gem, by [Elabs](http://elabs.se/)."
+        delayed_job:
+          title: "Queue System"
+          body: "For managing tasks in the background, this project uses [DelayedJob](https://github.com/collectiveidea/delayed_job)"

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

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+DOCKE_COMPOSE_ARGS="-f docker-compose.ci.yml run"
+
+<% if(selected?(:database, :mysql) || selected?(:database, :postgresql))-%>
+function test_<%=get(:database).to_s%> {
+  docker-compose $DOCKE_COMPOSE_ARGS test sh -c 'nc -z $<%=get(:database).to_s.upcase%>_HOST $<%=get(:database).to_s.upcase%>_PORT'
+}
+
+count=0
+# Chain tests together by using &&
+until ( test_<%=get(:database).to_s%> && echo "Services ready" )
+do
+  ((count++))
+  if [ ${count} -gt 50 ]
+  then
+    echo "Services didn't become ready in time"
+    exit 1
+  else
+    echo "Waiting for services to become ready..."
+  fi
+  sleep 0.2
+done
+<% end-%>
+
+docker-compose $DOCKE_COMPOSE_ARGS test /exec bundle exec rake db:setup
+docker-compose $DOCKE_COMPOSE_ARGS test /exec bundle exec rspec spec

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

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# Set up Rails app. Run this script immediately after cloning the codebase.
+# https://la-guia.platan.us/code/rails.html#getting-started
+
+# Exit if any subcommand fails
+set -e
+
+# Set up Ruby dependencies via Bundler
+gem install bundler --conservative
+bundle check || bundle install
+
+# Set up database
+bin/rake db:setup
+
+# Add binstubs to PATH via export PATH=".git/safe/../../bin:$PATH" in ~/.zshenv
+mkdir -p .git/safe
+
+<% if selected?(:heroku) -%>
+# Setup heroku remotes
+bin/setup_heroku
+<% end-%>

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

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+# Setup heroku application remotes
+if heroku auth:whoami &> /dev/null; then
+  if heroku apps:info --app <%= get(:heroku_app_name_staging) %> &> /dev/null; then
+    git remote add staging git@heroku.com:<%= get(:heroku_app_name_staging) %>.git || true
+    git config heroku.remote staging
+    echo 'You are a collaborator on the "<%= get(:heroku_app_name_staging) %>" Heroku app'
+  else
+    echo 'Ask for access to the "<%= get(:heroku_app_name_staging) %>" Heroku app'
+  fi
+
+  if heroku apps:info --app <%= get(:heroku_app_name_production) %> &> /dev/null; then
+    git remote add production git@heroku.com:<%= get(:heroku_app_name_production) %>.git || true
+    echo 'You are a collaborator on the "<%= get(:heroku_app_name_production) %>" Heroku app'
+  else
+    echo 'Ask for access to the "<%= get(:heroku_app_name_production) %>" Heroku app'
+  fi
+else
+  echo 'You need to login to heroku. Run "heroku login"'
+fi

data/lib/potassium/assets/circle.yml

@@ -0,0 +1,16 @@
+machine:
+  services:
+    - docker
+
+dependencies:
+  override:
+    - docker-compose -f docker-compose.ci.yml pull
+    - docker-compose -f docker-compose.ci.yml build test
+
+database:
+  override:
+    - echo "Skipping database"
+
+test:
+  override:
+    - bin/cibuild

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

@@ -0,0 +1,25 @@
+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 %>
+  min_messages: warning
+  pool: <%%= Integer(ENV.fetch("DB_POOL", 5)) %>
+  reaping_frequency: <%%= Integer(ENV.fetch("DB_REAPING_FREQUENCY", 10)) %>
+  timeout: 5000
+
+test:
+  <<: *default
+  database: <%= get(:underscorized_app_name) %>_test
+
+production: &deploy
+  adapter: mysql2
+  encoding: utf8
+  min_messages: warning
+  pool: <%%= [Integer(ENV.fetch("MAX_THREADS", 5)), Integer(ENV.fetch("DB_POOL", 5))].max %>
+  timeout: 5000
+  url: <%%= ENV.fetch("DATABASE_URL", "") %>
+
+staging: *deploy

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

@@ -0,0 +1,25 @@
+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"] %>
+  min_messages: warning
+  pool: <%%= Integer(ENV.fetch("DB_POOL", 5)) %>
+  reaping_frequency: <%%= Integer(ENV.fetch("DB_REAPING_FREQUENCY", 10)) %>
+  timeout: 5000
+
+test:
+  <<: *default
+  database: <%= get(:underscorized_app_name) %>_test
+
+production: &deploy
+  adapter: mysql2
+  encoding: utf8
+  min_messages: warning
+  pool: <%%= [Integer(ENV.fetch("MAX_THREADS", 5)), Integer(ENV.fetch("DB_POOL", 5))].max %>
+  timeout: 5000
+  url: <%%= ENV.fetch("DATABASE_URL", "") %>
+
+staging: *deploy

data/lib/potassium/assets/config/environments/staging.rb

@@ -0,0 +1,5 @@
+require_relative "production"
+
+Rails.application.configure do
+  # ...
+end

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

@@ -0,0 +1,29 @@
+# https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server
+
+# The environment variable WEB_CONCURRENCY may be set to a default value based
+# on dyno size. To manually configure this value use heroku config:set
+# WEB_CONCURRENCY.
+#
+# Increasing the number of workers will increase the amount of resting memory
+# your dynos use. Increasing the number of threads will increase the amount of
+# potential bloat added to your dynos when they are responding to heavy
+# requests.
+#
+# Starting with a low number of workers and threads provides adequate
+# performance for most applications, even under load, while maintaining a low
+# risk of overusing memory.
+workers Integer(ENV.fetch("WEB_CONCURRENCY", 2))
+threads_count = Integer(ENV.fetch("MAX_THREADS", 2))
+threads(threads_count, threads_count)
+
+preload_app!
+
+rackup DefaultRackup
+port ENV.fetch('PORT', 3000)
+environment ENV.fetch("RAILS_ENV", "development")
+
+on_worker_boot do
+  # Worker specific setup for Rails 4.1+
+  # See: https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#on-worker-boot
+  ActiveRecord::Base.establish_connection
+end

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

@@ -0,0 +1,14 @@
+default: &default
+  secret_key_base: <%%= ENV["SECRET_KEY_BASE"] %>
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+staging:
+  <<: *default
+
+production:
+  <<: *default

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

@@ -0,0 +1,6 @@
+test:
+  build: .
+  dockerfile: Dockerfile.ci
+  working_dir: '/app'
+  environment:
+    RAILS_ENV: test

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

@@ -3,19 +3,70 @@ module Potassium::CLI
   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.switch "version-check",
+      default_value: true,
+      desc: "Performs a version check before running.",
+      negatable: true
+
+    c.flag [:db, :database],
+      desc: "Decides which database to use. Available: mysql, postgresql, none"
+    c.flag [:lang, :language],
+      desc: "Decides which language to use. Available: es, en"
+    c.switch "devise",
+      desc: "Whether to use Devise for authentication or not",
+      negatable: true,
+      default_value: "none"
+    c.switch "devise-user-model",
+      desc: "Whether to create a User model for Devise",
+      negatable: true,
+      default_value: "none"
+    c.switch "admin",
+      desc: "Whether to use ActiveAdmin or not",
+      negatable: true,
+      default_value: "none"
+    c.switch "angular-admin",
+      desc: "Whether to use Angular within ActiveAdmin or not",
+      negatable: true,
+      default_value: "none"
+    c.switch "pundit",
+      desc: "Whether to use Pundit for authorization or not",
+      negatable: true,
+      default_value: "none"
+    c.switch "api",
+      desc: "Whether to apply the API mode or not",
+      negatable: true,
+      default_value: "none"
+    c.switch "paperclip",
+      desc: "Whether to include Paperclip as dependency",
+      negatable: true,
+      default_value: "none"
+    c.switch "heroku",
+      desc: "Whether to prepare to application for Heroku or not",
+      negatable: true,
+      default_value: "none"
+    c.switch "delayed-job",
+      desc: "Whether to use DelayedJob or not",
+      negatable: true,
+      default_value: "none"
+    c.switch "github",
+      desc: "Whether to create a github repository",
+      negatable: true,
+      default_value: "none"
+    c.switch "github-private",
+      desc: "Whether to the github repository is private",
+      negatable: true,
+      default_value: false
 
     c.action do |_global_options, options, _args|
       require "potassium/newest_version_ensurer"
 
       begin_creation = -> do
-        require "potassium/templates/application/generator"
+        require "potassium/generators/application"
         require "potassium/template_finder"
 
         template_finder = Potassium::TemplateFinder.new
         template = template_finder.default_template
+        template.cli_options = options
         template.source_paths << Rails::Generators::AppGenerator.source_root
         template.start
       end