RubyGems - code42template - Versions diffs - 2.0.0 - Mend

code42template 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (71) hide show

checksums.yaml +7 -0
data/.gitignore +5 -0
data/.ruby-version +1 -0
data/.travis.yml +11 -0
data/Gemfile +3 -0
data/NEWS.md +56 -0
data/README.md +280 -0
data/Rakefile +8 -0
data/bin/code42template +24 -0
data/bin/rake +16 -0
data/bin/rspec +16 -0
data/bin/setup +13 -0
data/code42template.gemspec +30 -0
data/lib/code42template/actions.rb +28 -0
data/lib/code42template/adapters/heroku.rb +174 -0
data/lib/code42template/app_builder.rb +251 -0
data/lib/code42template/generators/app_generator.rb +208 -0
data/lib/code42template/version.rb +9 -0
data/lib/code42template.rb +5 -0
data/spec/adapters/heroku_spec.rb +56 -0
data/spec/code42template.rb +58 -0
data/spec/fakes/bin/heroku +5 -0
data/spec/fakes/bin/hub +5 -0
data/spec/features/heroku_spec.rb +83 -0
data/spec/features/new_project_spec.rb +186 -0
data/spec/fixtures/feature_smoke_test.rb +15 -0
data/spec/fixtures/home_controller.rb +4 -0
data/spec/fixtures/index.html.erb +1 -0
data/spec/fixtures/routes.rb +3 -0
data/spec/fixtures/smoke_test.rb +10 -0
data/spec/spec_helper.rb +14 -0
data/spec/support/code42template.rb +83 -0
data/spec/support/fake_heroku.rb +83 -0
data/templates/Gemfile.erb +42 -0
data/templates/Procfile +3 -0
data/templates/README.md.erb +10 -0
data/templates/active_job.rb +1 -0
data/templates/application.js +1 -0
data/templates/bin_deploy +12 -0
data/templates/bin_setup +21 -0
data/templates/bin_setup_review_app.erb +19 -0
data/templates/code42_gitignore +16 -0
data/templates/config_locales_pt-BR.yml.erb +17 -0
data/templates/dotfiles/.babelrc +5 -0
data/templates/dotfiles/.codeclimate.yml +3 -0
data/templates/dotfiles/.env +8 -0
data/templates/dotfiles/.rspec +2 -0
data/templates/dotfiles/.rubocop.yml +20 -0
data/templates/feature_helper.rb.erb +5 -0
data/templates/health.rake +22 -0
data/templates/karma.conf.js +48 -0
data/templates/mocha-webpack.opts +4 -0
data/templates/package.json +39 -0
data/templates/postgresql_database.yml.erb +22 -0
data/templates/puma.rb +28 -0
data/templates/rails_helper.rb +59 -0
data/templates/secrets.yml +14 -0
data/templates/setup +32 -0
data/templates/sidekiq.yml +7 -0
data/templates/spec/javascripts/.gitkeep +0 -0
data/templates/spec/javascripts/index.browser.js +5 -0
data/templates/spec/javascripts/index.integration.js +5 -0
data/templates/spec/javascripts/integration/smoke.spec.js +7 -0
data/templates/spec/javascripts/unit/smoke.spec.js +7 -0
data/templates/spec_helper.rb +15 -0
data/templates/travis.yml.erb +12 -0
data/templates/webpack.config.js +68 -0
data/templates/webpack.config.test.browser.js +17 -0
data/templates/webpack.config.test.js +5 -0
data/templates/webpack.rake +26 -0
metadata +158 -0

data/lib/code42template/app_builder.rb ADDED Viewed

@@ -0,0 +1,251 @@
+require "forwardable"
+module Code42Template
+  class AppBuilder < Rails::AppBuilder
+    include Code42Template::Actions
+    extend Forwardable
+    def_delegators(
+      :heroku_adapter,
+      :create_heroku_apps,
+      :create_deploy_script,
+      :update_readme_with_deploy,
+      :create_heroku_pipeline,
+      :create_production_heroku_app,
+      :create_staging_heroku_app,
+      :create_review_apps_setup_script,
+      :configure_heroku_buildpacks,
+      :set_heroku_rails_secrets,
+      :set_heroku_rails_environment,
+      :set_heroku_remotes,
+      :set_heroku_application_host,
+      :set_heroku_serve_static_files
+    )
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+    def gitignore
+      copy_file "code42_gitignore", ".gitignore"
+    end
+    def gemfile
+      template "Gemfile.erb", "Gemfile"
+    end
+    def provide_setup_script
+      template "bin_setup", "bin/setup", force: true
+      run "chmod a+x bin/setup"
+    end
+    def setup_secret_token
+      template 'secrets.yml', 'config/secrets.yml', force: true
+    end
+    def copy_rspec_config
+      copy_file 'spec_helper.rb', 'spec/spec_helper.rb'
+      copy_file 'rails_helper.rb', 'spec/rails_helper.rb'
+    end
+    def add_puma_configuration
+      copy_file "puma.rb", "config/puma.rb", force: true
+    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 setup_background_jobs
+      copy_file 'active_job.rb', 'config/initializers/active_job.rb'
+      copy_file 'sidekiq.yml', 'config/sidekiq.yml'
+    end
+    def set_ruby_to_version_being_used
+      create_file '.ruby-version', "#{Code42Template::RUBY_VERSION}\n"
+    end
+    def configure_time_formats
+      remove_file "config/locales/en.yml"
+      template "config_locales_pt-BR.yml.erb", "config/locales/pt-BR.yml"
+    end
+    def setup_default_directories
+      [
+        'app/views/pages',
+        'spec/lib',
+        'spec/controllers',
+        'spec/models',
+        'spec/helpers',
+        'spec/features',
+        'spec/support/matchers',
+        'spec/support/mixins',
+        'spec/support/shared_examples',
+        'spec/factories',
+        'spec/javascripts/unit',
+        'spec/javascripts/integration',
+      ].each do |dir|
+        empty_directory_with_keep_file dir
+      end
+    end
+    def copy_dotfiles
+      directory("dotfiles", ".")
+    end
+    def setup_continuous_integration
+      template "travis.yml.erb", '.travis.yml'
+    end
+    def init_git
+      run 'git init'
+    end
+    def create_setup_script
+      copy_file 'setup', 'bin/setup', force: true
+    end
+    def customize_error_pages
+      meta_tags =<<-EOS
+  <meta charset="utf-8" />
+  <meta name="ROBOTS" content="NOODP" />
+  <meta name="viewport" content="initial-scale=1" />
+      EOS
+      %w(500 404 422).each do |page|
+        inject_into_file "public/#{page}.html", meta_tags, after: "<head>\n"
+        replace_in_file "public/#{page}.html", /<!--.+-->\n/, ''
+      end
+    end
+    def remove_uglifier_js_compressor_config
+      gsub_file(
+        'config/environments/production.rb',
+        /^.+config.assets.js_compressor = :uglifier.*\n/,
+        ''
+      )
+    end
+    def setup_test_env_action_dispatch_exceptions
+      gsub_file(
+        'config/environments/test.rb',
+        'config.action_dispatch.show_exceptions = false',
+        'config.action_dispatch.show_exceptions = true'
+      )
+    end
+    def configure_quiet_assets
+      config = <<-RUBY
+    config.assets.quiet = true
+      RUBY
+      inject_into_class "config/application.rb", "Application", config
+    end
+    def setup_spring
+	    bundle_command "exec spring binstub --all"
+	  end
+    def setup_javascript
+      copy_js_root_files
+      copy_js_spec_files
+      copy_webpack_and_karma_config
+      copy_webpack_entry_file
+      inject_webpack_into_application_layout
+      run "npm install"
+    end
+    def copy_js_root_files
+      %w(package.json Procfile mocha-webpack.opts).each do |root_file|
+        copy_file root_file, root_file
+      end
+    end
+    def copy_js_spec_files
+      %w(
+        index.browser.js
+        index.integration.js
+        unit/smoke.spec.js
+        integration/smoke.spec.js
+      ).each do |js_spec_file|
+        copy_file(
+          "spec/javascripts/#{js_spec_file}",
+          "spec/javascripts/#{js_spec_file}"
+        )
+      end
+    end
+    def copy_webpack_and_karma_config
+      %w(
+        karma.conf.js
+        webpack.config.js
+        webpack.config.test.js
+        webpack.config.test.browser.js
+      ).each do |config_file|
+        copy_file config_file, "config/#{config_file}"
+      end
+    end
+    def copy_webpack_entry_file
+      copy_file(
+        "application.js",
+        "app/assets/javascripts/application.js",
+        force: true
+      )
+    end
+    def inject_webpack_into_application_layout
+      replace_in_file(
+        'app/views/layouts/application.html.erb',
+        /javascript_include_tag 'application'/,
+        "javascript_include_tag(*webpack_asset_paths('application'))"
+      )
+    end
+    def configure_feature_tests
+      inject_into_file(
+        'config/environments/test.rb',
+        "  config.webpack.dev_server.enabled = false\n",
+        after: "Rails.application.configure do\n",
+      )
+      template 'feature_helper.rb.erb', 'spec/feature_helper.rb'
+    end
+    def add_bullet_gem_configuration
+      config = <<RUBY
+  config.after_initialize do
+    Bullet.enable = true
+    Bullet.bullet_logger = true
+    Bullet.rails_logger = true
+  end
+RUBY
+      inject_into_file(
+        "config/environments/development.rb",
+        config,
+        after: "config.file_watcher = ActiveSupport::EventedFileUpdateChecker\n",
+      )
+    end
+    def setup_health_task
+      copy_file "health.rake", "lib/tasks/health.rake"
+      append_file "Rakefile", %{\ntask default: "health"\n}
+    end
+    def setup_webpack_tasks
+      copy_file "webpack.rake", "lib/tasks/webpack.rake"
+    end
+    def heroku_adapter
+      @heroku_adapter ||= Adapters::Heroku.new(self)
+    end
+  end
+end

data/lib/code42template/generators/app_generator.rb ADDED Viewed

@@ -0,0 +1,208 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+module Code42Template
+  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"
+    class_option :heroku, type: :boolean, aliases: "-H", default: false,
+      desc: "Create staging and production Heroku apps"
+    class_option :heroku_flags, type: :string, default: "",
+      desc: "Set extra Heroku flags"
+    class_option :skip_test, type: :boolean, aliases: '-T', default: true,
+      desc: 'Skip test files'
+    def finish_template
+      invoke :code42_customization
+      super
+    end
+    def code42_customization
+      invoke :customize_gemfile
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_staging_environment
+      invoke :setup_continuous_integration
+      invoke :setup_secret_token
+      invoke :create_code42_views
+      invoke :configure_app
+      invoke :customize_error_pages
+      invoke :setup_dotfiles
+      invoke :setup_git
+      invoke :create_setup_script
+      invoke :setup_database
+      invoke :setup_background_jobs
+      invoke :create_local_heroku_setup
+      invoke :create_heroku_apps
+      invoke :setup_webpack_tasks
+      invoke :setup_spring
+      invoke :setup_javascript
+    end
+    def customize_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_background_jobs
+      say 'Setting up background jobs'
+      build :setup_background_jogs
+    end
+    def create_local_heroku_setup
+      say "Creating local Heroku setup"
+      build :create_review_apps_setup_script
+      build :create_deploy_script
+      build :update_readme_with_deploy
+    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 :set_heroku_rails_environment
+        build :set_heroku_application_host
+        build :create_heroku_pipeline
+        build :configure_heroku_buildpacks
+        build :configure_automatic_deployment
+      end
+    end
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build :add_bullet_gem_configuration
+      build :configure_quiet_assets
+    end
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :setup_test_env_action_dispatch_exceptions
+      build :copy_rspec_config
+      build :configure_feature_tests
+    end
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :remove_uglifier_js_compressor_config
+    end
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+    end
+    def setup_continuous_integration
+      say 'Setting up CI configuration'
+      build :setup_continuous_integration
+    end
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+    end
+    def create_code42_views
+      say 'Creating code42 views'
+    end
+    def configure_app
+      say 'Configuring app'
+      build :add_puma_configuration
+    end
+    def setup_git
+      if !options[:skip_git]
+        say "Initializing git"
+        invoke :setup_default_directories
+        invoke :init_git
+      end
+    end
+    def create_setup_script
+      say 'Creating a setup script'
+      build :create_setup_script
+    end
+    def setup_dotfiles
+      build :copy_dotfiles
+    end
+    def setup_default_directories
+      build :setup_default_directories
+    end
+    def setup_webpack_tasks
+      say "Setting up webpack tasks"
+      build :setup_webpack_tasks
+    end
+    def setup_health_task
+      say "Setting up health task"
+      build :setup_health_task
+    end
+    def init_git
+      build :init_git
+    end
+    def customize_error_pages
+      say 'Customizing the 500/404/422 pages'
+      build :customize_error_pages
+    end
+    def setup_spring
+      say "Springifying binstubs"
+      build :setup_spring
+    end
+    def setup_javascript
+      say "Setting up javascript environment with NPM and webpack"
+      say "This will also run npm install, so hold on..."
+      build :setup_javascript
+    end
+    protected
+    def get_builder_class
+      Code42Template::AppBuilder
+    end
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/code42template/version.rb ADDED Viewed

@@ -0,0 +1,9 @@
+require 'pathname'
+module Code42Template
+  RAILS_VERSION = "~> 5.0.0"
+  RUBY_VERSION = Pathname(__dir__).join('..', '..', '.ruby-version').read.strip
+  NODE_VERSION = "6.2.0"
+  VERSION = "2.0.0"
+end

data/lib/code42template.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require 'code42template/version'
+require "code42template/adapters/heroku"
+require 'code42template/generators/app_generator'
+require 'code42template/actions'
+require 'code42template/app_builder'

data/spec/adapters/heroku_spec.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require "spec_helper"
+module Code42Template
+  module Adapters
+    RSpec.describe Heroku do
+      it "sets the heroku remotes" do
+        setup_file = "bin/setup"
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:append_file)
+        Heroku.new(app_builder).set_heroku_remotes
+        expect(app_builder).to have_received(:append_file)
+          .with(setup_file, /heroku join --app #{app_name.dasherize}-production/)
+        expect(app_builder).to have_received(:append_file)
+          .with(setup_file, /heroku join --app #{app_name.dasherize}-staging/)
+      end
+      it "sets the heroku rails secrets" do
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:run)
+        Heroku.new(app_builder).set_heroku_rails_secrets
+        expect(app_builder).to(
+          have_configured_var("staging", "SECRET_KEY_BASE")
+        )
+        expect(app_builder).to(
+          have_configured_var("production", "SECRET_KEY_BASE")
+        )
+      end
+      it "sets the application host" do
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:run)
+        Heroku.new(app_builder).set_heroku_application_host
+        expect(app_builder).to(
+          have_configured_var("staging", "APPLICATION_HOST")
+        )
+        expect(app_builder).to(
+          have_configured_var("production", "APPLICATION_HOST")
+        )
+      end
+      def app_name
+        Code42TemplateTestHelpers::APP_NAME
+      end
+      def have_configured_var(remote_name, var)
+        have_received(:run).with(/config:add #{var}=.+ --remote #{remote_name}/)
+      end
+    end
+  end
+end

data/spec/code42template.rb ADDED Viewed

@@ -0,0 +1,58 @@
+module Code42TemplateTestHelpers
+  APP_NAME = "dummy_app"
+  def remove_project_directory
+    FileUtils.rm_rf(project_path)
+  end
+  def create_tmp_directory
+    FileUtils.mkdir_p(tmp_path)
+  end
+  def run_code42template(arguments = nil)
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        add_fakes_to_path
+        `
+          #{code42template_bin} #{APP_NAME} #{arguments}
+        `
+      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 add_fakes_to_path
+    ENV["PATH"] = "#{support_bin}:#{ENV['PATH']}"
+  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 code42template_bin
+    File.join(root_path, 'bin', 'code42template')
+  end
+  def support_bin
+    File.join(root_path, "spec", "fakes", "bin")
+  end
+  def root_path
+    Pathname(__dir__).join('..')
+  end
+end

data/spec/fakes/bin/heroku ADDED Viewed

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join('..', '..', 'support', 'fake_heroku'), File.dirname(__FILE__))
+FakeHeroku.new(ARGV).run!

data/spec/fakes/bin/hub ADDED Viewed

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join('..', '..', 'support', 'fake_github'), File.dirname(__FILE__))
+FakeGithub.new(ARGV).run!

data/spec/features/heroku_spec.rb ADDED Viewed

@@ -0,0 +1,83 @@
+require "spec_helper"
+RSpec.describe "Heroku" do
+  context "--heroku" do
+    before(:all) do
+      clean_up
+      run_code42template("--heroku=true")
+      setup_app_dependencies
+    end
+    it "suspends a project for Heroku" do
+      app_name = Code42TemplateTestHelpers::APP_NAME.dasherize
+      expect(FakeHeroku).to have_created_app_for("staging")
+      expect(FakeHeroku).to have_created_app_for("production")
+      expect(FakeHeroku).to have_configured_vars("staging", "SECRET_KEY_BASE")
+      expect(FakeHeroku).to(
+        have_configured_vars('production', 'SECRET_KEY_BASE')
+      )
+      expect(FakeHeroku).to(
+        have_configured_vars("staging", "RAILS_ENV", "production")
+      )
+      expect(FakeHeroku).to(
+        have_configured_vars("production", "RAILS_ENV", "production")
+      )
+      expect(FakeHeroku).to have_configured_vars(
+        'staging',
+        'APPLICATION_HOST',
+      )
+      expect(FakeHeroku).to have_configured_vars(
+        'production',
+        'APPLICATION_HOST',
+      )
+      expect(FakeHeroku).to have_setup_pipeline_for(app_name)
+      buildpack_urls = %w(
+        heroku/nodejs
+        heroku/ruby
+        https://github.com/febeling/webpack-rails-buildpack.git
+      )
+      expect(FakeHeroku).to have_configured_buildpacks_sequentially(
+        'staging',
+        buildpack_urls
+      )
+      expect(FakeHeroku).to have_configured_buildpacks_sequentially(
+        'production',
+        buildpack_urls
+      )
+      bin_setup_path = "#{project_path}/bin/setup"
+      bin_setup = IO.read(bin_setup_path)
+      expect(bin_setup).to include("heroku join --app #{app_name}-production")
+      expect(bin_setup).to include("heroku join --app #{app_name}-staging")
+      expect(bin_setup).to include('git config heroku.remote staging')
+      expect(File.stat(bin_setup_path)).to be_executable
+      readme = IO.read("#{project_path}/README.md")
+      expect(readme).to include('./bin/deploy staging')
+      expect(readme).to include('./bin/deploy production')
+    end
+  end
+  context "--heroku with region flag" do
+    before(:all) do
+      clean_up
+      run_code42template(%{--heroku=true --heroku-flags="--region eu"})
+      setup_app_dependencies
+    end
+    it 'suspends a project with extra Heroku flags' do
+      expect(FakeHeroku).to have_created_app_for('staging', '--region eu')
+      expect(FakeHeroku).to have_created_app_for('production', '--region eu')
+    end
+  end
+  def clean_up
+    drop_dummy_database
+    remove_project_directory
+    FakeHeroku.clear!
+  end
+end