voyage 1.0

data/lib/voyage/generators/app_generator.rb

@@ -0,0 +1,118 @@
+module Suspenders
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :skip_turbolinks, type: :boolean, default: false,
+      desc: "Skip turbolinks gem"
+
+    class_option :skip_bundle, type: :boolean, aliases: "-B", default: true,
+      desc: "Don't run bundle install"
+
+    def self.start
+      preflight_check
+      accept_defaults
+
+      super
+    end
+
+    def self.preflight_check
+      puts '"bundle install" will be run for the current ruby version and gemset. Press enter to continue...'
+      prompt = STDIN.gets.chomp
+
+      unless prompt.empty?
+        puts "Skipping install. Please create a ruby gemset first!"
+        exit 1
+      end
+    end
+
+    def self.accept_defaults
+      Suspenders::AppBuilder.new.accept_defaults
+    end
+
+    def finish_template
+      invoke :suspenders_customization
+      invoke :use_slim
+      invoke :install_devise
+      invoke :customize_application_js
+      invoke :require_files_in_lib
+      invoke :generate_ruby_version_and_gemset
+      invoke :generate_data_migrations
+      invoke :add_high_voltage_static_pages
+      invoke :generate_refills
+      invoke :generate_test_environment
+      invoke :update_test_environment
+
+
+      # Do these last
+      invoke :rake_db_setup
+      invoke :configure_rvm_prepend_bin_to_path
+      invoke :actually_setup_spring
+      invoke :bon_voyage
+      super
+    end
+
+    def use_slim
+      build :use_slim
+    end
+
+    def install_devise
+      build :install_devise
+    end
+
+    def customize_application_js
+      build :customize_application_js
+    end
+
+    def require_files_in_lib
+      build :require_files_in_lib
+    end
+
+    def generate_ruby_version_and_gemset
+      build :generate_ruby_version_and_gemset
+    end
+
+    def generate_data_migrations
+      build :generate_data_migrations
+    end
+
+    def add_high_voltage_static_pages
+      build :add_high_voltage_static_pages
+    end
+
+    def generate_refills
+      build :generate_refills
+    end
+
+    def generate_test_environment
+      build :generate_test_environment
+    end
+
+    def update_test_environment
+      build :update_test_environment
+    end
+
+    def rake_db_setup
+      build :rake_db_setup
+    end
+
+    def configure_rvm_prepend_bin_to_path
+      build :configure_rvm_prepend_bin_to_path
+    end
+
+    def setup_spring
+      # do nothing so we can run generators after suspenders_customization runs
+    end
+
+    def actually_setup_spring
+      say "Springifying binstubs"
+      build :setup_spring
+    end
+
+    def outro
+      # need this to be nothing so it doesn't output any text when
+      # :suspenders_customization runs and it invokes this method
+    end
+
+    def bon_voyage
+      say 'Congratulations! You just pulled our suspenders, Headway style!'
+    end
+  end
+end

data/lib/voyage/templates/Gemfile.erb

@@ -0,0 +1,118 @@
+# rubocop:disable Metrics/LineLength
+source "https://rubygems.org"
+
+ruby "<%= Voyage::RUBY_VERSION %>"
+#ruby-gemset=<%= @app_name %>
+
+gem "autoprefixer-rails"
+gem "bourbon", "~> 4.2.0"
+gem "coffee-rails", "~> 4.1.0"
+gem "delayed_job_active_record"
+gem "flutie"
+gem "high_voltage"
+gem "jquery-rails"
+gem "neat", "~> 1.7.0"
+gem "normalize-rails", "~> 3.0.0"
+gem "pg"
+gem "rack-canonical-host"
+gem "rails", "<%= Voyage::RAILS_VERSION %>"
+gem "recipient_interceptor"
+gem "sass-rails", "~> 5.0"
+gem "simple_form"
+gem "title"
+gem "uglifier"
+
+# Customizations
+gem 'responders' # respond to json/html/js more easily in controllers
+gem 'slim-rails' # templating
+gem 'font-awesome-rails'
+gem 'dynamic_form' # for custom messages without the database column
+gem 'nested_form_fields' # Dynamically add and remove nested has_many association fields in a Ruby on Rails form
+gem 'devise'
+
+gem 'turbolinks'
+gem 'jquery-turbolinks'
+gem 'jquery-ui-rails'
+gem 'nprogress-rails' # Show request progress when a link is clicked
+gem 'gon' # pass variables betwween rails and javascript. Several examples in the application_controller.rb
+
+gem 'cancancan' # authorization library
+gem 'canard', git: 'https://github.com/james2m/canard.git' # ties into cancancan, adds roles for the user
+
+gem 'friendly_id' # slugs in the url auto-generated
+gem 'paper_trail'
+gem 'settingslogic' # yaml settings (project wide, non-editable), this is implemented with the model Settings.rb
+
+# Want these here for debugging on production
+gem 'pry-rails' # better REPL than irb
+gem 'pry-awesome_print'
+gem 'pry-byebug'
+gem 'pry-remote'
+
+gem 'librato-rails' # general monitoring of things
+gem 'nondestructive_migrations'
+gem 'carrierwave'
+gem 'mini_magick'
+gem 'fog'
+gem 'whenever', require: false # provides a clear syntax for writing and deploying cron jobs
+gem 'whenever-web'
+
+group :development do
+  gem "quiet_assets"
+  gem "refills"
+  gem "spring"
+  gem "spring-commands-rspec"
+  gem "web-console"
+
+  # Customizations
+  gem 'annotate' # annotate models automatically when rake db:migrate is called
+  gem 'rails-erd' # auto gen ERD Diagram of models in the app on rake db:migrate
+  gem 'zenflow', github: 'zencoder/zenflow'
+  gem 'better_errors' # A better error page for rails when a local 500 (or similar) is thrown
+  gem 'binding_of_caller' # REPL in better_errors to debug in the browser at the point at which it failed
+  gem 'meta_request' # for chrome rails console plugin found here: https://chrome.google.com/webstore/detail/railspanel/gjpfobpafnhjhbajcjgccbbdofdckggg?hl=en-US
+  gem 'bitters', '~> 1.2'
+  gem 'redcarpet' # used to render the readme inside a static welcome page from the high_voltage gem
+end
+
+group :development, :test do
+  gem "awesome_print"
+  gem "bullet"
+  gem "bundler-audit", require: false
+  gem "dotenv-rails"
+  gem "factory_girl_rails"
+  gem "rspec-rails", "~> 3.4.0"
+
+  # Customizations
+  gem 'faker' # provides auto generated names for factories, can be customized
+
+  gem 'rubocop', '0.36.0', require: false # lock to keep in sync with Hound
+  gem 'rubocop-rspec', require: false
+
+  gem 'letter_opener' # auto-open emails when they're sent
+end
+
+group :development, :staging do
+  gem "rack-mini-profiler", require: false
+end
+
+group :test do
+  gem "database_cleaner"
+  gem "formulaic"
+  gem "launchy"
+  gem "shoulda-matchers"
+  gem "simplecov", require: false
+  gem "timecop"
+  gem "webmock"
+
+  # Customizations
+  gem 'cadre' # highlights code coverage in vim
+
+  gem 'capybara'
+  gem 'poltergeist'
+  gem 'selenium-webdriver' # brew install chromedriver
+end
+
+group :staging, :production do
+  gem "rack-timeout"
+end

data/lib/voyage/templates/README.md.erb

@@ -0,0 +1,28 @@
+# <%= app_name.humanize %>
+
+## Getting Started
+
+After you have cloned this repo, run this setup script to set up your machine
+with the necessary dependencies to run and test this app:
+
+    % ./bin/setup
+
+It assumes you have a machine equipped with Ruby, Postgres, etc. If not, set up
+your machine with [this script].
+
+[this script]: https://github.com/thoughtbot/laptop
+
+After setting up, you can run the application using [Heroku Local]:
+
+    % heroku local
+
+[Heroku Local]: https://devcenter.heroku.com/articles/heroku-local
+
+## Guidelines
+
+Use the following guides for getting things done, programming well, and
+programming in style.
+
+* [Protocol](http://github.com/thoughtbot/guides/blob/master/protocol)
+* [Best Practices](http://github.com/thoughtbot/guides/blob/master/best-practices)
+* [Style](http://github.com/thoughtbot/guides/blob/master/style)

data/lib/voyage/templates/about.html.erb

@@ -0,0 +1 @@
+<h1>Customize me, please!</h1>

data/lib/voyage/templates/application.js

@@ -0,0 +1,19 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery.turbolinks
+//= require jquery_ujs
+//
+// ... your other scripts here ...
+//
+//= require turbolinks

data/lib/voyage/templates/config_locales_en.yml.erb

@@ -0,0 +1,25 @@
+en:
+  date:
+    formats:
+      default:
+        '%m/%d/%Y'
+      short:
+        '%m/%d/%y'
+      with_weekday:
+        '%a %m/%d/%y'
+
+  time:
+    formats:
+      default:
+        '%a, %b %-d, %Y at %r'
+      date:
+        '%b %-d, %Y'
+      short:
+        '%B %d'
+      time_with_period:
+        '%-l:%M %p'
+      date_and_time_with_period:
+        '%m/%d/%Y - %-l:%M %p'
+
+  titles:
+    application: <%= app_name.humanize %>

data/lib/voyage/templates/controller_helpers.rb

@@ -0,0 +1,14 @@
+module ControllerHelpers
+  def sign_in(user = double('user'))
+    if user.nil?
+      allow(request.env['warden'])
+        .to receive(:authenticate!)
+        .and_throw(:warden, { scope: :user })
+
+      allow(controller).to receive(:current_user).and_return(nil)
+    else
+      allow(request.env['warden']).to receive(:authenticate!).and_return(user)
+      allow(controller).to receive(:current_user).and_return(user)
+    end
+  end
+end

data/lib/voyage/templates/custom_cancan_matchers.rb

@@ -0,0 +1,54 @@
+rspec_module = defined?(RSpec::Core) ? 'RSpec' : 'Spec' # RSpec 1 compatability
+
+if rspec_module == 'RSpec'
+  require 'rspec/core'
+  require 'rspec/expectations'
+else
+  ActiveSupport::Deprecation
+    .warn('RSpec < 3 will not be supported in the CanCanCan >= 2.0.0')
+end
+
+# Allow passing args like
+#
+#     be_able_to :read, thing
+#
+# or
+#
+#     be_able_to [:read, :update], thing
+#
+Kernel.const_get(rspec_module)::Matchers.define :be_able_to do |*args|
+  match do |ability|
+    actions = Array.wrap(args[0])
+    actions.all? { |action| ability.can?(action, *args[1..-1]) }
+  end
+
+  # Check that RSpec is < 2.99
+  if !respond_to?(:failure_message) && respond_to?(:failure_message_for_should)
+    alias :failure_message :failure_message_for_should
+    alias :failure_message_when_negated :failure_message_for_should_not
+  end
+
+  failure_message do
+    resource = args[1]
+    if resource.instance_of?(Class)
+      "expected to be able to #{args.map(&:to_s).join(' ')}"
+    else
+      "expected to be able to #{args.map(&:inspect).join(' ')}"
+    end
+  end
+
+  failure_message_when_negated do
+    resource = args[1]
+    if resource.instance_of?(Class)
+      "expected not to be able to #{args.map(&:to_s).join(' ')}"
+    else
+      "expected not to be able to #{args.map(&:inspect).join(' ')}"
+    end
+  end
+
+  description do
+    action = args[0].to_s
+    resource = args[1].class.name
+    "be able to #{action} #{resource}"
+  end
+end

data/lib/voyage/templates/rails_helper.rb.erb

@@ -0,0 +1,99 @@
+require 'simplecov'
+SimpleCov.command_name 'Rspec'
+
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../../config/environment", __FILE__)
+abort("DATABASE_URL environment variable is set") if ENV["DATABASE_URL"]
+
+require 'spec_helper'
+require "rspec/rails"
+require 'factory_girl'
+require 'capybara/rspec'
+require 'capybara/poltergeist'
+require 'shoulda/matchers'
+require 'database_cleaner'
+require 'cadre/rspec3'
+# require 'sidekiq/testing'
+# require 'paperclip/matchers'
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].sort.each { |file| require file }
+
+module Features
+  # Extend this module in spec/support/features/*.rb
+  include Formulaic::Dsl
+end
+
+RSpec.configure do |config|
+  config.include Features, type: :feature # not sure what this does: https://github.com/thoughtbot/suspenders/issues/142
+  config.infer_base_class_for_anonymous_controllers = false # not sure what this does: https://www.relishapp.com/rspec/rspec-rails/docs/controller-specs/anonymous-controller
+
+  config.use_transactional_fixtures = false
+
+  config.include Devise::TestHelpers, type: :controller
+  config.include ControllerHelpers, type: :controller
+  # config.include Paperclip::Shoulda::Matchers
+
+  Capybara.javascript_driver = :poltergeist
+  Capybara.asset_host = 'http://localhost:3000'
+
+  # Can be used by passing driver: :selenium_chrome to a test
+  Capybara.register_driver :selenium_chrome do |app|
+    Capybara::Selenium::Driver.new(app, browser: :chrome)
+  end
+
+  config.after(:each) do
+    Capybara.current_driver = Capybara.default_driver
+  end
+
+  config.before(:each) do |spec|
+    Capybara.current_driver = :selenium_chrome if spec.metadata[:browser]
+
+    # Sidekiq::Testing.fake!
+    # # This runs jobs immediately in the same thread
+    # Sidekiq::Testing.inline! if spec.metadata[:inline]
+  end
+
+  config.before(:suite) do
+    # Load seed data to bootstrap the app with things the real app will have at
+    # launch like States, roles, etc.
+    require_relative '../lib/seeder'
+    require 'rake'
+    <%= "#{app_name.camelize}::Application.load_tasks" %>
+    Rake::Task['db:seed'].invoke
+  end
+
+  config.after(:each) do
+    if Rails.env.test? || Rails.env.cucumber?
+      FileUtils.rm_rf(Dir["#{Rails.root}/spec/support/uploads"])
+    end
+  end
+
+  # Cadre (code coverage)
+  config.add_formatter(Cadre::RSpec3::NotifyOnCompleteFormatter)
+  config.add_formatter(Cadre::RSpec3::QuickfixFormatter)
+end
+
+# RSpec::Sidekiq.configure do |config|
+#   # Clears all job queues before each example
+#   config.clear_all_enqueued_jobs = true # default => true
+
+#   # Whether to use terminal colours when outputting messages
+#   config.enable_terminal_colours = true # default => true
+
+#   # Warn when jobs are not enqueued to Redis but to a job array
+#   config.warn_when_jobs_not_processed_by_sidekiq = true # default => true
+# end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end