oak 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'rdoc', "~> 3.11"
+end
+
+gem 'thor', "~> 0.14.6"
+

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    rake (0.9.2)
+    rcov (0.9.11)
+    rdoc (3.11)
+      json (~> 1.4)
+    shoulda (2.11.3)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rdoc (~> 3.11)
+  shoulda
+  thor (~> 0.14.6)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Huang Wei
+
+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,34 @@
+## oak
+
+Oak is a very simple tool that assists making rails application Open Source ready.
+
+**ONLY WORKS ON MAC OS X AND LINUX/BSD**
+
+When pushlishing your rails app to a public repository, it is often neccessary to find a way protecting you secret token and other private information. 
+
+Oak helps you on these tasks by running 
+
+    oak setup
+
+Then your private information will be stored in a file called 'config.yml', and automaticly ignored by git master branch. And on another branch named 'deploy' (which won't be pushed to the public repository) the config.yml file is included.
+So you can modify your apps on master branch as usual, and call
+
+    git push <production_repo> deploy:master
+    
+to push your local deploy branch to your production repository's master branch.
+
+## Contributing to oak
+ 
+* 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 Huang Wei. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "oak"
+  gem.homepage = "http://github.com/imonyse/oak"
+  gem.license = "MIT"
+  gem.summary = %Q{Oak is a tool that helps making your newly created rails app open source ready.}
+  gem.description = %Q{When pushing your rails app to a public repository, it is often neccessary to find a way protecting you secret token and other private information. Oak helps you on these tasks and assumes you use git as the version control system}
+  gem.email = "imonyse@gmail.com"
+  gem.authors = ["Huang Wei"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "oak #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/oak

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'oak'
+
+Oak.start

data/lib/oak.rb

@@ -0,0 +1,122 @@
+require 'thor'
+
+class Oak < Thor
+  include Thor::Actions
+  attr_reader :secret_token
+
+  desc "setup oak", "Set current rails app source open ready"
+  def setup(working_directory = '.')
+    self.destination_root = working_directory
+    FileUtils.chdir destination_root do
+      check_cfg
+      dummy_config 
+      git_prepare
+      create_config_on_deploy
+      commit_deploy_branch
+    end
+  end
+
+  no_tasks do
+
+    def check_cfg
+      ['config/application.rb', '.gitignore'].each do |f|
+        if !File.exists? f
+          raise "#{f} not found, are we at the root directory of a rails app?"
+        end
+      end
+
+      # make 'config/database.yml' globally ignored
+      global_ignore_file = File.expand_path('~/.gitignore')
+      if File.exist? global_ignore_file
+        ignored = File.binread global_ignore_file
+        if !ignored.include?('config/database.yml')
+          append_to_file(global_ignore_file, 'config/database.yml')
+        end
+      else
+        File.open(global_ignore_file, 'w') do |f|
+          f.write 'config/database.yml'
+        end
+      end
+      `git config --global core.excludesfile ~/.gitignore`
+
+      # append config/config.yml to .gitignore if not already in 
+      File.open('.gitignore') do |f|
+        f.each_line do |l|
+          if l == 'config/config.yml'
+            return
+          end
+        end
+      end
+
+      append_to_file '.gitignore', 'config/config.yml'
+
+      # protect secret_token 
+      full_text = File.binread 'config/initializers/secret_token.rb'
+      full_text.gsub! /(Application\.config\.secret_token\s=\s)'(.*)'/, '\1APP_CONFIG[\'secret_token\']'
+      # save per app secret_token for later use 
+      @secret_token = "#{$2}"
+      File.open('config/initializers/secret_token.rb', 'w') do |f|
+        f.write full_text
+      end
+    end
+
+    def dummy_config
+      File.open('config/config.example.yml', 'w') do |f|
+        f.write "secret_token = 'c1cae0f52a3ef8efa369a127c63bd6ede539a4089fd952b33199100a6769c8455ab4969f2eefaf1ebcbe0208bd57531204c77f41f715207f961e7e45f139f4e7'"
+      end
+      prepend_to_file 'config/application.rb', "require 'yaml'\nAPP_CONFIG = YAML.load(File.read(File.expand_path('../config.yml', __FILE__)))\n"
+
+      # simply copy database.yml to database.example.yml
+      File.open('config/database.example.yml', 'w') do |f|
+        File.open('config/database.yml', 'r') do |o|
+          f.write o.read
+        end
+      end
+    end
+
+    def git_prepare
+      if File.exists? '.git'
+        puts 'It seems a git repository has already created, I\'ll leave it untouched.'
+        return
+      end
+
+      `git init && git add . && git commit -m "init"`
+      `git checkout -b deploy`
+    end
+
+    def create_config_on_deploy
+      File.open('config/config.yml', 'w') do |f|
+        f.write 'secret_token = ' + secret_token
+      end
+
+      # remove 'config/config.yml' from .gitignore on deploy branch
+      ignored = File.binread('.gitignore')
+      ignored.gsub! /config\/config.yml/, ''
+      File.open('.gitignore', 'w') do |f|
+        f.write ignored
+      end
+
+      # add checkout hook for switching from 'deploy' to 'master'
+      File.open('.git/hooks/post-checkout', 'w') do |f|
+        f.write <<-EOS
+#!/bin/bash
+
+branch_name=$(git symbolic-ref -q HEAD)
+branch_name=${branch_name##refs/heads/}
+
+if [ "$branch_name" = master -a -e "config/config.example.yml" ]; then
+  cp config/config.example.yml config/config.yml
+  echo "cp config/config.example.yml config/config.yml"
+fi
+        EOS
+      end
+      `chmod +x .git/hooks/post-checkout`
+    end
+    
+    def commit_deploy_branch
+      # commit deploy branch
+      `git add . && git commit -m "deploy setup"`
+      `git checkout master`
+    end
+  end
+end

data/oak.gemspec

@@ -0,0 +1,71 @@
+# 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{oak}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Huang Wei}]
+  s.date = %q{2011-10-24}
+  s.description = %q{When pushing your rails app to a public repository, it is often neccessary to find a way protecting you secret token and other private information. Oak helps you on these tasks and assumes you use git as the version control system}
+  s.email = %q{imonyse@gmail.com}
+  s.executables = [%q{oak}]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/oak",
+    "lib/oak.rb",
+    "oak.gemspec",
+    "test/files/config/application.rb",
+    "test/files/config/database.yml",
+    "test/files/config/initializers/secret_token.rb",
+    "test/files/dot_gitignore",
+    "test/helper.rb",
+    "test/test_oak.rb"
+  ]
+  s.homepage = %q{http://github.com/imonyse/oak}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Oak is a tool that helps making your newly created rails app open source ready.}
+
+  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<thor>, ["~> 0.14.6"])
+      s.add_development_dependency(%q<shoulda>, [">= 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_development_dependency(%q<rdoc>, ["~> 3.11"])
+    else
+      s.add_dependency(%q<thor>, ["~> 0.14.6"])
+      s.add_dependency(%q<shoulda>, [">= 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<rdoc>, ["~> 3.11"])
+    end
+  else
+    s.add_dependency(%q<thor>, ["~> 0.14.6"])
+    s.add_dependency(%q<shoulda>, [">= 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<rdoc>, ["~> 3.11"])
+  end
+end
+

data/test/files/config/application.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'

data/test/files/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/files/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Oak::Application.config.secret_token = 'c1cae0f52a3ef8efa369a127c63bd6ede539a4089fd952b33199100a6769c8455ab4969f2eefaf1ebcbe0208bd57531204c77f41f715207f961e7e45f139f4e7'

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'oak'
+
+class Test::Unit::TestCase
+  def create_temp_file(oak_ref)
+    oak_ref.destination_root = 'test_tmp'
+    FileUtils.cp_r 'test/files', 'test_tmp'
+    FileUtils.mv 'test_tmp/dot_gitignore', 'test_tmp/.gitignore'
+  end
+
+  def clear_temp_file(oak_ref)
+    FileUtils.rm_rf oak_ref.destination_root
+  end
+end

data/test/test_oak.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+class TestOak < Test::Unit::TestCase
+  def setup
+    @oak = Oak.new
+    create_temp_file @oak
+  end
+
+  def teardown
+    clear_temp_file @oak
+  end
+
+  def test_check_cfg
+    FileUtils.cd @oak.destination_root do
+      @oak.check_cfg
+      assert_equal('config/config.yml', File.binread('.gitignore'))
+      assert_equal('c1cae0f52a3ef8efa369a127c63bd6ede539a4089fd952b33199100a6769c8455ab4969f2eefaf1ebcbe0208bd57531204c77f41f715207f961e7e45f139f4e7', @oak.secret_token)
+      ignored = File.binread(File.expand_path('~/.gitignore'))
+      assert(ignored.include?('config/database.yml'))
+    end
+  end
+
+  def test_create_config_on_deploy
+    FileUtils.cd @oak.destination_root do
+      @oak.check_cfg
+      @oak.git_prepare
+      @oak.create_config_on_deploy
+      assert_equal('secret_token = ' + @oak.secret_token, File.binread('config/config.yml'))
+    end
+  end
+
+  def test_setup
+    @oak.setup @oak.destination_root
+    FileUtils.chdir @oak.destination_root do
+      File.open('.gitignore') do |f|
+        lines = f.readlines
+        assert_equal('config/config.yml', lines[0].chomp)
+      end
+      
+      branch = `git symbolic-ref -q HEAD`.chomp
+      assert_equal('refs/heads/master', branch)
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: oak
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Huang Wei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &2153111440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153111440
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2153110120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153110120
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153109360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153109360
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2153108380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2153108380
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2153107460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153107460
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2153106420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: *2153106420
+description: When pushing your rails app to a public repository, it is often neccessary
+  to find a way protecting you secret token and other private information. Oak helps
+  you on these tasks and assumes you use git as the version control system
+email: imonyse@gmail.com
+executables:
+- oak
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/oak
+- lib/oak.rb
+- oak.gemspec
+- test/files/config/application.rb
+- test/files/config/database.yml
+- test/files/config/initializers/secret_token.rb
+- test/files/dot_gitignore
+- test/helper.rb
+- test/test_oak.rb
+homepage: http://github.com/imonyse/oak
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2735190199071783322
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Oak is a tool that helps making your newly created rails app open source
+  ready.
+test_files: []