initiate 0.1.0

data/README.md

@@ -0,0 +1,129 @@
+# Initiate [![Build Status](https://travis-ci.org/infinum/initiate.svg)](https://travis-ci.org/infinum/initiate)
+
+Initiate is the base Rails application used at
+[Infinum](https://infinum.co). It's a fork of [Suspenders](https://github.com/thoughtbot/suspenders) by [Thoughtbot](thoughtbot.com). Thnx Thoughtbot!
+
+
+## Installation
+
+First install the initiate gem:
+
+    gem install initiate
+
+Then run:
+
+    initiate projectname
+
+This will create a Rails app in `projectname` using the latest version of Rails.
+
+## Gemfile
+
+To see the latest and greatest gems, look at Initiate'
+[Gemfile](templates/Gemfile.erb), which will be appended to the default
+generated projectname/Gemfile.
+
+It includes application gems like:
+
+* [Bugsnag](https://github.com/bugsnag/bugsnag-ruby) for exception notification
+* [Delayed Job](https://github.com/collectiveidea/delayed_job) for background
+  processing
+* [Flutie](https://github.com/thoughtbot/flutie) for `page_title` and `body_class` view
+  helpers
+* [Postgres](https://github.com/ged/ruby-pg) for access to the Postgres database
+* [Recipient Interceptor](https://github.com/croaky/recipient_interceptor) to
+  avoid accidentally sending emails to real people from staging
+* [Simple Form](https://github.com/plataformatec/simple_form) for form markup
+  and style
+* [Title](https://github.com/calebthompson/title) for storing titles in
+  translations
+
+And development gems like:
+
+* [Dotenv](https://github.com/bkeepers/dotenv) for loading environment variables
+* [Pry Rails](https://github.com/rweng/pry-rails) for interactively exploring
+  objects
+* [ByeBug](https://github.com/deivid-rodriguez/byebug) for interactively
+  debugging behavior
+* [Bundler Audit](https://github.com/rubysec/bundler-audit) for scanning the
+  Gemfile for insecure dependencies based on published CVEs
+* [Spring](https://github.com/rails/spring) for fast Rails actions via
+  pre-loading
+* [Better errors](https://github.com/charliesome/better_errors) for better debugging via
+  in-browser IRB consoles.
+* [Quiet Assets](https://github.com/evrone/quiet_assets) for muting assets
+  pipeline log messages
+
+And testing gems like:
+
+* [Capybara](https://github.com/jnicklas/capybara) and
+  [Capybara Webkit](https://github.com/thoughtbot/capybara-webkit) for
+  integration testing
+* [Factory Girl](https://github.com/thoughtbot/factory_girl) for test data
+* [Formulaic](https://github.com/thoughtbot/formulaic) for integration testing
+  HTML forms
+* [RSpec](https://github.com/rspec/rspec) for unit testing
+* [RSpec Mocks](https://github.com/rspec/rspec-mocks) for stubbing and spying
+* [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers) for common
+  RSpec matchers
+* [Timecop](https://github.com/jtrupiano/timecop-console) for testing time
+
+## Other goodies
+
+Initiate also comes with:
+
+* The [`./bin/setup`][setup] convention for new developer setup
+* Rails' flashes set up and in application layout
+* A few nice time formats set up for localization
+* `Rack::Deflater` to [compress responses with Gzip][compress]
+* [Safe binstubs][binstub]
+* [t() and l() in specs without prefixing with I18n][i18n]
+* An automatically-created `SECRET_KEY_BASE` environment variable in all
+  environments
+
+## Spring
+
+Initiate uses [spring](https://github.com/rails/spring) by default.
+It makes Rails applications load faster, but it might introduce confusing issues
+around stale code not being refreshed.
+If you think your application is running old code, run `spring stop`.
+And if you'd rather not use spring, add `DISABLE_SPRING=1` to your login file.
+
+## Dependencies
+
+Initiate requires the latest version of Ruby.
+
+Some gems included in Initiate have native extensions. You should have GCC
+installed on your machine before generating an app with Initiate.
+
+Use [OS X GCC Installer](https://github.com/kennethreitz/osx-gcc-installer/) for
+Snow Leopard (OS X 10.6).
+
+Use [Command Line Tools for XCode](https://developer.apple.com/downloads/index.action)
+for Lion (OS X 10.7) or Mountain Lion (OS X 10.8).
+
+We use [Capybara Webkit](https://github.com/thoughtbot/capybara-webkit) for
+full-stack JavaScript integration testing. It requires QT. Instructions for
+installing QT are
+[here](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit).
+
+PostgreSQL needs to be installed and running for the `db:create` rake task.
+
+## Issues
+
+If you have problems, please create a
+[GitHub Issue](https://github.com/infinum/initiate/issues).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+Thank you, [contributors]!
+
+[contributors]: https://github.com/infinum/initiate/graphs/contributors
+
+## License
+
+Initiate is Copyright © 2015 Infinum.
+It is free software, and may be redistributed under the terms specified in the [LICENSE] file.
+
+[LICENSE]: LICENSE

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:rspec)
+
+desc 'Run the test suite'
+task :default => :rspec

data/bin/initiate

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'initiate'
+
+if ['-v', '--version'].include? ARGV[0]
+  puts Initiate::VERSION
+  exit 0
+end
+
+templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+Initiate::AppGenerator.source_root templates_root
+Initiate::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Initiate::AppGenerator.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -0,0 +1,13 @@
+#!/usr/bin/env sh
+
+# Run this script immediately after cloning the codebase.
+
+# Exit if any subcommand fails
+set -e
+
+# Set up Ruby dependencies via Bundler
+bundle install
+
+# Add binstubs to PATH in ~/.zshenv like this:
+#   export PATH=".git/safe/../../bin:$PATH"
+mkdir -p .git/safe

data/lib/initiate.rb

@@ -0,0 +1,6 @@
+require 'rails'
+require 'initiate/version'
+require 'initiate/config'
+require 'initiate/generators/app_generator'
+require 'initiate/actions'
+require 'initiate/app_builder'

data/lib/initiate/actions.rb

@@ -0,0 +1,33 @@
+module Initiate
+  module Actions
+    def replace_in_file(relative_path, find, replace)
+      path = File.join(destination_root, relative_path)
+      contents = IO.read(path)
+      unless contents.gsub!(find, replace)
+        raise "#{find.inspect} not found in #{relative_path}"
+      end
+      File.open(path, "w") { |file| file.write(contents) }
+    end
+
+    def action_mailer_host(rails_env, host)
+      config = "config.action_mailer.default_url_options = { host: #{host} }"
+      configure_environment(rails_env, config)
+    end
+
+    def configure_application_file(config)
+      inject_into_file(
+        "config/application.rb",
+        "\n\n    #{config}",
+        before: "\n  end"
+      )
+    end
+
+    def configure_environment(rails_env, config)
+      inject_into_file(
+        "config/environments/#{rails_env}.rb",
+        "\n\n  #{config}",
+        before: "\nend"
+      )
+    end
+  end
+end

data/lib/initiate/app_builder.rb

@@ -0,0 +1,341 @@
+module Initiate
+  class AppBuilder < Rails::AppBuilder
+    include Initiate::Actions
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def generate_bugsnag
+      copy_file 'bugsnag.rb', 'config/initializers/bugsnag.rb'
+    end
+
+    def setup_development_mailer
+      replace_in_file 'config/environments/development.rb',
+        '  config.action_mailer.raise_delivery_errors = false', mailer_configuration
+    end
+
+    def mailer_configuration
+      <<-RUBY
+  config.action_mailer.raise_delivery_errors = true
+  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+  config.action_mailer.delivery_method = :letter_opener
+  config.action_mailer.preview_path = "\#{Rails.root}/lib/mailer_previews"
+      RUBY
+    end
+
+    def raise_on_unpermitted_parameters
+      config = <<-RUBY
+    config.action_controller.action_on_unpermitted_parameters = :raise
+      RUBY
+
+      inject_into_class "config/application.rb", "Application", config
+    end
+
+    def configure_quiet_assets
+      config = <<-RUBY
+    config.quiet_assets = true
+      RUBY
+
+      inject_into_class "config/application.rb", "Application", config
+    end
+
+    def provide_setup_script
+      template "bin_setup.erb", "bin/setup", force: true
+      run "chmod a+x bin/setup"
+    end
+
+    def provide_dev_prime_task
+      copy_file 'dev.rake', 'lib/tasks/dev.rake'
+    end
+
+    def configure_generators
+      config = <<-RUBY
+
+    config.generators do |generate|
+      generate.helper false
+      generate.javascript_engine false
+      generate.request_specs false
+      generate.routing_specs false
+      generate.stylesheets false
+      generate.test_framework :rspec
+      generate.view_specs false
+    end
+
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def set_up_factory_girl_for_rspec
+      copy_file 'factory_girl_rspec.rb', 'spec/support/factory_girl.rb'
+    end
+
+    def generate_factories_file
+      copy_file "factories.rb", "spec/factories.rb"
+    end
+
+    def configure_smtp
+      copy_file 'smtp.rb', 'config/smtp.rb'
+
+      prepend_file 'config/environments/production.rb',
+        %{require Rails.root.join("config/smtp")\n}
+
+      config = <<-RUBY
+
+  config.action_mailer.delivery_method = :smtp
+  config.action_mailer.smtp_settings = SMTP_SETTINGS
+      RUBY
+
+      inject_into_file 'config/environments/production.rb', config,
+        after: "config.action_mailer.raise_delivery_errors = false"
+    end
+
+    def enable_rack_deflater
+      config = <<-RUBY
+
+  # Enable deflate / gzip compression of controller-generated responses
+  config.middleware.use Rack::Deflater
+      RUBY
+
+      inject_into_file(
+        "config/environments/production.rb",
+        config,
+        after: serve_static_files_line
+      )
+    end
+
+    def setup_asset_host
+      replace_in_file 'config/environments/production.rb',
+        "# config.action_controller.asset_host = 'http://assets.example.com'",
+        'config.action_controller.asset_host = ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))'
+
+      replace_in_file 'config/initializers/assets.rb',
+        "config.assets.version = '1.0'",
+        'config.assets.version = (ENV["ASSETS_VERSION"] || "1.0")'
+
+      inject_into_file(
+        "config/environments/production.rb",
+        '  config.static_cache_control = "public, max-age=#{1.year.to_i}"',
+        after: serve_static_files_line
+      )
+    end
+
+    def setup_staging_environment
+      staging_file = 'config/environments/staging.rb'
+      copy_file 'staging.rb', staging_file
+    end
+
+    def setup_secret_token
+      template 'secrets.yml', 'config/secrets.yml', force: true
+    end
+
+    def disallow_wrapping_parameters
+      remove_file "config/initializers/wrap_parameters.rb"
+    end
+
+    def create_partials_directory
+      empty_directory 'app/views/application'
+    end
+
+    def create_shared_flashes
+      copy_file "_flashes.html.erb", "app/views/application/_flashes.html.erb"
+      copy_file "flashes_helper.rb", "app/helpers/flashes_helper.rb"
+    end
+
+    def create_shared_javascripts
+      copy_file '_javascript.html.erb', 'app/views/application/_javascript.html.erb'
+    end
+
+    def create_application_layout
+      remove_file "app/views/layouts/application.html.erb"
+      template 'application.html.slim.erb',
+        'app/views/layouts/application.html.slim'
+    end
+
+    def use_postgres_config_template
+      template 'postgresql_database.yml.erb', 'config/database.yml',
+        force: true
+    end
+
+    def create_database
+      bundle_command 'exec rake db:create db:migrate'
+    end
+
+    def replace_gemfile
+      remove_file 'Gemfile'
+      template 'Gemfile.erb', 'Gemfile'
+    end
+
+    def set_ruby_to_version_being_used
+      create_file '.ruby-version', "#{Initiate::RUBY_VERSION}\n"
+    end
+
+    def enable_database_cleaner
+      copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
+    end
+
+    def provide_shoulda_matchers_config
+      copy_file(
+        "shoulda_matchers_config_rspec.rb",
+        "spec/support/shoulda_matchers.rb"
+      )
+    end
+
+    def configure_spec_support_features
+      empty_directory_with_keep_file 'spec/features'
+      empty_directory_with_keep_file 'spec/support/features'
+    end
+
+    def configure_rspec
+      remove_file "spec/rails_helper.rb"
+      remove_file "spec/spec_helper.rb"
+      copy_file "rails_helper.rb", "spec/rails_helper.rb"
+      copy_file "spec_helper.rb", "spec/spec_helper.rb"
+    end
+
+    def configure_i18n_for_test_environment
+      copy_file "i18n.rb", "spec/support/i18n.rb"
+    end
+
+    def configure_i18n_for_missing_translations
+      raise_on_missing_translations_in("development")
+      raise_on_missing_translations_in("test")
+    end
+
+    def configure_i18n_tasks
+      run "cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/"
+      copy_file "config_i18n_tasks.yml", "config/i18n-tasks.yml"
+    end
+
+    def configure_background_jobs_for_rspec
+      run 'rails g delayed_job:active_record'
+    end
+
+    def configure_action_mailer_in_specs
+      copy_file 'action_mailer.rb', 'spec/support/action_mailer.rb'
+    end
+
+    def configure_capybara_webkit
+      copy_file "capybara_webkit.rb", "spec/support/capybara_webkit.rb"
+    end
+
+    def configure_time_formats
+      remove_file "config/locales/en.yml"
+      template "config_locales_en.yml.erb", "config/locales/en.yml"
+    end
+
+    def configure_simple_form
+      bundle_command "exec rails generate simple_form:install"
+    end
+
+    def configure_action_mailer
+      action_mailer_host "development", %{"localhost:3000"}
+      action_mailer_host "test", %{"www.example.com"}
+      action_mailer_host "production", %{ENV.fetch("APPLICATION_HOST")}
+    end
+
+    def configure_active_job
+      configure_application_file(
+        "config.active_job.queue_adapter = :delayed_job"
+      )
+      configure_environment "test", "config.active_job.queue_adapter = :inline"
+    end
+
+    def fix_i18n_deprecation_warning
+      config = <<-RUBY
+    config.i18n.enforce_available_locales = true
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def generate_rspec
+      generate 'rspec:install'
+    end
+
+    def setup_stylesheets
+      remove_file "app/assets/stylesheets/application.css"
+      copy_file "application.scss",
+                "app/assets/stylesheets/application.scss"
+    end
+
+    def gitignore_files
+      %w(.sass-cache powder public/system dump.rdb logfile .DS_Store).each do |gitignored|
+        append_file ".gitignore", gitignored
+      end
+    end
+
+    def init_git
+      run 'git init'
+    end
+
+    def provide_deploy_script
+      copy_file "deploy.rb", "config/deploy.rb"
+    end
+
+    def setup_bundler_audit
+      copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
+      append_file "Rakefile", %{\ntask default: "bundler:audit"\n}
+    end
+
+    def setup_annotate
+      copy_file 'annotate.rake', 'lib/tasks/annotate.rake'
+    end
+
+    def setup_spring
+      bundle_command "exec spring binstub --all"
+    end
+
+    def copy_miscellaneous_files
+      copy_file "browserslist", "browserslist"
+      copy_file "errors.rb", "config/initializers/errors.rb"
+      copy_file "json_encoding.rb", "config/initializers/json_encoding.rb"
+    end
+
+    def remove_routes_comment_lines
+      replace_in_file 'config/routes.rb',
+        /Rails\.application\.routes\.draw do.*end/m,
+        "Rails.application.routes.draw do\nend"
+    end
+
+    def disable_xml_params
+      copy_file 'disable_xml_params.rb', 'config/initializers/disable_xml_params.rb'
+    end
+
+    def setup_default_rake_task
+      append_file 'Rakefile' do
+        <<-EOS
+task(:default).clear
+task default: [:spec]
+
+if defined? RSpec
+  task(:spec).clear
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.verbose = false
+  end
+end
+        EOS
+      end
+    end
+
+    private
+
+    def raise_on_missing_translations_in(environment)
+      config = 'config.action_view.raise_on_missing_translations = true'
+
+      uncomment_lines("config/environments/#{environment}.rb", config)
+    end
+
+    def override_path_for_tests
+      if ENV['TESTING']
+        support_bin = File.expand_path(File.join('..', '..', 'spec', 'fakes', 'bin'))
+        "PATH=#{support_bin}:$PATH"
+      end
+    end
+
+    def serve_static_files_line
+      "config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?\n"
+    end
+  end
+end