freelancing-god / thinking-sphinx

Sphinx plugin for Rails and Merb

This URL has Read+Write access

thinking-sphinx / contribute.rb
100755 366 lines (262 sloc) 7.381 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
#!/usr/bin/env ruby
 
require 'rubygems'
require 'yaml'
require 'pp'
 
require 'optparse'
 
options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"
 
  opts.on("-g [NAME]", "--ginger [NAME]", "Ginger gem name") do |name|
    options[:ginger] = name
  end
 
  opts.on("-n [NAME]", "--notamock [NAME]", "Not A Mock gem name") do |name|
    options[:notamock] = name
  end
 
  opts.on("-s [NAME]", "--sphinx [NAME]", "Sphinx daemon name") do |name|
    options[:sphinx] = name
  end
end.parse!
 
OPTIONS = options
 
module ContributeHelper; end
 
class Contribute
  include ContributeHelper
  
  def dependencies
    [
      Dependencies::Sphinx,
      Dependencies::Mysql,
      Dependencies::AR,
      Dependencies::Ginger,
      Dependencies::NotAMock
    ]
  end
 
  def show
    show_welcome_screen
    
    (
      check_for_dependencies &&
      create_database_yaml &&
      check_mysql_is_working &&
      create_test_database
    ) || exit(1)
    
    show_done_screen
  end
 
private
WELCOME_SCREEN = <<-EO_WELCOME
<banner>Thinking Sphinx Contribution</banner>
 
Thanks for contributing to Thinking Sphinx.
 
In this script we'll help you get setup to hack:
 
<b>1.</b> We'll check that you have the right software installed and running.
<b>2.</b> We'll set up the test database for specs to run against.
 
EO_WELCOME
 
DONE_SCREEN = <<-EO_DONE
<banner>Setup done!</banner>
 
All done! Now you can start hacking by running
 
<b>rake spec</b>
 
EO_DONE
 
REVIEW_YAML = <<-EO_REVIEW_YAML
 
Please review the database details in the yaml file details before continuing.
 
This file is used by the specs to connect to the database.
 
Current details:
EO_REVIEW_YAML
 
 
 
MYSQL_FAILED = <<-EO_MYSQL_FAILED
 
Looks like we couldn't successfully talk to the mysql database.
 
Don't worry though...
 
EO_MYSQL_FAILED
 
CREATE_DATABASE_FAILED = <<-EO_CREATE_DATABASE_FAILED
 
Looks like we couldn't create a test database to work against.
 
Don't worry though...
 
EO_CREATE_DATABASE_FAILED
 
  def show_welcome_screen
    colour_puts WELCOME_SCREEN
    wait!
  end
 
  def show_done_screen
    colour_puts DONE_SCREEN
  end
 
  # create database.yml
  def create_database_yaml
    colour_puts "<banner>creating database yaml</banner>"
    puts
    
    
    config = {
          'username' => 'root',
          'password' => nil,
          'host' => 'localhost'
        }
    
    
    colour_print " * <b>#{db_yml}</b>... "
    unless File.exist?(db_yml)
      open(db_yml,'w') {|f| f << config.to_yaml}
      colour_puts "<green>created</green>"
    else
      config = YAML.load_file(db_yml)
      colour_puts "<green>already exists</green>"
    end
    
    colour_puts REVIEW_YAML
    
    config.each do |(k,v)|
      colour_puts " * <b>#{k}</b>: #{v}"
    end
    
    puts
    
    wait!
    true
  end
  
  def check_mysql_is_working
    require 'activerecord'
    colour_puts "<banner>check mysql is working</banner>"
    puts
    
    connect_to_db
    
    print " * connecting to mysql... "
    
    begin
      ActiveRecord::Base.connection.select_value('select sysdate() from dual')
      
      colour_puts "<green>successful</green>"
      puts
      
      return true
    rescue defined?(JRUBY_VERSION) ? Java::JavaSql::SQLException : Mysql::Error
      colour_puts "<red>failed</red>"
      
      puts MYSQL_FAILED
    end
    
    false
  end
 
  # create test db
  def create_test_database
    colour_puts "<banner>create test database</banner>"
    puts
    
    connect_to_db
    
    colour_print " * <b>creating thinking_sphinx database</b>... "
    begin
      ActiveRecord::Base.connection.create_database('thinking_sphinx')
      colour_puts "<green>successful</green>"
      puts
      return true
    rescue ActiveRecord::StatementInvalid
      if $!.message[/database exists/]
        colour_puts "<green>successful</green> (database already existed)"
        puts
        return true
      else
        colour_puts "<red>failed</red>"
colour_puts CREATE_DATABASE_FAILED
      end
    end
    
    false
  end
  
  # project
  def ts_root
    File.expand_path(File.dirname(__FILE__))
  end
  
  def specs
    ts_root / 'spec'
  end
  
  def db_yml
    specs / 'fixtures' / 'database.yml'
  end
  
  def mysql_adapter
    defined?(JRUBY_VERSION) ? 'jdbcmysql' : 'mysql'
  end
 
  def connect_to_db
    config = YAML.load_file(db_yml)
    config.update(:adapter => mysql_adapter, :database => 'test')
    config.symbolize_keys!
 
    ActiveRecord::Base.establish_connection(config)
  end
end
 
 
 
 
 
 
 
class String
  def /(other)
    "#{self}/#{other}"
  end
end
 
module ContributeHelper
  class Dependency
    def self.name(name=nil)
      if name then @name = name else @name end
    end
    
    attr_reader :location
    
    def initialize
      @found = false
      @location = nil
    end
    
    def name; self.class.name end
    
    def check; false end
    def check!
      @found = check
    end
    
    def found?
      @found
    end
  end
  
  class Gem < Dependency
    def gem_name; self.class.name end
    def name; "#{super} gem" end
    
    def check
      ::Gem.available? self.gem_name
    end
  end
  
  
  def check_for_dependencies
    colour_puts "<banner>Checking for required software</banner>"
    puts
    
    all_found = true
    
    dependencies.each do |klass|
      dep = klass.new
      print " * #{dep.name}... "
      dep.check!
      
      if dep.found?
        if dep.location
          colour_puts "<green>found at #{dep.location}</green>"
        else
          colour_puts "<green>found</green>"
        end
      else
        all_found &= false
        colour_puts "<red>not found</red>"
      end
    end
    
    puts
    
    if !all_found
print "You may wish to try setting additional options. Use ./contribute.rb -h for details"
puts
end
    
    all_found
  end
  
  
  
  DEFAULT_TERMINAL_COLORS = "\e[0m\e[37m\e[40m"
  def subs_colour(data)
   data = data.gsub(%r{<b>(.*?)</b>}m, "\e[1m\\1#{DEFAULT_TERMINAL_COLORS}")
   data.gsub!(%r{<red>(.*?)</red>}m, "\e[1m\e[31m\\1#{DEFAULT_TERMINAL_COLORS}")
   data.gsub!(%r{<green>(.*?)</green>}m, "\e[1m\e[32m\\1#{DEFAULT_TERMINAL_COLORS}")
   data.gsub!(%r{<yellow>(.*?)</yellow>}m, "\e[1m\e[33m\\1#{DEFAULT_TERMINAL_COLORS}")
   data.gsub!(%r{<banner>(.*?)</banner>}m, "\e[33m\e[44m\e[1m\\1#{DEFAULT_TERMINAL_COLORS}")
  
   return data
  end
  
  def colour_puts(text)
    puts subs_colour(text)
  end
 
  def colour_print(text)
    print subs_colour(text)
  end
 
  
  def wait!
    colour_puts "<b>Hit Enter to continue, or Ctrl-C to quit.</b>"
    STDIN.readline
  rescue Interrupt
    exit!
  end
end
 
module Dependencies
  class Mysql < ContributeHelper::Gem
    name(defined?(JRUBY_VERSION) ? 'jdbc-mysql' : 'mysql')
  end
  
  class AR < ContributeHelper::Gem
    name 'activerecord'
  end
  
  class Ginger < ContributeHelper::Gem
    name(OPTIONS.has_key?(:ginger) ? OPTIONS[:ginger] : 'ginger')
  end
  
  class NotAMock < ContributeHelper::Gem
    name(OPTIONS.has_key?(:notamock) ? OPTIONS[:notamock] : 'not_a_mock')
  end
  
  class Sphinx < ContributeHelper::Dependency
    name 'sphinx'
    
    def check
app_name = OPTIONS.has_key?(:sphinx) ? OPTIONS[:sphinx] : 'searchd'
      output = `which #{app_name}`
      @location = output.chomp if $? == 0
      $? == 0
    end
  end
end
 
Contribute.new.show