java_override 0.1.3-java

data/.gitignore

@@ -0,0 +1,25 @@
+*.swp
+.rvmrc
+.vimrc
+Gemfile.lock
+pkg/
+vendor/cache/*.gem
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+*.class

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2012-07-29
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Szymon Wrozynski
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+Java::Override JRuby Module
+===========================
+
+* [Homepage](https://rubygems.org/gems/java_override)
+* [Documentation](http://rubydoc.info/gems/java_override/frames)
+
+Description
+-----------
+
+Java::Override is a JRuby module enabling overriding native Java methods with
+Ruby naming conventions. JRuby allows you to call Java methods (of Java classes/interfaces)
+with Ruby conventions. You can use so called *snake_case*, Java Beans accessors are
+*translated* to Ruby ones (e.g. <code>getFooBar</code> can be accessed via <code>foo\_bar</code>,
+<code>isFooBar</code> via <code>foo\_bar?</code>, or <code>setFooBar</code> via <code>foo\_bar=</code>).
+Those methods are added to Java classes as JRuby aliases. However, if you want to override
+a Java method you cannot override such alias because Java will not see it. Java will do polymorphic
+call of its own, native methods. Therefore you have to override native Java methods and it
+doesn't look pretty in JRuby code.
+
+The Java::Override module abolishes this inconvenience. Once included in the subclass it
+creates aliases to native java methods and supports inheritance and polymorphism that way.
+Moreover, it adds proper aliases for Java interfaces included as modules.
+
+Examples
+--------
+
+Look at the following implementation of javax.swing.table.AbstractTableModel class.
+
+    require 'java/override'
+
+    java_import javax::swing::table::AbstractTableModel
+
+    class MyTableModel < AbstractTableModel
+      include Java::Override
+
+      def initialize
+        super
+        @column_names = ['First Name', 'Last Name']
+        @data = [
+          ['John', 'Doe'],
+          ['Jack', 'FooBar']
+        ]
+      end
+
+      def column_count
+        @column_names.size
+      end
+
+      def row_count
+        @data.size
+      end
+
+      def column_name(col)
+        @column_names[col]
+      end
+
+      def get_value_at(row, col)
+        @data[row][col]
+      end
+
+      def column_class(col)
+        get_value_at(0, c).java_class
+      end
+
+      def cell_editable?(row, col)
+        col.zero?
+      end
+
+      def set_value_at(value, row, col)
+        @data[row][col] = value
+        fire_table_cell_updated(row, col)
+      end
+    end
+
+Requirements
+------------
+
+Java::Override requires JRuby in 1.9 mode and a decent JVM. It has been tested
+under JRuby 1.6.2 and Oracle Java 7 JDK.
+
+Install
+-------
+
+    $ gem install java_override
+
+Copyright
+---------
+
+Copyright (c) 2012 Szymon Wrozynski
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/java_override.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+require_relative 'lib/java/override/version'
+
+Gem::Specification.new do |gem|
+  gem.name                  = "java_override"
+  gem.version               = Java::Override::VERSION
+  gem.summary               = %q{Support for Java class and interface inheritance in JRuby}
+  gem.description           = %q{Support for Java class and interface inheritance in JRuby. Enable overriding native Java methods with JRuby ones follwing Ruby naming conventions.}
+  gem.license               = "MIT"
+  gem.authors               = ["Szymon Wrozynski"]
+  gem.email                 = "szymon@wrozynski.com"
+  gem.homepage              = "https://rubygems.org/gems/java_override"
+
+  gem.required_ruby_version = '>= 1.9.2'
+  gem.platform              = 'java'
+
+  gem.files                 = `git ls-files`.split($/)
+  gem.executables           = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files            = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths         = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 0.8'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'shoulda'
+end

data/lib/java/override.rb

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+#
+# Java::Override JRuby Module
+# Copyright (c) 2012 Szymon Wrozynski
+# Licensed under the MIT License conditions.
+#
+# Support for Java class inheritance in JRuby.
+# Enable overriding plain Java methods with Ruby naming conventions.
+
+require 'java'
+require 'set'
+require 'java/override/version'
+
+module Java
+  module Override
+
+    private
+
+    def method_added(m)
+      return if @_java_override_internal_call
+      @_java_override_internal_call = true
+
+      unless private_instance_methods(true).include?(m)
+        super_methods = Set.new(superclass.instance_methods.map(&:to_s))
+
+        included_modules.each do |i|
+          if i.respond_to?(:java_class)
+            super_methods.merge(i.java_class.java_instance_methods.map(&:name).uniq)
+          end
+        end
+
+        if m.to_s.end_with?('?')
+          prefix = 'is'
+        elsif m.to_s.end_with?('=')
+          prefix = 'set'
+        else
+          prefix = 'get'
+        end
+
+        base = m.to_s.gsub(/[^a-z0-9]/i, '')
+
+        find_java_m = ->(n) { super_methods.find { |m| m.to_s.casecmp(n).zero? } }
+        java_m = find_java_m.call("#{prefix}#{base}") || find_java_m.call(base)
+
+        alias_method(java_m, m) if java_m && java_m != m.to_s
+      end
+
+      remove_instance_variable(:@_java_override_internal_call)
+    end
+
+    def self.included(klass)
+      klass.extend(self)
+      klass.send(:undef_method, :method_added)
+    end
+  end
+end

data/lib/java/override/version.rb

@@ -0,0 +1,6 @@
+module Java
+  module Override
+    # Java::Override version
+    VERSION = "0.1.3"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'test/unit'
+
+class Test::Unit::TestCase
+end

data/test/java/TestInterface.java

@@ -0,0 +1,4 @@
+public interface TestInterface {
+    String method();
+    String myLongMethodNameWithABBRV();
+}

data/test/java/TestSuperclass.java

@@ -0,0 +1,39 @@
+public class TestSuperclass {
+    protected String foo;
+
+    public String method() {
+        return "TestSuperclass#method";
+    }
+
+    public String myLongMethodName() {
+        return "TestSuperclass#myLongMethodName";
+    }
+
+    public String myLongMethodNameWithABBRV() {
+        return "TestSuperclass#myLongMethodNameWithABBRV";
+    }
+
+    public boolean isFooBar() {
+        return true;
+    }
+
+    public String getFoo() {
+        return this.foo;
+    }
+
+    public void setFoo(String foo) {
+        this.foo = foo;
+    }
+
+    public String testInterface(TestInterface ti) {
+        return ti.method() + ti.myLongMethodNameWithABBRV();
+    }
+
+    protected String protectedMethod() {
+        return "TestSuperclass#protectedMethod";
+    }
+
+    public String testProtectedMethod() {
+        return protectedMethod();
+    }
+}

data/test/test_java_override.rb

@@ -0,0 +1,135 @@
+require 'helper'
+require 'java'
+require 'java/override'
+require 'shoulda'
+require 'fileutils'
+
+`javac -d . #{File.join('test', 'java', 'TestInterface.java')} #{File.join('test', 'java', 'TestSuperclass.java')}`
+
+java_import "TestInterface"
+java_import "TestSuperclass"
+
+FileUtils.rm 'TestInterface.class'
+FileUtils.rm 'TestSuperclass.class'
+
+class TestJavaOverride < Test::Unit::TestCase
+  def setup
+    @superclass = TestSuperclass.new
+    @my_class = MyClass.new
+  end
+
+  should "have version" do
+    version = Java::Override.const_get('VERSION')
+
+    assert !version.empty?, 'should have a VERSION constant'
+  end
+
+  should "override simple methods" do
+    assert_equal "MyClass: TestSuperclass#myLongMethodName", @my_class.my_long_method_name
+    assert_equal "MyClass: TestSuperclass#myLongMethodName", @my_class.myLongMethodName
+  end
+
+  should "override javabean accessors" do
+    @my_class.foo = 'FOO'
+
+    assert_equal "MyClassGetter: MyClassSetter: FOO", @my_class.foo
+    assert_equal "MyClassGetter: MyClassSetter: FOO", @my_class.getFoo
+
+    assert TestSuperclass.new.foo_bar?
+    assert TestSuperclass.new.isFooBar
+
+    refute @my_class.foo_bar?
+    refute @my_class.isFooBar
+  end
+
+  should "not add aliases for private methods" do
+    assert MyClass.private_instance_methods(true).include?(:my_private_method)
+    refute MyClass.private_instance_methods(true).include?(:myPrivateMethod)
+    refute MyClass.instance_methods(false).include?(:myPrivateMethod)
+  end
+
+  should "add method_added only to the singleton class even if included" do
+    refute_respond_to @my_class, :method_added
+    refute MyClass.instance_methods.include?(:method_added)
+  end
+
+  should "add method_added as a private singleton method" do
+    assert MyClass.private_methods.include?(:method_added)
+    assert MyClass.class.private_instance_methods(true).include?(:method_added)
+  end
+
+  should "handle names with abbreviations written in upper case" do
+    assert_equal "MyClass: TestSuperclass#myLongMethodNameWithABBRV", @my_class.my_long_method_name_with_abbrv
+    assert_equal "MyClass: TestSuperclass#myLongMethodNameWithABBRV", @my_class.myLongMethodNameWithABBRV
+  end
+
+  should "handle plain method names" do
+    assert_equal "MyClass: TestSuperclass#method", @my_class.method
+  end
+
+  should "handle protected methods" do
+    assert_equal "MyClass: TestSuperclass#protectedMethod", @my_class.test_protected_method
+    assert_equal "MyClass: TestSuperclass#protectedMethod", @my_class.testProtectedMethod
+  end
+
+  should "handle interface methods" do
+    assert_equal(
+      "MyInterface#methodMyInterface#my_long_method_name_with_abbrv",
+      @my_class.testInterface(MyInterfaceImpl.new)
+    )
+  end
+end
+
+
+class MyClass < TestSuperclass
+  include Java::Override
+
+  def method
+    "MyClass: #{super}"
+  end
+
+  def my_long_method_name
+    "MyClass: #{super}"
+  end
+
+  def my_long_method_name_with_abbrv
+    "MyClass: #{super}"
+  end
+
+  def foo_bar?
+    !super
+  end
+
+  def foo
+    "MyClassGetter: #{super}"
+  end
+
+  def foo=(foo)
+    super("MyClassSetter: #{foo}")
+  end
+
+  protected
+
+  def protected_method
+    "MyClass: #{super}"
+  end
+
+  private
+
+  def my_private_method
+
+  end
+end
+
+class MyInterfaceImpl
+  include Java::Override
+  include TestInterface
+
+  def method
+    "MyInterface#method"
+  end
+
+  def my_long_method_name_with_abbrv
+    "MyInterface#my_long_method_name_with_abbrv"
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: java_override
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.3
+platform: java
+authors:
+- Szymon Wrozynski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+description: Support for Java class and interface inheritance in JRuby. Enable overriding native Java methods with JRuby ones follwing Ruby naming conventions.
+email: szymon@wrozynski.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- java_override.gemspec
+- lib/java/override.rb
+- lib/java/override/version.rb
+- test/helper.rb
+- test/java/TestInterface.java
+- test/java/TestSuperclass.java
+- test/test_java_override.rb
+homepage: https://rubygems.org/gems/java_override
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Support for Java class and interface inheritance in JRuby
+test_files:
+- test/helper.rb
+- test/java/TestInterface.java
+- test/java/TestSuperclass.java
+- test/test_java_override.rb
+...