buildr-iidea 0.0.2

data/lib/buildr/intellij_idea/project_extension.rb

@@ -0,0 +1,92 @@
+require 'stringio'
+
+module Buildr
+  module IntellijIdea
+    module ProjectExtension
+
+      include Extension
+
+      first_time do
+        desc "Generate Intellij IDEA artifacts for all projects"
+        Project.local_task "iidea:generate" => "artifacts"
+
+        desc "Delete the generated Intellij IDEA artifacts"
+        Project.local_task "iidea:clean"
+      end
+
+      before_define do |project|
+        project.recursive_task("iidea:generate")
+        project.recursive_task("iidea:clean")
+      end
+
+      after_define do |project|
+        iidea = project.task("iidea:generate")
+
+        files = [
+            (project.iml if project.iml?),
+            (project.ipr if project.ipr?)
+        ].compact
+
+        files.each do |ideafile|
+          module_dir =  File.dirname(ideafile.filename)         
+          # Need to clear the actions else the extension included as part of buildr will run
+          file(ideafile.filename).clear_actions
+          directory(module_dir)
+          iidea.enhance [ file(ideafile.filename) ]
+          file(ideafile.filename => [Buildr.application.buildfile, module_dir]) do |task|
+            info "Writing #{task.name}"
+            temp_filename = nil
+            Tempfile.open("buildr-iidea") do |f|
+              temp_filename = f.path
+              ideafile.write f
+            end
+            mv temp_filename, ideafile.filename
+          end
+        end
+
+        project.task("iidea:clean") do
+          files.each do |f|
+            info "Removing #{f.filename}" if File.exist?(f.filename)
+            rm_rf f.filename
+          end
+        end
+      end
+
+      def ipr
+        if ipr?
+          @ipr ||= IdeaProject.new(self)
+        else
+          raise "Only the root project has an IPR"
+        end
+      end
+
+      def ipr?
+        self.parent.nil?
+      end
+
+      def iml
+        if iml?
+          unless @iml
+            @iml = self.parent ? self.parent.iml.clone : IdeaModule.new
+            @iml.buildr_project = self
+          end
+          return @iml
+        else
+          raise "IML generation is disabled for #{self.name}"
+        end
+      end
+
+      def no_iml
+        @has_iml = false
+      end
+
+      def iml?
+        @has_iml = @has_iml.nil? ? true : @has_iml
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::IntellijIdea::ProjectExtension
+end

data/lib/buildr_iidea.rb

@@ -0,0 +1,5 @@
+require 'buildr'
+require File.expand_path(File.dirname(__FILE__) + '/buildr/intellij_idea/idea_file')
+require File.expand_path(File.dirname(__FILE__) + '/buildr/intellij_idea/idea_module')
+require File.expand_path(File.dirname(__FILE__) + '/buildr/intellij_idea/idea_project')
+require File.expand_path(File.dirname(__FILE__) + '/buildr/intellij_idea/project_extension')

data/spec/buildr/intellij_idea/clean_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "iidea:clean" do
+  before do
+    write "foo.ipr"
+    write "foo.iml"
+    write "other.ipr"
+    write "other.iml"
+    mkdir_p 'bar'
+    write "bar/bar.iml"
+    write "bar/other.ipr"
+    write "bar/other.iml"
+
+    @foo = define "foo" do
+      define "bar"
+    end
+    invoke_clean_task
+  end
+
+  it "should remove the ipr file" do
+    File.exists?("foo.ipr").should be_false
+  end
+
+  it "should remove the project iml file" do
+    File.exists?("foo.iml").should be_false
+  end
+
+  it "should remove the subproject iml file" do
+    File.exists?("foo.iml").should be_false
+  end
+
+  it "should not remove other iml and ipr files" do
+    File.exists?("other.ipr").should be_true
+    File.exists?("other.iml").should be_true
+    File.exists?("bar/other.ipr").should be_true
+    File.exists?("bar/other.iml").should be_true
+  end
+end

data/spec/buildr/intellij_idea/dependency_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+ORDER_ENTRY_XPATH = "/module/component[@name='NewModuleRootManager']/orderEntry"
+DEPENDENCY_NAME = 'group:id:jar:1.0'
+DEPENDENCY2_NAME = 'group:id2:jar:1.0'
+
+describe "iidea:generate" do
+
+  describe "with a single dependency" do
+    before do
+      @artifact = artifact(DEPENDENCY_NAME) { |t| write t.to_s }
+    end
+
+    describe "of type compile" do
+      before do
+        @foo = define "foo" do
+          compile.with DEPENDENCY_NAME
+        end
+        invoke_generate_task
+      end
+
+      it "generates one exported 'module-library' orderEntry in IML" do
+        root_module_xml(@foo).should have_nodes("#{ORDER_ENTRY_XPATH}[@type='module-library', @exported='']", 1)
+      end
+    end
+
+    describe "of type test" do
+      before do
+        @foo = define "foo" do
+          test.with DEPENDENCY_NAME
+        end
+        invoke_generate_task
+      end
+
+      it "generates one non-exported 'module-library' orderEntry in IML" do
+        root_module_xml(@foo).should have_nodes("#{ORDER_ENTRY_XPATH}[@type='module-library' and @exported]", 0)
+        root_module_xml(@foo).should have_nodes("#{ORDER_ENTRY_XPATH}[@type='module-library']", 1)
+      end
+    end
+
+    describe "with local_repository_env_override set to nil" do
+      before do
+        @foo = define "foo" do
+          iml.local_repository_env_override = nil
+          compile.with DEPENDENCY_NAME
+        end
+        invoke_generate_task
+      end
+
+      it "generates orderEntry with absolute path for classes jar" do
+        root_module_xml(@foo).should match_xpath("#{ORDER_ENTRY_XPATH}/library/CLASSES/root/@url",
+                                                 "jar://#{@artifact.to_s}!/")
+      end
+    end
+    describe "with local_repository_env_override set to MAVEN_REPOSITORY" do
+      before do
+        @foo = define "foo" do
+          iml.local_repository_env_override = 'MAVEN_REPOSITORY'
+          compile.with DEPENDENCY_NAME
+        end
+        invoke_generate_task
+      end
+
+      it "generates orderEntry with absolute path for classes jar" do
+        root_module_xml(@foo).should match_xpath("#{ORDER_ENTRY_XPATH}/library/CLASSES/root/@url",
+                                                 "jar://$MAVEN_REPOSITORY$/group/id/1.0/id-1.0.jar!/")
+      end
+    end
+  end
+
+  describe "with multiple dependencies" do
+    before do
+      @artifact1 = artifact(DEPENDENCY_NAME) { |t| write t.to_s }
+      @artifact2 = artifact(DEPENDENCY2_NAME) { |t| write t.to_s }
+      @foo = define "foo" do
+        compile.with DEPENDENCY_NAME, DEPENDENCY2_NAME
+      end
+      invoke_generate_task
+    end
+
+    it "generates multiple 'module-library' orderEntry in IML" do
+      root_module_xml(@foo).should have_nodes("#{ORDER_ENTRY_XPATH}[@type='module-library']", 2)
+    end
+  end
+end

data/spec/buildr/intellij_idea/extra_modules_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "iidea:generate" do
+  describe "with extra_modules specified" do
+    before do
+      @foo = define "foo" do
+        ipr.extra_modules << 'other.iml'
+        ipr.extra_modules << 'other_other.iml'
+      end
+      invoke_generate_task
+    end
+
+    it "generate an IPR with extra modules specified" do
+      doc = xml_document(@foo._("foo.ipr"))
+      doc.should have_nodes("#{xpath_to_module}", 3)
+      module_ref = "$PROJECT_DIR$/foo.iml"
+      doc.should have_xpath("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}']")
+      module_ref = "$PROJECT_DIR$/other.iml"
+      doc.should have_xpath("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}']")
+      module_ref = "$PROJECT_DIR$/other_other.iml"
+      doc.should have_xpath("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}']")
+    end
+  end
+end

data/spec/buildr/intellij_idea/facet_generation_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+FACET_XPATH = "/module/component[@name='FacetManager']/facet"
+
+describe "iidea:generate" do
+  describe "with web and webservice facet added to root project" do
+    before do
+      @foo = define "foo" do
+        iml.add_facet("Web", "web") do |facet|
+          facet.configuration do |conf|
+            conf.descriptors do |desc|
+              desc.deploymentDescriptor :name => 'web.xml',
+                                        :url => "file://$MODULE_DIR$/src/main/webapp/WEB-INF/web.xml",
+                                        :optional => "false", :version => "2.4"
+            end
+            conf.webroots do |webroots|
+              webroots.root :url => "file://$MODULE_DIR$/src/main/webapp", :relative => "/"
+            end
+          end
+        end
+        iml.add_facet("WebServices Client", "WebServicesClient") do |facet|
+          facet.configuration "ws.engine" => "Glassfish / JAX-WS 2.X RI / Metro 1.X / JWSDP 2.0"
+        end
+        define 'bar'
+      end
+      invoke_generate_task
+    end
+
+    it "generates an IML for root project with a web and webservice facet" do
+      doc = xml_document(@foo._("foo.iml"))
+      doc.should have_nodes(FACET_XPATH, 2)
+      doc.should have_xpath("#{FACET_XPATH}[@type='web', @name='Web']")
+      doc.should have_xpath("#{FACET_XPATH}[@type='WebServicesClient', @name='WebServices Client']")
+    end
+  end
+end

data/spec/buildr/intellij_idea/group_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "iidea:generate" do
+  describe "with iml.group specified" do
+    before do
+      @foo = define "foo" do
+        iml.group = true
+        define 'bar' do
+          define 'baz' do
+
+          end
+        end
+        define 'rab' do
+          iml.group = "MyGroup"
+        end
+      end
+      invoke_generate_task
+    end
+
+    it "generate an IPR with correct group references" do
+      doc = xml_document(@foo._("foo.ipr"))
+      doc.should have_nodes("#{xpath_to_module}", 4)
+      module_ref = "$PROJECT_DIR$/foo.iml"
+      doc.should have_xpath("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}']")
+      module_ref = "$PROJECT_DIR$/rab/rab.iml"
+      doc.should have_xpath("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}' @group = 'MyGroup']")
+      module_ref = "$PROJECT_DIR$/bar/bar.iml"
+      doc.should have_xpath("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}' @group = 'foo']")
+      module_ref = "$PROJECT_DIR$/bar/baz/baz.iml"
+      doc.should have_xpath("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}' @group = 'foo/bar']")
+    end
+  end
+end

data/spec/buildr/intellij_idea/idea_file_generation_spec.rb

@@ -0,0 +1,177 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "iidea:generate" do
+  describe "with a single project definition" do
+    describe "and default naming" do
+      before do
+        @foo = define "foo"
+        invoke_generate_task
+      end
+
+      it "generates a single IPR" do
+        Dir[@foo._("**/*.ipr")].should have(1).entry
+      end
+
+      it "generate an IPR in the root directory" do
+        File.should be_exist(@foo._("foo.ipr"))
+      end
+
+      it "generates a single IML" do
+        Dir[@foo._("**/*.iml")].should have(1).entry
+      end
+
+      it "generates an IML in the root directory" do
+        File.should be_exist(@foo._("foo.iml"))
+      end
+
+      it "generate an IPR with the reference to correct module file" do
+        File.should be_exist(@foo._("foo.ipr"))
+        doc = xml_document(@foo._("foo.ipr"))
+        module_ref = "$PROJECT_DIR$/foo.iml"
+        doc.should have_nodes("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}']", 1)
+      end
+    end
+
+    describe "with no_iml generation disabled" do
+      before do
+        @foo = define "foo" do
+          project.no_iml
+        end
+        invoke_generate_task
+      end
+
+      it "generates no IML" do
+        Dir[@foo._("**/*.iml")].should have(0).entry
+      end
+
+      it "generate an IPR with no references" do
+        File.should be_exist(@foo._("foo.ipr"))
+        doc = xml_document(@foo._("foo.ipr"))
+        doc.should have_nodes("#{xpath_to_module}", 0)
+      end
+    end
+
+    describe "and id overrides" do
+      before do
+        @foo = define "foo" do
+          ipr.id = 'fooble'
+          iml.id = 'feap'
+          define "bar" do
+            iml.id = "baz"
+          end
+        end
+        invoke_generate_task
+      end
+
+      it "generate an IPR in the root directory" do
+        File.should be_exist(@foo._("fooble.ipr"))
+      end
+
+      it "generates an IML in the root directory" do
+        File.should be_exist(@foo._("feap.iml"))
+      end
+
+      it "generates an IML in the subproject directory" do
+        File.should be_exist(@foo._("bar/baz.iml"))
+      end
+
+      it "generate an IPR with the reference to correct module file" do
+        File.should be_exist(@foo._("fooble.ipr"))
+        doc = xml_document(@foo._("fooble.ipr"))
+        module_ref = "$PROJECT_DIR$/feap.iml"
+        doc.should have_nodes("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}']", 1)
+      end
+    end
+
+    describe "and a suffix defined" do
+      before do
+        @foo = define "foo" do
+          ipr.suffix = '-ipr-suffix'
+          iml.suffix = '-iml-suffix'
+        end
+        invoke_generate_task
+      end
+
+      it "generate an IPR in the root directory" do
+        File.should be_exist(@foo._("foo-ipr-suffix.ipr"))
+      end
+
+      it "generates an IML in the root directory" do
+        File.should be_exist(@foo._("foo-iml-suffix.iml"))
+      end
+
+      it "generate an IPR with the reference to correct module file" do
+        File.should be_exist(@foo._("foo-ipr-suffix.ipr"))
+        doc = xml_document(@foo._("foo-ipr-suffix.ipr"))
+        doc.should have_nodes("#{xpath_to_module}", 1)
+        module_ref = "$PROJECT_DIR$/foo-iml-suffix.iml"
+        doc.should have_nodes("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}']", 1)
+      end
+    end
+  end
+
+  describe "with a subproject" do
+    before do
+      @foo = define "foo" do
+        define 'bar'
+      end
+      invoke_generate_task
+    end
+
+    it "creates the subproject directory" do
+      File.should be_exist(@foo._("bar"))
+    end
+
+    it "generates an IML in the subproject directory" do
+      File.should be_exist(@foo._("bar/bar.iml"))
+    end
+
+    it "generate an IPR with the reference to correct module file" do
+      File.should be_exist(@foo._("foo.ipr"))
+      doc = xml_document(@foo._("foo.ipr"))
+      doc.should have_nodes("#{xpath_to_module}", 2)
+      module_ref = "$PROJECT_DIR$/foo.iml"
+      doc.should have_nodes("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}']", 1)
+      module_ref = "$PROJECT_DIR$/bar/bar.iml"
+      doc.should have_nodes("#{xpath_to_module}[@fileurl='file://#{module_ref}', @filepath='#{module_ref}']", 1)
+    end
+  end
+
+  describe "with base_dir specified" do
+    before do
+      @foo = define "foo" do
+        define('bar', :base_dir => 'fe') do
+          define('baz', :base_dir => 'fi') do
+            define('foe')
+          end
+          define('fum')
+        end
+      end
+      invoke_generate_task
+    end
+
+    it "generates a subproject IML in the specified directory" do
+      File.should be_exist(@foo._("fe/bar.iml"))
+    end
+
+    it "generates a sub-subproject IML in the specified directory" do
+      File.should be_exist(@foo._("fi/baz.iml"))
+    end
+
+    it "generates a sub-sub-subproject IML that inherits the specified directory" do
+      File.should be_exist(@foo._("fi/foe/foe.iml"))
+    end
+
+    it "generates a sub-subproject IML that inherits the specified directory" do
+      File.should be_exist(@foo._("fe/fum/fum.iml"))
+    end
+
+    it "generate an IPR with the references to correct module files" do
+      doc = xml_document(@foo._("foo.ipr"))
+      doc.should have_nodes("#{xpath_to_module}", 5)
+      ["foo.iml", "fe/bar.iml", "fi/baz.iml", "fi/foe/foe.iml","fe/fum/fum.iml"].each do |module_ref|
+        doc.should have_nodes("#{xpath_to_module}[@fileurl='file://$PROJECT_DIR$/#{module_ref}', @filepath='$PROJECT_DIR$/#{module_ref}']", 1)
+      end
+    end
+  end
+end