rails-skeleton 0.0.1

data/README.rdoc

@@ -0,0 +1,23 @@
+= RailsSkeleton
+
+This repository contains various rails skeleton projects as branches, 
+and a gem to get the skeleton out of the closet.
+
+== Usage
+
+    # rails-skeleton MyApp mysql
+
+This clones the mysql branch in git://github.com/gudleik/rails-skeleton.git
+If you want to use your own skeleton project, pass -r git-url:
+    
+    # rails-skeleton MyApp mybranch -r git://github.com/you/my-rails-templates.git
+
+rails-skeleton will perform these steps:
+
+  * Clone the repository
+  * Rename all occurrences of application name to MyApp (ie MyApp::Application)
+  * Run bundle install
+  * Generate a new secret token
+  * Reinitialize git repository (rm -rf .git && git init)
+  * Run git flow init on the new repository
+

data/bin/rails-skeleton

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/rails-skeleton")
+require File.expand_path(File.dirname(__FILE__) + "/../lib/rails-skeleton/cli")
+
+RailsSkeleton::CLI.execute(STDOUT, ARGV)
+

data/lib/rails-skeleton.rb

@@ -0,0 +1,12 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rails-skeleton/client'
+require 'rails-skeleton/string'
+
+module RailsSkeleton
+
+  VERSION = "0.0.1"
+  DEFAULT_SKELETON_REPOSITORY = "git://github.com/gudleik/rails-skeleton.git"
+
+end

data/lib/rails-skeleton/cli.rb

@@ -0,0 +1,58 @@
+require 'optparse'
+
+module RailsSkeleton
+
+  #
+  # CLI is the Command-Line Interface class.
+  # This class parses the arguments from the command line
+  #
+  class CLI
+    
+    # Reads parameters from +arguments+ and fires up the Botify::Client.
+    #
+    # == Parameters:
+    # stdout::
+    #   Where to send output
+    # arguments::
+    #   The arguments to parse
+    #
+    def self.execute(stdout, arguments=[])
+
+      # NOTE: the option -p/--path= is given as an example, and should be replaced in your application.
+      repos = RailsSkeleton::DEFAULT_SKELETON_REPOSITORY
+      mandatory_options = %w(  )
+
+      parser = OptionParser.new do |opts|
+        opts.banner = <<-BANNER.gsub(/^          /,'')
+          RailsSkeleton -- Get that skeleton out of the closet
+
+          Usage: #{File.basename($0)} APP_NAME branch [options]
+
+          Options are:
+        BANNER
+        opts.separator ""
+        opts.on("-r", "--repos=URL", String,  "Skeleton repository URL [#{repos}]")  { |arg| repos = arg }
+        opts.on("-h", "--help",    "Show this help message.")                        { stdout.puts opts; exit }
+        opts.on("-v", "--version", "Show version.")                                  { stdout.puts "RailsSkeleton version #{RailsSkeleton::VERSION}"; exit }
+        
+        opts.parse!(arguments)
+
+        if mandatory_options && mandatory_options.find { |option| options[option.to_sym].nil? }
+          stdout.puts opts; exit
+        end
+      end
+      
+
+      name   = ARGV[0]
+      branch = ARGV[1]
+
+      unless name && branch
+        puts parser.to_s
+        exit
+      end
+
+      app = RailsSkeleton::Client.new(name, branch, repos)
+      app.lolcats
+    end
+  end
+end

data/lib/rails-skeleton/client.rb

@@ -0,0 +1,112 @@
+module RailsSkeleton
+
+  class Client
+
+    def initialize(name, branch, repos = RailsSkeleton::DEFAULT_SKELETON_REPOSITORY)
+      @name       = name
+      @app_name   = @name.camelize
+      @branch     = branch
+      @repository = repos
+      @path       = name
+    end
+
+    def lolcats
+      sanity_check
+      clone
+      rename
+      bundler
+      generate_secret
+      copy_db_config
+      regit
+
+      puts "Successfully copied #{@repository/@branch} into #{@name.green}"
+    end
+
+    private
+
+    # Copy config/database.example.yml to config/database.yml
+    def copy_db_config
+      if File.exists?(File.join(@name, 'config', 'database.example.yml'))
+        run "Creating config/database.yml:" do
+          system "cp #{@name}/config/database.example.yml #{@name}/config/database.yml"
+        end
+      end
+    end
+
+    # Reinitialize git and run git flow init
+    def regit
+      run "Reinitializing git:" do
+        system "cd #{@name} && git init -q && git add . && git ci -qm 'Initial commit'"
+        system "cd #{@name} && git flow init"
+      end
+    end
+
+    def generate_secret
+      run "Generating secret token:" do
+        secret = `cd #{@name} && rake -s secret`.chomp
+        File.open(File.join(@name, 'config', 'initializers', 'secret_token.rb'), 'w') do |f|
+          f.puts "#{@app_name}::Application.config.secret_token = '#{secret}'"
+        end
+      end
+    end
+
+    # Replace of file
+    def replace_file(path, pattern, replacement)
+      return unless File.exist?(path)
+      text = File.read(path)
+      File.open(path, "w") { |f| f.puts text.gsub(pattern, replacement) }
+    end
+
+    # Replace old app name 
+    def rename
+
+      files = [ 'config.ru', 'config/application.rb', 'Rakefile', 'config/environment.rb', 'config/environments/development.rb', 'config/environments/production.rb',
+        'config/database.example.yml', 'config/environments/test.rb', 'config/initializers/secret_token.rb', 'config/initializers/session_store.rb', 'config/routes.rb' ]
+
+      run "Renaming application to #{@name}:" do
+        error "Unable to determine name of cloned repository!" unless original_name
+
+        files.each do |filename|
+          replace_file(File.join(@name, filename), original_name, @app_name)
+        end
+      end
+
+      replace_file File.join(@name, 'config', 'database.example.yml'), /dbname/, @app_name.downcase
+    end
+
+    def bundler
+      run "Installing gems:" do
+        system "cd #{@path} && bundle install --quiet"
+      end
+    end
+
+    def clone
+      run "Cloning repository into #{@name}:" do
+        system "git clone -q -b #{@branch} #{@repository} #{@name}"
+        system "rm -rf #{@name}/.git"
+      end
+    end
+
+    def run(msg, &block)
+      printf "%-45s", msg
+      yield if block_given?
+      print "OK\n".green
+    end
+
+    # Determine original application name
+    def original_name
+      @original_name ||= File.read(File.join(@path, 'config', 'environment.rb')).match(%r{(.*)::Application.initialize!})[1] rescue nil
+    end
+
+    def sanity_check
+      error("The directory #{@name.red} already exists!") if Dir.exists?(@name)
+    end
+
+    def error(msg)
+      puts "Error: ".red + msg
+      exit
+    end
+
+  end
+
+end

data/lib/rails-skeleton/string.rb

@@ -0,0 +1,19 @@
+class String
+
+  # Adds coloring to strings
+  def red; colorize(self, "\e[1m\e[31m"); end
+  def green; colorize(self, "\e[1m\e[32m"); end
+  def dark_green; colorize(self, "\e[32m"); end
+  def yellow; colorize(self, "\e[1m\e[33m"); end
+  def blue; colorize(self, "\e[1m\e[34m"); end
+  def dark_blue; colorize(self, "\e[34m"); end
+  def pur; colorize(self, "\e[1m\e[35m"); end
+  def colorize(text, color_code)  "#{color_code}#{text}\e[0m" end
+
+  # similar to ActiveSupport::Inflector.camelize
+  def camelize
+    self.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+  
+end
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: rails-skeleton
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gudleik Rasch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-14 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Jumpstart new rails projects by cloning existing skeleton projects
+email: 
+- gudleik@gmail.com
+executables: 
+- rails-skeleton
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- bin/rails-skeleton
+- lib/rails-skeleton/cli.rb
+- lib/rails-skeleton/client.rb
+- lib/rails-skeleton/string.rb
+- lib/rails-skeleton.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/gudleik/rails-skeleton
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Copy rails skeleton projects into new projects
+test_files: []
+