orats 0.9.7 → 5.0.0

data/lib/orats/templates/base.rb

@@ -1,546 +0,0 @@
-require 'securerandom'
-
-# =============================================================================
-# template for generating an orats base project for rails 4.2.x
-# =============================================================================
-# view the task list at the bottom of the file
-# -----------------------------------------------------------------------------
-
-# -----------------------------------------------------------------------------
-# private functions
-# -----------------------------------------------------------------------------
-def generate_token
-  SecureRandom.hex(64)
-end
-
-def method_to_sentence(method)
-  method.tr!('_', ' ')
-  method[0] = method[0].upcase
-  method
-end
-
-def task(message, color = :blue)
-  puts
-  say_status 'task', set_color(message, :bold), color
-end
-
-def commit(message)
-  git add: '-A'
-  git commit: "-m '#{message}'"
-end
-
-def git_config(field)
-  command         = "git config --global user.#{field}"
-  git_field_value = run(command, capture: true).gsub("\n", '')
-  default_value   = "YOUR_#{field.upcase}"
-
-  git_field_value.to_s.empty? ? default_value : git_field_value
-end
-
-def orats_to_local(source, dest = '')
-  dest = source if dest.empty?
-
-  base_path = "#{File.expand_path File.dirname(__FILE__)}/includes/new/rails"
-
-  run "mkdir -p #{File.dirname(dest)}" unless Dir.exist?(File.dirname(dest))
-  run "cp -f #{base_path}/#{source} #{dest}"
-end
-
-# ---
-
-def initial_commit
-  task __method__
-
-  git :init
-  commit 'Initial git commit'
-end
-
-def update_gitignore
-  task __method__
-
-  append_to_file '.gitignore' do
-    <<-S
-# OS and editor files
-.DS_Store
-*/**.DS_Store
-._*
-.*.sw*
-*~
-.idea/
-
-# the dotenv file
-.env
-
-# app specific folders
-/vendor/bundle
-/public/assets/*
-    S
-  end
-  commit 'Add common OS files, editor files and other paths'
-end
-
-def copy_gemfile
-  task __method__
-
-  orats_to_local 'Gemfile'
-  commit 'Add Gemfile'
-end
-
-def copy_base_favicon
-  task __method__
-
-  orats_to_local 'app/assets/favicon/favicon_base.png'
-  commit 'Add a 256x256 base favicon'
-end
-
-def add_dotenv
-  task 'add_dotenv'
-
-  orats_to_local '.env', '.env'
-  gsub_file '.env', 'generate_token', generate_token
-  gsub_file '.env', 'app_name', app_name
-  commit 'Add development environment file'
-end
-
-def add_procfile
-  task __method__
-
-  orats_to_local 'Procfile'
-  commit 'Add Procfile'
-end
-
-def add_markdown_readme
-  task __method__
-
-  orats_to_local 'README.md'
-  commit 'Add markdown readme'
-end
-
-def add_license
-  task __method__
-
-  author_name  = git_config 'name'
-  author_email = git_config 'email'
-
-  orats_to_local '../../common/LICENSE', 'LICENSE'
-  gsub_file 'LICENSE', 'Time.now.year', Time.now.year.to_s
-  gsub_file 'LICENSE', 'author_name', author_name
-  gsub_file 'LICENSE', 'author_email', author_email
-  commit 'Add MIT license'
-end
-
-def update_app_secrets
-  task __method__
-
-  orats_to_local 'config/secrets.yml'
-  commit 'DRY out the yaml'
-end
-
-def update_app_config
-  task __method__
-
-  inject_into_file 'config/application.rb', after: "automatically loaded.\n" do
-    <<-S
-    config.action_mailer.delivery_method = :smtp
-    config.action_mailer.smtp_settings = {
-      :address              => ENV['SMTP_ADDRESS'],
-      :port                 => ENV['SMTP_PORT'].to_i,
-      :domain               => ENV['SMTP_DOMAIN'],
-      :user_name            => ENV['SMTP_USERNAME'],
-      :password             => ENV['SMTP_PASSWORD'],
-      :authentication       => ENV['SMTP_AUTH']
-    }
-
-    config.action_mailer.smtp_settings[:enable_starttls_auto] = true if ENV['SMTP_ENCRYPTION'] == 'starttls'
-    config.action_mailer.smtp_settings[:ssl] = true if ENV['SMTP_ENCRYPTION'] == 'ssl'
-    config.action_mailer.default_options = { from: ENV['ACTION_MAILER_DEFAULT_FROM'] }
-    config.action_mailer.default_url_options = { host: ENV['ACTION_MAILER_HOST'] }
-
-    config.cache_store = :redis_store, ENV['CACHE_URL'],
-                         { namespace: '#{app_name}::cache' }
-
-    # run `bundle exec rake time:zones:all` to get a complete list of valid time zone names
-    config.time_zone = ENV['TIME_ZONE'] unless ENV['TIME_ZONE'] == 'UTC'
-
-    # http://www.loc.gov/standards/iso639-2/php/English_list.php
-    config.i18n.default_locale = ENV['DEFAULT_LOCALE'] unless ENV['DEFAULT_LOCALE'] == 'en'
-
-    # Log everything to a single file.
-    config.paths['log'] = ENV['LOG_FILE']
-
-    # Rotate logs daily. This gets overwritten in staging/production by writing
-    # to syslog instead of a log file. Rotating in development prevents your
-    # log file from getting out of control in size.
-    config.logger = Logger.new(config.paths['log'].first, 'daily')
-    S
-  end
-
-  append_file 'config/application.rb' do
-    <<-'S'
-
-ActionView::Base.field_error_proc = Proc.new do |html_tag, instance|
-  if html_tag =~ /\<label/
-    html_tag
-  else
-    errors = Array(instance.error_message).join(',')
-    %(#{html_tag}<p class="validation-error"> #{errors}</p>).html_safe
-  end
-end
-    S
-  end
-  commit 'Configure various application wide settings'
-end
-
-def update_database_config
-  task __method__
-
-  orats_to_local 'config/database.yml'
-  commit 'DRY out the yaml'
-end
-
-def add_puma_config
-  task __method__
-
-  orats_to_local 'config/puma.rb'
-  gsub_file 'config/puma.rb', 'app_name', app_name
-  commit 'Add the puma config'
-end
-
-def add_unicorn_config
-  task __method__
-
-  orats_to_local 'config/unicorn.rb'
-  gsub_file 'config/unicorn.rb', 'app_name', app_name
-  commit 'Add the unicorn config'
-end
-
-def add_sidekiq_config
-  task __method__
-
-  orats_to_local 'config/sidekiq.yml'
-  commit 'Add the sidekiq config'
-end
-
-def add_sitemap_config
-  task __method__
-
-  orats_to_local 'config/sitemap.rb'
-  gsub_file 'config/sitemap.rb', 'app_name', app_name
-  commit 'Add the sitemap config'
-end
-
-def add_whenever_config
-  task __method__
-
-  orats_to_local 'config/schedule.rb'
-  commit 'Add the whenever config'
-end
-
-def add_sidekiq_initializer
-  task __method__
-
-  orats_to_local 'config/initializers/sidekiq.rb'
-  gsub_file 'config/initializers/sidekiq.rb', 'ns_app', app_name
-  commit 'Add the sidekiq initializer'
-end
-
-def add_mini_profiler_initializer
-  task __method__
-
-  orats_to_local 'config/initializers/mini_profiler.rb'
-  commit 'Add the mini profiler initializer'
-end
-
-def add_staging_environment
-  task __method__
-
-  orats_to_local 'config/environments/staging.rb'
-  gsub_file 'config/environments/staging.rb', 'app_name.humanize',
-            app_name.humanize
-  commit 'Add a staging environment'
-end
-
-def update_development_environment
-  task __method__
-
-  inject_into_file 'config/environments/development.rb',
-                   before: "\nend" do
-    <<-'S'
-  # Set the default generator asset engines
-  config.generators.stylesheet_engine = :scss
-  config.generators.javascript_engine = :coffee
-    S
-  end
-  commit 'Update the default generator asset engines'
-end
-
-def update_production_environment
-  task __method__
-
-  inject_into_file 'config/environments/production.rb',
-                   before: "Rails.application.configure" do
-    <<-'S'
-require 'syslog/logger'
-
-    S
-  end
-
-  inject_into_file 'config/environments/production.rb',
-                   after: "config.log_level = :debug\n" do
-    <<-S
-
-  # Log to syslog.
-  config.log_tags = [ :subdomain, :uuid ]
-  config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new('#{app_name}'))
-    S
-  end
-  commit 'Update the logger to be tagged and sent to syslog'
-
-  inject_into_file 'config/initializers/assets.rb',
-                   after: "%w( search.js )\n" do
-    <<-'S'
-Rails.application.config.assets.precompile << Proc.new { |path|
-  if path =~ /\.(eot|svg|ttf|woff|png)\z/
-    true
-  end
-}
-    S
-  end
-  commit 'Update the assets precompiler to include common file types'
-end
-
-def update_routes
-  task __method__
-
-  prepend_file 'config/routes.rb', "require 'sidekiq/web'\n\n"
-
-  inject_into_file 'config/routes.rb', after: "draw do\n" do
-    <<-S
-  concern :pageable do
-    get 'page/:page', action: :index, on: :collection
-  end
-
-  # you may want to protect this behind authentication
-  mount Sidekiq::Web => '/sidekiq'
-    S
-  end
-  commit 'Add a concern for pagination and mount sidekiq'
-end
-
-def add_favicon_task
-  task __method__
-
-  orats_to_local 'lib/tasks/orats/favicon.rake'
-  commit 'Add a favicon generator task'
-end
-
-def add_helpers
-  task __method__
-
-  orats_to_local 'app/helpers/application_helper.rb'
-  commit 'Add various helpers'
-end
-
-def add_layout
-  task __method__
-
-  orats_to_local 'app/views/layouts/application.html.erb'
-  commit 'Add layout'
-end
-
-def add_layout_partials
-  task __method__
-
-  orats_to_local 'app/views/layouts/_flash.html.erb'
-
-  orats_to_local 'app/views/layouts/_navigation.html.erb'
-  gsub_file 'app/views/layouts/_navigation.html.erb', 'app_name', app_name
-
-  orats_to_local 'app/views/layouts/_navigation_links.html.erb'
-
-  orats_to_local 'app/views/layouts/_footer.html.erb'
-  gsub_file 'app/views/layouts/_footer.html.erb', 'Time.now.year.to_s',
-            Time.now.year.to_s
-  gsub_file 'app/views/layouts/_footer.html.erb', 'app_name', app_name
-
-  orats_to_local 'app/views/layouts/_google_analytics_snippet.html.erb'
-
-  orats_to_local 'app/views/layouts/_disqus_comments_snippet.html.erb'
-  orats_to_local 'app/views/layouts/_disqus_count_snippet.html.erb'
-
-  commit 'Add layout partials'
-end
-
-def add_public_html_pages
-  task __method__
-
-  orats_to_local 'public/404.html'
-  orats_to_local 'public/422.html'
-  orats_to_local 'public/500.html'
-  orats_to_local 'public/502.html'
-  orats_to_local 'public/deploy.html'
-
-  commit 'Add public html pages'
-end
-
-def update_sass
-  task __method__
-
-  run 'mv app/assets/stylesheets/application.css app/assets/stylesheets/' + \
-      'application.scss'
-
-  inject_into_file 'app/assets/stylesheets/application.scss',
-                   " *= require font-awesome\n",
-                   before: " *= require_self\n"
-  append_file 'app/assets/stylesheets/application.scss' do
-    <<-S
-
-// Core variables and mixins
-@import "bootstrap/variables";
-@import "bootstrap/mixins";
-
-// Reset
-@import "bootstrap/normalize";
-@import "bootstrap/print";
-
-// Core CSS
-@import "bootstrap/scaffolding";
-@import "bootstrap/type";
-@import "bootstrap/code";
-@import "bootstrap/grid";
-@import "bootstrap/tables";
-@import "bootstrap/forms";
-@import "bootstrap/buttons";
-
-// Components
-@import "bootstrap/component-animations";
-// @import "bootstrap/glyphicons";
-@import "bootstrap/dropdowns";
-@import "bootstrap/button-groups";
-@import "bootstrap/input-groups";
-@import "bootstrap/navs";
-@import "bootstrap/navbar";
-@import "bootstrap/breadcrumbs";
-@import "bootstrap/pagination";
-@import "bootstrap/pager";
-@import "bootstrap/labels";
-@import "bootstrap/badges";
-@import "bootstrap/jumbotron";
-@import "bootstrap/thumbnails";
-@import "bootstrap/alerts";
-@import "bootstrap/progress-bars";
-@import "bootstrap/media";
-@import "bootstrap/list-group";
-@import "bootstrap/panels";
-@import "bootstrap/wells";
-@import "bootstrap/close";
-
-// Components w/ JavaScript
-@import "bootstrap/modals";
-@import "bootstrap/tooltip";
-@import "bootstrap/popovers";
-@import "bootstrap/carousel";
-
-// Utility classes
-@import "bootstrap/utilities";
-@import "bootstrap/responsive-utilities";
-
-.alert-notice {
-  @extend .alert-success;
-}
-
-.alert-alert {
-  @extend .alert-danger;
-}
-
-img {
-  @extend .img-responsive;
-}
-
-.validation-error {
-  margin-top: 2px;
-  color: $brand-danger;
-  font-size: $font-size-small;
-}
-
-html.turbolinks-progress-bar::before {
-  background-color: #aa0000 !important;
-  height: 3px !important;
-}
-    S
-  end
-  commit 'Add font-awesome, bootstrap and a few default styles'
-end
-
-def update_coffeescript
-  task __method__
-
-  gsub_file 'app/assets/javascripts/application.js', "//= require jquery\n", ''
-  commit 'Remove jquery because it is loaded from a CDN'
-
-  inject_into_file 'app/assets/javascripts/application.js',
-                   "//= require jquery.turbolinks\n",
-                   before: "//= require_tree .\n"
-  inject_into_file 'app/assets/javascripts/application.js',
-                   before: "//= require_tree .\n" do
-    <<-S
-//= require bootstrap/affix
-//= require bootstrap/alert
-//= require bootstrap/button
-//= require bootstrap/carousel
-//= require bootstrap/collapse
-//= require bootstrap/dropdown
-//= require bootstrap/modal
-//= require bootstrap/tooltip
-//= require bootstrap/popover
-//= require bootstrap/scrollspy
-//= require bootstrap/tab
-//= require bootstrap/transition
-    S
-  end
-
-  inject_into_file 'app/assets/javascripts/application.js',
-                   "\nTurbolinks.enableProgressBar();\n",
-                   after: "//= require_tree .\n"
-  commit 'Add jquery.turbolinks and bootstrap'
-end
-
-def remove_unused_files_from_git
-  task __method__
-
-  git add: '-u'
-  commit 'Remove unused files'
-end
-
-# ---
-
-initial_commit
-update_gitignore
-copy_gemfile
-copy_base_favicon
-add_dotenv
-add_procfile
-add_markdown_readme
-add_license
-update_app_secrets
-update_app_config
-update_database_config
-add_puma_config
-add_unicorn_config
-add_sidekiq_config
-add_sitemap_config
-add_whenever_config
-add_sidekiq_initializer
-add_mini_profiler_initializer
-add_staging_environment
-update_development_environment
-update_production_environment
-update_routes
-add_favicon_task
-add_helpers
-add_layout
-add_layout_partials
-add_public_html_pages
-update_sass
-update_coffeescript
-remove_unused_files_from_git