anadea-spark 0.2.0

data/lib/spark/generators/app_generator.rb

@@ -0,0 +1,204 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Spark
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database, type: :string, aliases: "-d", default: "postgresql",
+      desc: "Configure for selected database (options: #{DATABASES.join("/")})"
+
+    class_option :skip_test_unit, type: :boolean, aliases: "-T", default: true,
+      desc: "Skip Test::Unit files"
+
+    class_option :skip_turbolinks, type: :boolean, default: true,
+      desc: "Skip turbolinks gem"
+
+    class_option :skip_bundle, type: :boolean, aliases: "-B", default: true,
+      desc: "Don't run bundle install"
+
+    def finish_template
+      invoke :spark_customization
+      super
+      invoke :run_bin_setup
+    end
+
+    def spark_customization
+      invoke :customize_gemfile
+      invoke :setup_secret_token
+      invoke :create_spark_views
+      invoke :configure_app
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_assets
+      invoke :configure_mail_interceptor
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :add_root_route
+      invoke :setup_git
+      invoke :setup_database
+      invoke :setup_bundler_audit
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+
+      bundle_command 'install'
+    end
+
+    def setup_database
+      say 'Setting up database'
+
+      if 'postgresql' == options[:database]
+        build :use_postgres_config_template
+      end
+
+      build :create_database
+    end
+
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build :raise_on_delivery_errors
+      build :set_test_delivery_method
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :provide_dev_prime_task
+      build :configure_generators
+      build :configure_i18n_for_missing_translations
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :set_up_factory_girl_for_rspec
+      build :generate_rspec
+      build :configure_rspec
+      build :configure_background_jobs_for_rspec
+      build :enable_database_cleaner
+      build :configure_spec_support_features
+      build :configure_i18n_for_test_environment
+      build :configure_i18n_tasks
+      build :configure_action_mailer_in_specs
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_exception_notification
+      build :configure_smtp
+      build :enable_rack_deflater
+      build :setup_asset_host
+    end
+
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+      build :setup_staging_environment
+    end
+
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
+    end
+
+    def create_spark_views
+      say 'Creating spark views'
+      build :create_partials
+      build :create_application_layout
+      build :create_home_page
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :setup_figaro
+      build :configure_action_mailer
+      build :configure_active_job
+      build :configure_time_formats
+      build :configure_rack_timeout
+      build :configure_simple_form
+      build :disable_xml_params
+      build :fix_i18n_deprecation_warning
+      build :setup_default_rake_task
+      build :configure_puma
+      build :setup_foreman
+    end
+
+    def setup_assets
+      say 'Set up assets'
+      build :setup_stylesheets
+      build :setup_javascripts
+    end
+
+    def configure_mail_interceptor
+      say 'Configure mail interceptor'
+      build :configure_mail_interceptor
+    end
+
+    def setup_git
+      if !options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    end
+
+    def create_heroku_apps
+      if options[:heroku]
+        say "Creating Heroku apps"
+        build :create_heroku_apps, options[:heroku_flags]
+        build :set_heroku_serve_static_files
+        build :set_heroku_remotes
+        build :set_heroku_rails_secrets
+        build :provide_deploy_script
+      end
+    end
+
+    def setup_gitignore
+      build :gitignore_files
+    end
+
+    def setup_bundler_audit
+      say "Setting up bundler-audit"
+      build :setup_bundler_audit
+    end
+
+    def init_git
+      build :init_git
+    end
+
+    def copy_miscellaneous_files
+      say 'Copying miscellaneous support files'
+      build :copy_miscellaneous_files
+    end
+
+    def customize_error_pages
+      say 'Customizing the 500/404/422 pages'
+      build :customize_error_pages
+    end
+
+    def remove_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
+    def add_root_route
+      build :add_root_route
+    end
+
+    def run_bin_setup
+      build :run_bin_setup
+    end
+
+    def outro
+      say 'Congratulations! Now start creating a great app.'
+    end
+
+    protected
+
+    def get_builder_class
+      Spark::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/spark/version.rb

@@ -0,0 +1,5 @@
+module Spark
+  RAILS_VERSION = "4.2.1"
+  RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
+  VERSION = "0.2.0"
+end

data/spec/features/new_project_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+RSpec.feature 'Build a new project with default configuration' do
+  scenario 'specs pass', :smoke do
+    run_generator
+
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        expect(`rake`).to include('0 failures')
+      end
+    end
+  end
+
+  scenario 'generated .ruby-version is pulled from gem .ruby-version' do
+    run_generator
+
+    ruby_version_file = IO.read("#{project_path}/.ruby-version")
+
+    expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+  end
+
+  scenario 'secrets.yml reads secret from env' do
+    run_generator
+
+    secrets_file = IO.read("#{project_path}/config/secrets.yml")
+
+    expect(secrets_file).to match(/secret_key_base: <%= ENV\["SECRET_KEY_BASE"\] %>/)
+  end
+
+  scenario 'action mailer support file is added' do
+    run_generator
+
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  scenario "i18n support file is added" do
+    run_generator
+
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  scenario 'exception notification reads mail address from ENV' do
+    run_generator
+
+    exception_notification_file =
+      IO.read("#{project_path}/config/initializers/exception_notification.rb")
+
+    expect(exception_notification_file).to match(
+      /exception_recipients: ENV\["MAIL_ERRORS_TO"\]/
+    )
+  end
+
+  scenario 'records pageviews through Google Analytics if ENV variable set' do
+    run_generator
+
+    expect(analytics_partial).
+      to include(%{- if ENV.key?("GOOGLE_ANALYTICS_KEY")})
+    expect(analytics_partial).
+      to include(%{_gaq.push(['_setAccount', '\#{ENV["GOOGLE_ANALYTICS_KEY"]}']);})
+  end
+
+  scenario "raises on unpermitted parameters in all environments" do
+    run_generator
+
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(
+      /^ +config.action_controller.action_on_unpermitted_parameters = :raise$/
+    )
+  end
+
+  scenario "raises on missing translations in development and test" do
+    run_generator
+
+    %w[development test].each do |environment|
+      environment_file =
+        IO.read("#{project_path}/config/environments/#{environment}.rb")
+      expect(environment_file).to match(
+        /^ +config.action_view.raise_on_missing_translations = true$/
+      )
+    end
+  end
+
+  scenario "specs for missing or unused translations" do
+    run_generator
+
+    expect(File).to exist("#{project_path}/spec/i18n_spec.rb")
+  end
+
+  scenario "config file for i18n tasks" do
+    run_generator
+
+    expect(File).to exist("#{project_path}/config/i18n-tasks.yml")
+  end
+
+  scenario "generated en.yml is evaluated" do
+    run_generator
+
+    locales_en_file = IO.read("#{project_path}/config/locales/en.yml")
+    app_name = TestHelpers::APP_NAME
+
+    expect(locales_en_file).to match(/application: #{app_name.humanize}/)
+  end
+
+  scenario "config simple_form" do
+    run_generator
+
+    expect(File).to exist("#{project_path}/config/initializers/simple_form.rb")
+  end
+
+  scenario "config :smtp email delivery method for development" do
+    run_generator
+
+    dev_env_file = IO.read("#{project_path}/config/environments/development.rb")
+    expect(dev_env_file).
+      to match(/^ +config.action_mailer.delivery_method = :smtp$/)
+  end
+
+  scenario "config active job queue adapter" do
+    run_generator
+
+    application_config = IO.read("#{project_path}/config/application.rb")
+    test_config = IO.read("#{project_path}/config/environments/test.rb")
+
+    expect(application_config).to match(
+      /^ +config.active_job.queue_adapter = :delayed_job$/
+    )
+    expect(test_config).to match(
+      /^ +config.active_job.queue_adapter = :inline$/
+    )
+  end
+
+  def analytics_partial
+    IO.read("#{project_path}/app/views/application/_analytics.html.haml")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'capybara/rspec'
+require 'bundler/setup'
+
+Bundler.require(:default, :test)
+
+require (Pathname.new(__FILE__).dirname + '../lib/spark').expand_path
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include TestHelpers
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.before(:all) do
+    drop_dummy_database
+    recreate_tmp_directory
+  end
+
+  config.before(:each) do
+    drop_dummy_database
+    remove_project_directory
+  end
+
+end

data/spec/support/spark.rb

@@ -0,0 +1,51 @@
+module TestHelpers
+  APP_NAME = "dummy_app"
+
+  def remove_project_directory
+    FileUtils.rm_rf(project_path)
+  end
+
+  def recreate_tmp_directory
+    FileUtils.rm_rf(project_path)
+    FileUtils.mkdir_p(tmp_path)
+  end
+
+  def run_generator(arguments = nil)
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        ENV['TESTING'] = '1'
+
+        %x(#{generator_bin} #{APP_NAME} #{arguments})
+        fail 'Application generation failed' unless $?.exitstatus == 0
+      end
+    end
+  end
+
+  def drop_dummy_database
+    if File.exist?(project_path)
+      Dir.chdir(project_path) do
+        Bundler.with_clean_env do
+          `rake db:drop`
+        end
+      end
+    end
+  end
+
+  def project_path
+    @project_path ||= Pathname.new("#{tmp_path}/#{APP_NAME}")
+  end
+
+  private
+
+  def tmp_path
+    @tmp_path ||= Pathname.new("#{root_path}/tmp")
+  end
+
+  def generator_bin
+    File.join(root_path, 'bin', 'spark')
+  end
+
+  def root_path
+    File.expand_path('../../../', __FILE__)
+  end
+end

data/templates/Gemfile.erb

@@ -0,0 +1,53 @@
+source "https://rubygems.org"
+
+ruby "<%= Spark::RUBY_VERSION %>"
+
+gem "bootstrap-sass", "~> 3.3.4"
+gem "coffee-rails", "~> 4.1.0"
+gem "delayed_job_active_record"
+gem "email_validator"
+gem "exception_notification"
+gem "figaro"
+gem "haml-rails"
+gem "high_voltage"
+gem "i18n-tasks"
+gem "jquery-rails"
+gem "pg"
+gem "puma"
+gem "rack-timeout"
+gem "rails", "<%= Spark::RAILS_VERSION %>"
+gem "recipient_interceptor"
+gem "sass-rails", "~> 5.0"
+gem "simple_form"
+gem "title"
+gem "uglifier"
+
+group :development do
+  gem "spring"
+  gem "spring-commands-rspec"
+  gem "web-console"
+end
+
+group :development, :test do
+  gem "awesome_print"
+  gem "bundler-audit", require: false
+  gem "byebug"
+  gem "factory_girl_rails"
+  gem "pry-rails"
+  gem "rspec-rails", "~> 3.1.0"
+end
+
+group :test do
+  gem "database_cleaner"
+  gem "formulaic"
+  gem "launchy"
+  gem "poltergeist"
+  gem "shoulda-matchers", require: false
+  gem "simplecov", require: false
+  gem "timecop"
+  gem "webmock"
+end
+
+group :production do
+  gem "rails_12factor"
+end