buildr-iidea 0.0.2

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+gem_spec = Gem::Specification.load(File.expand_path('buildr-iidea.gemspec', File.dirname(__FILE__)))
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+desc "Generate RDoc documentation in rdoc/"
+Rake::RDocTask.new :rdoc do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = gem_spec.name
+  rdoc.options = gem_spec.rdoc_options.clone
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include gem_spec.extra_rdoc_files
+end
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/buildr-iidea.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name           = 'buildr-iidea'
+  spec.version        = `git describe`.strip.split('-').first
+  spec.authors        = ['Rhett Sutphin', 'Peter Donald']
+  spec.email          = ["rhett@detailedbalance.net","peter@realityforge.org"]
+  spec.homepage       = "http://github.com/rockninja/buildr-iidea"
+  spec.summary        = "Buildr tasks to generate Intellij IDEA project files"
+  spec.description    = <<-TEXT
+This is a buildr extension that provides tasks to generate Intellij IDEA
+project files. The iidea task generates the project files based on the
+settings of each project and extension specific settings. 
+  TEXT
+
+  spec.files          = Dir['{lib,spec}/**/*', '*.gemspec'] +
+                        ['LICENSE', 'NOTICE', 'README.rdoc', 'Rakefile']
+  spec.require_paths  = ['lib']
+
+  spec.has_rdoc         = true
+  spec.extra_rdoc_files = 'README.rdoc', 'LICENSE', 'NOTICE'
+  spec.rdoc_options     = '--title', "#{spec.name} #{spec.version}", '--main', 'README.rdoc'
+
+  spec.post_install_message = "Thanks for installing the Intellij IDEA extension for Buildr"
+end

data/lib/buildr/intellij_idea/idea_file.rb

@@ -0,0 +1,86 @@
+module Buildr
+  module IntellijIdea
+    # Abstract base class for IdeaModule and IdeaProject
+    class IdeaFile
+      DEFAULT_SUFFIX = ""
+
+      attr_reader :buildr_project
+      attr_writer :suffix
+      attr_writer :id
+      attr_accessor :template
+
+      def suffix
+        @suffix ||= DEFAULT_SUFFIX
+      end
+
+      def filename
+        buildr_project.path_to("#{name}.#{extension}")
+      end
+
+      def id
+        @id ||= buildr_project.name.split(':').last
+      end
+
+      def add_component(name, attrs = {}, &xml)
+        self.components << create_component(name, attrs, &xml)
+      end
+
+      def write(f)
+        document.write f
+      end
+
+      protected
+
+      def name
+        "#{self.id}#{suffix}"
+      end
+
+      def create_component(name, attrs = {})
+        target = StringIO.new
+        Builder::XmlMarkup.new(:target => target, :indent => 2).component(attrs.merge({ :name => name })) do |xml|
+          yield xml if block_given?
+        end
+        REXML::Document.new(target.string).root
+      end
+
+      def components
+        @components ||= self.default_components.compact
+      end
+
+      def load_document(filename)
+        REXML::Document.new(File.read(filename))
+      end
+
+      def document
+        if File.exist?(self.filename)
+          doc = load_document(self.filename)
+        else
+          doc = base_document
+          inject_components( doc, self.initial_components )
+        end
+        if self.template
+          template_doc = load_document(self.template)
+          REXML::XPath.each(template_doc, "//component") do |element|
+            inject_component(doc, element)
+          end
+        end
+        inject_components( doc, self.components )
+        doc
+      end
+
+      def inject_components(doc, components)
+        components.each do |component|
+          # execute deferred components
+          component = component.call if Proc === component
+          inject_component(doc, component) if component
+        end
+      end
+
+      # replace overridden component (if any) with specified component
+      def inject_component(doc, component)
+        doc.root.delete_element("//component[@name='#{component.attributes['name']}']")
+        doc.root.add_element component
+      end
+    end
+  end
+end

data/lib/buildr/intellij_idea/idea_module.rb

@@ -0,0 +1,217 @@
+module Buildr
+  module IntellijIdea
+    class IdeaModule < IdeaFile
+      DEFAULT_TYPE = "JAVA_MODULE"
+      DEFAULT_LOCAL_REPOSITORY_ENV_OVERRIDE = "M2_REPO"
+      MODULE_DIR_URL = "file://$MODULE_DIR$"
+
+      attr_writer :buildr_project
+      attr_accessor :type
+      attr_accessor :local_repository_env_override
+      attr_accessor :group
+      attr_reader :facets
+
+      def initialize
+        @type = DEFAULT_TYPE
+        @local_repository_env_override = DEFAULT_LOCAL_REPOSITORY_ENV_OVERRIDE
+        @facets = []
+      end
+
+      def buildr_project=(buildr_project)
+        @id = nil
+        @facets = []
+        @buildr_project = buildr_project
+      end
+
+      def extension
+        "iml"
+      end
+
+      def main_source_directories
+        @main_source_directories ||= [
+            buildr_project.compile.sources,
+            buildr_project.resources.sources
+        ].flatten.compact
+      end
+
+      def test_source_directories
+        @test_source_directories ||= [
+            buildr_project.test.compile.sources,
+            buildr_project.test.resources.sources
+        ].flatten.compact
+      end
+
+      def excluded_directories
+        @excluded_directories ||= [
+            buildr_project.resources.target,
+            buildr_project.test.resources.target,
+            buildr_project.path_to(:target, :main),
+            buildr_project.path_to(:target, :test),
+            buildr_project.path_to(:reports)
+        ].flatten.compact
+      end
+
+      def main_output_dir
+        buildr_project.compile.target || buildr_project.path_to(:target, :main, 'idea')
+      end
+
+      def test_output_dir
+        buildr_project.test.compile.target || buildr_project.path_to(:target, :test, 'idea')
+      end
+
+      def resources
+        [buildr_project.test.resources.target, buildr_project.resources.target].compact
+      end
+
+      def main_dependencies
+        buildr_project.compile.dependencies.map(&:to_s)
+      end
+
+      def test_dependencies
+        buildr_project.test.compile.dependencies.map(&:to_s) - [ buildr_project.compile.target.to_s ]
+      end
+
+      def base_directory
+        buildr_project.path_to
+      end
+
+      def add_facet(name, type)
+        target = StringIO.new
+        Builder::XmlMarkup.new(:target => target, :indent => 2).facet(:name => name, :type => type) do |xml|
+          yield xml if block_given?
+        end
+        self.facets << REXML::Document.new(target.string).root
+      end
+
+      protected
+
+      def base_document
+        target = StringIO.new
+        Builder::XmlMarkup.new(:target => target).module(:version => "4", :relativePaths => "true", :type => self.type)
+        REXML::Document.new(target.string)
+      end
+
+      def initial_components
+        []
+      end
+
+      def default_components
+        [
+            lambda { module_root_component },
+            lambda { facet_component }
+        ]
+      end
+
+      def facet_component
+        return nil if self.facets.empty?
+        fm = self.create_component("FacetManager")
+        self.facets.each do |facet|
+          fm.add_element facet
+        end
+        fm
+      end
+
+      def module_root_component
+        m2repo = Buildr::Repositories.instance.local
+
+        create_component("NewModuleRootManager", "inherit-compiler-output" => "false") do |xml|
+          generate_compile_output(xml)
+          generate_content(xml)
+          generate_initial_order_entries(xml)
+
+          # Note: Use the test classpath since IDEA compiles both "main" and "test" classes using the same classpath
+          self.test_dependencies.each do |dependency_path|
+            export = self.main_dependencies.include?(dependency_path)
+            project_for_dependency = Buildr.projects.detect do |project|
+              project.packages.detect { |pkg| pkg.to_s == dependency_path }
+            end
+            if project_for_dependency
+              if project_for_dependency.iml?
+                generate_project_dependency( xml, project_for_dependency.iml.name, export )
+              end
+              next
+            elsif dependency_path.to_s.index(m2repo) == 0
+              entry_path = dependency_path
+              unless self.local_repository_env_override.nil?
+                entry_path = entry_path.sub(m2repo, "$#{self.local_repository_env_override}$")
+              end
+              generate_module_lib(xml, "jar://#{entry_path}!/", export )
+            end
+          end
+
+          self.resources.each do |resource|
+            generate_module_lib(xml, "#{MODULE_DIR_URL}/#{relative(resource.to_s)}", true)
+          end
+
+          xml.orderEntryProperties
+        end
+      end
+
+      def relative(path)
+        Util.relative_path(File.expand_path(path.to_s), self.base_directory)
+      end
+
+      def generate_compile_output(xml)
+        xml.output(:url => "#{MODULE_DIR_URL}/#{relative(self.main_output_dir.to_s)}")
+        xml.tag!("output-test", :url => "#{MODULE_DIR_URL}/#{relative(self.test_output_dir.to_s)}")
+        xml.tag!("exclude-output")
+      end
+
+      def generate_content(xml)
+        xml.content(:url => MODULE_DIR_URL) do
+          # Source folders
+          {
+              :main => self.main_source_directories,
+              :test => self.test_source_directories
+          }.each do |kind, directories|
+            directories.map { |dir| relative(dir) }.compact.sort.uniq.each do |dir|
+              xml.sourceFolder :url => "#{MODULE_DIR_URL}/#{dir}", :isTestSource => (kind == :test ? 'true' : 'false')
+            end
+          end
+
+          # Exclude target directories
+          self.net_excluded_directories.sort.each do |dir|
+            xml.excludeFolder :url => "#{MODULE_DIR_URL}/#{dir}"
+          end
+        end
+      end
+
+      def generate_initial_order_entries(xml)
+        xml.orderEntry :type => "sourceFolder", :forTests => "false"
+        xml.orderEntry :type => "inheritedJdk"
+      end
+
+      def generate_project_dependency(xml, other_project, export = true)
+        attribs = {:type => 'module', "module-name" => other_project}
+        attribs[:exported] = '' if export
+        xml.orderEntry attribs
+      end
+
+      def generate_module_lib(xml, path, export)
+        attribs = {:type => 'module-library'}
+        attribs[:exported] = '' if export
+        xml.orderEntry attribs do
+          xml.library do
+            xml.CLASSES do
+              xml.root :url => path
+            end
+            xml.JAVADOC
+            xml.SOURCES
+          end
+        end
+      end
+
+      # Don't exclude things that are subdirectories of other excluded things
+      def net_excluded_directories
+        net = []
+        all = self.excluded_directories.map { |dir| relative(dir.to_s) }.sort_by { |d| d.size }
+        all.each_with_index do |dir, i|
+          unless all[0 ... i].find { |other| dir =~ /^#{other}/ }
+            net << dir
+          end
+        end
+        net
+      end
+    end
+  end
+end

data/lib/buildr/intellij_idea/idea_project.rb

@@ -0,0 +1,98 @@
+module Buildr
+  module IntellijIdea
+    class IdeaProject < IdeaFile
+      attr_accessor :vcs
+      attr_accessor :extra_modules
+      attr_writer :jdk_version
+
+      def initialize(buildr_project)
+        @buildr_project = buildr_project
+        @vcs = detect_vcs
+        @extra_modules = []
+      end
+
+      def jdk_version
+        @jdk_version ||= buildr_project.compile.options.source || "1.6"
+      end
+      
+      protected
+
+      def extension
+        "ipr"
+      end
+
+      def detect_vcs
+        if File.directory?(buildr_project._('.svn'))
+          "svn"
+        elsif File.directory?(buildr_project._('.git'))
+          "Git"
+        end
+      end
+
+      def base_document
+        target = StringIO.new
+        Builder::XmlMarkup.new(:target => target).project(:version => "4", :relativePaths => "false")
+        REXML::Document.new(target.string)
+      end
+
+      def default_components
+        [
+            lambda { modules_component },
+            vcs_component
+        ]
+      end
+
+      def initial_components
+        [
+            lambda { project_root_manager_component }
+        ]
+      end
+
+      def project_root_manager_component
+        attribs = {"version" => "2",
+                   "assert-keyword" => "true",
+                   "jdk-15" => "true",
+                   "project-jdk-name" => self.jdk_version,
+                   "project-jdk-type" => "JavaSDK",
+                   "languageLevel" => "JDK_#{self.jdk_version.gsub('.','_')}" }
+        create_component("ProjectRootManager",attribs) do |xml|
+          xml.output("url" => "file://$PROJECT_DIR$/out")
+        end
+      end
+
+      def modules_component
+        create_component("ProjectModuleManager") do |xml|
+          xml.modules do
+            buildr_project.projects.select { |subp| subp.iml? }.each do |subproject|
+              module_path = subproject.base_dir.gsub(/^#{buildr_project.base_dir}\//, '')
+              path = "#{module_path}/#{subproject.iml.name}.iml"
+              attribs = { :fileurl => "file://$PROJECT_DIR$/#{path}", :filepath => "$PROJECT_DIR$/#{path}" }
+              if subproject.iml.group == true
+                attribs[:group] = subproject.parent.name.gsub(':', '/')
+              elsif !subproject.iml.group.nil?
+                attribs[:group] = subproject.group.to_s
+              end
+              xml.module attribs
+            end
+            self.extra_modules.each do |iml_file|
+              xml.module :fileurl => "file://$PROJECT_DIR$/#{iml_file}",
+                         :filepath => "$PROJECT_DIR$/#{iml_file}"
+            end
+            if buildr_project.iml?
+              xml.module :fileurl => "file://$PROJECT_DIR$/#{buildr_project.iml.name}.iml",
+                         :filepath => "$PROJECT_DIR$/#{buildr_project.iml.name}.iml"
+            end
+          end
+        end
+      end
+
+      def vcs_component
+        if vcs
+          create_component("VcsDirectoryMappings") do |xml|
+            xml.mapping :directory => "", :vcs => vcs
+          end
+        end
+      end
+    end
+  end
+end