bob_the_builder 0.0.0 → 0.1.0

data/README.md

@@ -0,0 +1,117 @@
+# Bob The Builder
+
+Bob The Builder is easy building and deploying applications.
+
+![Bob The Builder](http://i.imgur.com/C7GBG.jpg "Bob The Builder")
+
+## Installation
+
+This can be achieved by easily using RubyGems
+
+    $ gem install bob_the_builder
+
+## What to do after installation
+
+Once it is installed, you can configure any project by running its handy tool, called ```bobify```. It receives only one argument, and it is the location of the application's folder. If you are inside it, you just need to do:
+
+    $ bobify .
+
+This will generate a set of files, including a sample configuration YAML, and a couple sample scripts.
+
+## Configuration
+
+There should be a file called ```script/config.yml```. The main idea is that it contains a set of variables, that can be overridden per environment in different ways. The precedence order is:
+
+1. Environment variables
+2. Git configuration variables
+3. YAML variable per environment
+4. YAML global variable
+
+Configuration variables defined in the YAML can call to another variable. There's a set of needed variables, here's the basic set:
+
+```yaml
+output: builds/my_output_v{{version}}_{{date}}.o
+build_command: {{gcc}} {{input}} -o {{output}}
+changes_regexp: "(Bug Fix|Improvement)"
+gcc: /usr/bin/env gcc
+input: src/input.c
+
+github:
+  username: my_github_username
+  password: mypassword
+  repo: ivanvc/bob
+
+production:
+  server: ivanvc@ec-12.compute1.amazonaws.com:/var/www/prod
+  output: builds/output_prod.o
+daily_build:
+  server: ivanvc@ec-12.compute1.amazonaws.com:/var/www/daily
+development:
+  server: ivanvc@localhost:/Users/ivan/Sites/project
+  output: builds/output.o
+```
+
+Here are a couple of things demonstrated, a variable can request another one using a [mustache](http://mustache.github.com/) similar syntax. There are two **Magic Variables** ```date``` and ```version```. The first one is the date when the command was called, ehmmm, Today... And version is the one read from the latest git tag.
+
+Also, the variables inside each environment (development, daily_build and production) override the ones at the root.
+
+If you specify GitHub's credentials, you will be able to upload the latest version to a GitHub repo, directly to the downloads section.
+
+## Usage
+
+In order to use Bob, you need to instantiate it, and do a build, deploy, version bump, etc. Here's a sample script:
+
+```ruby
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bob_the_builder'
+include BobTheBuilder
+
+# The first argument is the environment, matches the one from the config
+# file. It also takes two optional arguments, the directory where the git
+# repo is, defaults to '.'. The last one is the branch that bob should use
+# defaults to 'master'.
+builder = Bob.new('daily_build')
+
+# We don't want the daily build if there are no changes, or if the source
+# doesn't compiles.
+if builder.changes_since_last_version? && builder.build
+  # Bump the version 'patch', 'minor' or 'major'.
+  builder.version_bump! ARGV[0]
+  builder.build
+  # Deploy to the server, and to GitHub.
+  builder.deploy
+  builder.deploy 'github'
+end
+```
+
+This is the sample for a daily building script, it can be found in the script folder, and to call it, you just need to do:
+
+    $ script/daily_build
+
+And to do a simple deploy, here's a sample script:
+
+```ruby
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bob_the_builder'
+include BobTheBuilder
+
+# The first argument is the environment, matches the one from the config
+# file. It also takes two optional arguments, the directory where the git
+# repo is, defaults to '.'. The last one is the branch that bob should use
+# defaults to 'master'.
+builder = Bob.new(ARGV[0] || 'development')
+builder.build
+# The deploy option has an optional argument, where this deploy should be
+# done. Defaults to 'server', but can be 'github'.
+builder.deploy
+```
+
+In the latter, it initializes with the passed environment, i.e. ```script/deploy production``` will deploy and build using production settings.
+
+As said before, any variable can be overridden using environment variables, let's say: ```OUTPUT=hello.o script/deploy development``` will use hello.o as the output instead of the stated in the configuration file.
+
+## License
+
+Copyright (c) 2011 Ivan Valdes (@ivanvc). See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/bin/bobify

@@ -82,13 +82,13 @@ FILE
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'bob_the_builder'
+include BobTheBuilder
 
 # The first argument is the environment, matches the one from the config
 # file. It also takes two optional arguments, the directory where the git
 # repo is, defaults to '.'. The last one is the branch that bob should use
 # defaults to 'master'.
 builder = Bob.new('daily_build')
-include BobTheBuilder
 
 # We don't want the daily build if there are no changes, or if the source
 # doesn't compiles.

data/bob_the_builder.gemspec

@@ -0,0 +1,91 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bob_the_builder}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Ivan Valdes (@ivanvc)}]
+  s.date = %q{2011-11-04}
+  s.description = %q{longer description of your gem}
+  s.email = %q{ivan@ooyala.com}
+  s.executables = [%q{bobify}]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/bobify",
+    "bob_the_builder.gemspec",
+    "lib/bob_the_builder.rb",
+    "lib/bob_the_builder/bob.rb",
+    "lib/bob_the_builder/git_hub_uploader.rb",
+    "spec/bob_the_builder_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ivanvc/bob_the_builder}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{one-line summary of your gem}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<git>, [">= 0"])
+      s.add_runtime_dependency(%q<zipruby>, [">= 0"])
+      s.add_runtime_dependency(%q<orderedhash>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<git>, [">= 0"])
+      s.add_runtime_dependency(%q<zipruby>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<git>, [">= 0"])
+      s.add_dependency(%q<zipruby>, [">= 0"])
+      s.add_dependency(%q<orderedhash>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<git>, [">= 0"])
+      s.add_dependency(%q<zipruby>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<git>, [">= 0"])
+    s.add_dependency(%q<zipruby>, [">= 0"])
+    s.add_dependency(%q<orderedhash>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<git>, [">= 0"])
+    s.add_dependency(%q<zipruby>, [">= 0"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bob_the_builder
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ivan Valdes (@ivanvc)
@@ -213,17 +213,18 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bin/bobify
+- bob_the_builder.gemspec
 - lib/bob_the_builder.rb
 - lib/bob_the_builder/bob.rb
 - lib/bob_the_builder/git_hub_uploader.rb

data/README.rdoc

@@ -1,19 +0,0 @@
-= bob_the_builder
-
-Description goes here.
-
-== Contributing to bob_the_builder
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Ivan Valdes (@ivanvc). See LICENSE.txt for
-further details.
-