app_base.rb 7.6 KB
Newer Older
1 2
require 'digest/md5'
require 'active_support/secure_random'
3
require 'active_support/core_ext/string/strip'
4 5 6 7
require 'rails/version' unless defined?(Rails::VERSION)
require 'rbconfig'
require 'open-uri'
require 'uri'
8 9
require 'bundler'
require 'bundler/cli'
10 11 12 13

module Rails
  module Generators
    class AppBase < Base
A
Arun Agrawal 已提交
14
      DATABASES = %w( mysql oracle postgresql sqlite3 frontbase ibm_db )
15
      JDBC_DATABASES = %w( jdbcmysql jdbcsqlite3 jdbcpostgresql )
A
Arun Agrawal 已提交
16
      DATABASES.concat(JDBC_DATABASES)
17

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
      attr_accessor :rails_template
      add_shebang_option!

      argument :app_path,               :type => :string

      def self.add_shared_options_for(name)
        class_option :builder,            :type => :string, :aliases => "-b",
                                          :desc => "Path to a #{name} builder (can be a filesystem path or URL)"

        class_option :template,           :type => :string, :aliases => "-m",
                                          :desc => "Path to an #{name} template (can be a filesystem path or URL)"

        class_option :skip_gemfile,       :type => :boolean, :default => false,
                                          :desc => "Don't create a Gemfile"

        class_option :skip_git,           :type => :boolean, :aliases => "-G", :default => false,
                                          :desc => "Skip Git ignores and keeps"

36
        class_option :skip_active_record, :type => :boolean, :aliases => "-O", :default => false,
37 38 39 40 41
                                          :desc => "Skip Active Record files"

        class_option :database,           :type => :string, :aliases => "-d", :default => "sqlite3",
                                          :desc => "Preconfigure for selected database (options: #{DATABASES.join('/')})"

42 43 44
        class_option :javascript,         :type => :string, :aliases => '-j', :default => 'jquery',
                                          :desc => 'Preconfigure for selected JavaScript library'

45
        class_option :skip_javascript,    :type => :boolean, :aliases => "-J", :default => false,
X
Xavier Noria 已提交
46
                                          :desc => "Skip JavaScript files"
47

48 49 50 51 52 53
        class_option :dev,                :type => :boolean, :default => false,
                                          :desc => "Setup the #{name} with Gemfile pointing to your Rails checkout"

        class_option :edge,               :type => :boolean, :default => false,
                                          :desc => "Setup the #{name} with Gemfile pointing to Rails repository"

54 55 56
        class_option :skip_test_unit,     :type => :boolean, :aliases => "-T", :default => false,
                                          :desc => "Skip Test::Unit files"

57 58
        class_option :help,               :type => :boolean, :aliases => "-h", :group => :rails,
                                          :desc => "Show this help message and quit"
59 60 61

        class_option :old_style_hash,     :type => :boolean, :default => false,
                                          :desc => "Force using old style hash (:foo => 'bar') on Ruby >= 1.9"
62 63
      end

64 65 66 67 68 69
      def initialize(*args)
        @original_wd = Dir.pwd

        super
      end

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
    protected

      def builder
        @builder ||= begin
          if path = options[:builder]
            if URI(path).is_a?(URI::HTTP)
              contents = open(path, "Accept" => "application/x-thor-template") {|io| io.read }
            else
              contents = open(File.expand_path(path, @original_wd)) {|io| io.read }
            end

            prok = eval("proc { #{contents} }", TOPLEVEL_BINDING, path, 1)
            instance_eval(&prok)
          end

          builder_class = get_builder_class
          builder_class.send(:include, ActionMethods)
          builder_class.new(self)
        end
      end

      def build(meth, *args)
        builder.send(meth, *args) if builder.respond_to?(meth)
      end

      def create_root
        self.destination_root = File.expand_path(app_path, destination_root)
        valid_const?

        empty_directory '.'
        set_default_accessors!
        FileUtils.cd(destination_root) unless options[:pretend]
      end

      def apply_rails_template
        apply rails_template if rails_template
      rescue Thor::Error, LoadError, Errno::ENOENT => e
        raise Error, "The template [#{rails_template}] could not be loaded. Error: #{e}"
      end

      def set_default_accessors!
        self.rails_template = case options[:template]
          when /^https?:\/\//
            options[:template]
          when String
            File.expand_path(options[:template], Dir.pwd)
          else
            options[:template]
        end
      end

      def database_gemfile_entry
122
        options[:skip_active_record] ? "" : "gem '#{gem_for_database}'\n"
123 124
      end

A
Aditya Sanghi 已提交
125 126 127 128 129 130 131 132
      def include_all_railties?
        !options[:skip_active_record] && !options[:skip_test_unit]
      end

      def comment_if(value)
        options[value] ? '#' : ''
      end

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
      def rails_gemfile_entry
        if options.dev?
          <<-GEMFILE.strip_heredoc
            gem 'rails',     :path => '#{Rails::Generators::RAILS_DEV_PATH}'
          GEMFILE
        elsif options.edge?
          <<-GEMFILE.strip_heredoc
            gem 'rails',     :git => 'git://github.com/rails/rails.git'
          GEMFILE
        else
          <<-GEMFILE.strip_heredoc
            gem 'rails', '#{Rails::VERSION::STRING}'

            # Bundle edge Rails instead:
            # gem 'rails',     :git => 'git://github.com/rails/rails.git'
          GEMFILE
        end
      end

      def gem_for_database
153
        # %w( mysql oracle postgresql sqlite3 frontbase ibm_db jdbcmysql jdbcsqlite3 jdbcpostgresql )
154 155 156 157 158
        case options[:database]
        when "oracle"     then "ruby-oci8"
        when "postgresql" then "pg"
        when "frontbase"  then "ruby-frontbase"
        when "mysql"      then "mysql2"
159
        when "jdbcmysql"  then "activerecord-jdbcmysql-adapter"
160
        when "jdbcsqlite3"  then "activerecord-jdbcsqlite3-adapter"
161
        when "jdbcpostgresql"  then "activerecord-jdbcpostgresql-adapter"
162 163 164
        else options[:database]
        end
      end
J
Joshua Peek 已提交
165

166 167 168 169 170 171 172
      def gem_for_ruby_debugger
        if RUBY_VERSION < "1.9.2"
          "gem 'ruby-debug'"
        else
          "gem 'ruby-debug19', :require => 'ruby-debug'"
        end
      end
J
Joshua Peek 已提交
173

174 175 176 177 178 179 180 181 182 183
      def gem_for_turn
        unless RUBY_VERSION < "1.9.2"
          <<-GEMFILE.strip_heredoc
            group :test do
              # Pretty printed test output
              gem 'turn', :require => false
            end
          GEMFILE
        end
      end
184

185 186 187 188
      def gem_for_javascript
        "gem '#{options[:javascript]}-rails'" unless options[:skip_javascript]
      end

189
      def bundle_command(command)
190
        say_status :run, "bundle #{command}"
191
        Bundler::CLI.new.send(command)
192 193 194 195 196 197 198
      end

      def run_bundle
        unless options[:skip_gemfile]
          command = dev_or_edge? ? 'install' : 'check'
          bundle_command(command)
        end
199 200 201 202 203 204 205 206 207 208
      end

      def dev_or_edge?
        options.dev? || options.edge?
      end

      def empty_directory_with_gitkeep(destination, config = {})
        empty_directory(destination, config)
        git_keep(destination)
      end
J
Joshua Peek 已提交
209

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
      def git_keep(destination)
        create_file("#{destination}/.gitkeep") unless options[:skip_git]
      end

      # Returns Ruby 1.9 style key-value pair if current code is running on
      # Ruby 1.9.x. Returns the old-style (with hash rocket) otherwise.
      def key_value(key, value)
        if options[:old_style_hash] || RUBY_VERSION < '1.9'
          ":#{key} => #{value}"
        else
          "#{key}: #{value}"
        end
      end
    end
  end
J
Joshua Peek 已提交
225
end