preseason 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3f322e9dc43834fa74890214948632d6d82b671
+  data.tar.gz: 1a3f38dfe75b3f614929f1046622f9a58811b0cf
+SHA512:
+  metadata.gz: 7622582d00ee54d3b46b16292142cbb662e7c5f75033703e5ccd0919dda375fa1c4db8bc6edb22145ef171f0e13d18f62316acbae81272e2c892c952a56b2652
+  data.tar.gz: f3ba95012bf1a9f4afd4c479e4a943a0a1e2628c95c7c56ed47a847b4259845bfa2044d6cb121222e78fe49741c7dd23bf410e1da59c214032fc407c22480b12

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+logfile

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+## Contributing
+1. fork the repo
+2. exhibit your brilliance
+3. push to your fork
+4. submit a pull request
+
+### Submitting Bug Reports
+
+If you're nice enough to submit a bug and make Preseason better, please
+provide the following information to make resolving the bug easier.
+
+1. Your operating system (and version)
+2. Your shell type and version (Bash, Zsh, Bourne, etc)
+3. Clear steps to reproduce the bug. What answers did you select during
+   the prompts?
+4. Any error messages seen in the console
+5. A description of what you expected to happen
+6. A description of what actually happened

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in preseason.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    preseason (0.0.1)
+      rails (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.5)
+      actionpack (= 4.1.5)
+      actionview (= 4.1.5)
+      mail (~> 2.5.4)
+    actionpack (4.1.5)
+      actionview (= 4.1.5)
+      activesupport (= 4.1.5)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+    activerecord (4.1.5)
+      activemodel (= 4.1.5)
+      activesupport (= 4.1.5)
+      arel (~> 5.0.0)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    coderay (1.1.0)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (5.4.0)
+    multi_json (1.10.1)
+    polyglot (0.3.5)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.5)
+      actionmailer (= 4.1.5)
+      actionpack (= 4.1.5)
+      actionview (= 4.1.5)
+      activemodel (= 4.1.5)
+      activerecord (= 4.1.5)
+      activesupport (= 4.1.5)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.5)
+      sprockets-rails (~> 2.0)
+    railties (4.1.5)
+      actionpack (= 4.1.5)
+      activesupport (= 4.1.5)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (0.9.6)
+    slop (3.6.0)
+    sprockets (2.12.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  preseason!
+  pry (~> 0)
+  rake (~> 0)

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Centresource Interactive Agency
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,129 @@
+# Preseason
+A Centresource Interactive Agency open internal project for generating new Rails applications.
+
+### Why
+We start new Ruby on Rails projects frequently. In doing so, we end up
+repeating many of the same steps. As Rubyists, we are always looking for
+ways to DRY things up. This project is intended to serve as a launching
+pad for new Rails applications. Perhaps most importantly, it is **NOT** supposed to cover everything that every Rails app will ever need, but to be a good starting place.
+
+### How
+N.B. This project assumes you have a development environment setup that is capable of installing Rails projects. If not, start with the [Rails Guides](http://guides.rubyonrails.org/getting_started.html "Rails Guides"). You must also have the rvm gem installed. It also assumes that you are using SSH if you plan to make your project a Github repo.
+
+0. Install the `rvm` gem if you don't already have it installed
+
+        `gem install rvm`
+
+1. Install the preseason gem into your global gemset:
+
+        `gem install preseason`
+
+2. Make sure your db is running (postgres/mysql/etc)
+
+3. Install a new Rails application with:
+
+        `preseason <name_of_your_project>`
+
+3. Follow the prompts to choose your database, etc.
+
+4. Make a mistake? Just `rm -rf` your application's directory and repeat steps 1-4.
+
+5. `cd` into your application directory
+
+6. Make magic happen and dreams come true.
+
+####Note About ERB Templates
+If you need to write a template that executes ERB in the context of the running script and also outputs ERB for the purposes of the generated application code, be sure to escape your application-bound ERB as `<%%>`
+
+### What
+#### Preseason does the following:
+
++ asks for your db of preference
++ asks for your preferences on a few gems
++ creates an RVM gemset for your project and switches to that gemset
++ creates a new config/database.yml file with info from your db of choice
++ adds the database.yml to .gitignore and creates a database.yml.dist as a placeholder
++ adds .ruby-version, .ruby-gemset, swp files, public/assets, s3 files, etc to .gitignore
++ cleans up the Gemfile (removes comments and empty lines)
++ enables lograge for production (for non-Heroku apps)
++ installs gems via bundler
++ creates a database
++ cleans up routes.rb
++ sets up flash messages in the application layout
++ sets config.assets.initialize_on_precompile to false
++ sets config.autoload_paths += %W(\#{config.root}/lib)
++ sets up a template for using whenever for cronjobs (for non-Heroku apps)
++ installs rspec
++ installs and sets up bourbon and neat
++ creates a template for your whiskey_disk deploy in config/deploy.yml (for non-Heroku apps)
++ creates Procfile for foreman
++ starts guard
++ creates a new spec_helper with spork and simplecov
++ removes the test unit directory, the smoke test page, and the Rails logo.
++ migrates the db and recreates the test db from the DEV's schema
++ initializes a git repository, makes an "initial commit", and checks out a 'develop' branch
++ setup Heroku
+
+#### Preseason offers use of the following technologies:
+
++  Either postgresql, mysql2, or sqlite3
++  [factory_girl](https://github.com/thoughtbot/factory_girl)
++  [authlogic](https://github.com/binarylogic/authlogic), [devise](https://github.com/plataformatec/devise), or [activeadmin](http://www.activeadmin.info/) (with devise)
++  [rvm](https://rvm.io/)
++  [whiskey_disk](https://github.com/flogic/whiskey_disk) (for embarrassingly fast deployments)
++  [lograge](https://github.com/roidrage/lograge)
++  [whenever](https://github.com/javan/whenever)
++  [foreman](https://github.com/ddollar/foreman)
++  [guard](https://github.com/guard/guard)
++  [spork](https://github.com/sporkrb/spork)
++  [pry](http://pryrepl.org/)
++  [awesome_print](https://github.com/michaeldv/awesome_print)
++  [quiet_assets](https://github.com/evrone/quiet_assets)
++  [rspec](http://rspec.info/)
++  [database_cleaner](https://github.com/bmabey/database_cleaner)
++  [shoulda-matchers](https://github.com/thoughtbot/shoulda-matchers)
++  [capybara-webkit](https://github.com/thoughtbot/capybara-webkit)
++  [launchy](https://github.com/copiousfreetime/launchy)
++  [fuubar](https://github.com/jeffkreeftmeijer/fuubar)
++  [simplecov](https://github.com/colszowka/simplecov)
++  [bourbon](http://bourbon.io/)
++  [neat](http://neat.bourbon.io/)
++  [bitters](http://bitters.bourbon.io)
+
+### Who
+
+Preseason is a project by the development team at the [Centresource Interactive Agency](http://www.centresource.com) in Nashville, TN. The main push for this project is from [Cade Truitt](https://github.com/cade), [Travis Roberts](https://github.com/travisr), [Jeremy Holland](https://github.com/awebneck), [Adam Scott](https://github.com/ascot21), [Rian Rainey](https://github.com/rianrainey), and [Max Beizer](https://github.com/maxbeizer)
+
+### ToDos
+* integration spec setup?
+* add active admin precompile asset list to production.rb
+* add logic to setup activeadmin for authlogic and allow choice between
+  devise and authlogic rather than y/n for authlogic
+
+### Developing Locally
+1. Fork the repo
+2. Clone it to your local machine
+3. `gem uninstall preseason` if you have it installed already
+  - you may be prompted about removing an executable called preseason. The answer is yes
+4. Crack the project open and make magic happen
+5. `gem build preseason.gemspec`
+  - should you receive an error message about the gem containing itself, try `rm preseason-0.0.1.gem` (or whatever version number we are on and stage that deletion
+6. `gem install preseason` in your global gemset
+7. In a separate terminal (or just outside the preseason dir), `presason <the name of your test project>`
+8. Information on tests coming soon.
+
+## Troubleshooting
+* If you don't have QT libraries installed, you may get this error when installing Capybara
+   * `Command 'qmake -spec macx-g++' not available`
+      * Just run `brew install qt`. [Learn more](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit)
+* If you get the following error when building the gem, you need to stage the deletion of
+`preseason.gem` file by `git stage -u preseason.x.x.x.gem`
+```
+└[$] gem build preseason.gemspec
+WARNING:  See http://guides.rubygems.org/specification-reference/ for help
+ERROR:  While executing gem ... (Gem::InvalidSpecificationException)
+        from bin/rails:4:in `<main>'
+```
+
+## License
+Preseason is Copyright © 2014 Centresource. It is free software, and may be redistributed under the terms specified in the [LICENSE](https://github.com/centresource/preseason/blob/master/LICENSE) file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/preseason

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+#TODO remove any args except the project name
+argv = ARGV + ['-m'] +  ["#{File.dirname(__FILE__)}/../lib/play.rb"]
+Rails::Generators::AppGenerator.start argv

data/lib/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in preseason.gemspec
+gemspec

data/lib/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/play.rb

@@ -0,0 +1,2 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'preseason'))
+Preseason.new(self).game_on!

data/lib/preseason/colorize.rb

@@ -0,0 +1,57 @@
+class Preseason
+  module Colorize
+    include Preseason::GeneratorContext
+
+    # override method from Thor::Shell::Basic
+    def ask(statement, *args)
+      statement = colorize(statement)
+      super
+    end
+
+    # override method from Thor::Shell::Basic
+    def yes?(statement, color = nil)
+      statement = colorize(statement)
+      super
+    end
+
+    # override method from Rails::Generators::Actions
+    def readme(path)
+      begin
+        say "#{option_color}"
+        super
+      ensure
+        say "#{no_color}"
+      end
+    end
+
+    private
+    def colorize(statement)
+      statement.insert 0, ask_color
+      statement.insert option_index(statement), option_color if option_index(statement)
+      statement.insert aside_index(statement) || -1, no_color
+
+      statement
+    end
+
+    def option_index(statement)
+      index = statement.rindex '['
+      index if index && index > ask_color.size
+    end
+
+    def aside_index(statement)
+      statement.rindex '('
+    end
+
+    def ask_color
+      "\033[35m" # magenta
+    end
+
+    def option_color
+      "\033[33m" # yellow
+    end
+
+    def no_color
+      "\033[0m" # reset
+    end
+  end
+end

data/lib/preseason/config/authentication.rb

@@ -0,0 +1,31 @@
+class Preseason
+  module Config
+    class Authentication
+      include Config
+
+      attr_accessor :library
+
+      def ask_user
+        if yes? "Will you be using Authlogic? [y/n]"
+          self.library = :authlogic
+        elsif yes? "Will you be using ActiveAdmin? [y/n]"
+          self.library = :active_admin
+        elsif yes? "Ok then, how about Devise? [y/n]"
+          self.library = :devise
+        end
+      end
+
+      def authlogic?
+        library == :authlogic
+      end
+
+      def active_admin?
+        library == :active_admin
+      end
+
+      def devise?
+        library == :devise || active_admin?
+      end
+    end
+  end
+end

data/lib/preseason/config/database.rb

@@ -0,0 +1,48 @@
+class Preseason
+  module Config
+    class Database
+      include Config
+
+      attr_accessor :database, :password
+      attr_reader :username
+
+      def ask_user
+        self.database ||= ask "What db will you be using?", :limited_to => gems.keys
+
+        unless database == 'sqlite'
+          self.username = ask "What is your #{database} database username? (leave blank for `whoami`)"
+          self.password = ask "What is your #{database} database password? (leave blank for none)"
+        end
+      end
+
+      def username=(other)
+        @username = other.blank? ? (`whoami`).chomp : other
+      end
+
+      def postgres?
+        database == 'postgres'
+      end
+
+      def sqlite?
+        database == 'sqlite'
+      end
+
+      def adapter_name
+        adapters[database]
+      end
+
+      def gem_name
+        gems[database]
+      end
+
+      private
+      def adapters
+        { 'postgres' => 'postgresql', 'mysql' => 'mysql2', 'sqlite' => 'sqlite3' }
+      end
+
+      def gems
+        { 'postgres' => 'pg', 'mysql' => 'mysql2', 'sqlite' => 'sqlite3' }
+      end
+    end
+  end
+end

data/lib/preseason/config/factory.rb

@@ -0,0 +1,19 @@
+class Preseason
+  module Config
+    class Factory
+      include Config
+
+      attr_accessor :library
+
+      def ask_user
+        if yes? "Will you be using Factory Girl? [y/n]"
+          self.library = :factory_girl
+        end
+      end
+
+      def factory_girl?
+        library == :factory_girl
+      end
+    end
+  end
+end

data/lib/preseason/config/heroku.rb

@@ -0,0 +1,17 @@
+class Preseason
+  module Config
+    class Heroku
+      include Config
+
+      attr_accessor :use
+
+      def ask_user
+        self.use = yes? "Will this app be deployed to Heroku? [y/n]"
+      end
+
+      def use?
+        use
+      end
+    end
+  end
+end

data/lib/preseason/config/ie8.rb

@@ -0,0 +1,17 @@
+class Preseason
+  module Config
+    class IE8
+      include Config
+
+      attr_accessor :enabled
+
+      def ask_user
+        self.enabled = yes? "Will this app need to support Internet Explorer 8 (install selectivizr.js and respond.js)? [y/n]"
+      end
+
+      def enabled?
+        enabled
+      end
+    end
+  end
+end

data/lib/preseason/config.rb

@@ -0,0 +1,6 @@
+class Preseason
+  module Config
+    include Preseason::GeneratorContext
+    include Preseason::Colorize
+  end
+end

data/lib/preseason/generator_context.rb

@@ -0,0 +1,20 @@
+class Preseason
+  module GeneratorContext
+    class << self
+      attr_reader :context
+
+      def context=(context)
+        # squashes `rails new` and `bundle exec spring binstub --all` attempts
+        # to run since we run it ourselves and the timing of `rails new` obscures
+        # our custom post_install messages
+        context.define_singleton_method(:run_bundle, -> {})
+        context.define_singleton_method(:generate_spring_binstubs, -> {})
+        @context = context
+      end
+    end
+
+    def method_missing(meth, *args, &blk)
+      GeneratorContext.context.send meth, *args, &blk
+    end
+  end
+end

data/lib/preseason/recipe/active_admin.rb

@@ -0,0 +1,7 @@
+class Preseason::Recipe::ActiveAdmin < Preseason::Recipe
+  def prepare
+    return unless config.authentication.active_admin?
+
+    generate 'active_admin:install'
+  end
+end

data/lib/preseason/recipe/application.rb

@@ -0,0 +1,6 @@
+class Preseason::Recipe::Application < Preseason::Recipe
+  def prepare
+    insert_into_file 'config/application.rb', "\n    config.assets.initialize_on_precompile = false\n", :before => /^  end$/
+    insert_into_file 'config/application.rb', "    config.autoload_paths += %W(\#{config.root}/lib)", :after => /config.autoload_paths.*\n/
+  end
+end

data/lib/preseason/recipe/authlogic.rb

@@ -0,0 +1,50 @@
+class Preseason::Recipe::Authlogic < Preseason::Recipe
+  def prepare
+    return unless config.authentication.authlogic?
+
+    setup_model
+    setup_factory
+    setup_routes
+    setup_controllers
+    setup_views
+    setup_mailer
+  end
+
+  def post_install_hook
+    'POST_INSTALL' if config.authentication.authlogic?
+  end
+
+  private
+  def setup_model
+    # if you edit this, mirror your changes in the user_factory
+    generate 'model user first_name:string last_name:string email:string crypted_password:string password_salt:string persistence_token:string perishable_token:string'
+
+    insert 'app/models/user.rb', :before => /^end$/
+    mirror_file 'app/models/user_session.rb'
+  end
+
+  def setup_factory
+    mirror_file 'spec/factories/users.rb'
+  end
+
+  def setup_routes
+    insert 'config/routes.rb', :before => /^end$/
+  end
+
+  def setup_controllers
+    mirror_file 'app/controllers/user_session_controller.rb'
+    insert 'app/controllers/application_controller.rb', :after => 'protect_from_forgery'
+  end
+
+  def setup_views
+    %w(new forgot_password acquire_password).each do |file_name|
+      mirror_file "app/views/user_session/#{file_name}.html.erb"
+    end
+  end
+
+  def setup_mailer
+    generate 'mailer SiteMailer'
+    insert 'app/mailers/site_mailer.rb', :before => /^end$/
+    mirror_file 'app/views/site_mailer/password_reset_instructions.html.erb'
+  end
+end

data/lib/preseason/recipe/bundle.rb

@@ -0,0 +1,7 @@
+class Preseason::Recipe::Bundle < Preseason::Recipe
+  def prepare
+    run 'bundle install'
+    run 'bundle exec spring binstub --all'
+    run 'rake db:create'
+  end
+end

data/lib/preseason/recipe/custom_error_pages.rb

@@ -0,0 +1,30 @@
+class Preseason::Recipe::CustomErrorPages < Preseason::Recipe
+  def prepare
+    handle_errors_in_app
+    create_errors_controller
+    create_views
+    remove_default_error_pages
+  end
+
+  private
+  def handle_errors_in_app
+    insert_into_file 'config/application.rb', "\n\n    config.exceptions_app = self.routes", :after => /config.active_record.whitelist_attributes = true$/
+    insert 'config/routes.rb', :before => /^end$/
+  end
+
+  def create_errors_controller
+    generate 'controller errors --no-helper --no-assets'
+  end
+
+  def create_views
+    mirror_file 'app/views/errors/application_error.html.erb'
+    mirror_file 'app/views/errors/not_found.html.erb'
+    mirror_file 'app/views/errors/unprocessable_entity.html.erb'
+  end
+
+  def remove_default_error_pages
+    remove_file 'public/404.html'
+    remove_file 'public/422.html'
+    remove_file 'public/500.html'
+  end
+end

data/lib/preseason/recipe/database.rb

@@ -0,0 +1,28 @@
+class Preseason::Recipe::Database < Preseason::Recipe
+  def recipe_root
+    # this is only used in the sqlite context
+    "#{template_path}/sqlite"
+  end
+
+  def prepare
+    config.database.sqlite? ? prepare_sqlite : prepare_default
+    append_to_file '.gitignore', "\n#{db_yml}"
+  end
+
+  private
+  def prepare_default
+    remove_file db_yml
+    create_file "#{db_yml}.dist", parse_template("database/#{db_yml}.dist.erb")
+    create_file db_yml, parse_template("database/#{db_yml}.erb")
+  end
+
+  def prepare_sqlite
+    mirror_file db_yml
+    copy_file "#{recipe_root}/#{db_yml}", "#{db_yml}.dist"
+    append_to_file '.gitignore', db_yml
+  end
+
+  def db_yml
+    'config/database.yml'
+  end
+end