stairs 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dec9fd2bdccded9eacffcd67da756dea35293ba0
-  data.tar.gz: 84608f9052e256e3cad955b4e413ee5157e42370
+  metadata.gz: 10da079ffb8a6117c979d9c4433a9708bac58baa
+  data.tar.gz: c21c9c77a94b8b6f6c8e2dba3c746d0c0739f22b
 SHA512:
-  metadata.gz: 809edea5ecec10ba6e986985f3c2d7ed5ba9501dc00c4af81b7cebad5992e3641410bbf67fac6a1d874114de82ab8d4e0b3ff238abe19914f3ec40cfcf1274ed
-  data.tar.gz: dcd4ab32f237f0ee42ada35dfadf326c8e30e4cec8120df24581c575a4f01449256dcbc4a979bb24e42da15ccce4654a9658d3f79373f1ee960b2a1faa63eaa7
+  metadata.gz: 65567fc827aa2f8696d16c387df52bbecfe2649d8a204e1884def2c84df2df410098776a2ab6a3b8f76588fa67989a8f7d0d32556091052c36b87692438dad67
+  data.tar.gz: 13af55966c609b0e9d8295632291a807e2f7db52270cfd1f50e4db45ab2c8fde99c22ba089f396fbe36f1eb094fa204e280927266c1d32dc48ad4a322c9428ed

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 1.9.3
+  - 1.9.3
+addons:
+  code_climate:
+    repo_token: 6b9b2949be0934c1ef9c1b4db4ec1568e616d56c9c493ff470fd70dda0d96a08

data/README.md

@@ -1,12 +1,21 @@
 # Stairs
 
-It's a pain to setup new developers. Stairs is a utility and framework from
-which to write scripts for faster and easier setup of apps in new development
-environments. Scripts try to automate as much as possible and provide
-interactive prompts for everything else.
+It's a pain to set up new developers on your codebase. Stairs makes it easy.
+
+### The Problem
+
+Apps these days come with dependencies—S3, Facebook, Twitter, Zencoder, etc. We
+can stub certain things in development, but we also want to make sure we're
+developing in a realistic setting. Satisfying all of these requirements can
+really slow down onboarding time when adding new developers to your existing
+codebase.
 
-Stairs currently supports writing environment variables for rbenv-vars, RVM,
-and dotenv.
+### The Solution
+
+Every codebase should come with a script to set itself up. An interactive
+README, if you will. __Stairs__ aims to provide the tools to make writing these
+scripts fast and easy. Scripts try to automate as much as possible and provide
+interactive prompts for everything else.
 
 [![Build Status](https://travis-ci.org/patbenatar/stairs.png?branch=master)](https://travis-ci.org/patbenatar/stairs)
 [![Code Climate](https://codeclimate.com/github/patbenatar/stairs.png)](https://codeclimate.com/github/patbenatar/stairs)
@@ -62,37 +71,7 @@ rake "db:setup"
 finish "Just run rails s and sidekiq to get rolling!"
 ```
 
-### Example CLI
-
-Given the above script, the CLI might look like this.
-
-```
-$ rake newb
-Looks like you're using rbenv to manage environment variables. Is this correct? (Y/N): Y
-= Running script setup.rb
-== Running bundle
-...
-== Completed bundle
-== Running S3
-AWS access key: 39u39d9u291
-AWS secret: 19jd920i10is0i01i0s01ks0kfknkje
-Do you have an existing bucket? (Y/N): Y
-Bucket name (leave blank for app-dev): my-cool-bucket
-== Completed S3
-== Starting Zencoder
-This step is optional, would you like to perform it? (Y/N): N
-== Completed Zencoder
-== Starting Misc
-Cool check it value: w00t
-== Completed Misc
-== Running db:setup
-...
-== Completed db:setup
-== All done!
-Run rails s and sidekiq to get rolling!
-```
-
-## DSL
+[See Example CLI](#example-cli)
 
 ### Collecting values
 ```ruby
@@ -111,6 +90,8 @@ dinner = choice "Meat or vegetables?", ["Meat", "Vegetables"]
 ```
 
 ### Setting env vars
+Stairs currently supports writing environment variables for rbenv-vars, RVM, and dotenv.
+
 ```ruby
 env "NAME", value
 ```
@@ -155,15 +136,20 @@ setup :facebook, required: false
 ## Plugins for common setups
 
 ### Built-in
+
 * `:secret_token` sets a secure random secret token
+* `:postgresql` quickly setup database.yml for use with PostgreSQL
+* `:facebook` interactive prompt for setting Facebook app credentials
+
+### Available as independent gems
+
+Any plugin that has specific dependencies on third party gems is shipped
+independently to avoid maintaining those dependencies within Stairs.
 
-### Available as extension gems
 * `:s3` interactive prompt for setting AWS + S3 bucket access credentials:
   [patbenatar/stairs-steps-s3][s3]
 * `:balanced` automatically creates a test Marketplace on Balanced:
   [patbenatar/stairs-steps-balanced][balanced]
-* `:facebook` interactive prompt for setting Facebook app credentials:
-  [patbenatar/stairs-steps-facebook][facebook]
 
 ### Defining custom plugins
 
@@ -171,6 +157,37 @@ Steps inherit from `Stairs::Step` and live in `Stairs::Steps`, have a title,
 description, and implement the `run` method. See those included and in the
 various extension gems for examples.
 
+## Example CLI
+
+Given the [example script above](#defining-scripts), the CLI would look like
+this:
+
+```
+$ rake newb
+Looks like you're using rbenv to manage environment variables. Is this correct? (Y/N): Y
+= Running script setup.rb
+== Running bundle
+...
+== Completed bundle
+== Running S3
+AWS access key: 39u39d9u291
+AWS secret: 19jd920i10is0i01i0s01ks0kfknkje
+Do you have an existing bucket? (Y/N): Y
+Bucket name (leave blank for app-dev): my-cool-bucket
+== Completed S3
+== Starting Zencoder
+This step is optional, would you like to perform it? (Y/N): N
+== Completed Zencoder
+== Starting Misc
+Cool check it value: w00t
+== Completed Misc
+== Running db:setup
+...
+== Completed db:setup
+== All done!
+Run rails s and sidekiq to get rolling!
+```
+
 ## Contributing
 
 1. Fork it

data/lib/stairs/steps/facebook.rb

@@ -0,0 +1,13 @@
+module Stairs
+  module Steps
+    class Facebook < Stairs::Step
+      title "Facebook App"
+      description "Configure credentials for Facebook app"
+
+      def run
+        env "FACEBOOK_ID", provide("Facebook App ID")
+        env "FACEBOOK_SECRET", provide("Facebook App Secret")
+      end
+    end
+  end
+end

data/lib/stairs/steps/postgresql.rb

@@ -0,0 +1,63 @@
+module Stairs
+  module Steps
+    class Postgresql < Stairs::Step
+      title "PostgreSQL"
+      description "Setup database.yml for PostgreSQL"
+
+      def run
+        set_database_name
+        set_test_database_name
+        set_username
+        set_password
+
+        write contents, "config/database.yml"
+      end
+
+      private
+
+      def set_database_name
+        contents.gsub!(
+          "{{database_name}}",
+          provide("Database name", default: "#{app_name}_development"),
+        )
+      end
+
+      def set_test_database_name
+        contents.gsub!(
+          "{{test_database_name}}",
+          provide("Test database name", default: "#{app_name}_test"),
+        )
+      end
+
+      def set_username
+        contents.gsub!(
+          "{{username}}",
+          provide("User", default: `whoami`.strip),
+        )
+      end
+
+      def set_password
+        contents.gsub!(
+          "{{password}}",
+          provide("Password", default: ""),
+        )
+      end
+
+      def app_name
+        @app_name ||= Rails.application.class.parent_name.downcase
+      end
+
+      def contents
+        @contents ||= template
+      end
+
+      def template
+        File.read "#{gem_root}/templates/postgresql/database.yml"
+      end
+
+      def gem_root
+        "#{File.dirname(__FILE__)}/../../.."
+      end
+    end
+  end
+end

data/lib/stairs/steps.rb

@@ -1,5 +1,7 @@
 module Stairs
   module Steps
     autoload :SecretToken, "stairs/steps/secret_token"
+    autoload :Postgresql, "stairs/steps/postgresql"
+    autoload :Facebook, "stairs/steps/facebook"
   end
 end

data/lib/stairs/version.rb

@@ -1,3 +1,3 @@
 module Stairs
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/spec/spec_helper.rb

@@ -1,8 +1,13 @@
 require "bundler"
 Bundler.require
 
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require "stairs"
 
+require "mock_stdio"
+
 Dir["./spec/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
@@ -10,8 +15,8 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
-  config.include MockStdIO
+  config.include MockStdio
 
   config.before(:all, &:silence_output)
   config.after(:all, &:enable_output)
-end
+end

data/stairs.gemspec

@@ -28,6 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "fakefs", "~> 0.4.3"
   spec.add_development_dependency "rubocop", "~> 0.14.1"
   spec.add_development_dependency "guard-rubocop", "~> 1.0.0"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "mock_stdio", "~> 0.0.1"
 
   spec.add_dependency "activesupport", ">= 3.2.0"
   spec.add_dependency "colorize", "~> 0.6.0"

data/templates/postgresql/database.yml

@@ -0,0 +1,15 @@
+development:
+  adapter: postgresql
+  encoding: unicode
+  database: {{database_name}}
+  pool: 5
+  username: {{username}}
+  password: {{password}}
+
+test:
+  adapter: postgresql
+  encoding: unicode
+  database: {{test_database_name}}
+  pool: 5
+  username: {{username}}
+  password: {{password}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stairs
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - patbenatar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-02 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mock_stdio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -208,6 +236,8 @@ files:
 - lib/stairs/script.rb
 - lib/stairs/step.rb
 - lib/stairs/steps.rb
+- lib/stairs/steps/facebook.rb
+- lib/stairs/steps/postgresql.rb
 - lib/stairs/steps/secret_token.rb
 - lib/stairs/tasks.rb
 - lib/stairs/util.rb
@@ -226,8 +256,8 @@ files:
 - spec/lib/stairs/util/cli_spec.rb
 - spec/lib/stairs/util/file_mutation_spec.rb
 - spec/spec_helper.rb
-- spec/support/mock_stdout.rb
 - stairs.gemspec
+- templates/postgresql/database.yml
 homepage: http://github.com/patbenatar/stairs
 licenses:
 - MIT
@@ -265,4 +295,3 @@ test_files:
 - spec/lib/stairs/util/cli_spec.rb
 - spec/lib/stairs/util/file_mutation_spec.rb
 - spec/spec_helper.rb
-- spec/support/mock_stdout.rb

data/spec/support/mock_stdout.rb

@@ -1,52 +0,0 @@
-require "stringio"
-
-module MockStdIO
-  def follow_prompts(*responses, &block)
-    old_stdin = $stdin
-    old_stdout = $stdout
-
-    $stdin = StringIO.new("", "r+")
-    fake_stdout = StringIO.new
-    $stdout = fake_stdout
-
-    responses.each { |r| $stdin << "#{r}\n" }
-    $stdin.rewind
-
-    block.call
-
-    fake_stdout.string
-  ensure
-    $stdin = old_stdin
-    $stdout = old_stdout
-  end
-
-  def capture_stdout(&block)
-    old_stdout = $stdout
-
-    fake_stdout = StringIO.new
-    $stdout = fake_stdout
-
-    block.call
-
-    fake_stdout.string
-  ensure
-    $stdout = old_stdout
-  end
-
-  def silence_output
-    @orig_stderr = $stderr
-    @orig_stdout = $stdout
-
-    # redirect stderr and stdout to /dev/null
-    $stderr = File.new("/dev/null", "w")
-    $stdout = File.new("/dev/null", "w")
-  end
-
-  # Replace stdout and stderr so anything else is output correctly.
-  def enable_output
-    $stderr = @orig_stderr
-    $stdout = @orig_stdout
-    @orig_stderr = nil
-    @orig_stdout = nil
-  end
-end