eclipse-plugin 0.0.1

data/README.textile

@@ -0,0 +1,42 @@
+h1. Eclipse::Plugin
+
+A Ruby Gem to extract information about views, properties and perspectives from an eclipse plugin or a workspace
+
+Use it at your own risk, as it is just a small utility gem to help for some release engineering for the Elexis-RCP. See http://elexis.info.
+
+But I have an open ear for suggestions for improvements, especially if they come with a patch including specs.
+
+License: GPLv3 or later
+
+Copyright: 2014 (c) by Niklaus Giger <niklaus.giger@member.fsf.org>
+
+h2. Installation
+
+Add this line to your application's Gemfile:
+
+bc.   $ gem 'eclipse-plugin'
+
+And then execute:
+
+bc.   $ bundle
+
+Or install it yourself as:
+
+bc.   $ gem install eclipse-plugin
+
+h2. Usage
+
+bc.  require 'eclipse/plugin'
+  workspace =  Eclipse::Workspace.new('/path/to/eclipse/app')
+  workspace.parsePluginDir
+  workspace.views.first {|view| puts view.id }
+
+Or you can inspire you from the spec/*_spec.rb files to see tested examples.
+
+h2. Contributing
+
+# Fork it ( http://github.com/<my-github-username>/eclipse-plugin/fork )
+# Create your feature branch (`git checkout -b my-new-feature`)
+# Commit your changes (`git commit -am 'Add some feature'`)
+# Push to the branch (`git push origin my-new-feature`)
+# Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/eclipse-plugin.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eclipse/plugin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eclipse-plugin"
+  spec.version       = Eclipse::Plugin::VERSION
+  spec.authors       = ["Niklaus Giger"]
+  spec.email         = ["niklaus.giger@member.fsf.org"]
+  spec.summary       = "Extract information about views, properties and perspectives from an eclipse plugin"
+  spec.description   = "Extracts localized info out of an Eclipse plugin jar"
+  spec.homepage      = ""
+  spec.license       = "GPLv3"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'rubyzip', '>= 1.0.0'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry-debugger"
+end

data/lib/eclipse/helpers.rb

@@ -0,0 +1,21 @@
+#encoding : utf-8
+require 'iconv' unless String.method_defined?(:encode)
+
+module Eclipse
+
+  module Helpers
+
+    module_function
+
+    # properties files are saved (at least in the cases, that interest me)
+    # as ISO-8859-15 files
+    def unescape(inhalt)
+      if String.method_defined?(:encode)
+        inhalt.encode!('UTF-8', 'ISO-8859-15', :invalid => :replace)
+      else
+        ic = Iconv.new('UTF-8//IGNORE', 'ISO-8859-15')
+        inhalt = ic.iconv(inhalt)
+      end
+    end
+  end
+end

data/lib/eclipse/plugin.rb

@@ -0,0 +1,201 @@
+require "eclipse/plugin/version"
+
+require 'zip'
+require "rexml/document"
+include REXML  # so that we don't have to prefix everything with REXML::...
+
+module Eclipse
+  class Workspace
+    attr_reader :workspace_dir, :views, :view_categories, :preferencePages, :perspectives, :preferencePage_categories
+    def initialize(workspace_dir)
+      @workspace_dir             = workspace_dir
+      @views                     = Hash.new
+      @view_categories           = Hash.new
+      @preferencePages           = Hash.new
+      @perspectives              = Hash.new
+      @preferencePage_categories       = Hash.new
+    end
+    
+    def parsePluginDir(plugins_dir = File.join(@workspace_dir, "plugins"))
+      name = "#{plugins_dir}/*.jar"
+      Dir.glob(name).each{
+        |jarname|
+          info = Plugin::Info.new(jarname)
+          fields = [:views, :view_categories, :preferencePages, :perspectives, :preferencePage_categories]
+          info.views.each{ |k, v| @views[k] = v }
+          info.view_categories.each{ |k, v| @views[k] = v }
+          info.perspectives.each{ |k, v| @views[k] = v }
+          info.preferencePages.each{ |k, v| @views[k] = v }
+          info.preferencePage_categories.each{ |k, v| @views[k] = v }
+      }
+    end
+  end
+  
+  module Plugin
+    class Info
+      # Some helper classes for the extension points we are interested in
+      UI_PreferencePage = Struct.new('UI_PreferencePage', :id, :category, :translation)
+      UI_View           = Struct.new('UI_View',           :id, :category, :translation)
+      UI_Perspective    = Struct.new('UI_Perspective',    :id, :category, :translation)
+      Category          = Struct.new('Category',    :id, :name, :translation)
+      attr_reader :iso, :views, :view_categories, :preferencePages, :perspectives, :workspace, :preferencePage_categories
+
+      def initialize(jarname, iso='de')
+        @workspace                 = File.dirname(jarname).sub(/\/plugins$/, '')
+        @iso                       = iso
+        @jarname                   = jarname
+        @jarfile                   = Zip::File.open(jarname)
+        @views                     = Hash.new
+        @view_categories           = Hash.new
+        @preferencePages           = Hash.new
+        @perspectives              = Hash.new
+        @preferencePage_categories       = Hash.new
+        # we use hashes to be able to find the categories fast
+        readPluginXML(File.basename(jarname))
+      rescue => e # HACK: we need this to handle org.apache.commons.lang under Windows-7
+        puts "Skipped plugin #{File.expand_path(jarname)}"
+        puts "error was #{e.inspect}"
+        puts caller
+      end
+
+      def addCategory(hash, id, name = nil)
+        return if hash[id] and hash[id].translation
+        hash[id] = Category.new(id, name) unless hash[id]
+        translation = getTranslationForPlugin(name, @iso) if name
+        hash[id].translation = translation if name and translation
+        puts "#{File.basename(@jarname)}: Added category #{id} name #{name} tr '#{translation}'" if $VERBOSE
+      end
+
+      def getTranslatedPreferencePages
+        all = []
+        @preferencePages.each{
+          |id, content|
+            unless content.category
+              next if @preferencePages.find { |sub_id, x| x.category.eql?(content.id) }
+            end
+            category =  content.category
+            cat_trans = content.translation
+            text = nil
+            if @preferencePage_categories[category]
+              text = "#{@preferencePage_categories[category].translation}/#{content.translation}"
+              puts "preferencePages #{id} category #{category.inspect} text #{cat_trans}" if $VERBOSE
+            else
+              text = content.translation
+              puts "preferencePages #{id} text #{text}" if $VERBOSE
+            end
+            all << text
+        }
+        all.sort.reverse.uniq if all and all.size > 0
+      end
+
+      def getTranslatedViews
+        all = []
+        @views.each{
+          |id, content|
+            category =  content.category
+            cat_trans = content.translation
+            text = nil
+            if category
+              text = "#{@view_categories[category].translation}/#{content.translation}"
+            else
+              text = "Other/#{content.translation}"
+            end
+            all << text if text
+        }
+        all.sort.reverse.uniq if all and all.size > 0
+      end
+      def getTranslatedPerspectives
+        all = []
+        @perspectives.each{
+          |id, content|
+            category =  content.category
+            cat_trans = content.translation
+            text = nil
+            if category
+              text = "#{@perspectives[category].translation}/#{content.translation}"
+              puts "perspectives #{id} category #{category.inspect} text #{cat_trans}" if $VERBOSE
+            else
+              text = content.translation
+              puts "perspectives #{id} categories #{category} text #{text}" if $VERBOSE
+            end
+            all << text
+        }
+        all.sort.reverse.uniq if all and all.size > 0
+      end
+
+      def getTranslationForPlugin(look_for, iso)
+        properties = "plugin_#{iso}.properties"
+        properties = "plugin.properties" unless @jarfile.find_entry(properties)
+        puts "Looking for translation of #{look_for} in #{properties}"  if $VERBOSE
+        line_nr = 0
+        @jarfile.read(properties).split("\n").each {
+          |line|
+              line_nr += 1
+              id,value = line.split(' = ')
+              if id and id.index(look_for) and value
+                return Helpers::unescape(value.sub("\r","").sub("\n",""))
+              else id,value = line.split('=')
+                return Helpers::unescape(value.sub("\r","").sub("\n","")) if id and id.index(look_for)
+              end
+        } if @jarfile.find_entry(properties)
+        return look_for # default
+      end
+
+      def readPluginXML(plugin_xml)
+        return unless  @jarfile.find_entry('plugin.xml')
+        doc = Document.new @jarfile.read('plugin.xml')
+        # Get all perspectives
+        root = doc.root
+        res = []
+        root.elements.collect { |x| res << x if /org.eclipse.ui.perspectives/.match(x.attributes['point']) }
+        res[0].elements.each{
+          |x|
+          id = x.attributes['name'].sub(/^%/,'')
+          @perspectives[id] = UI_Perspective.new(id, nil, getTranslationForPlugin(id, @iso))
+        } if res and res[0] and res[0].elements
+        puts "found #{@perspectives.size} perspectives in #{plugin_xml}" if $VERBOSE
+
+        # Get all views
+        res = []
+        root.elements.collect { |x| res << x if /org.eclipse.ui.views/.match(x.attributes['point']) }
+        res[0].elements.each{
+          |x|
+          name     = x.attributes['name'].sub(/^%/,'') if  x.attributes['name']
+          id       = x.attributes['id'].sub(/^%/,'')
+          if x.name.eql?('category')
+            addCategory(@view_categories, id, name)
+          elsif x.attributes['name']
+            category = x.attributes['category']
+            translation =  getTranslationForPlugin(name, @iso)
+            puts "#{File.basename(@jarname, '.jar')}: Adding view: id #{id} category #{category.inspect} translation #{translation}" if $VERBOSE
+            unless category
+              @views[id]           = UI_View.new(id, nil, translation)
+            else
+              @views[id]           = UI_View.new(id, category, translation)
+            end
+          end
+        } if res and res[0] and res[0].elements
+        puts "found #{@views.size} views and #{@view_categories.size} categories" if $VERBOSE
+
+        # Get all preferencePages
+        res = []
+        root.elements.collect { |x| res << x if /org.eclipse.ui.preferencePages/.match(x.attributes['point']) }
+        res[0].elements.each{
+          |x|
+          name     = x.attributes['name'].sub(/^%/,'')
+          id       = x.attributes['id'].sub(/^%/,'')
+          category = x.attributes['category']
+          addCategory(@preferencePage_categories, id, name) unless category
+          translation =  getTranslationForPlugin(name, @iso)
+          puts "Adding preferences: id #{id} category #{category.inspect} translation #{translation}" if $VERBOSE
+          unless category
+            @preferencePages[id]           = UI_PreferencePage.new(id, nil, translation)
+          else
+            @preferencePages[id]           = UI_PreferencePage.new(id, category, translation)
+          end
+        } if res and res[0] and res[0].elements
+        puts "#{sprintf("%-40s", File.basename(File.dirname(plugin_xml)))}: now #{@preferencePages.size} preferencePages" if $VERBOSE
+      end
+    end
+  end
+end

data/lib/eclipse/plugin/version.rb

@@ -0,0 +1,5 @@
+module Eclipse
+  module Plugin
+    VERSION = "0.0.1"
+  end
+end

data/spec/data/plugin_de.properties

@@ -0,0 +1,3 @@
+#Created by JInto - www.guh-software.de
+Ansicht=Agenda-Ansicht
+Add_Recurring_Appointment=Terminserie hinzuf�gen

data/spec/helpers_spec.rb

@@ -0,0 +1,21 @@
+#encoding : utf-8
+require 'spec_helper'
+
+require 'eclipse/plugin'
+require 'eclipse/helpers'
+
+describe 'Helpers' do
+
+  before :each do
+    @dataDir =  File.expand_path(File.join(File.dirname(__FILE__), 'data'))
+  end
+
+  it "should escape a property_string into an UTF-8 string" do
+     IO.readlines(File.join(@dataDir, 'plugin_de.properties')).each{
+       |line|
+        next unless line.index('Add_Recurring_Appointment')
+        unescaped = Eclipse::Helpers.unescape(line)
+        unescaped.should match /hinzufügen/
+     }
+  end
+end

data/spec/plugin_spec.rb

@@ -0,0 +1,84 @@
+#encoding : utf-8
+require 'spec_helper'
+
+require 'eclipse/plugin'
+
+describe 'Plugin' do
+
+  CHECK_4_VIEW            = 'ch.elexis.views.TemplatePrintView'
+  CHECK_4_PERSPECTIVE     = 'elexis.articlePerspective'
+  CHECK_4_PREFERENCE_PAGE = 'org.iatrix.preferences.IatrixPreferences'
+  APP_JAR                 = 'ch.elexis.core.application_3.0.0.v20140314-1352.jar'
+  IATRIX_JAR              = 'org.iatrix_3.0.0.v20140313-1017.jar'
+  JAR_WITHOUT_LOCALIZE    = 'ch.elexis.laborimport.hl7.allg-3.0.0-SNAPSHOT.jar'
+  before :all do
+    @dataDir =  File.expand_path(File.join(File.dirname(__FILE__), 'data'))
+  end
+
+  it "should run the readme example" do
+      require 'eclipse/plugin'
+      workspace =  Eclipse::Workspace.new(@dataDir)
+      workspace.parsePluginDir
+      workspace.views.first {|view| puts view.id }
+      workspace.views.size.should == 66
+  end
+
+  it "must be able to analyse a plugin.xml without localization" do
+    plugin = File.join(@dataDir, 'plugins', JAR_WITHOUT_LOCALIZE)
+    info = Eclipse::Plugin::Info.new(plugin)
+    info.preferencePages['ch.elexis.laborimport.hl7.preferences'].should_not be nil
+    info.workspace.should == @dataDir
+  end
+
+  it "must be able to analyse a plugin.xml with localization" do
+    plugin = File.join(@dataDir, 'plugins', IATRIX_JAR)
+    info = Eclipse::Plugin::Info.new(plugin)
+    info.views['org.iatrix.views.JournalView'].should_not be nil
+    info.view_categories['org.iatrix'].should_not be nil
+    info.workspace.should == @dataDir
+  end
+
+  it "must return the perspectives" do
+    plugin = File.join(@dataDir, 'plugins', APP_JAR)
+    info = Eclipse::Plugin::Info.new(plugin)
+    info.perspectives[CHECK_4_PERSPECTIVE].should_not be nil
+  end
+
+  it "must return the preferencePages" do
+    plugin = File.join(@dataDir, 'plugins', IATRIX_JAR)
+    info = Eclipse::Plugin::Info.new(plugin)
+    info.preferencePages[CHECK_4_PREFERENCE_PAGE].should_not be nil
+  end
+
+  it "must return the correct translation for a view" do
+    plugin = File.join(@dataDir, 'plugins', APP_JAR)
+    info = Eclipse::Plugin::Info.new(plugin)
+    info.views[CHECK_4_VIEW].should_not be nil
+    german = 'Vorlage Drucken'
+    info.views[CHECK_4_VIEW].translation.should == german
+    pp info.getTranslatedViews.find_all{ |item| item.match(german) }
+    info.workspace.should == @dataDir
+    info.getTranslatedViews.find_all{ |item| item.match(german) }.should_not be nil
+  end
+
+  it "must return the correct translation for a preferencePage" do
+    plugin = File.join(@dataDir, 'plugins', IATRIX_JAR)
+    info = Eclipse::Plugin::Info.new(plugin)
+    info.preferencePages[CHECK_4_PREFERENCE_PAGE].should_not be nil
+    german = 'Iatrix'
+    info.preferencePages[CHECK_4_PREFERENCE_PAGE].translation.should == german
+    info.workspace.should == @dataDir
+    info.getTranslatedPreferencePages.find_all{ |item| item.match(german) }.should_not be nil
+  end
+
+  it "must return the correct translation for a perspective" do
+    plugin = File.join(@dataDir, 'plugins', APP_JAR)
+    info = Eclipse::Plugin::Info.new(plugin)
+    info.perspectives[CHECK_4_PERSPECTIVE].should_not be nil
+    german = 'Artikel'
+    info.perspectives[CHECK_4_PERSPECTIVE].translation.should == german
+    info.workspace.should == @dataDir
+    info.getTranslatedPerspectives.find_all{ |item| item.match(german) }.should_not be nil
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler.setup(:default, :development)
+
+unless RUBY_PLATFORM =~ /java/
+  require "simplecov"
+  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+  SimpleCov.start do
+      add_filter "spec"
+  end
+end
+
+require "rspec"
+

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: eclipse-plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Niklaus Giger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extracts localized info out of an Eclipse plugin jar
+email:
+- niklaus.giger@member.fsf.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.textile
+- Rakefile
+- eclipse-plugin.gemspec
+- lib/eclipse/helpers.rb
+- lib/eclipse/plugin.rb
+- lib/eclipse/plugin/version.rb
+- spec/data/plugin_de.properties
+- spec/data/plugins/ch.elexis.core.application_3.0.0.v20140314-1352.jar
+- spec/data/plugins/ch.elexis.laborimport.hl7.allg-3.0.0-SNAPSHOT.jar
+- spec/data/plugins/org.iatrix_3.0.0.v20140313-1017.jar
+- spec/helpers_spec.rb
+- spec/plugin_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- GPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Extract information about views, properties and perspectives from an eclipse
+  plugin
+test_files:
+- spec/data/plugin_de.properties
+- spec/data/plugins/ch.elexis.core.application_3.0.0.v20140314-1352.jar
+- spec/data/plugins/ch.elexis.laborimport.hl7.allg-3.0.0-SNAPSHOT.jar
+- spec/data/plugins/org.iatrix_3.0.0.v20140313-1017.jar
+- spec/helpers_spec.rb
+- spec/plugin_spec.rb
+- spec/spec_helper.rb