Skip to content
This repository
tree: 9eca588bdf
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 372 lines (335 sloc) 9.824 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
require File.dirname(__FILE__) + '/scm/scm'
require File.dirname(__FILE__) + '/scm/git'
require File.dirname(__FILE__) + '/scm/svn'

require 'open-uri'
require 'fileutils'

module Rails
  class TemplateRunner
    attr_reader :behavior, :description, :root

    def initialize(root, template) # :nodoc:
      @root = Dir.pwd + "/" + root

      puts "applying template: #{template}"

      load_template(template)

      puts "#{template} applied."
    end

    def load_template(template)
      begin
        code = open(template).read
        in_root { self.instance_eval(code) }
      rescue LoadError
        raise "The template [#{template}] could not be loaded."
      end
    end

    # Create a new file in the Rails project folder. Specify the
    # relative path from RAILS_ROOT. Data is the return value of a block
    # or a data string.
    #
    # ==== Examples
    #
    # file("lib/fun_party.rb") do
    # hostname = ask("What is the virtual hostname I should use?")
    # "vhost.name = #{hostname}"
    # end
    #
    # file("config/apach.conf", "your apache config")
    #
    def file(filename, data = nil, &block)
      puts "creating file #{filename}"
      dir, file = [File.dirname(filename), File.basename(filename)]

      inside(dir) do
        File.open(file, "w") do |f|
          if block_given?
            f.write(block.call)
          else
            f.write(data)
          end
        end
      end
    end

    # Install a plugin. You must provide either a Subversion url or Git url.
    # For a Git-hosted plugin, you can specify if it should be added as a submodule instead of cloned.
    #
    # ==== Examples
    #
    # plugin 'restful-authentication', :git => 'git://github.com/technoweenie/restful-authentication.git'
    # plugin 'restful-authentication', :git => 'git://github.com/technoweenie/restful-authentication.git', :submodule => true
    # plugin 'restful-authentication', :svn => 'svn://svnhub.com/technoweenie/restful-authentication/trunk'
    #
    def plugin(name, options)
      puts "installing plugin #{name}"

      if options[:git] && options[:submodule]
        in_root do
          Git.run("submodule add #{options[:git]} vendor/plugins/#{name}")
        end
      elsif options[:git] || options[:svn]
        in_root do
          `script/plugin install #{options[:svn] || options[:git]}`
        end
      else
        puts "! no git or svn provided for #{name}. skipping..."
      end
    end

    # Adds an entry into config/environment.rb for the supplied gem :
    def gem(name, options = {})
      puts "adding gem #{name}"

      sentinel = 'Rails::Initializer.run do |config|'
      gems_code = "config.gem '#{name}'"

      if options.any?
        opts = options.inject([]) {|result, h| result << [":#{h[0]} => '#{h[1]}'"] }.join(", ")
        gems_code << ", #{opts}"
      end

      in_root do
        gsub_file 'config/environment.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
          "#{match}\n #{gems_code}"
        end
      end
    end

    # Run a command in git.
    #
    # ==== Examples
    #
    # git :init
    # git :add => "this.file that.rb"
    # git :add => "onefile.rb", :rm => "badfile.cxx"
    #
    def git(command = {})
      puts "running git #{command}"

      in_root do
        if command.is_a?(Symbol)
          Git.run(command.to_s)
        else
          command.each do |command, options|
            Git.run("#{command} #{options}")
          end
        end
      end
    end

    # Create a new file in the vendor/ directory. Code can be specified
    # in a block or a data string can be given.
    #
    # ==== Examples
    #
    # vendor("sekrit.rb") do
    # sekrit_salt = "#{Time.now}--#{3.years.ago}--#{rand}--"
    # "salt = '#{sekrit_salt}'"
    # end
    #
    # vendor("foreign.rb", "# Foreign code is fun")
    #
    def vendor(filename, data = nil, &block)
      puts "vendoring file #{filename}"
      inside("vendor") do |folder|
        File.open("#{folder}/#{filename}", "w") do |f|
          if block_given?
            f.write(block.call)
          else
            f.write(data)
          end
        end
      end
    end

    # Create a new file in the lib/ directory. Code can be specified
    # in a block or a data string can be given.
    #
    # ==== Examples
    #
    # lib("crypto.rb") do
    # "crypted_special_value = '#{rand}--#{Time.now}--#{rand(1337)}--'"
    # end
    #
    # lib("foreign.rb", "# Foreign code is fun")
    #
    def lib(filename, data = nil)
      puts "add lib file #{filename}"
      inside("lib") do |folder|
        File.open("#{folder}/#{filename}", "w") do |f|
          if block_given?
            f.write(block.call)
          else
            f.write(data)
          end
        end
      end
    end

    # Create a new Rakefile with the provided code (either in a block or a string).
    #
    # ==== Examples
    #
    # rakefile("bootstrap.rake") do
    # project = ask("What is the UNIX name of your project?")
    #
    # <<-TASK
    # namespace :#{project} do
    # task :bootstrap do
    # puts "i like boots!"
    # end
    # end
    # TASK
    # end
    #
    # rakefile("seed.rake", "puts 'im plantin ur seedz'")
    #
    def rakefile(filename, data = nil, &block)
      puts "adding rakefile #{filename}"
      inside("lib/tasks") do |folder|
        File.open("#{folder}/#{filename}", "w") do |f|
          if block_given?
            f.write(block.call)
          else
            f.write(data)
          end
        end
      end
    end

    # Create a new initializer with the provided code (either in a block or a string).
    #
    # ==== Examples
    #
    # initializer("globals.rb") do
    # data = ""
    #
    # ['MY_WORK', 'ADMINS', 'BEST_COMPANY_EVAR'].each do
    # data << "#{const} = :entp"
    # end
    #
    # data
    # end
    #
    # initializer("api.rb", "API_KEY = '123456'")
    #
    def initializer(filename, data = nil, &block)
      puts "adding initializer #{filename}"
      inside("config/initializers") do |folder|
        File.open("#{folder}/#{filename}", "w") do |f|
          if block_given?
            f.write(block.call)
          else
            f.write(data)
          end
        end
      end
    end

    # Generate something using a generator from Rails or a plugin.
    # The second parameter is the argument string that is passed to
    # the generator or an Array that is joined.
    #
    # ==== Example
    #
    # generate(:authenticated, "user session")
    #
    def generate(what, *args)
      puts "generating #{what}"
      argument = args.map(&:to_s).flatten.join(" ")

      in_root { `#{root}/script/generate #{what} #{argument}` }
    end

    # Executes a command
    #
    # ==== Example
    #
    # inside('vendor') do
    # run('ln -s ~/edge rails)
    # end
    #
    def run(command)
      puts "executing #{command} from #{Dir.pwd}"
      `#{command}`
    end

    # Runs the supplied rake task
    #
    # ==== Example
    #
    # rake("db:migrate")
    # rake("db:migrate", :env => "production")
    # rake("gems:install", :sudo => true)
    #
    def rake(command, options = {})
      puts "running rake task #{command}"
      env = options[:env] || 'development'
      sudo = options[:sudo] ? 'sudo ' : ''
      in_root { `#{sudo}rake #{command} RAILS_ENV=#{env}` }
    end

    # Just run the capify command in root
    #
    # ==== Example
    #
    # capify!
    #
    def capify!
      in_root { `capify .` }
    end

    # Add Rails to /vendor/rails
    #
    # ==== Example
    #
    # freeze!
    #
    def freeze!(args = {})
      puts "vendoring rails edge"
      in_root { `rake rails:freeze:edge` }
    end

    # Make an entry in Rails routing file conifg/routes.rb
    #
    # === Example
    #
    # route "map.root :controller => :welcome"
    #
    def route(routing_code)
      sentinel = 'ActionController::Routing::Routes.draw do |map|'

      in_root do
        gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
          "#{match}\n #{routing_code}\n"
        end
      end
    end

    protected

    # Get a user's input
    #
    # ==== Example
    #
    # answer = ask("Should I freeze the latest Rails?")
    # freeze! if ask("Should I freeze the latest Rails?") == "yes"
    #
    def ask(string)
      puts string
      gets.strip
    end

    # Do something in the root of the Rails application or
    # a provided subfolder; the full path is yielded to the block you provide.
    # The path is set back to the previous path when the method exits.
    def inside(dir = '', &block)
      folder = File.join(root, dir)
      FileUtils.mkdir_p(folder) unless File.exist?(folder)
      FileUtils.cd(folder) { block.arity == 1 ? yield(folder) : yield }
    end

    def in_root
      FileUtils.cd(root) { yield }
    end

    # Helper to test if the user says yes(y)?
    #
    # ==== Example
    #
    # freeze! if yes?("Should I freeze the latest Rails?")
    #
    def yes?(question)
      answer = ask(question).downcase
      answer == "y" || answer == "yes"
    end

    # Helper to test if the user does NOT say yes(y)?
    #
    # ==== Example
    #
    # capify! if no?("Will you be using vlad to deploy your application?")
    #
    def no?(question)
      !yes?(question)
    end

    def gsub_file(relative_destination, regexp, *args, &block)
      path = destination_path(relative_destination)
      content = File.read(path).gsub(regexp, *args, &block)
      File.open(path, 'wb') { |file| file.write(content) }
    end

    def destination_path(relative_destination)
      File.join(root, relative_destination)
    end
  end
end
Something went wrong with that request. Please try again.