instadoc 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+#RubyMine
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@instadoc --create

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.3

data/Changelog.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/.+_helper\.rb$}) { "spec" }
+  watch(%r{^spec/.+_matcher\.rb$}) { "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { "spec" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Markus Hanses
+
+MIT License
+
+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,34 @@
+[![Build Status](https://secure.travis-ci.org/marhan/instadoc.png)](http://travis-ci.org/marhan/instadoc)
+
+# Instadoc
+
+Reads annotated Java code and collects the inserted documentation and creates a summery.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'instadoc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install instadoc
+
+## Usage
+
+    $instadoc -s /path/to/source html -o output.html -l http://server/path/PLACEHOLDER
+
+Use the upper case string `PLACEHOLDER` is a placeholder for package and Java file name.
+The placeholder will be created by the relative path from the given source path `-s /path/to/source` as a base path and the Java file itself.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/README.rdoc

@@ -0,0 +1,6 @@
+= instadoc
+
+Describe your project here
+
+:include:instadoc.rdoc
+

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+#default
+task :default => :spec

data/bin/instadoc

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'instadoc'
+
+include GLI::App
+
+program_desc 'A documentation generation tool for source code'
+
+version Instadoc::VERSION
+
+desc 'be verbose'
+switch [:v, :verbose]
+
+desc 'The path to Java source'
+default_value './java'
+arg_name 'source_path'
+flag [:s, :source_path]
+
+desc 'Generates a HTML overview'
+command :html do |html_command|
+
+  html_command.desc 'HTML output file'
+  html_command.default_value 'overview.html'
+  html_command.arg_name 'output_file'
+  html_command.flag [:o, :output_file]
+
+  html_command.desc 'Link to source in web'
+  html_command.default_value 'file:///'
+  html_command.arg_name 'hyperlink'
+  html_command.flag [:l, :hyperlink]
+
+  html_command.action do |global_options, options, args|
+
+    verbose = !global_options[:v].nil?
+    source_path = global_options[:s]
+    html_output_path = options[:o]
+    hyperlink = options[:l]
+
+    unless verbose
+      puts "I will use following option"
+      puts "Global options:"
+      puts "-v = #{verbose}"
+      puts "-s = #{source_path}"
+      puts ""
+      puts "HTML command options:"
+      puts "-o = #{html_output_path}"
+      puts "-l = #{hyperlink}"
+      puts ""
+    end
+
+    Instadoc.generate_html(verbose, source_path, html_output_path, hyperlink)
+
+  end
+end
+
+pre do |global, command, options, args|
+  # Pre logic here
+  # Return true to proceed; false to abourt and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global, command, options, args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  puts exception
+  true
+end
+
+exit run(ARGV)

data/instadoc.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__), 'lib', 'instadoc', 'version.rb'])
+
+spec = Gem::Specification.new do |gem|
+  gem.name = 'instadoc'
+  gem.version = Instadoc::VERSION
+  gem.platform = Gem::Platform::RUBY
+  gem.summary = 'A documentation generation tool for source code'
+
+  gem.author = 'Markus Hanses'
+  gem.email = 'me@markushanses.de'
+  gem.homepage = 'https://github.com/marhan/instadoc'
+
+  gem.files = `git ls-files`.split($\)
+  gem.require_paths << 'lib'
+  gem.bindir = 'bin'
+  gem.executables << 'instadoc'
+  gem.test_files = gem.files.grep(%r{^(spec)/})
+
+  gem.add_development_dependency('rake', '~> 0.9')
+  gem.add_development_dependency('rspec', '~> 2.10')
+  gem.add_development_dependency('guard', '~> 1.0.0')
+  gem.add_development_dependency('guard-rspec', '~> 0.6.0')
+  gem.add_development_dependency('rdoc')
+
+  gem.add_runtime_dependency('gli', '2.2.1')
+  gem.add_runtime_dependency('nokogiri', '~> 1.5.5')
+end

data/lib/instadoc.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require "instadoc/version"
+require "instadoc/java/java_code"
+require "instadoc/config"
+require "instadoc/html_builder"
+require "instadoc/analyzer"
+require "optparse"
+
+module Instadoc
+
+  def Instadoc.generate_html(verbose, source_path, output_path, hyperlink)
+
+    config.verbose = verbose
+    config.hyperlink = hyperlink
+    config.input_path = Pathname.new(source_path)
+
+    File.new(output_path, 'w')
+    config.output_path = Pathname.new(output_path)
+
+    analyzer = Instadoc::Analyzer.new(config)
+    analyzer.create_documentation()
+  end
+
+  def Instadoc.config
+    @config ||= Config.new
+  end
+
+
+end

data/lib/instadoc/analyzer.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'pathname'
+
+module Instadoc
+  class Analyzer
+
+    def initialize(config = Instadoc.config)
+      @config = config
+    end
+
+    def create_documentation()
+      java_files = java()
+      html_builder = Instadoc::HtmlBuilder.new(@config)
+      html_builder.create(java_files)
+    end
+
+    def java()
+      java_code = Instadoc::Java::JavaCode.new(@config)
+      java_code.search(@config.input_path)
+      java_code.files
+    end
+
+    def create_file(path)
+      Pathname.new(File.new(path, 'w').path)
+    end
+
+    def validate_directory(base_dir)
+      unless FileTest.exists?(base_dir)
+        STDERR.puts "Requires a existing path! Given was => #{base_dir}"
+        exit false
+      end
+    end
+  end
+end

data/lib/instadoc/config.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Instadoc
+  class Config
+
+    attr_accessor :output_path
+    attr_accessor :input_path
+    attr_accessor :hyperlink
+    attr_accessor :verbose
+
+    def initialize()
+      @hyperlink = "PLACEHOLDER"
+    end
+
+    def hyperlink_for(file_name)
+      @hyperlink.gsub("PLACEHOLDER",file_name)
+    end
+
+    def open_new_file(pathname)
+      File.new(pathname.realpath, 'w')
+    end
+
+  end
+
+end

data/lib/instadoc/html_builder.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+require "nokogiri"
+
+module Instadoc
+  class HtmlBuilder
+
+    def initialize(config)
+      @config = config
+    end
+
+    def build(files)
+      builder = Nokogiri::HTML::Builder.new do |doc|
+        doc.html {
+          doc.body() {
+            doc.table(:border => 1) {
+              doc.th "Documentation"
+              doc.th "Hyperlink to class"
+              doc.th "Line number"
+              files.each { |file|
+                file.documented_lines.keys.each { |line_number|
+                  doc.tr {
+                    doc.td_ file.documented_lines[line_number]
+                    doc.td {
+                      doc.a(:href => build_hyperlink(file.name_with_package)) {
+                        doc.text file.pathname.basename
+                      }
+                    }
+                    doc.td_ line_number
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+      builder.to_html
+    end
+
+    def create(files, pathname = @config.output_path)
+      html = build(files)
+      write_to_file(html, pathname)
+      unless @config.verbose
+        puts "Documentation summery written to #{pathname.realpath}"
+      end
+    end
+
+    def write_to_file(html, pathname)
+      file = @config.open_new_file(pathname)
+      file.puts html
+      file
+    end
+
+    def build_hyperlink(file_name)
+      @config.hyperlink_for(file_name)
+    end
+
+  end
+end

data/lib/instadoc/java/java_code.rb

@@ -0,0 +1,29 @@
+require "instadoc/java/pathname_seeker"
+require "instadoc/java/java_file"
+
+# encoding: utf-8
+module Instadoc
+  module Java
+    class JavaCode
+
+      def initialize(config)
+        @config = config
+        @files = Array.new
+        @java_file_seeker = PathnameSeeker.new(@config)
+      end
+
+      attr_reader :files
+
+      def search(base_pathname)
+        path_names = @java_file_seeker.search_in(base_pathname)
+        @files.concat(JavaFile.create_files(@config, path_names))
+      end
+
+      def to_s
+        "Instadoc::JavaCode"
+      end
+
+      private
+    end
+  end
+end

data/lib/instadoc/java/java_file.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+module Instadoc
+  module Java
+    class JavaFile
+
+      DOC_REGEX = '@InstaDoc\(\"(.*)\"\)'
+
+      def self.create_files(config, path_names)
+        files = Array.new
+        path_names.each { |pathname|
+          java_file = JavaFile.new(config, pathname)
+          java_file.search_documentation
+          files << java_file
+        }
+        return files
+      end
+
+      def initialize(config, pathname)
+        @config = config
+        @pathname = pathname
+        @documented_lines = Hash.new()
+        valid?
+      end
+
+      attr_accessor :pathname
+      attr_accessor :documented_lines
+
+      def valid?
+        unless @config
+          raise ArgumentError, "#{self} requires a configuration"
+        end
+        unless @pathname.file?
+          raise ArgumentError, "#{self} requires a file Given was => #{@pathname}"
+        end
+      end
+
+      attr_reader :pathname
+      attr_reader :documented_lines
+
+
+      def search_documentation()
+        line_number = 0
+
+        @pathname.each_line { |line|
+          line_number = line_number.succ
+          match = line.match(DOC_REGEX)
+          if (match)
+            @documented_lines[line_number] = match[1]
+          end
+        }
+
+        return @documented_lines
+      end
+
+      def name()
+        @pathname.basename.to_s
+      end
+
+      def name_with_package()
+        @pathname.relative_path_from(@config.input_path).to_s
+      end
+
+      private
+
+    end
+  end
+end

data/lib/instadoc/java/pathname_seeker.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Instadoc
+  module Java
+    class PathnameSeeker
+
+      def initialize(config)
+        @config = config
+      end
+
+      def search_in(base_pathname)
+        raise(ArgumentError, "base_pathname must not be null.") if  base_pathname.nil?
+
+        path_names = Array.new
+        files_path = File.join(base_pathname, "**", "*.java")
+        Dir.glob(files_path) { |file|
+          path_name = Pathname.new(file).realpath
+          path_names << path_name
+        }
+
+        path_names
+      end
+
+      private
+    end
+  end
+end

data/lib/instadoc/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Instadoc
+  VERSION = "0.0.1"
+end

data/spec/instadoc_toolbox/analyzer_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Instadoc::Analyzer do
+
+  context ".validate_directory" do
+
+    let(:subject) { Instadoc::Analyzer.new() }
+
+    context "with an invalid string as path" do
+
+      it "should raise error" do
+        lambda { subject.validate_directory('any/path') }.should terminate.with_code(1)
+      end
+
+    end
+  end
+
+  context ".create_documentation" do
+
+     let(:subject) {
+       Instadoc::Analyzer.new(Helpers::TestConfig.new)
+     }
+
+     context "with an invalid string as path" do
+
+       it "should raise error" do
+         lambda{subject.create_documentation}.should raise_error
+       end
+
+     end
+  end
+
+
+end

data/spec/instadoc_toolbox/html_builder_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Instadoc::HtmlBuilder do
+
+  context ".build" do
+
+    let(:subject) {Instadoc::HtmlBuilder.new(Helpers::TestConfig.new)}
+    let(:java_files) {
+      java_files = Array.new
+
+      java_file = Instadoc::Java::JavaFile.new(
+          Helpers::TestConfig.new,
+          Helpers::TestConfig.pathname_for_java_file("AnnotatedTestMethods.java"))
+
+      java_file.search_documentation
+      java_files << java_file
+    }
+
+    it "should contain documentation text" do
+      subject.build(java_files).should include("Text that documents the method number one")
+      subject.build(java_files).should include("Text that documents the method number two")
+    end
+
+  end
+
+  context ".write_to_file" do
+
+    let(:subject) {Instadoc::HtmlBuilder.new(Helpers::TestConfig.new)}
+
+    it "should write content to file" do
+      subject.write_to_file("<content/>", Pathname.new("dummy.txt")).string.should eq("<content/>\n")
+    end
+
+  end
+
+end

data/spec/instadoc_toolbox/instadoc_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Instadoc do
+
+  it "config should be accessible" do
+    Instadoc.config.should_not be_nil
+  end
+
+end

data/spec/instadoc_toolbox/java/java_code_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Instadoc::Java::JavaCode do
+
+  context ".search" do
+
+    context "with real test_data path" do
+
+      let(:java_code) {Instadoc::Java::JavaCode.new(Instadoc.config)}
+
+      it "should not raise error" do
+        lambda {java_code.search(Helpers::TestConfig.test_data_path)}.should_not raise_error(ArgumentError)
+      end
+
+      it "should find all classes in package" do
+        java_code.search(Helpers::TestConfig.test_data_path).should have(3).items
+      end
+
+      it "should add all classes in package to classes variable" do
+        java_code.search(Helpers::TestConfig.test_data_path)
+        java_code.files.should have(3).items
+      end
+
+    end
+
+  end
+  
+end

data/spec/instadoc_toolbox/java/java_file_spec.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Instadoc::Java::JavaFile do
+
+  context ".new" do
+
+    context "with valid arguments" do
+
+      let(:pathname) { pathname = Helpers::TestConfig.pathname_for_java_file('AnnotatedTestClazz.java') }
+      let(:subject) { Instadoc::Java::JavaFile.new(Helpers::TestConfig.new, pathname) }
+
+      it "should set pathname" do
+        subject.pathname.should eq(pathname)
+      end
+
+      it "should set pathname" do
+        subject.documented_lines.should have(0).items
+      end
+    end
+
+    context "with invalid pathname" do
+
+      it "should raise error" do
+        lambda {
+          Instadoc::Java::JavaFile.new(Helpers::TestConfig.new, Pathname.new("invalid/path"))
+        }.should raise_error(ArgumentError)
+      end
+    end
+
+    context "with missing config" do
+
+      it "should raise error" do
+        lambda {
+          Instadoc::Java::JavaFile.new(nil, Helpers::TestConfig.pathname_for_java_file('AnnotatedTestClazz.java'))
+        }.should raise_error(ArgumentError)
+      end
+    end
+
+  end
+
+  context ".search_documentation" do
+
+    context "for AnnotatedTestClazz.java" do
+
+      let(:subject) do
+        pathname = Helpers::TestConfig.pathname_for_java_file('AnnotatedTestClazz.java')
+        subject = Instadoc::Java::JavaFile.new(Helpers::TestConfig.new, pathname)
+      end
+
+      it "should return one line" do
+        subject.search_documentation.should have(1).item
+      end
+
+      it "should return annotation txt" do
+        subject.search_documentation.values.should include("Text that documents the code")
+      end
+
+      it "should return annotation line number" do
+        subject.search_documentation.keys.should include(7)
+      end
+
+      it "should set variable documented_lines" do
+        subject.search_documentation.should be(subject.documented_lines)
+      end
+
+      it "should return name with package" do
+        subject.name_with_package.should eq('org/company/AnnotatedTestClazz.java')
+      end
+
+    end
+
+    context "for AnnotatedTestMethods.java" do
+
+      let(:subject) do
+        pathname = Helpers::TestConfig.pathname_for_java_file('AnnotatedTestMethods.java')
+        subject = Instadoc::Java::JavaFile.new(Helpers::TestConfig.new, pathname)
+      end
+
+      it "should return two lines" do
+        subject.search_documentation.should have(2).item
+      end
+
+      it "should return annotation txt by correct line number" do
+        subject.search_documentation[9].should eq("Text that documents the method number one")
+        subject.search_documentation[12].should eq("Text that documents the method number two")
+      end
+
+      it "should set variable documented_lines" do
+        subject.search_documentation.should be(subject.documented_lines)
+      end
+    end
+
+    context "for NotAnnotatedDummy.java" do
+
+      let(:subject) do
+        pathname = Helpers::TestConfig.pathname_for_java_file('NotAnnotatedDummy.java')
+        subject = Instadoc::Java::JavaFile.new(Helpers::TestConfig.new, pathname)
+      end
+
+      it "should found no lines" do
+        subject.search_documentation.should have(0).item
+      end
+
+      it "should set variable documented_lines" do
+        subject.documented_lines.should have(0).items
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+# require application
+Dir[File.join(File.dirname(__FILE__),"../lib/**/*.rb")].each { |f| require f }
+# require helpers
+Dir[File.join(File.dirname(__FILE__),"support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include ExitCodeMatchers
+end
+

data/spec/support/exit_code_matcher.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require 'rspec/expectations'
+
+module ExitCodeMatchers
+  extend RSpec::Matchers::DSL
+
+  matcher :terminate do
+    actual = nil
+
+    match do |block|
+      begin
+        block.call
+      rescue SystemExit => e
+        actual = e.status
+      end
+      actual and actual == status_code
+    end
+
+    chain :with_code do |status_code|
+      @status_code = status_code
+    end
+
+    failure_message_for_should do |block|
+      "expected block to call exit(#{status_code}) but exit" +
+        (actual.nil? ? " not called" : "(#{actual}) was called")
+    end
+
+    failure_message_for_should_not do |block|
+      "expected block not to call exit(#{status_code})"
+    end
+
+    description do
+      "expect block to call exit(#{status_code})"
+    end
+
+    def status_code
+      @status_code ||= 0
+    end
+
+  end
+
+end

data/spec/support/temp_folder_helper.rb

@@ -0,0 +1,32 @@
+module Helpers
+  #https://gabebw.wordpress.com/2011/03/21/temp-files-in-rspec/
+  module UsesTempFolder
+    def self.included(example_group)
+      example_group.extend(self)
+    end
+
+    def in_directory_with_file(file)
+      before do
+        @pwd = Dir.pwd
+        @tmp_dir = File.join(File.dirname(__FILE__), 'tmp')
+        FileUtils.mkdir_p(@tmp_dir)
+        Dir.chdir(@tmp_dir)
+
+        FileUtils.mkdir_p(File.dirname(file))
+        FileUtils.touch(file)
+      end
+
+      define_method(:content_for_file) do |content|
+        f = File.new(File.join(@tmp_dir, file), 'a+')
+        f.write(content)
+        f.flush # VERY IMPORTANT
+        f.close
+      end
+
+      after do
+        Dir.chdir(@pwd)
+        FileUtils.rm_rf(@tmp_dir)
+      end
+    end
+  end
+end

data/spec/support/test_config_helper.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Helpers
+
+  class TestConfig < Instadoc::Config
+
+    def initialize()
+      super()
+      @input_path = TestConfig.test_java_code_path
+    end
+
+    def TestConfig.test_data_path
+      Pathname.new(File.join(File.dirname(__FILE__), '..', 'test_data'))
+    end
+
+    def TestConfig.test_java_code_path
+      Pathname.new(File.join(File.dirname(__FILE__), '..', 'test_data', 'java_code'))
+    end
+
+    def TestConfig.java_code_package_path
+      File.join(File.dirname(__FILE__), '..', 'test_data/java_code/org/company/')
+    end
+
+    def TestConfig.pathname_for_java_file(test_file)
+      Pathname.new(File.join(java_code_package_path, test_file))
+    end
+
+    def open_new_file(pathname)
+      StringIO.new
+    end
+
+  end
+end

data/spec/test_data/java_code/org/company/AnnotatedTestClazz.java

@@ -0,0 +1,12 @@
+package org.company;
+/**
+* TestData class for annotation on class itself.
+*
+* @author markus.hanses
+*/
+@InstaDoc("Text that documents the code")
+public class AnnotatedTestClazz {
+
+  public void anyMethod(){}
+  
+}

data/spec/test_data/java_code/org/company/AnnotatedTestMethods.java

@@ -0,0 +1,15 @@
+package org.company;
+/**
+* TestData class for annotation on methods.
+*
+* @author markus.hanses
+*/
+public class AnnotatedTestMethods {
+
+  @InstaDoc("Text that documents the method number one")
+  public void annotatedMethodNumberOne(){}
+
+  @InstaDoc("Text that documents the method number two")
+  public void annotatedMethodNumberTwo(){}
+  
+}

data/spec/test_data/java_code/org/company/NotAnnotatedDummy.java

@@ -0,0 +1,13 @@
+package org.company;
+/**
+* TestData class without '@JavaDoc("dummy")' annotation,
+* but with some other that instadoc has to ignore.
+*
+* @author markus.hanses
+*/
+@Component
+public class AnnotatedTestClazz {
+
+  @Transaction
+  public void anyMethod(){}
+}

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: instadoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Markus Hanses
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+description: 
+email: me@markushanses.de
+executables:
+- instadoc
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Changelog.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- README.rdoc
+- Rakefile
+- bin/instadoc
+- instadoc.gemspec
+- lib/instadoc.rb
+- lib/instadoc/analyzer.rb
+- lib/instadoc/config.rb
+- lib/instadoc/html_builder.rb
+- lib/instadoc/java/java_code.rb
+- lib/instadoc/java/java_file.rb
+- lib/instadoc/java/pathname_seeker.rb
+- lib/instadoc/version.rb
+- spec/instadoc_toolbox/analyzer_spec.rb
+- spec/instadoc_toolbox/html_builder_spec.rb
+- spec/instadoc_toolbox/instadoc_spec.rb
+- spec/instadoc_toolbox/java/java_code_spec.rb
+- spec/instadoc_toolbox/java/java_file_spec.rb
+- spec/spec_helper.rb
+- spec/support/exit_code_matcher.rb
+- spec/support/temp_folder_helper.rb
+- spec/support/test_config_helper.rb
+- spec/test_data/java_code/org/company/AnnotatedTestClazz.java
+- spec/test_data/java_code/org/company/AnnotatedTestMethods.java
+- spec/test_data/java_code/org/company/NotAnnotatedDummy.java
+homepage: https://github.com/marhan/instadoc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4380620093360648879
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4380620093360648879
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A documentation generation tool for source code
+test_files:
+- spec/instadoc_toolbox/analyzer_spec.rb
+- spec/instadoc_toolbox/html_builder_spec.rb
+- spec/instadoc_toolbox/instadoc_spec.rb
+- spec/instadoc_toolbox/java/java_code_spec.rb
+- spec/instadoc_toolbox/java/java_file_spec.rb
+- spec/spec_helper.rb
+- spec/support/exit_code_matcher.rb
+- spec/support/temp_folder_helper.rb
+- spec/support/test_config_helper.rb
+- spec/test_data/java_code/org/company/AnnotatedTestClazz.java
+- spec/test_data/java_code/org/company/AnnotatedTestMethods.java
+- spec/test_data/java_code/org/company/NotAnnotatedDummy.java