stairs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33a677ee365b86ecafb40d9c1edf90ac58e1bfb2
+  data.tar.gz: 338a869ea99daa99b2169d68c50c332e5267082a
+SHA512:
+  metadata.gz: dc5721e3e681b11129b0128fbeb61b90c0e3327e6e03b65e6b4cc3769904e7d0022715ced79b38924bdd5d7d3ac79da32c43053a26213185587f01c6822db645
+  data.tar.gz: 29762a735866dd6d8b064959ef751b5a8563f12967d5113f63ee7cb5de86a7dce649aa639251f02bdeb273b8639028151b591a1f28b69950d650e5ae2c37df40

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 stairs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 patbenatar
+
+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,149 @@
+# Stairs
+
+A DSL and collection of plugins for easy setup of projects on new development
+environments.
+
+## Setup
+
+1. Install gem `stairs`
+
+1. Require tasks in Rakefile
+```ruby
+require "stairs/tasks"
+```
+
+1. Define `setup.rb` in the root of your project
+
+## Usage
+
+In an app with a `setup.rb`, just run the rake task:
+
+```
+$ rake newb
+```
+
+## Defining scripts
+
+A script composes many steps that setup a project.
+
+```ruby
+setup :secret_token
+
+setup :s3
+setup :zencoder, required: false
+
+env "CHECK_IT", provide "Cool check it value"
+
+puts "Sweet you're good to go. Just run `rails s` and `sidekiq` to get rolling!"
+```
+
+### Example CLI
+
+Given the above script, the CLI would look like this:
+
+```
+$ rake newb
+... bundle install
+... db setup + seed
+
+== Starting S3 Setup
+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
+
+== Starting Zencoder
+This step is optional, would you like to perform it? (Y/N): N
+
+== Starting misc
+Cool check it value: w00t
+
+== All done!
+Run rails s and sidekiq to get rolling!
+```
+
+## DSL
+
+### Collecting values
+```ruby
+value = provide "Something"
+value = provide "Another", required: false
+provide "More", default: "a-default"
+```
+
+### Asking questions
+```ruby
+i_should = choice "Should I?"
+choice "Should I?" do |yes|
+  do_something if yes
+end
+dinner = choice "Meat or vegetables?", ["Meat", "Vegetables"]
+```
+
+### Setting env vars
+```ruby
+env "NAME", value
+```
+
+### Writing files
+```ruby
+write "awesome: true", "config/settings.yml"
+write_line "more: false", "config/settings.yml"
+```
+
+### Defining setup steps
+```ruby
+setup :a_cool_service do
+  ## ..
+end
+```
+
+#### Using predefined steps
+```ruby
+setup :s3
+```
+
+## Plugins for common setups
+
+```ruby
+require "fog"
+class S3Setup < Stairs::Step
+  title "S3"
+  description "Setup AWS tokens and bucket"
+
+  def run
+    @key = provide "AWS access key"
+    @secret = provide "AWS secret"
+
+    choice "Do you have an existing bucket?" do |yes|
+      env "S3_BUCKET", if yes
+        provide "Bucket name", default: "app-dev"
+      else
+        create_bucket
+      end
+    end
+
+    env "AWS_ACCESS_KEY", @key
+    env "AWS_SECRET", @secret
+  end
+
+  private
+
+  def create_bucket
+    # use @key and @secret to create bucket via API
+  end
+end
+```
+
+## To think about...
+
+* How to manage gem dependencies (S3Setup for example requires fog to be
+  installed)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/stairs/script.rb

@@ -0,0 +1,21 @@
+module Stairs
+  class Script
+    def initialize(filename)
+      @filename = filename
+      @script = File.read(@filename)
+    end
+
+    def run!
+      puts "= Running script #{filename}"
+      run
+    end
+
+    def run
+      Step.new.instance_eval(script)
+    end
+
+    private
+
+    attr_reader :script, :filename
+  end
+end

data/lib/stairs/step.rb

@@ -0,0 +1,88 @@
+require "highline/import"
+
+module Stairs
+  class Step
+    def run!
+      puts "== Running #{self.class.title}"
+      run
+    end
+
+    private
+
+    class_attribute :title, :description
+
+    def self.title(title)
+      self.title = title
+    end
+
+    def self.description(description)
+      self.description = description
+    end
+
+    # Prompt user to provide input
+    def provide(prompt, options={})
+      options.reverse_merge! required: true, default: nil
+      required = options[:required] && !options[:default]
+
+      prompt << " (leave blank for #{options[:default]})" if options[:default]
+      prompt << ": "
+
+      response = ask(prompt) { |q| q.validate = /\S+/ if required }
+      response.present? ? response : options[:default]
+    end
+
+    # Prompt user to make a choice
+    # TODO shouldn't care about case
+    def choice(question, choices=["Y", "N"])
+      prompt = "#{question} (#{choices.join("/")}): "
+      response = ask(prompt) { |q| q.in = choices }
+
+      case response
+      when "Y"
+        response = true
+      when "N"
+        response = false
+      end
+
+      yield response if block_given?
+      response
+    end
+
+    # Set or update env var in .rbenv-vars
+    def env(name, value)
+      string = "#{name}=#{value}"
+
+      if File.exists? ".rbenv-vars"
+        contents = File.read ".rbenv-vars"
+        regexp = Regexp.new "^#{name}=(.*)$"
+        if contents.index regexp
+          contents.sub! regexp, string
+          write contents, ".rbenv-vars"
+          return
+        end
+      end
+
+      write_line string, ".rbenv-vars"
+    end
+
+    # Replace contents of file
+    def write(string, filename)
+      File.truncate filename, 0 if File.exists? filename
+      write_line string, filename
+    end
+
+    # Append line to file
+    def write_line(string, filename)
+      File.open filename, "a" do |file|
+        file.puts string
+      end
+    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!
+    end
+  end
+end

data/lib/stairs/steps/s3.rb

@@ -0,0 +1,14 @@
+module Stairs
+  module Steps
+    class S3 < Step
+      title "S3"
+      description "Setup AWS and S3 bucket access"
+
+      def run
+        env "AWS_ACCESS_KEY_ID", provide("AWS Access Key ID")
+        env "AWS_SECRET_ACCESS_KEY", provide("AWS Secret Access Key")
+        env "AWS_S3_BUCKET", provide("S3 Bucket name")
+      end
+    end
+  end
+end

data/lib/stairs/steps/secret_token.rb

@@ -0,0 +1,14 @@
+require "securerandom"
+
+module Stairs
+  module Steps
+    class SecretToken < Step
+      title "Secret Token"
+      description "Generate a secure random secret token"
+
+      def run
+        env "SECRET_TOKEN", SecureRandom.hex(64)
+      end
+    end
+  end
+end

data/lib/stairs/steps.rb

@@ -0,0 +1,6 @@
+module Stairs
+  module Steps
+    autoload :SecretToken, "stairs/steps/secret_token"
+    autoload :S3, "stairs/steps/s3"
+  end
+end

data/lib/stairs/tasks.rb

@@ -0,0 +1,16 @@
+require "stairs"
+
+module Stairs
+  class Tasks
+    include Rake::DSL
+
+    def install!
+      desc "Setup the project"
+      task :newb do
+        Stairs::Script.new("setup.rb").run!
+      end
+    end
+  end
+end
+
+Stairs::Tasks.new.install!

data/lib/stairs/version.rb

@@ -0,0 +1,3 @@
+module Stairs
+  VERSION = "0.0.1"
+end

data/lib/stairs.rb

@@ -0,0 +1,8 @@
+require "stairs/version"
+require "active_support/core_ext"
+
+module Stairs
+  autoload :Step, "stairs/step"
+  autoload :Script, "stairs/script"
+  autoload :Steps, "stairs/steps"
+end

data/stairs.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stairs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stairs"
+  spec.version       = Stairs::VERSION
+  spec.authors       = ["patbenatar"]
+  spec.email         = ["nick@gophilosophie.com"]
+  spec.description   = "A DSL and collection of plugins for easy setup of projects on new development environments."
+  spec.summary       = "A DSL and collection of plugins for easy setup of projects on new development environments."
+  spec.homepage      = "http://github.com/patbenatar/stairs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "highline", "~> 1.6.20"
+  spec.add_dependency "activesupport", "> 3.2.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: stairs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- patbenatar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.20
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: A DSL and collection of plugins for easy setup of projects on new development
+  environments.
+email:
+- nick@gophilosophie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stairs.rb
+- lib/stairs/script.rb
+- lib/stairs/step.rb
+- lib/stairs/steps.rb
+- lib/stairs/steps/s3.rb
+- lib/stairs/steps/secret_token.rb
+- lib/stairs/tasks.rb
+- lib/stairs/version.rb
+- stairs.gemspec
+homepage: http://github.com/patbenatar/stairs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A DSL and collection of plugins for easy setup of projects on new development
+  environments.
+test_files: []