stairs 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f617dda7fd3f43d796cde18e6cd509b7556ea2f4
-  data.tar.gz: 8e2926466d8c307a8dbcd9be9a5a320e320495c5
+  metadata.gz: 7065dce0f1a914961380b69ee67aeab6ca1a3633
+  data.tar.gz: b9adf5378fc447b10dd8a4cb9e349b2d56faff3d
 SHA512:
-  metadata.gz: eb0910186b1a3886ecff848942bb6c119cc58f7017fc74b0720ccf142aa0495eba3a0ba3461de3d9af65276fc3272da90b6d769067bc299b8525e35efe0ad9e2
-  data.tar.gz: fc18be8d140dbd7c1c1b07d3252f3b7a389e0826d855693120b86c6edc30a7fdb424a3fb9ab1f8d449eaa79aa59a5554bbdffc99eb1a2201066c3f1f08081978
+  metadata.gz: 8838ad2217b046c6fcc40fa578df6ce8e6b282d1752224d76aab26ee437e08e72dc0b5d02af85cfddca0c9f103eedc4aebf907429928dd6c05ac94bc7d8b5cfc
+  data.tar.gz: f6ba56450cf0aafb9156f0ca625eadf3d3c4fa8374b6a25e3ea8a23489b5a932c6949b5c18a48062eb666c7df25a35e0e7218fd0429d7b863149ebb91881e281

data/README.md

@@ -30,14 +30,20 @@ A script composes many steps that setup a project. __Note:__ optional steps are
 not yet implemented.
 
 ```ruby
+bundle
+
 setup :secret_token
 
 setup :s3
 setup :zencoder, required: false
 
-env "CHECK_IT", provide "Cool check it value"
+setup :misc do
+  env "CHECK_IT", provide "Cool check it value"
+end
+
+rake "db:setup"
 
-puts "Sweet you're good to go. Just run `rails s` and `sidekiq` to get rolling!"
+finish "Just run rails s and sidekiq to get rolling!"
 ```
 
 ### Example CLI
@@ -47,20 +53,32 @@ is desired future functionality (bundle/db tasks, spacing, last words).
 
 ```
 $ rake newb
-... bundle install
-... db setup + seed
+Looks like you're using rbenv to manage environment variables. Is this correct? (Y/N): Y
+
+= Running script setup.rb
+
+== Running bundle
+...
+== Completed bundle
 
-== Starting S3 Setup
+== 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
+== 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!
@@ -95,14 +113,28 @@ write "awesome: true", "config/settings.yml"
 write_line "more: false", "config/settings.yml"
 ```
 
-### Defining setup steps
+### Misc helpers
 
-__Note:__ this block syntax is not yet implemented, use predefined steps for
-now.
+Run bundle to install gems
+```ruby
+bundle
+```
+
+Run rake tasks
+```ruby
+rake "task_name"
+```
+
+Display a message when setup completes
+```ruby
+finish "Now that you're done, go have a drink!"
+```
+
+### Defining setup steps
 
 ```ruby
 setup :a_cool_service do
-  ## ..
+  # ...
 end
 ```
 

data/lib/stairs/script.rb

@@ -6,7 +6,7 @@ module Stairs
     end
 
     def run!
-      puts "= Running script #{filename}"
+      puts "= Running script #{filename}".light_black
       run
     end
 

data/lib/stairs/step.rb

@@ -3,20 +3,31 @@ require "highline/import"
 module Stairs
   class Step
     def run!
-      puts "== Running #{self.class.title}"
+      stairs_info "== Running #{step_title}"
       run
+      stairs_info "== Completed #{step_title}"
     end
 
+    attr_writer :step_title, :step_description
+
     private
 
-    class_attribute :title, :description
+    class_attribute :step_title, :step_description
 
     def self.title(title)
-      self.title = title
+      self.step_title = title
     end
 
     def self.description(description)
-      self.description = description
+      self.step_description = description
+    end
+
+    def step_title
+      @step_title || self.class.step_title
+    end
+
+    def step_description
+      @step_description || self.class.step_description
     end
 
     # Prompt user to provide input
@@ -27,7 +38,7 @@ module Stairs
       prompt << " (leave blank for #{options[:default]})" if options[:default]
       prompt << ": "
 
-      response = ask(prompt) { |q| q.validate = /\S+/ if required }
+      response = ask(prompt.blue) { |q| q.validate = /\S+/ if required }
       response.present? ? response : options[:default]
     end
 
@@ -35,7 +46,7 @@ module Stairs
     # TODO shouldn't care about case
     def choice(question, choices=["Y", "N"])
       prompt = "#{question} (#{choices.join("/")}): "
-      response = ask(prompt) { |q| q.in = choices }
+      response = ask(prompt.blue) { |q| q.in = choices }
 
       case response
       when "Y"
@@ -48,7 +59,19 @@ module Stairs
       response
     end
 
-    # Set or update env var in .rbenv-vars
+    def bundle
+      stairs_info "== Running bundle"
+      system "bundle"
+      stairs_info "== Completed bundle"
+    end
+
+    def rake(task)
+      stairs_info "== Running #{task}"
+      system "rake #{task}"
+      stairs_info "== Completed #{task}"
+    end
+
+    # Set or update env var
     def env(name, value)
       Stairs.configuration.env_adapter.set name, value
     end
@@ -64,10 +87,27 @@ module Stairs
     end
 
     # Embed a step where step_name is a symbol that can be resolved to a class
-    # in Stairs::Steps
-    def setup(step_name)
-      klass = "Stairs::Steps::#{step_name.to_s.camelize}".constantize
-      klass.new.run!
+    # in Stairs::Steps or a block is provided to be executed in an instance
+    # of Step
+    def setup(step_name, &block)
+      if block_given?
+        Step.new.tap do |step|
+          step.define_singleton_method :run, &block
+          step.step_title = step_name.to_s.titleize
+        end.run!
+      else
+        klass = "Stairs::Steps::#{step_name.to_s.camelize}".constantize
+        klass.new.run!
+      end
+    end
+
+    def finish(message)
+      puts "== All done!".green
+      puts message.green
+    end
+
+    def stairs_info(message)
+      puts message.light_black
     end
   end
 end

data/lib/stairs/version.rb

@@ -1,3 +1,3 @@
 module Stairs
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/stairs.rb

@@ -1,5 +1,6 @@
 require "stairs/version"
 require "active_support/core_ext"
+require "colorize"
 
 module Stairs
   autoload :Step, "stairs/step"

data/stairs.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "highline", "~> 1.6.20"
   spec.add_dependency "activesupport", ">= 3.2.0"
+  spec.add_dependency "colorize", "~> 0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stairs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - patbenatar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: A DSL and collection of plugins for easy setup of projects on new development
   environments.
 email: