prop_up 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa06a9843fd70391c6eeea5bc6ec6367bc542022
+  data.tar.gz: ff82e6f19d3ac2edd571e890655e30fcb4ca3e62
+SHA512:
+  metadata.gz: 696346f3d82eccefc517e29a0f85ab92ffeb4fa92d94b8432681472b25832d8ad9517f70142134b0a5653eb7f1e8806096cb64da9d361b2dc13646a75b0999f1
+  data.tar.gz: fd292bad7f6f5628ce8d3ff38cc203cde376c95069a0ca81b22e45304caeefb561a42ef1d7cb9a17681b4bf4fce1014b40183ab97033e5c4383db5d4bedca230

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nathaniel Wroblewski
+
+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,228 @@
+Prop
+===
+![Peg Leg Bates Photo](https://raw.github.com/NathanielWroblewski/prop/master/app/assets/images/peg-leg-bates.jpg)
+
+Description
+---
+Prop is a Rails 4 app generator with customized defaults and an opinionated workflow.
+
+Installation
+---
+First, install [hub](https://github.com/github/hub) if you don't have it.
+```bash
+brew install hub
+```
+Install Prop.
+```bash
+gem install prop
+```
+Let Prop prop your app up.
+```bash
+prop up <my-app-name>
+```
+Get all up inside your new app.
+```bash
+cd <my-app-name>
+```
+Open four tabs in your terminal.  In the first, start [zeus](https://github.com/burke/zeus).
+```bash
+zeus start
+```
+Zeus pre-loads your Rails app making specs, rake tasks, and generators run much faster.  Common tasks run through zeus include:
+```bash
+zeus g migration <name of migration>
+zeus d migration <name of migration>
+zeus rake db:create
+zeus rake db:migrate
+zeus rake db:test:prepare
+zeus c
+zeus s
+```
+In general, anything that would normally be `rails blah` is now `zeus blah`, and anything that would be `rake blah` is now `zeus rake blah`.  Ctrl+c will exit.
+
+In the next tab, start the zeus server.
+```bash
+zeus s
+```
+Use Ctrl+c to exit.
+
+In the third tab, run [guard](https://github.com/guard/guard).
+```bash
+guard
+```
+Guard watches your spec files so that anytime you make a change, your specs will run.  You can also hit your enter/return key to run all your specs.  `exit` will exit guard.
+
+I use the final tab as my normal terminal window/git branching/for entering `zeus c` when necessary.
+
+Finally, create your database.
+
+```bash
+zeus rake db:create
+```
+
+Workflow
+---
+At a high level, have a `production` branch, a `master` branch for staging, and your development branches which are prefixed with your initials.  Use continuous integration/continuous deployment so that when you push to master, your tests are run and your app is deployed to staging.  When you push to production, your tests are run and the app is deployed to production.  Rollbar is used to monitor errors, and Codeship is used for CI.  The following git practices were inspired by [Thoughtbot](http://www.thoughtbot.com/)'s [protocol](https://github.com/thoughtbot/guides/tree/master/protocol).
+
+1. Start a story in Pivotal Tracker (http://www.pivotaltracker.com) by clicking the 'start' button of a story assigned to you.
+
+2. Create a new branch with
+```bash
+$ git checkout -b <your initials>-<name of branch>
+```
+  For example:
+```bash
+$ git checkout -b nw-promo-codes
+```
+
+3. After changing files, stage your changes
+```bash
+$ git status
+$ git add <changed file>
+```
+
+4. Commit your changes with a commit message that is under 80 characters
+```bash
+$ git commit -m '<commit message>'
+```
+
+5. If you have multiple, smaller commits that could be grouped into a larger commit, check the log to see how many commits you need to group together and then rebase them.
+```bash
+$ git log
+$ git rebase -i HEAD~<the number of commits to be rebased>
+```
+  For example:
+```bash
+$ git rebase -i HEAD~3
+```
+
+  Note: The syntax is HEAD followed by a tilde (~) not a dash (-)
+
+  You will receive a message like this:
+```bash
+pick 95f08f0 <commit message>
+pick 09d7d95 <commit message>
+pick c86dd4e <commit message>
+# Rebase 665d9f8..c86dd4e onto 665d9f8
+#
+# Commands:
+#  p, pick = use commit
+#  r, reword = use commit, but edit the commit message
+#  e, edit = use commit, but stop for amending
+#  s, squash = use commit, but meld into previous commit
+#  f, fixup = like "squash", but discard this commit's log message
+#  x, exec = run command (the rest of the line) using shell
+```
+
+  Change the 'pick' to the appropriate command.  In general, the top commit will receive an 'r' while the following commits will be fixed up with an 'f':
+```bash
+r 95f08f0 <commit message>
+f 09d7d95 <commit message>
+f c86dd4e <commit message>
+# Rebase 665d9f8..c86dd4e onto 665d9f8
+#
+# Commands:
+#  p, pick = use commit
+#  r, reword = use commit, but edit the commit message
+#  e, edit = use commit, but stop for amending
+#  s, squash = use commit, but meld into previous commit
+#  f, fixup = like "squash", but discard this commit's log message
+#  x, exec = run command (the rest of the line) using shell
+```
+
+  You will then be prompted to rename the commit message.  The commit message should be assigned the Pivotal Tracker story id, followed by an 80 character commit message title, and an optional '*' delimited log of more detailed changes.
+
+  Generally, it should follow the form:
+  
+  ```
+  [#<Pivotal Tracker Story ID>] <80-character commit message>
+  
+  * <detailed commit message>
+  * <detailed commit message>
+  ```
+
+  For example:
+  ```
+  [#12345678] Added a new kit page
+  
+  * Generated a new kit controller
+  * Generated a new kit migration
+  ...
+  ```
+
+6. If you have not yet pushed, or you didn't squash any commits or otherwise change history, you can leave off the `-f` flag on the following push.  Otherwise, the branch you are working on should then be force pushed to change history.  Then, open a pull request.
+```bash
+$ git branch
+$ git push origin <branch name> -f
+```
+
+  For example:
+
+  ```bash
+  $ git push origin nw-promo-codes -f
+  ```
+
+  A pull request can be made by visiting your github repo, selecting your branch name from the drop down, selecting the pull request icon, and then selecting the button to make a pull request.
+
+7.  When your pull request has been accepted, you should be sure to fetch the lastest master, and rebase master under your latest commit.  Then force push to your branch to change history.
+```bash
+$ git fetch
+$ git rebase origin/master
+$ git push origin <name of branch> -f
+```
+
+  If you have conflicts, be sure to continue the rebase after resolving the conflicts.  Do not commit.
+  ```bash
+  $ git status
+  $ git add <file after resolving conflicts>
+  $ git rebase --continue
+  ```
+
+8. Then, checkout master, pull the latest changes, and merge your branch into master only if there will not be a merge conflict.
+```bash
+$ git checkout master
+$ git pull origin master
+$ git merge <name of branch> --ff-only
+```
+  For example:
+  ```bash
+  $ git merge nw-promo-codes --ff-only
+  ```
+
+9. Now push your changes and delete your branch locally and remotely.
+```bash
+$ git push origin master
+$ git branch -d <name of branch>
+$ git push origin :<name of branch>
+```
+  For example:
+```bash
+$ git branch -d nw-promo-codes
+$ git push origin :nw-promo-codes
+```
+
+10. Mark your story in Pivotal Tracker as finished.
+
+11. Once codeship has verified the tests pass, checkout your changes on staging on Heroku.
+
+12.  If your changes have been tested on staging, mark your story as delivered in Pivotal.
+
+13.  Once your story has been accepted and if it is time to push to production, checkout the production branch, merge master into it, and push your changes.
+```bash
+$ git checkout production
+$ git merge master --ff-only
+$ git push origin production
+```
+
+14.  Once codeship has verified the tests pass, checkout your changes at on production.  Monitor rollbar for any errors that may be occurring.
+
+TODO
+====
+
+* Automate the opening of the iTerm tabs and run the scripts inside those tabs (starting zeus, guard, server)
+* Add Devise
+* Add a Google Maps map and a Leaflet map
+* Add Figaro
+* Add Google Places library
+* Add Backbone
+* Add spec generation

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'

data/bin/prop

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join('..', 'lib', 'prop', 'generators', 'app_generator'), File.dirname(__FILE__))
+require File.expand_path(File.join('..', 'lib', 'prop', 'actions'), File.dirname(__FILE__))
+require File.expand_path(File.join('..', 'lib', 'prop', 'app_builder'), File.dirname(__FILE__))
+
+if 'up' == ARGV[0]
+  ARGV.shift
+  templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+  Prop::AppGenerator.source_root templates_root
+  Prop::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+  Prop::AppGenerator.start
+end

data/lib/prop/actions.rb

@@ -0,0 +1,40 @@
+module Prop
+  module Actions
+    def concat_file(source, destination)
+      contents = IO.read(find_in_source_paths(source))
+      append_file(destination, contents)
+    end
+
+    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
+
+    def download_file(uri_string, destination)
+      uri = URI.parse(uri_string)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri_string =~ /^https/
+      request = Net::HTTP::Get.new(uri.path)
+      contents = http.request(request).body
+      path = File.join(destination_root, destination)
+      File.open(path, 'w') { |file| file.write(contents) }
+    end
+  end
+end

data/lib/prop/app_builder.rb

@@ -0,0 +1,334 @@
+module Prop
+  class AppBuilder < Rails::AppBuilder
+    include Prop::Actions
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def remove_public_index
+      remove_file 'public/index.html'
+    end
+
+    def remove_rails_logo_image
+      remove_file 'app/assets/images/rails.png'
+    end
+
+    def raise_on_delivery_errors
+      replace_in_file 'config/environments/development.rb',
+        'raise_delivery_errors = false', 'raise_delivery_errors = true'
+    end
+
+    def raise_on_unpermitted_parameters
+      configure_environment 'development',
+        'config.action_controller.action_on_unpermitted_parameters = :raise'
+    end
+
+    def provide_setup_script
+      copy_file 'bin_setup', 'bin/setup'
+      run 'chmod a+x bin/setup'
+    end
+
+    def configure_generators
+      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
+    end
+
+    def enable_factory_girl_syntax
+      copy_file 'factory_girl_syntax_rspec.rb', 'spec/support/factory_girl.rb'
+    end
+
+    def test_factories_first
+      copy_file 'factories_spec.rb', 'spec/models/factories_spec.rb'
+      append_file 'Rakefile', factories_spec_rake_task
+    end
+
+    def configure_smtp
+      copy_file 'smtp.rb', 'config/initializers/smtp.rb'
+
+      prepend_file 'config/environments/production.rb',
+        "require Rails.root.join('config/initializers/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'
+    end
+
+    def setup_staging_environment
+      run 'cp config/environments/production.rb config/environments/staging.rb'
+
+      prepend_file 'config/environments/staging.rb',
+        "Mail.register_interceptor RecipientInterceptor.new(ENV['EMAIL_RECIPIENTS'])\n"
+    end
+
+    def create_partials_directory
+      empty_directory 'app/views/application'
+    end
+
+    def create_shared_flashes
+      copy_file '_flashes.html.erb', 'app/views/application/_flashes.html.erb'
+    end
+
+    def create_shared_javascripts
+      copy_file '_javascript.html.erb', 'app/views/application/_javascript.html.erb'
+    end
+
+    def create_application_layout
+      template 'prop_layout.html.erb.erb',
+        'app/views/layouts/application.html.erb',
+        :force => true
+    end
+
+    def remove_turbolinks
+      replace_in_file 'app/assets/javascripts/application.js',
+        /\/\/= require turbolinks\n/,
+        ''
+    end
+
+    def create_common_javascripts
+      directory 'javascripts', 'app/assets/javascripts'
+    end
+
+    def use_postgres_config_template
+      template 'postgresql_database.yml.erb', 'config/database.yml',
+        :force => true
+    end
+
+    def create_database
+      begin
+        bundle_command 'exec rake db:create'
+      rescue
+        run 'pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start'
+        bundle_command 'exec rake db:create'
+      end
+    end
+
+    def replace_gemfile
+      remove_file 'Gemfile'
+      copy_file 'Gemfile_clean', 'Gemfile'
+    end
+
+    def set_ruby_to_version_being_used
+      inject_into_file 'Gemfile', "\n\nruby '#{RUBY_VERSION}'",
+        after: /source 'https:\/\/rubygems.org'/
+    end
+
+    def enable_database_cleaner
+      copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
+    end
+
+    def configure_rspec
+      remove_file 'spec/spec_helper.rb'
+      copy_file 'spec_helper.rb', 'spec/spec_helper.rb'
+    end
+
+    def use_rspec_binstub
+      run 'bundle binstub rspec-core'
+      run 'rm bin/autospec'
+    end
+
+    def configure_background_jobs_for_rspec
+      copy_file 'background_jobs_rspec.rb', 'spec/support/background_jobs.rb'
+      run 'rails g delayed_job:active_record'
+    end
+
+    def configure_time_zone
+      config = <<-RUBY
+    config.active_record.default_timezone = :utc
+
+      RUBY
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def configure_time_formats
+      remove_file 'config/locales/en.yml'
+      copy_file 'config_locales_en.yml', 'config/locales/en.yml'
+    end
+
+    def configure_rack_timeout
+      copy_file 'rack_timeout.rb', 'config/initializers/rack_timeout.rb'
+    end
+
+    def configure_action_mailer
+      action_mailer_host 'development', "#{app_name}.local"
+      action_mailer_host 'test', 'www.example.com'
+      action_mailer_host 'staging', "staging.#{app_name}.com"
+      action_mailer_host 'production', "#{app_name}.com"
+    end
+
+    def generate_rspec
+      generate 'rspec:install'
+    end
+
+    def generate_clearance
+      generate 'clearance:install'
+    end
+
+    def configure_unicorn
+      copy_file 'unicorn.rb', 'config/unicorn.rb'
+    end
+
+    def setup_foreman
+      copy_file 'sample.env', '.sample.env'
+      copy_file 'Procfile', 'Procfile'
+    end
+
+    def setup_stylesheets
+      remove_file 'app/assets/stylesheets/application.css'
+      copy_file 'application.css.scss',
+        'app/assets/stylesheets/application.css.scss'
+    end
+
+    def setup_guardfile
+      copy_file 'Guardfile', 'Guardfile'
+    end
+
+    def init_zeus
+      run 'zeus init'
+    end
+
+    def gitignore_files
+      remove_file '.gitignore'
+      copy_file 'prop_gitignore', '.gitignore'
+      [
+        'app/views/pages',
+        'spec/lib',
+        'spec/controllers',
+        'spec/helpers',
+        'spec/support/matchers',
+        'spec/support/mixins',
+        'spec/support/shared_examples'
+      ].each do |dir|
+        run "mkdir #{dir}"
+        run "touch #{dir}/.keep"
+      end
+    end
+
+    def init_git
+      run 'git init'
+    end
+
+    def create_heroku_apps
+      path_addition = override_path_for_tests
+      run "#{path_addition} heroku create #{app_name}-production --remote=production"
+      run "#{path_addition} heroku create #{app_name}-staging --remote=staging"
+      run "#{path_addition} heroku config:add RACK_ENV=staging RAILS_ENV=staging --remote=staging"
+    end
+
+    def set_heroku_remotes
+      begin
+        concat_file(
+          'templates/bin_setup',
+          "# Set up staging and production git remotes\r
+          git remote add staging git@heroku.com: #{app_name}-staging.git\r
+          git remote add production git@heroku.com: #{app_name}-production.git"
+        )
+      rescue
+      end
+    end
+
+    def create_github_repo(repo_name)
+      path_addition = override_path_for_tests
+      run "#{path_addition} hub create #{repo_name}"
+    end
+
+    def copy_miscellaneous_files
+      copy_file 'errors.rb', 'config/initializers/errors.rb'
+    end
+
+    def customize_error_pages
+      meta_tags =<<-EOS
+  <meta charset='utf-8' />
+  <meta name='ROBOTS' content='NOODP' />
+      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_routes_comment_lines
+      replace_in_file 'config/routes.rb',
+        /Application\.routes\.draw do.*end/m,
+        "Application.routes.draw do\nend"
+    end
+
+    def disable_xml_params
+      copy_file 'disable_xml_params.rb', 'config/initializers/disable_xml_params.rb'
+    end
+
+    def setup_default_rake_task
+      append_file 'Rakefile' do
+        "task(:default).clear\ntask :default => [:spec]\n"
+      end
+    end
+
+    def open_tab
+      run 'PWD = pwd'
+      run 'launch () {
+        /usr/bin/osascript <<-EOF
+        tell application "iTerm"
+            make new terminal
+            tell the current terminal
+                activate current session
+                launch session "Default Session"
+                tell the last session
+                    write text "cd $PWD"
+                end tell
+            end tell
+        end tell
+        EOF
+        }'
+    end
+
+    def start_zeus
+      run 'PWD = pwd'
+      run 'launch () {
+        /usr/bin/osascript <<-EOF
+        tell application "iTerm"
+            make new terminal
+            tell the current terminal
+                activate current session
+                launch session "Default Session"
+                tell the last session
+                    write text "cd $PWD"
+                    write text "zeus start"
+                end tell
+            end tell
+        end tell
+        EOF
+        }'
+      run 'launch'
+    end
+
+    private
+
+    def override_path_for_tests
+      if ENV['TESTING']
+        support_bin = File.expand_path(File.join('..', '..', '..', 'features', 'support', 'bin'))
+        "PATH=#{support_bin}:$PATH"
+      end
+    end
+
+    def factories_spec_rake_task
+      IO.read find_in_source_paths('factories_spec_rake_task.rb')
+    end
+  end
+end