ruboto-core 0.0.3 → 0.1.0

data/lib/ruboto/util/build.rb

@@ -0,0 +1,183 @@
+module Ruboto
+  module Util
+    module Build
+      include Verify
+      ###########################################################################
+      #
+      # Build Subclass or Interface:
+      #
+
+      #
+      # build_file: Reads the src from the appropriate location,
+      #   uses the substitutions hash to modify the contents,
+      #   and writes to the new location
+      #
+      def build_file(src, package, name, substitutions, dest='.')
+        to = File.join(dest, "src/#{package.gsub('.', '/')}")
+        Dir.mkdir(to) unless File.directory?(to)
+
+        text = File.read(File.expand_path(Ruboto::GEM_ROOT + "/assets/src/#{src}.java"))
+        substitutions.each {|k,v| text.gsub!(k, v)}
+
+        File.open(File.join(to, "#{name}.java"), 'w') {|f| f << text}
+      end
+
+      #
+      # get_class_or_interface: Opens the xml file and locates the specified class.
+      #   Aborts if the class is not found or if it is not available for
+      #   all api levels
+      #
+      def get_class_or_interface(klass, force=false)
+        element = verify_api.find_class_or_interface(klass, "either")
+
+        abort "ERROR: #{klass} not found" unless element
+
+        unless force
+          abort "#{klass} not available in minSdkVersion, added in #{element.attribute('api_added')}; use --force to create it" if
+          element.attribute('api_added') and element.attribute('api_added').to_i > verify_min_sdk.to_i
+          abort "#{klass} deprecated for targetSdkVersion, deprecatrd in #{element.attribute('deprecated')}; use --force to create it" if
+          element.attribute('deprecated') and element.attribute('deprecated').to_i <= verify_target_sdk.to_i
+        end
+
+        abort "#{klass} removed for targetSdkVersion, removed in #{element.attribute('api_removed')}" if
+        element.attribute('api_removed') and element.attribute('api_removed').to_i <= verify_target_sdk.to_i
+
+        element
+      end
+
+      #
+      # check_methods: Checks the methods to see if they are available for all api levels
+      #
+      def check_methods(methods, force=false)
+        min_api = verify_min_sdk.to_i
+        target_api = verify_target_sdk.to_i
+
+        # Remove methods changed outside of the scope of the sdk versions
+        methods = methods.select{|i| not i.attribute('api_added') or i.attribute('api_added').to_i <= target_api}
+        methods = methods.select{|i| not i.attribute('deprecated') or i.attribute('deprecated').to_i > min_api}
+        methods = methods.select{|i| not i.attribute('api_removed') or i.attribute('api_removed').to_i > min_api}
+
+        # Inform and remove methods that do not exist in one of the sdk versions
+        methods = methods.select do |i|
+          if i.attribute('api_removed') and i.attribute('api_removed').to_i <= target_api
+            puts "Can't create #{i.method_signature} -- removed in #{i.attribute('api_removed')}"
+            false
+          else
+            true
+          end
+        end
+
+        new_methods = methods
+        unless force
+          # Inform and remove methods changed inside the scope of the sdk versions
+          new_methods = methods.select do |i|
+            if i.attribute('api_added') and i.attribute('api_added').to_i > min_api
+              puts "Can't create #{i.method_signature} -- added in #{i.attribute('api_added')} -- exclude or force"
+              false
+            elsif i.attribute('deprecated') and i.attribute('deprecated').to_i <= target_api
+              puts "Can't create #{i.method_signature} -- deprecated in #{i.attribute('deprecated')} -- exclude or force"
+              false
+            else
+              true
+            end
+          end
+
+          abort("Aborting!") if methods.count != new_methods.count
+        end
+
+        new_methods
+      end
+
+      #
+      # generate_subclass_or_interface: Creates a subclass or interface based on the specifications.
+      #
+      def generate_subclass_or_interface(params)
+        defaults = {:template => "InheritingClass", :method_base => "all", :method_include => "", :method_exclude => "", :force => false, :implements => ""}
+        params = defaults.merge(params)
+        params[:package] = verify_package unless params[:package]
+
+        class_desc = get_class_or_interface(params[:class] || params[:interface], params[:force])
+
+        puts "Generating methods for #{params[:name]}..."
+        methods = class_desc.all_methods(params[:method_base], params[:method_include], params[:method_exclude], params[:implements])
+        methods = check_methods(methods, params[:force])
+        puts "Done. Methods created: #{methods.count}"
+
+        # Remove any duplicate constants (use *args handle multiple parameter lists)
+        constants = methods.map(&:constant_string).uniq
+
+        build_file params[:template], params[:package], params[:name], {
+          "THE_PACKAGE" => params[:package],
+          "THE_ACTION" => class_desc.name == "class" ? "extends" : "implements",
+          "THE_ANDROID_CLASS" => (params[:class] || params[:interface]) +
+          (params[:implements] == "" ? "" : (" implements " + params[:implements].split(",").join(", "))),
+          "THE_RUBOTO_CLASS" => params[:name],
+          "THE_CONSTANTS" =>  constants.map {|i| "public static final int #{i} = #{constants.index(i)};"}.indent.join("\n"),
+          "CONSTANTS_COUNT" => methods.count.to_s,
+          "THE_CONSTRUCTORS" => class_desc.name == "class" ?
+          class_desc.get_elements("constructor").map{|i| i.constructor_definition(params[:name])}.join("\n\n") : "",
+          "THE_METHODS" => methods.map{|i| i.method_definition}.join("\n\n")
+        }
+      end
+
+      #
+      # generate_core_classe: generates RubotoActivity, RubotoService, etc. based
+      #   on the API specifications.
+      #
+      def generate_core_classes(params)
+        %w(android.view.View.OnClickListener android.widget.AdapterView.OnItemClickListener).each do |i|
+          name = i.split(".")[-1]
+          if(params[:class] == name or params[:class] == "all")
+            generate_subclass_or_interface({:package => "org.ruboto.callbacks", :class => i, :name => "Ruboto#{name}"})
+          end
+        end
+
+        hash = {:package => "org.ruboto"}
+        %w(method_base method_include implements force).inject(hash) {|h, i| h[i.to_sym] = params[i.to_sym]; h}
+        hash[:method_exclude] = params[:method_exclude].split(",").push("onCreate").push("onReceive").join(",")
+
+        %w(android.app.Activity android.app.Service android.content.BroadcastReceiver android.view.View).each do |i|
+          name = i.split(".")[-1]
+          if(params[:class] == name or params[:class] == "all")
+            generate_subclass_or_interface(
+            hash.merge({:template => name == "View" ? "InheritingClass" : "Ruboto#{name}", :class => i, :name => "Ruboto#{name}"}))
+          end
+        end
+
+        # Activities that can be created, but only directly  (i.e., not included in all)
+        %w(android.preference.PreferenceActivity android.app.TabActivity).each do |i|
+          name = i.split(".")[-1]
+          if params[:class] == name
+            generate_subclass_or_interface(hash.merge({:template => "RubotoActivity", :class => i, :name => "Ruboto#{name}"}))
+          end
+        end
+      end
+
+      ###########################################################################
+      #
+      # generate_inheriting_file:
+      #   Builds a script based subclass of Activity, Service, or BroadcastReceiver
+      #
+
+      def generate_inheriting_file(klass, name, package, script_name, dest='.', filename = name)
+        file = File.join(dest, "src/#{package.gsub('.', '/')}", "#{filename}.java")
+        text = File.read(File.join(Ruboto::ASSETS, "src/Inheriting#{klass}.java"))
+        File.open(file, 'w') do |f|
+          f << text.gsub("THE_PACKAGE", package).gsub("Inheriting#{klass}", name).gsub("start.rb", script_name)
+        end
+
+        sample_source = File.read(File.join(Ruboto::ASSETS, "samples/sample_#{underscore klass}.rb")).gsub("THE_PACKAGE", package).gsub("Sample#{klass}", name).gsub("start.rb", script_name)
+        FileUtils.mkdir_p File.join(dest, 'assets/scripts')
+        File.open File.join(dest, "assets/scripts/#{script_name}"), "a" do |f|
+          f << sample_source
+        end
+
+        sample_test_source = File.read(File.join(Ruboto::ASSETS, "samples/sample_#{underscore klass}_test.rb")).gsub("THE_PACKAGE", package).gsub("Sample#{klass}", name)
+        FileUtils.mkdir_p File.join(dest, 'test/assets/scripts')
+        File.open File.join(dest, "test/assets/scripts/#{script_name.chomp('.rb')}_test.rb"), "a" do |f|
+          f << sample_test_source
+        end
+      end
+    end
+  end
+end

data/lib/ruboto/util/code_formatting.rb

@@ -0,0 +1,22 @@
+module Ruboto
+  module Util
+    module CodeFormatting
+      ###########################################################################
+      #
+      # Methods for formatting code
+      #
+      def method_call(return_type=nil, method_name="", parameters=[], body_clause=[])
+        ["public #{return_type || ""} #{method_name}(" + parameters.map{|i| "#{i[1]} #{i[0]}"}.join(", ") + ") {",
+        body_clause.indent, "}"]
+      end
+
+      def if_else(condition, if_clause, else_clause)
+        ["if (#{condition}) {", if_clause.indent, else_clause.compact.empty? ? nil : "} else {", else_clause.indent, "}"]
+      end
+
+      def try_catch(try_clause, catch_clause)
+        ["try {", try_clause.indent, "} catch (RaiseException re) {", catch_clause.indent, "}"]
+      end
+    end
+  end
+end

data/lib/ruboto/util/log_action.rb

@@ -0,0 +1,20 @@
+module Ruboto
+  module Util
+    module LogAction
+      ###########################################################################
+      #
+      # log_action: put text to stdout around the execution of a block
+      #
+      
+      def log_action(initial_text, final_text="Done.", &block)
+        $stdout.sync = true
+
+        print initial_text, "..."
+        result = yield
+        puts final_text
+        
+        result
+      end
+    end
+  end
+end

data/lib/ruboto/util/main_fix.rb

@@ -0,0 +1,13 @@
+# fix main (to an extent)
+module Main
+  class Program
+    module InstanceMethods
+      def setup_finalizers
+        @finalizers ||= []
+        ObjectSpace.define_finalizer(self) do
+          while((f = @finalizers.pop)); f.call; end
+        end
+      end
+    end
+  end
+end

data/lib/ruboto/util/objectspace.rb

@@ -0,0 +1,8 @@
+module Ruboto
+  # Enable ObjectSpace if running in JRuby, for the "main" lib
+  def self.enable_objectspace
+    require 'jruby'
+    JRuby.objectspace = true
+  rescue LoadError
+  end
+end

data/lib/ruboto/util/scan_in_api.rb

@@ -0,0 +1,40 @@
+module Ruboto
+  module Util
+    module ScanInAPI
+      ###########################################################################
+      #
+      # Scan the XML file. Much faster than using REXML.
+      #
+
+      def scan_in_api(file)
+        require 'strscan'
+        doc = StringScanner.new(file)
+        Thread.current[:api] = XMLElement.new
+        parents = [Thread.current[:api]]
+
+        while not doc.eos?
+          doc.scan(/</)
+          if doc.scan(/\/\w+>/)
+            parents.pop
+          else
+            name = doc.scan(/\w+/)
+            doc.scan(/\s+/)
+            values = {}
+            while not (term = doc.scan(/[\/>]/))
+              key = doc.scan(/\w+/)
+              doc.scan(/='/)
+              value = doc.scan(/[^']*/)
+              doc.scan(/'\s*/)
+              values[key] = value.include?("&") ? value.gsub('&lt;', '<').gsub('&gt;', '>').gsub('&quot;', "\"") : value
+            end
+            element = parents[-1].add_element(name, values)
+            parents.push(element) if term == ">"
+            doc.scan(/>/) if term == "/"
+          end
+        end
+
+        Thread.current[:api]
+      end
+    end
+  end
+end

data/lib/ruboto/util/update.rb

@@ -0,0 +1,102 @@
+module Ruboto
+  module Util
+    module Update
+      ###########################################################################
+      #
+      # Updating components
+      #
+
+      def update_jruby(force=nil)
+        jruby_core = Dir.glob("libs/jruby-core-*.jar")[0]
+        jruby_stdlib = Dir.glob("libs/jruby-stdlib-*.jar")[0]
+        new_jruby_version = JRubyJars::core_jar_path.split('/')[-1][11..-5]
+
+        unless force
+          abort "cannot find existing jruby jars in libs. Make sure you're in the root directory of your app" if
+          (not jruby_core or not jruby_stdlib)
+
+          current_jruby_version = jruby_core ? jruby_core[16..-5] : "None"
+          abort "both jruby versions are #{new_jruby_version}. Nothing to update. Make sure you 'gem update jruby-jars' if there is a new version" if
+          current_jruby_version == new_jruby_version
+
+          puts "Current jruby version: #{current_jruby_version}"
+          puts "New jruby version: #{new_jruby_version}"
+        end
+
+        copier = AssetCopier.new Ruboto::ASSETS, File.expand_path(".")
+        log_action("Removing #{jruby_core}") {File.delete jruby_core} if jruby_core
+        log_action("Removing #{jruby_stdlib}") {File.delete jruby_stdlib} if jruby_stdlib
+        log_action("Copying #{JRubyJars::core_jar_path} to libs") {copier.copy_from_absolute_path JRubyJars::core_jar_path, "libs"}
+        log_action("Copying #{JRubyJars::stdlib_jar_path} to libs") {copier.copy_from_absolute_path JRubyJars::stdlib_jar_path, "libs"}
+
+        reconfigure_jruby_libs
+
+        puts "JRuby version is now: #{new_jruby_version}"
+      end
+
+      def update_ruboto(force=nil)
+        verify_manifest
+
+        from = File.expand_path(Ruboto::GEM_ROOT + "/assets/assets/scripts/ruboto.rb")
+        to = File.expand_path("./assets/scripts/ruboto.rb")
+
+        from_text = File.read(from)
+        to_text = File.read(to) if File.exists?(to)
+
+        unless force
+          puts "New version: #{from_text[/\$RUBOTO_VERSION = (\d+)/, 1]}"
+          puts "Old version: #{to_text ? to_text[/\$RUBOTO_VERSION = (\d+)/, 1] : 'none'}"
+
+          abort "The ruboto.rb verion has not changed. Use --force to force update." if
+          from_text[/\$RUBOTO_VERSION = (\d+)/, 1] == to_text[/\$RUBOTO_VERSION = (\d+)/, 1]
+        end
+
+        log_action("Copying ruboto.rb and setting the package name") do
+          File.open(to, 'w') {|f| f << from_text.gsub("THE_PACKAGE", verify_package).gsub("ACTIVITY_NAME", verify_activity)}
+        end
+      end
+
+      #
+      # reconfigure_jruby_libs:
+      #   - removes unneeded code from jruby-core
+      #   - moves ruby stdlib to the root of the ruby-stdlib jar
+      #
+
+      def reconfigure_jruby_libs
+        jruby_core = JRubyJars::core_jar_path.split('/')[-1]
+        log_action("Removing unneeded classes from #{jruby_core}") do
+          Dir.mkdir "libs/tmp"
+          Dir.chdir "libs/tmp"
+          FileUtils.move "../#{jruby_core}", "."
+          `jar -xf #{jruby_core}`
+          File.delete jruby_core
+          ['cext', 'jni', 'org/jruby/ant', 'org/jruby/compiler/ir', 'org/jruby/demo', 'org/jruby/embed/bsf',
+            'org/jruby/embed/jsr223', 'org/jruby/ext/ffi','org/jruby/javasupport/bsf'
+            ].each {|i| FileUtils.remove_dir i, true}
+            `jar -cf ../#{jruby_core} .`
+            Dir.chdir "../.."
+            FileUtils.remove_dir "libs/tmp", true
+          end
+
+          jruby_stdlib = JRubyJars::stdlib_jar_path.split('/')[-1]
+          log_action("Reformatting #{jruby_stdlib}") do
+            Dir.mkdir "libs/tmp"
+            Dir.chdir "libs/tmp"
+            FileUtils.move "../#{jruby_stdlib}", "."
+            `jar -xf #{jruby_stdlib}`
+            File.delete jruby_stdlib
+            FileUtils.move "META-INF/jruby.home/lib/ruby/1.8", ".."
+            Dir["META-INF/jruby.home/lib/ruby/site_ruby/1.8/*"].each do |f|
+              next if File.basename(f) =~ /^..?$/
+              FileUtils.move f, "../1.8/" + File.basename(f)
+            end
+            Dir.chdir "../1.8"
+            FileUtils.remove_dir "../tmp", true
+            `jar -cf ../#{jruby_stdlib} .`
+            Dir.chdir "../.."
+            FileUtils.remove_dir "libs/1.8", true
+          end
+        end
+      end
+    end
+  end

data/lib/ruboto/util/verify.rb

@@ -0,0 +1,59 @@
+require 'ruboto/api'
+
+module Ruboto
+  module Util
+    module Verify
+      ###########################################################################
+      #
+      # Verify the presence of important components
+      #
+
+      def verify_manifest
+        abort "cannot find your AndroidManifest.xml to extract info from it. Make sure you're in the root directory of your app" unless
+        File.exists? 'AndroidManifest.xml'
+        @manifest ||= REXML::Document.new(File.read('AndroidManifest.xml')).root
+      end
+
+      def verify_package
+        verify_manifest
+        @package ||= @manifest.attribute('package').value
+      end
+
+      def verify_activity
+        verify_manifest
+        @activity ||= @manifest.elements['application/activity'].attribute('android:name').value
+      end
+
+      def verify_sdk_versions
+        verify_manifest
+        @uses_sdk ||= @manifest.elements["uses-sdk"]
+        abort "you must specify your sdk level in the manifest (e.g., <uses-sdk android:minSdkVersion='3' android:targetSdkVersion='8' />)" unless @uses_sdk
+        @uses_sdk
+      end
+
+      def verify_min_sdk
+        verify_sdk_versions
+        @min_sdk ||= @uses_sdk.attribute('android:minSdkVersion').value
+        abort "you must specify a minimum sdk level in the manifest (e.g., <uses-sdk android:minSdkVersion='3' android:targetSdkVersion='8' />)" unless @min_sdk
+        @min_sdk
+      end
+
+      def verify_target_sdk
+        verify_sdk_versions
+        @target_sdk ||= @uses_sdk.attribute('android:targetSdkVersion').value
+        abort "you must specify a target sdk level in the manifest (e.g., <uses-sdk android:minSdkVersion='3' android:targetSdkVersion='8' />)" unless @target_sdk
+        @target_sdk
+      end
+
+      def verify_strings
+        abort "cannot find your strings.xml to extract info from it. Make sure you're in the root directory of your app" unless
+        File.exists? 'res/values/strings.xml'
+        @strings ||= REXML::Document.new(File.read('res/values/strings.xml'))
+      end
+
+      def verify_api
+        Ruboto::API.api
+      end
+    end
+  end
+end