kratos 1.0.0

data/templates/deploy.rake

@@ -0,0 +1,28 @@
+namespace :deploy do
+  task :setup_env do
+    on roles(:web) do
+      within release_path do
+        execute(:cp, "~/.#{fetch(:application)}.yml config/application.yml")
+        execute(:cp, "~/.#{fetch(:application)}.env .env")
+        execute(:cp, "~/.#{fetch(:application)}.foreman .foreman")
+      end
+    end
+  end
+  before :updated, :setup_env
+
+  task :restart do
+    invoke 'foreman:export'
+    invoke 'foreman:restart'
+  end
+
+  desc 'reload the database with seed data'
+  task :seed do
+    on primary :db do
+      within current_path do
+        with rails_env: fetch(:stage) do
+          execute(:rake, 'db:seed')
+        end
+      end
+    end
+  end
+end

data/templates/deploy_config.rb.erb

@@ -0,0 +1,33 @@
+# config valid only for current version of Capistrano
+lock '3.4.0'
+
+set :application, '<%= app_name.dasherize %>'
+set :user, 'deploy'
+# set :repo_url, 'git@github.com:organization/repository.git'
+
+set :rbenv_ruby, File.read('.ruby-version').strip
+set :rbenv_type, :user
+set :rbenv_bin_path, '/home/deploy/.rbenv/shims'
+
+# Always deploy the current branch.
+set :branch, `git rev-parse --abbrev-ref HEAD`.chomp
+
+set :deploy_to, '/home/deploy/<%= app_name.dasherize %>'
+set :log_level, :info
+
+set :linked_dirs, fetch(:linked_dirs, []).push('log',
+                                               'tmp/pids',
+                                               'tmp/cache')
+
+set :default_env, path: '/home/deploy/.rbenv/shims:$PATH'
+
+namespace :deploy do
+  after :restart, :clear_cache do
+    on roles(:web), in: :groups, limit: 3, wait: 10 do
+      # Here we can do anything such as:
+      # within release_path do
+      #   execute :rake, 'cache:clear'
+      # end
+    end
+  end
+end

data/templates/dev.rake

@@ -0,0 +1,12 @@
+if Rails.env.development? || Rails.env.test?
+  require 'factory_girl'
+
+  namespace :dev do
+    desc 'Sample data for local development environment'
+    task prime: 'db:setup' do
+      include FactoryGirl::Syntax::Methods
+
+      # create(:user, email: "user@example.com", password: "password")
+    end
+  end
+end

data/templates/disable_xml_params.rb

@@ -0,0 +1 @@
+ActionDispatch::ParamsParser::DEFAULT_PARSERS.delete(Mime::XML)

data/templates/dotfiles/.ctags

@@ -0,0 +1,2 @@
+--recurse=yes
+--exclude=vendor

data/templates/dotfiles/.gitignore

@@ -0,0 +1,14 @@
+!.keep
+*.DS_Store
+*.swo
+*.swp
+/.bundle
+/.env.local
+/coverage/*
+/db/*.sqlite3
+/log/*
+/public/system
+/public/assets
+/tags
+/tmp/*
+/config/application.yml

data/templates/dotfiles/.sample.application.yml

@@ -0,0 +1,15 @@
+ASSET_HOST: localhost:3000
+APPLICATION_HOST: localhost:3000
+PORT: 3000
+RACK_ENV: development
+REDIS_URL: redis://127.0.0.1:6379
+SECRET_KEY_BASE: development_secret
+EXECJS_RUNTIME: Node
+SMTP_ADDRESS: smtp.example.com
+SMTP_DOMAIN: example.com
+SMTP_PASSWORD: password
+SMTP_USERNAME: username
+WEB_CONCURRENCY: 1
+AWS_REGION: us-east-1
+AWS_ACCESS_KEY_ID: <put-your-key-here>
+AWS_SECRET_ACCESS_KEY: <put-your-secret-here>

data/templates/errors.rb

@@ -0,0 +1,34 @@
+require 'net/http'
+require 'net/smtp'
+
+# Example:
+#   begin
+#     some http call
+#   rescue *HTTP_ERRORS => error
+#     notify_hoptoad error
+#   end
+
+HTTP_ERRORS = [
+  EOFError,
+  Errno::ECONNRESET,
+  Errno::EINVAL,
+  Net::HTTPBadResponse,
+  Net::HTTPHeaderSyntaxError,
+  Net::ProtocolError,
+  Timeout::Error
+].freeze
+
+SMTP_SERVER_ERRORS = [
+  IOError,
+  Net::SMTPAuthenticationError,
+  Net::SMTPServerBusy,
+  Net::SMTPUnknownError,
+  Timeout::Error
+].freeze
+
+SMTP_CLIENT_ERRORS = [
+  Net::SMTPFatalError,
+  Net::SMTPSyntaxError
+].freeze
+
+SMTP_ERRORS = SMTP_SERVER_ERRORS + SMTP_CLIENT_ERRORS

data/templates/factory_girl_rspec.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/templates/foreman.rake

@@ -0,0 +1,39 @@
+namespace :foreman do
+  desc "Export the Procfile to Ubuntu's upstart scripts"
+  task :export do
+    on roles(:app) do
+      within current_path do
+        # Add path to .env.
+        # Needed for rbenv to work properly.
+        execute(:echo, "\"PATH=#{fetch(:rbenv_bin_path)}:$PATH\" >> .env")
+        # Create the upstart script
+        execute(:sudo, "#{fetch(:rbenv_prefix)} " \
+                'foreman export upstart /etc/init ' \
+                "-a #{fetch(:application)} " \
+                "-u #{fetch(:user)} ")
+      end
+    end
+  end
+
+  desc 'Start the application services'
+  task :start do
+    on roles(:app) do
+      execute("sudo service #{fetch(:application)} start")
+    end
+  end
+
+  desc 'Stop the application services'
+  task :stop do
+    on roles(:app) do
+      execute("sudo service #{fetch(:application)} stop")
+    end
+  end
+
+  desc 'Restart the application services'
+  task :restart do
+    on roles(:app), in: :sequence, wait: 15 do
+      execute("sudo service #{fetch(:application)} start || " \
+              "sudo service #{fetch(:application)} restart")
+    end
+  end
+end

data/templates/i18n-tasks.yml

@@ -0,0 +1,22 @@
+locales:
+  - en
+  - pt-BR
+data:
+  read:
+    - config/locales/%{locale}.*.yml
+  write:
+    - config/locales/%{locale}.auto.yml
+
+search:
+  paths:
+    - "app/controllers"
+    - "app/models"
+    - "app/views"
+    - "spec"
+ignore_unused:
+  - activerecord.*
+  - date.*
+  - datetime.*
+  - number.*
+  - time.*
+  - titles.*

data/templates/i18n.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include ActionView::Helpers::TranslationHelper
+end

data/templates/i18n_rspec.rb

@@ -0,0 +1,19 @@
+require 'i18n/tasks'
+
+RSpec.describe 'I18n' do
+  let(:i18n) { I18n::Tasks::BaseTask.new }
+  let(:missing_keys) { i18n.missing_keys }
+  let(:unused_keys) { i18n.unused_keys }
+
+  it 'does not have missing keys' do
+    expect(missing_keys)
+      .to be_empty, "Missing #{missing_keys.leaves.count} i18n keys, run " \
+                    'i18n-tasks missing to show them'
+  end
+
+  it 'does not have unused keys' do
+    expect(unused_keys)
+      .to be_empty, "#{unused_keys.leaves.count} unused i18n keys, run "\
+                    "'i18n-tasks unused' to show them"
+  end
+end

data/templates/json_encoding.rb

@@ -0,0 +1 @@
+ActiveSupport::JSON::Encoding.time_precision = 0

data/templates/kratos_layout.html.erb.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="<%= I18n.locale %>">
+<head>
+  <meta charset="utf-8" />
+  <meta name="ROBOTS" content="NOODP" />
+  <meta name="viewport" content="initial-scale=1" />
+  <%%#
+    Configure default and controller-, and view-specific titles in
+    config/locales/en.yml. For more see:
+    https://github.com/calebthompson/title#usage
+  %>
+  <title><%%= title %></title>
+  <%%= stylesheet_link_tag :application, media: "all" %>
+  <%%= csrf_meta_tags %>
+</head>
+<body class="<%%= body_class %>">
+  <%%= yield %>
+  <%%= render "javascript" %>
+</body>
+</html>

data/templates/lograge.rb

@@ -0,0 +1,14 @@
+Rails.application.configure do
+  if Rails.env.production?
+    config.lograge.enabled = true
+    config.log_tags = [:uuid]
+
+    config.lograge.custom_options = lambda do |event|
+      params = event.payload[:params].reject do |k|
+        %w(controller action).include? k
+      end
+
+      { 'params' => params }
+    end
+  end
+end

data/templates/postgresql_database.yml.erb

@@ -0,0 +1,22 @@
+development: &default
+  adapter: postgresql
+  database: <%= app_name %>_development
+  encoding: utf8
+  host: localhost
+  min_messages: warning
+  pool: <%%= Integer(ENV.fetch("DB_POOL", 5)) %>
+  reaping_frequency: <%%= Integer(ENV.fetch("DB_REAPING_FREQUENCY", 10)) %>
+  timeout: 5000
+
+test:
+  <<: *default
+  database: <%= app_name %>_test
+
+production: &deploy
+  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/templates/puma.rb

@@ -0,0 +1,28 @@
+# 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
+environment ENV.fetch('RACK_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/templates/rails_helper.rb

@@ -0,0 +1,28 @@
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../../config/environment', __FILE__)
+abort('DATABASE_URL environment variable is set') if ENV['DATABASE_URL']
+
+require 'rspec/rails'
+require 'ffaker'
+
+Dir[Rails.root.join('spec/support/**/*.rb')].sort.each { |file| require file }
+
+# Define the feature Dsl
+module Features
+  # Extend this module in spec/support/features/*.rb
+  include Formulaic::Dsl
+end
+
+RSpec.configure do |config|
+  config.include Features, type: :feature
+  config.infer_base_class_for_anonymous_controllers = false
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+
+  config.before(:all) do
+    Rails.cache.clear
+  end
+end
+
+ActiveRecord::Migration.maintain_test_schema!

data/templates/redis.rb

@@ -0,0 +1,10 @@
+url = URI.parse(ENV['REDIS_URL'] ||
+                'redis://127.0.0.1:6379')
+
+if Rails.env.test?
+  Redis.current = Redis.new(host: url.host, port: url.port,
+                            password: url.password, thread_safe: true, db: '15')
+else
+  Redis.current = Redis.new(host: url.host, port: url.port,
+                            password: url.password, thread_safe: true)
+end

data/templates/rspec_api_documentation_rspec.rb.erb

@@ -0,0 +1,33 @@
+require 'rspec_api_documentation'
+require 'rspec_api_documentation/dsl'
+
+RspecApiDocumentation.configure do |config|
+  config.format = [:json, :html]
+  config.api_name = '<%= app_name %>'
+  config.curl_headers_to_filter = %w('Cookie')
+  config.post_body_formatter = 'json'
+  config.keep_source_order = true
+  config.request_headers_to_include = ['Accept',
+                                       'Content-Type',
+                                       'Authorization',
+                                       'Host']
+
+  # Removes the DSL method `status`,
+  # this is required if you have a parameter named status
+  # response_status is an alias to status
+  # because status is commonly a parameter.
+  config.disable_dsl_status!
+
+  if ENV['CIRCLE_ARTIFACTS']
+    config.docs_dir = Pathname.new("#{ENV['CIRCLE_ARTIFACTS']}/api-docs")
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:each) do |example|
+    if example.metadata[:document]
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+    end
+  end
+end

data/templates/rubocop.rake

@@ -0,0 +1,4 @@
+if Rails.env.development? || Rails.env.test?
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+end

data/templates/rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  Exclude:
+    - "Gemfile"
+    - "db/**/*"
+    - "vendor/**/*"
+    - "tmp/**/*"
+    - "config/**/*"
+    - "bin/**/*"
+    - "log/**/*"
+    - "Guardfile"
+    - "spec/factories/*"
+  RunRailsCops: true
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*

data/templates/schedule.rb

@@ -0,0 +1,8 @@
+# Use this file to easily define all of your cron jobs.
+#
+# It's helpful, but not entirely necessary to understand cron before proceeding.
+# http://en.wikipedia.org/wiki/Cron
+
+# every 1.day, at: '1:00 am' do
+# rake ...
+# end

data/templates/secrets.yml

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

data/templates/shoulda_matchers_config_rspec.rb

@@ -0,0 +1,6 @@
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

data/templates/sidekiq.yml

@@ -0,0 +1,4 @@
+:concurrency: <%= ENV.fetch("MAX_THREADS", 5) %>
+:pidfile: tmp/pids/sidekiq.pid
+:queues:
+  - default

data/templates/sidekiq_rspec.yml

@@ -0,0 +1,10 @@
+require 'sidekiq/testing'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Sidekiq::Worker.clear_all
+  end
+  config.after(:each) do
+    Sidekiq::Testing.fake!
+  end
+end

data/templates/sidekiq_security.rb

@@ -0,0 +1,6 @@
+require 'sidekiq'
+require 'sidekiq/web'
+
+Sidekiq::Web.use(Rack::Auth::Basic) do |user, password|
+  [user, password] == %w(admin sidekiq)
+end

data/templates/smtp.rb

@@ -0,0 +1,9 @@
+SMTP_SETTINGS = {
+  address: ENV.fetch('SMTP_ADDRESS'), # example: "smtp.sendgrid.net"
+  authentication: :plain,
+  domain: ENV.fetch('SMTP_DOMAIN'), # example: "heroku.com"
+  enable_starttls_auto: true,
+  password: ENV.fetch('SMTP_PASSWORD'),
+  port: '587',
+  user_name: ENV.fetch('SMTP_USERNAME')
+}.freeze

data/templates/spec_helper.rb

@@ -0,0 +1,31 @@
+if ENV.fetch('COVERAGE', false)
+  require 'simplecov'
+  SimpleCov.start 'rails' do
+    add_filter '/lib/'
+    minimum_coverage 95
+
+    if ENV['CIRCLE_ARTIFACTS']
+      coverage_dir File.join(
+        '..', '..', '..', ENV['CIRCLE_ARTIFACTS'], 'coverage')
+    end
+  end
+end
+
+require 'webmock/rspec'
+
+# http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+  config.example_status_persistence_file_path = 'tmp/rspec_examples.txt'
+  config.order = :random
+end
+
+WebMock.disable_net_connect!(allow_localhost: true)

data/templates/staging.rb

@@ -0,0 +1,5 @@
+require_relative 'production'
+
+Mail.register_interceptor(
+  RecipientInterceptor.new(ENV.fetch('EMAIL_RECIPIENTS'))
+)

data/templates/timezones.rb

@@ -0,0 +1,26 @@
+module ActiveSupport
+  class TimeZone
+    MAPPING.merge!('Noronha' => 'America/Noronha',
+                   'Belém' => 'America/Belem',
+                   'Fortaleza' => 'America/Fortaleza',
+                   'Recife' => 'America/Recife',
+                   'Araguaina' => 'America/Araguaina',
+                   'Maceió' => 'America/Maceio',
+                   'Campo Grande' => 'America/Campo_Grande',
+                   'Cuiabá' => 'America/Cuiaba',
+                   'Santarém' => 'America/Santarem',
+                   'Porto Velho' => 'America/Porto_Velho',
+                   'Boa Vista' => 'America/Boa_Vista',
+                   'Manaus' => 'America/Manaus',
+                   'Eirunepé' => 'America/Eirunepe',
+                   'Rio Branco' => 'America/Rio_Branco')
+
+    def self.br_zones
+      @br_zones ||= all.find_all do |z|
+        ['Noronha', 'Belém', 'Fortaleza', 'Recife', 'Araguaina', 'Maceió',
+         'Campo Grande', 'Cuiabá', 'Santarém', 'Porto Velho', 'Boa Vista',
+         'Manaus', 'Eirunepé', 'Rio Branco', 'Brasilia'].include?(z.name)
+      end
+    end
+  end
+end