Module: Ruboto::Commands::Base

Includes:
SdkVersions, Util::Verify
Defined in:
lib/ruboto/commands/base.rb

Constant Summary collapse

API_LEVEL_PATTERN =
/^(android|google_apis)-(\d+)$/
API_NUMBER_PATTERN =
/(\d+)/
VERSION_HELP_TEXT =
"(e.g., 'android-19' or '19' for kitkat, " \
"'google_apis-23' for Android 6.0 with Google APIs)"

Constants included from Util::Verify

Util::Verify::ON_TRAVIS

Constants included from SdkVersions

SdkVersions::API_LEVEL_TO_VERSION, SdkVersions::DEFAULT_TARGET_SDK, SdkVersions::DEFAULT_TARGET_SDK_LEVEL, SdkVersions::MINIMUM_SUPPORTED_SDK, SdkVersions::MINIMUM_SUPPORTED_SDK_LEVEL, SdkVersions::VERSION_TO_API_LEVEL

Class Method Summary collapse

Methods included from Util::Verify

#project_api_level, #project_properties, #save_manifest, #save_ruboto_config, #save_test_manifest, #verify_activity, #verify_api, #verify_manifest, #verify_min_sdk, #verify_package, #verify_project_properties, #verify_ruboto_config, #verify_sdk_versions, #verify_strings, #verify_target_sdk, #verify_test_manifest

Class Method Details

.mainObject


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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
# File 'lib/ruboto/commands/base.rb', line 27

def self.main
  Main do
    mode 'gen' do
      require 'ruboto/util/update'

      mode 'app' do
        include Ruboto::Util::LogAction
        include Ruboto::Util::Build
        include Ruboto::Util::Update

        option('package') {
          required
          argument :required
          description 'Name of package. Must be unique for every app. A common pattern is yourtld.yourdomain.appname (Ex. org.ruboto.irb)'
        }
        option('name') {
          argument :required
          description 'Name of your app.  Defaults to the last part of the package name capitalized.'
        }
        option('activity') {
          argument :required
          description 'Name of your primary Activity.  Defaults to the name of the application with "Activity" appended.'
        }
        option('path') {
          argument :required
          description 'Path to where you want your app.  Defaults to the last part of the package name.'
        }
        option('target', 't') {
          argument :required
          defaults DEFAULT_TARGET_SDK
          description "Android version to target #{VERSION_HELP_TEXT}"
          cast { |t| t =~ API_NUMBER_PATTERN ? "android-#$1" : t }
          validate { |t| t =~ API_LEVEL_PATTERN }
        }
        option('min-sdk') {
          argument :required
          description "Minimum android version supported. #{VERSION_HELP_TEXT}"
          cast { |t| t =~ API_NUMBER_PATTERN ? "android-#$1" : t }
          validate { |t| t =~ API_LEVEL_PATTERN }
        }
        option('with-jruby') {
          description 'Install the JRuby jars in your libs directory.  Optionally set the JRuby version to install.  Otherwise the latest available version is installed.'
          argument :optional
          cast { |v| Gem::Version.new(v) }
          validate { |v| Gem::Version.correct?(v) }
        }
        option('ruby-version') {
          description 'Using what version of Ruby? (e.g., 1.8, 1.9, 2.0)'
          argument :required
          cast :float
          validate { |rv| [1.8, 1.9, 2.0].include?(rv) }
        }
        option('force') {
          description 'Force creation of project even if the path exists'
          cast :boolean
        }

        def run
          package = params['package'].value
          name = params['name'].value || package.split('.').last.split('_').map { |s| s.capitalize }.join
          name[0..0] = name[0..0].upcase
          activity = params['activity'].value || "#{name}Activity"
          path = params['path'].value || package.split('.').last
          target = params['target'].value
          min_sdk = params['min-sdk'].value || target
          with_jruby = params['with-jruby'].value
          with_jruby = '1.7.25' unless with_jruby.is_a?(Gem::Version)
          ruby_version = params['ruby-version'].value
          force = params['force'].value

          abort "Path (#{path}) must be to a directory that does not yet exist. It will be created." if !force && File.exists?(path)
          unless target =~ API_LEVEL_PATTERN
            abort "Target must match #{API_LEVEL_PATTERN}: got #{target}"
          end

          if $2.to_i < MINIMUM_SUPPORTED_SDK_LEVEL
            abort "Minimum Android api level is #{MINIMUM_SUPPORTED_SDK}: got #{target}"
          end

          root = File.expand_path(path)
          puts "\nGenerating Android app #{name} in #{root}..."
          system "android create project -n #{name} -t #{target} -p #{path} -k #{package} -a #{activity}"
          exit $?.to_i unless $? == 0
          unless File.exists? path
            puts 'Android project was not created'
            exit_failure!
          end
          Dir.chdir path do
            FileUtils.rm_f "src/#{package.gsub '.', '/'}/#{activity}.java"
            puts "Removed file #{"src/#{package.gsub '.', '/'}/#{activity}"}.java"
            FileUtils.rm_f 'res/layout/main.xml'
            puts 'Removed file res/layout/main.xml'
            verify_strings.root.elements['string'].text = name.gsub(/([A-Z]+)([A-Z][a-z])/, '\1 \2').gsub(/([a-z\d])([A-Z])/, '\1 \2')
            File.open('res/values/strings.xml', 'w') { |f| verify_strings.document.write(f, 4) }
          end
          puts 'Done'

          Dir.chdir root do
            update_manifest min_sdk[API_NUMBER_PATTERN], target[API_NUMBER_PATTERN], true
            update_test true, target[API_NUMBER_PATTERN]
            update_assets

            if ruby_version
              source = File.read('ruboto.yml')
              pattern = %r{^#? ?ruby_version: 1.9$}
              File.open('ruboto.yml', 'w') { |f| f << source.sub(pattern, "ruby_version: #{ruby_version}") }
            end

            update_ruboto true
            update_icons true
            update_classes nil, 'exclude'
            if with_jruby
              update_jruby true, with_jruby
              update_dx_jar true
            end
            update_core_classes 'exclude'

            log_action('Generating the default Activity and script') do
              generate_inheriting_file 'Activity', activity, package
            end
            FileUtils.touch 'bin/classes2.dex'
          end

          puts "\nHello, #{name}\n"
        end
      end

      mode 'jruby' do
        include Ruboto::Util::LogAction
        include Ruboto::Util::Build
        include Ruboto::Util::Update

        argument('version') {
          required false
          description 'The JRuby version to install.'
          cast { |v| Gem::Version.new(v) }
          validate { |v| Gem::Version.correct?(v) }
        }

        def run
          update_jruby true, params['version'].value
        end
      end

      mode 'class' do
        include Ruboto::Util::Build

        argument('class') {
          required
          alternatives = Dir[File.join(Ruboto::ASSETS, 'src/Inheriting*.java')].map { |f| File.basename(f)[10..-6] } - %w(Class)
          description "the Android Class that you want: #{alternatives[0..-2].map { |c| "#{c}, " }}or #{alternatives[-1]}"
          validate { |v| alternatives.include? v }
        }

        option('script_name') {
          argument :required
          description 'name of the ruby script that this class will execute. Should end in .rb.  Optional.'
        }

        option('name') {
          required
          argument :required
          description 'name of the class (and file). Should be CamelCase'
        }

        def run
          name = params['name'].value
          name[0..0] = name[0..0].upcase
          script_name = params['script_name'].value || "#{underscore(name)}.rb"
          klass = params['class'].value

          generate_inheriting_file klass, name, verify_package, script_name

          app_element = verify_manifest.elements['application']
          if klass == 'Activity' || klass == 'Service'
            tag = klass.downcase
            if app_element.elements["#{tag}[@android:name='#{name}']"]
              puts "#{klass} already present in manifest."
            else
              app_element.add_element tag, {'android:name' => "#{"#{verify_package}." if klass == 'Service'}#{name}"}
              save_manifest
              puts "Added #{tag} to manifest."
            end
          end
        end
      end

      mode 'subclass' do
        include Ruboto::Util::Build

        argument('class') {
          required
          description 'the Android Class that you want to subclass (e.g., package.Class).'
        }

        option('name') {
          required
          argument :required
          description 'name of the class (and file). Should be CamelCase'
        }

        option('package') {
          argument :required
          description 'package for the new class (if not specified, uses project package)'
        }

        option('method_base') {
          required
          validate { |i| %w(all on none abstract).include?(i) }
          argument :required
          description 'the base set of methods to generate (adjusted with method_include and method_exclude): all, none, abstract, on (e.g., onClick)'
        }

        option('method_include') {
          argument :required
          defaults ''
          description 'additional methods to add to the base list'
        }

        option('method_exclude') {
          argument :required
          defaults ''
          description 'methods to remove from the base list'
        }

        option('implements') {
          required
          argument :required
          defaults ''
          description 'comma separated list interfaces to implement'
        }

        option('force') {
          argument :required
          validate { |i| %w(include exclude).include?(i) }
          description "force handling of added and deprecated methods (values: 'include' or 'exclude') unless individually included or excluded"
        }

        def run
          generate_inheriting_file 'Class', params['name'].value
          generate_subclass_or_interface(
              %w(class name package method_base method_include method_exclude implements force).inject({}) { |h, i| h[i.to_sym] = params[i].value; h })
        end
      end

      mode 'interface' do
        include Ruboto::Util::Build

        argument('interface') {
          required
          description 'the Android Interface that you want to implement (e.g., package.Interface).'
        }

        option('name') {
          required
          argument :required
          description 'name of the class (and file) that will implement the interface. Should be CamelCase'
        }

        option('package') {
          argument :required
          description 'package for the new class (if not specified, uses project package)'
        }

        option('force') {
          argument :required
          validate { |i| %w(include exclude).include?(i) }
          description "force added and deprecated interfaces (values: 'include' or 'exclude')"
        }

        def run
          # FIXME(uwe):  DEPRECATED!  Remove before Ruboto version 1.0.0.
          puts "\nThe use of \"ruboto gen interface\" has been deprecated.  Please use\n\n    ruboto gen subclass\n\ninstead.\n\n"
          generate_inheriting_file 'Class', params['name'].value
          generate_subclass_or_interface %w(interface name package force).inject({}) { |h, i| h[i.to_sym] = params[i].value; h }
        end
      end

      mode 'core' do
        include Ruboto::Util::Build

        argument('class') {
          required
          validate { |i| %w(Activity Service BroadcastReceiver View PreferenceActivity TabActivity OnClickListener OnItemClickListener OnItemSelectedListener all).include?(i) }
          description "Activity, Service, BroadcastReceiver, View, OnClickListener, OnItemClickListener, OnItemSelectedListener, or all (default = all); Other activities not included in 'all': PreferenceActivity, TabActivity"
        }

        option('method_base') {
          required
          argument :required
          validate { |i| %w(all on none).include?(i) }
          defaults 'on'
          description 'the base set of methods to generate (adjusted with method_include and method_exclude): all, none, on (e.g., onClick)'
        }

        option('method_include') {
          required
          argument :required
          defaults ''
          description 'additional methods to add to the base list'
        }

        option('method_exclude') {
          required
          argument :required
          defaults ''
          description 'methods to remove from the base list'
        }

        option('implements') {
          required
          argument :required
          defaults ''
          description "for classes only, interfaces to implement (cannot be used with 'gen core all')"
        }

        option('force') {
          argument :required
          validate { |i| %w(include exclude).include?(i) }
          description "force handling of added and deprecated methods (values: 'include' or 'exclude') unless individually included or excluded"
        }

        def run
          abort("specify 'implements' only for Activity, Service, BroadcastReceiver, PreferenceActivity, or TabActivity") unless %w(Activity Service BroadcastReceiver PreferenceActivity TabActivity).include?(params['class'].value) or params['implements'].value == ''
          generate_core_classes [:class, :method_base, :method_include, :method_exclude, :implements, :force].inject({}) { |h, i| h[i] = params[i.to_s].value; h }
        end
      end
    end

    mode 'update' do
      require 'ruboto/util/update'
      include Ruboto::Util::LogAction
      include Ruboto::Util::Update

      mode 'app' do
        # FIXME(uwe): Change to cast to integer for better comparison
        option('target', 't') {
          argument :required
          description "Android version to target #{VERSION_HELP_TEXT}"
          cast { |t| t =~ API_NUMBER_PATTERN ? "android-#$1" : t }
          validate { |t| t =~ API_LEVEL_PATTERN }
        }
        option('with-jruby') {
          description 'Install the JRuby jars in your libs directory.  Optionally set the JRuby version to install.  Otherwise the latest available version is installed.  If the JRuby jars are already present in your project, this option is implied.'
          argument :optional
          cast { |v| Gem::Version.new(v) }
          validate { |v| Gem::Version.correct?(v) }
        }
        option('force') {
          description "force an update even if the version hasn't changed"
        }

        def run
          force = params['force'].value
          old_version = read_ruboto_version
          if old_version && Gem::Version.new(old_version) < Gem::Version.new(Ruboto::UPDATE_VERSION_LIMIT)
            puts "Detected old Ruboto version: #{old_version}"
            puts "Will use Ruboto #{Ruboto::UPDATE_VERSION_LIMIT} to update it first."
            `gem query -i -n ruboto -v #{Ruboto::UPDATE_VERSION_LIMIT}`
            system "gem install ruboto -v #{Ruboto::UPDATE_VERSION_LIMIT}" unless $? == 0
            raise "Install of Ruboto #{Ruboto::UPDATE_VERSION_LIMIT} failed!" unless $? == 0
            system "ruboto _#{Ruboto::UPDATE_VERSION_LIMIT}_ update app"
            raise "Ruboto update app to #{Ruboto::UPDATE_VERSION_LIMIT} failed!" unless $? == 0
          end

          if (target = params['target'].value)
            unless target =~ API_LEVEL_PATTERN
              abort "Target must match #{API_LEVEL_PATTERN}: got #{target}"
            end

            unless $2.to_i >= MINIMUM_SUPPORTED_SDK_LEVEL
              abort "Minimum Android api level is #{MINIMUM_SUPPORTED_SDK}: got #{target}"
            end

            target_level = target[API_NUMBER_PATTERN]
            update_android(target_level)
            update_test force, target_level
          else
            update_android
            update_test force
          end

          update_assets old_version
          update_ruboto force
          update_classes old_version, force
          update_dx_jar force
          update_jruby force, params['with-jruby'].value
          update_manifest nil, nil, force
          update_icons force
          update_core_classes 'exclude'
          update_bundle
        end
      end

      mode 'jruby' do

        argument('version') {
          required false
          description 'The JRuby version to install.  The jruby-jars gem of the same version should be installed on your system already.'
          cast { |v| Gem::Version.new(v) }
          validate { |v| Gem::Version.correct?(v) }
        }

        option('force') {
          description "force an update even if the version hasn't changed"
        }

        def run
          update_jruby(params['force'].value, params['version'].value, true) || abort
        end
      end
    end

    mode 'setup' do
      require 'ruboto/util/setup'
      include Ruboto::Util::Setup

      option('target', 't') {
        description "sets the target Android API level to set up for #{VERSION_HELP_TEXT}"
        argument :required
        default DEFAULT_TARGET_SDK
        arity -1
        cast { |t| t =~ API_NUMBER_PATTERN ? "android-#$1" : t }
        validate { |t| t =~ API_LEVEL_PATTERN }
      }

      option('yes', 'y') {
        description 'answer "yes" to all interactive questions.  Will automatically install needed components.'
      }

      option('update', 'u') {
          description 'updates intel haxm'
      }

      option('upgrade') {
          description 'DEPRECATED:  Use --update instead'
      }

      def run
        update = params['update'].value

        # FIXME(uwe): Remove after Ruboto 1.5.0 is released
        update ||= params['upgrade'].value
        # EMXIF

        setup_ruboto(params['yes'].value, params['target'].values, update)
      end
    end

    mode 'emulator' do
      require 'ruboto/util/emulator'
      include Ruboto::Util::Emulator
      extend Ruboto::Util::Verify
      api_level = project_api_level

      option('target', 't') {
        extend Ruboto::Util::Emulator
        description 'sets the target Android API level for the emulator'
        examples Ruboto::SdkVersions::API_LEVEL_TO_VERSION.keys.join(', ')
        required unless api_level
        argument :required
        default(api_level) if api_level
        cast { |t| t =~ API_NUMBER_PATTERN ? "android-#$1" : t }
        validate { |t| t =~ API_LEVEL_PATTERN && sdk_level_name($2.to_i) }
      }

      option('no-snapshot', 's') {
        description 'do not use a snapshot when starting the emulator'
      }

      def run
        start_emulator(params['target'].value, params['no-snapshot'].value)
      end
    end

    option 'version' do
      description 'display ruboto version'
    end

    # just running `ruboto`
    def run
      # FIXME(uwe):  Simplify when we stop supporting rubygems < 1.8.0
      if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.8.0')
        gem_spec = Gem::Specification.find_by_path 'ruboto'
      else
        gem_spec = Gem.searcher.find('ruboto')
      end
      # EMXIF

      version = gem_spec.version.version

      if params['version'].value
        puts version
      else
        puts <<EOF

    Ruboto -- Ruby for Android #{version}
    Execute `ruboto gen app --help` for instructions on how to generate a fresh Ruboto app
    Execute `ruboto --help` for other options

EOF
      end
    end
  end
end