bluebase 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b30695940e980d067e78c365e1bc3725d64d6120
-  data.tar.gz: 3b0f08169a8752d20ea74c66c361b6e6dd896d23
+  metadata.gz: cce8b9840b608aaebdf0183fa3eac8d9fb9af18b
+  data.tar.gz: ad92bc123c41e2f23434b81624a9956ec75ef277
 SHA512:
-  metadata.gz: 0fdc0e9226fdc656fd8c541d47e0dc6471b5b794246cfc4eea6d5b3eae85aacfc270a7c676f1473bbbfa7afe98dd1814c167f0df5d216af3f204b676a1b1c028
-  data.tar.gz: a2eb564897732bb1920e8040758a4c9469a2d21e2cc58533a2a347abfc97697b36d855324816f1f599d757cac3324a83a0ed3b6b6292e66f3296ecb560831b6e
+  metadata.gz: b53700958a0010816ff6730a20e5dabfd0cd3a98f65691d35ceb970ab06fd5e45fef03e37b58390c98dc5d0b83399a49f954a16c201768024d6af7adff5a7887
+  data.tar.gz: d24f48fd12c0bab0142c9365825939a158c009222d83f6cf3674669c5dcc9ed57642d088d742d14745ffcc2998c2fe78905f46cfc11ab35d9c21dfb8929563d3

data/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/README.md

@@ -2,23 +2,78 @@
 
 The base app for Blueprint's Rails apps.
 
-## Installation
-
-Add this line to your application's Gemfile:
+## Features
+
+Core gems:
+- [Thin](https://github.com/macournoyer/thin/) for the server
+- [Postgres](https://rubygems.org/gems/pg) to use postgres as the database
+- [Figaro](https://github.com/laserlemon/figaro) for environment variables
+
+Component gems:
+- [Devise](https://github.com/plataformatec/devise) for user auth
+- [Simple Form](https://github.com/plataformatec/simple_form) for easier forms
+- [Gon](https://github.com/gazay/gon) to push data to javascript
+- [Kaminari](https://github.com/amatsuda/kaminari) for pagination
+- [Recipient Interceptor](https://github.com/croaky/recipient_interceptor) to stop email sending from staging
+
+Frontend gems:
+- [Slim](https://github.com/slim-template/slim-rails) to use the [Slim](http://slim-lang.com/) templating language
+- [Autoprefixer](https://github.com/ai/autoprefixer-rails) to autogenerate vendor prefixes
+- [Flutie](https://github.com/thoughtbot/flutie) for the ```body_class``` view helper
+- [Title](https://github.com/calebthompson/title) for page titles in I18n
+
+Development gems:
+- [Annotate](https://github.com/ctran/annotate_models) to annotate models
+- [FFaker](https://github.com/EmmanuelOga/ffaker) to generate random data
+- [Better Errors](https://github.com/charliesome/better_errors) + [Binding of Caller](https://github.com/banister/binding_of_caller) for useful error pages
+- [Quiet Assets](https://github.com/evrone/quiet_assets) to quiet asset rending output in the server
+- [Spring](https://github.com/rails/spring) for fast commands
+- [Rubocop](https://github.com/bbatsov/rubocop) for Rails linting
+- [I18n Tasks](https://github.com/glebm/i18n-tasks) to lint translation files
+- [Awesome Print](https://github.com/michaeldv/awesome_print) for better console object printing
+- [Guard](https://github.com/guard/guard) to run tasks on file changes
+- [Pry](https://github.com/pry/pry) and [Pry Byebug](https://github.com/deivid-rodriguez/pry-byebug) to explore objects and debug
+
+Test gems:
+- [RSpec](https://github.com/rspec/rspec-rails) for specs
+- [Capybara](https://github.com/jnicklas/capybara) for integration tests
+- [FactoryGirl](https://github.com/thoughtbot/factory_girl) for test data
+- [Shoulda Matchers](https://github.com/thoughtbot/shoulda) for common RSpec matchers
+- Launchy to use ```save_and_open_page``` in Capybara
+- [Database Cleaner](https://github.com/DatabaseCleaner/database_cleaner) to clear the database for specs
+- [CodeClimate Test Reporter](https://github.com/codeclimate/ruby-test-reporter) to track test coverage
+
+Production gems/features (most of these require setup):
+- New Relic for monitoring performance
+- Rollbar for error logging
+- Rails 12Factor for Heroku
+
+Other features:
+- Staging environment config
+- Email config using SMTP
+- The ```./bin/setup``` convention for new developer setup
+- Rails' flashes set up and in application layout
+- Configuration for Rubocop/[Hound](https://houndci.com/)
+- A Guardfile set up with [Livereload](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en), RSpec, and Rubocop
+- A few nice time formats set up for localization
+- ```Rack::Deflater``` to compress responses with Gzip
+- A low database connection pool limit
+- ```t()``` and ```l()``` in specs without prefixing with I18n
+- An automatically-created ```SECRET_KEY_BASE``` environment variable in all environments.
+- Configuration for Travis continuous integration.
+- Config for Google Analytics
 
-    gem 'bluebase'
-
-And then execute:
+## Installation
 
-    $ bundle
+Run
 
-Or install it yourself as:
+    gem install bluebase
 
-    $ gem install bluebase
+Then you can run
 
-## Usage
+    bluebase app_name
 
-TODO: Write usage instructions here
+To create an app called ```app_name```. Optionally append ```-G repo_name``` and ```-H``` to create a Github repo and staging + production Heroku apps, respectively.
 
 ## Contributing
 
@@ -30,7 +85,7 @@ advance for your help!
 **[Cal Blueprint](http://www.calblueprint.org/)** is a student-run UC Berkeley organization devoted to matching the skills of its members to our desire to see social good enacted in our community. Each semester, teams of 4-5 students work closely with a non-profit to bring technological solutions to the problems they face every day.
 
 ## Credits
-bluebase was based on thoughtbot's [suspenders](https://github.com/thoughtbot/suspenders)
+Bluebase is a fork of thoughtbot's [suspenders](https://github.com/thoughtbot/suspenders)
 
 ## License
 

data/Rakefile

@@ -1,2 +1,8 @@
-require "bundler/gem_tasks"
+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/bluebase

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'bluebase'
+
+templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+Bluebase::AppGenerator.source_root templates_root
+Bluebase::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Bluebase::AppGenerator.start

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' 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('bluebase', 'bundler')

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('bluebase', '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('bluebase', 'rspec')

data/bluebase.gemspec

@@ -26,5 +26,6 @@ Bluebase is Blueprint's base Rails app. We use it internally to get a jump start
   spec.add_runtime_dependency "bundler", "~> 1.6"
 
   spec.add_development_dependency "rspec", "~> 3.1", ">= 3.1.0"
+  spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "capybara", "~> 2.4", ">= 2.4.4"
 end

data/lib/bluebase.rb

@@ -1,7 +1,4 @@
 require "bluebase/version"
-
-module Bluebase
-  def self.hello
-    'world'
-  end
-end
+require "bluebase/generators/app_generator"
+require "bluebase/actions"
+require "bluebase/app_builder"

data/lib/bluebase/actions.rb

@@ -0,0 +1,25 @@
+module Bluebase
+  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)
+      host_config = "config.action_mailer.default_url_options = { host: '#{host}' }"
+      configure_environment(rails_env, host_config)
+    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/bluebase/app_builder.rb

@@ -0,0 +1,356 @@
+module Bluebase
+  class AppBuilder < Rails::AppBuilder
+    include Bluebase::Actions
+
+    #########################################################
+    # Root directory files
+    #########################################################
+    def readme
+      template "README.md.erb", "README.md"
+    end
+
+    def replace_gemfile
+      remove_file "Gemfile"
+      template "Gemfile.erb", "Gemfile"
+    end
+
+    def add_envrc
+      copy_file ".envrc", ".envrc"
+    end
+
+    def replace_gitignore
+      remove_file ".gitignore"
+      copy_file "bluebase_gitignore", ".gitignore"
+    end
+
+    def add_rubocop_and_hound_config
+      copy_file ".hound.yml", ".hound.yml"
+      copy_file ".rubocop.yml", ".rubocop.yml"
+    end
+
+    def add_rvm_config
+      create_file ".ruby-gemset",  "#{app_path}\n"
+      create_file ".ruby-version", "#{Bluebase::RUBY_VERSION}\n"
+    end
+
+    def add_travis_config
+      template ".travis.yml.erb", ".travis.yml"
+    end
+
+    def add_guardfile
+      copy_file "Guardfile", "Guardfile"
+    end
+
+    def add_dot_rspec
+      copy_file ".rspec", ".rspec"
+    end
+
+    #########################################################
+    # app/ directory files
+    #########################################################
+    def add_vendor_dirs
+      %w(app/assets/javascripts/vendor app/assets/stylesheets/vendor).each do |dir|
+        run "mkdir #{dir}"
+        run "touch #{dir}/.keep"
+      end
+    end
+
+    def replace_application_css_with_scss
+      base_dir = "app/assets/stylesheets"
+      remove_file "#{base_dir}/application.css"
+      copy_file "app/application.css.scss", "#{base_dir}/application.css.scss"
+    end
+
+    def add_application_folder_and_files_to_views
+      base_dir = "app/views/application"
+      empty_directory base_dir
+      copy_file "app/_flash.html.slim", "#{base_dir}/_flash.html.slim"
+      copy_file "app/_ga_boiler.html.slim", "#{base_dir}/_ga_boiler.html.slim"
+      copy_file "app/_fb_meta_tags.html.slim", "#{base_dir}/_fb_meta_tags.html.slim"
+    end
+
+    def replace_application_erb_with_slim
+      base_dir = "app/views/layouts"
+      remove_file "#{base_dir}/application.html.erb"
+      copy_file "app/application.html.slim", "#{base_dir}/application.html.slim"
+    end
+
+    #########################################################
+    # bin/ directory files
+    #########################################################
+    def add_setup_to_bin
+      copy_file "bin/setup", "bin/setup"
+      run "chmod a+x bin/setup"
+    end
+
+    #########################################################
+    # config/ directory files
+    #########################################################
+    def configure_application_environment
+      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
+
+      config = <<-RUBY
+    config.active_record.default_timezone = :utc
+      RUBY
+      inject_into_class "config/application.rb", "Application", config
+
+      config = <<-RUBY
+    config.i18n.enforce_available_locales = true
+      RUBY
+      inject_into_class "config/application.rb", "Application", config
+
+      config = <<-RUBY
+    config.action_controller.action_on_unpermitted_parameters = :raise
+      RUBY
+
+      inject_into_class "config/application.rb", "Application", config
+    end
+
+    def configure_development_environment
+      replace_in_file "config/environments/development.rb",
+        "raise_delivery_errors = false", "raise_delivery_errors = true"
+      inject_into_file "config/environments/development.rb",
+        "  # Don't send emails in development\n  config.action_mailer.perform_deliveries = false",
+        after: "raise_delivery_errors = true\n"
+      raise_on_missing_translations_in "development"
+      action_mailer_host "development", "localhost:3000"
+    end
+
+    def configure_test_environment
+      raise_on_missing_translations_in "test"
+    end
+
+    def configure_production_environment
+      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"
+
+      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: "config.serve_static_assets = false\n"
+
+      action_mailer_host "production", "please-change-me.com"
+    end
+
+    def add_staging_environment
+      template "config/staging.rb.erb", "config/environments/staging.rb"
+    end
+
+    def add_devise_config
+      copy_file "config/devise.rb", "config/initializers/devise.rb"
+    end
+
+    def add_figaro_config
+      copy_file "config/figaro.rb", "config/initializers/figaro.rb"
+    end
+
+    def replace_en_yml
+      file = "config/locales/en.yml"
+      remove_file file
+      template "config/en.yml.erb", file
+    end
+
+    def add_application_yml
+      template "config/application.yml.sample.erb", "config/application.yml.sample"
+
+      template "config/application.yml.sample.erb", "config/application.yml"
+      replace_in_file "config/application.yml",
+        "# Copy this file into application.yml and change env variables as necessary.",
+        "# Change env variables as necessary."
+
+      template "config/application.yml.sample.erb", "config/application.yml.travis"
+      replace_in_file "config/application.yml.travis",
+        "# Copy this file into application.yml and change env variables as necessary.",
+        "# Change env variables as necessary for Travis."
+    end
+
+    def add_database_yml
+      template "config/database.yml.sample.erb", "config/database.yml.sample"
+
+      remove_file "config/database.yml"
+      template "config/database.yml.sample.erb", "config/database.yml"
+      replace_in_file "config/database.yml",
+        "# and then copy the file into database.yml", ""
+    end
+
+    def add_travis_database_yml
+      template "config/database.yml.travis.erb", "config/database.yml.travis"
+    end
+
+    def add_i18n_tasks_yml
+      file = "config/i18n-tasks.yml"
+      copy_file file, file
+    end
+
+    def replace_secrets_yml
+      file = "config/secrets.yml"
+      remove_file file
+      copy_file "config/bluebase_secrets.yml", file
+    end
+
+    def add_smtp_settings
+      file = "config/smtp.rb"
+      copy_file file, file
+    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
+
+    #########################################################
+    # spec/ directory files
+    #########################################################
+    def add_spec_dirs
+      empty_directory "spec"
+      empty_directory_with_keep_file "spec/features"
+      empty_directory_with_keep_file "spec/factories"
+    end
+
+    def configure_rspec
+      %w(spec/rails_helper.rb spec/spec_helper.rb).each do |file|
+        copy_file file, file
+      end
+    end
+
+    def configure_factorygirl
+      copy_file "spec/factory_girl.rb", "spec/support/factory_girl.rb"
+    end
+
+    def configure_actionmailer
+      copy_file "spec/action_mailer.rb", "spec/support/action_mailer.rb"
+    end
+
+    def configure_i18n
+      copy_file "spec/i18n.rb", "spec/support/i18n.rb"
+    end
+
+    def configure_database_cleaner
+      copy_file "spec/database_cleaner_and_factory_girl_lint.rb",
+        "spec/support/database_cleaner_and_factory_girl_lint.rb"
+    end
+
+    #########################################################
+    # git/heroku setup
+    #########################################################
+    def git_init
+      run 'git init'
+    end
+
+    def create_github_repo(repo_name)
+      path_addition = override_path_for_tests
+      run "#{path_addition} hub create #{repo_name}"
+    end
+
+    def create_heroku_apps
+      run_heroku "create #{heroku_app_name :production}", "production"
+      run_heroku "create #{heroku_app_name :staging}", "staging"
+      run_heroku "config:add RACK_ENV=staging RAILS_ENV=staging", "staging"
+    end
+
+    def set_heroku_remotes
+      remotes = <<-SHELL
+
+# Set up the staging and production apps.
+#{join_heroku_app :staging}
+#{join_heroku_app :production}
+      SHELL
+
+      append_file "bin/setup", remotes
+    end
+
+    def set_heroku_env_variables
+      config = <<-SHELL
+# Sets Heroku env variables
+figaro heroku:set -a #{heroku_app_name :production} -e production
+figaro heroku:set -a #{heroku_app_name :staging} -e production
+      SHELL
+      append_file "bin/setup", config
+    end
+
+    def add_heroku_addons
+      config = <<-SHELL
+
+# Heroku addons for production
+heroku addons:add mandrill --app #{heroku_app_name :production}
+heroku addons:add newrelic:stark --app #{heroku_app_name :production}
+heroku addons:add rollbar --app #{heroku_app_name :production}
+      SHELL
+      append_file "bin/setup", config
+    end
+
+    def set_memory_management_variable
+      %w(staging production).each do |environment|
+        run_heroku "config:add NEW_RELIC_AGGRESSIVE_KEEPALIVE=1", environment
+      end
+    end
+
+    #########################################################
+    # Helper methods
+    #########################################################
+    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 run_heroku(command, environment)
+      path_addition = override_path_for_tests
+      run "#{path_addition} heroku #{command} --remote #{environment}"
+    end
+
+    def heroku_app_name(environment)
+      "#{app_name.gsub '_', '-'}-#{environment}"
+    end
+
+    def join_heroku_app(environment)
+      name = heroku_app_name environment
+      <<-SHELL
+if heroku join --app #{name} &> /dev/null; then
+  git remote add #{environment} git@heroku.com:#{name}.git || true
+  printf 'You are a collaborator on the "#{name}" Heroku app\n'
+else
+  printf 'Ask for access to the "#{name}" Heroku app\n'
+fi
+      SHELL
+    end
+
+    def generate_secret
+      SecureRandom.hex(64)
+    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
+  end
+end