buildr-iidea 0.0.2

data/spec/buildr/intellij_idea/inform_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "iidea:generate" do
+  describe "with a single project definition" do
+    before do
+      @foo = define "foo"
+    end
+
+    it "informs the user about generating IPR" do
+      lambda { invoke_generate_task }.should show_info(/Writing (.+)\/foo\.ipr/)
+    end
+
+    it "informs the user about generating IML" do
+      lambda { invoke_generate_task }.should show_info(/Writing (.+)\/foo\.iml/)
+    end
+  end
+  describe "with a subproject" do
+    before do
+      @foo = define "foo" do
+        define 'bar'
+      end
+    end
+
+    it "informs the user about generating subporoject IML" do
+      lambda { invoke_generate_task }.should show_info(/Writing (.+)\/bar\/bar\.iml/)
+    end
+  end
+end

data/spec/buildr/intellij_idea/initial_components_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "iidea:generate" do
+  describe "with compile.options.source = '1.6'" do
+
+    before do
+      @foo = define "foo" do
+        compile.options.source = '1.5'
+      end
+      invoke_generate_task
+    end
+
+    it "generate an ProjectRootManager with 1.5 jdk specified" do
+      #raise File.read(@foo._("foo.ipr"))
+      xml_document(@foo._("foo.ipr")).
+          should have_xpath("/project/component[@name='ProjectRootManager' and @project-jdk-name = '1.5' and @languageLevel = 'JDK_1_5']")
+    end
+  end
+
+  describe "with compile.options.source = '1.6'" do
+    before do
+      @foo = define "foo" do
+        compile.options.source = '1.6'
+      end
+      invoke_generate_task
+    end
+
+    it "generate an ProjectRootManager with 1.6 jdk specified" do
+      xml_document(@foo._("foo.ipr")).
+          should have_xpath("/project/component[@name='ProjectRootManager' and @project-jdk-name = '1.6' and @languageLevel = 'JDK_1_6']")
+    end
+  end
+end

data/spec/buildr/intellij_idea/module_property_inheritance_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "Buildr::IntellijIdea::IdeaModule" do
+  describe "settings inherited in subprojects" do
+    before do
+      mkdir_p 'bar'
+      @foo = define "foo" do
+        iml.type = "FOO_MODULE_TYPE"
+        define 'bar'
+      end
+      invoke_generate_task
+    end
+
+    it "generates root IML with specified type" do
+      module_file = root_module_filename(@foo)
+      File.should be_exist(module_file)
+      File.read(module_file).should =~ /FOO_MODULE_TYPE/
+    end
+
+    it "generates subproject IML with inherited type" do
+      module_file = subproject_module_filename(@foo, "bar")
+      File.should be_exist(module_file)
+      File.read(module_file).should =~ /FOO_MODULE_TYPE/
+    end
+  end
+
+end

data/spec/buildr/intellij_idea/project_extension_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "project extension" do
+  it "provides an 'iidea:generate' task" do
+    Rake::Task.tasks.detect{|task| task.to_s == "iidea:generate"}.should_not be_nil
+  end
+
+  it "documents the 'iidea:generate' task" do
+    Rake::Task.tasks.detect{|task| task.to_s == "iidea:generate"}.comment.should_not be_nil
+  end
+
+  it "provides an 'iidea:clean' task" do
+    Rake::Task.tasks.detect{|task| task.to_s == "iidea:clean"}.should_not be_nil
+  end
+
+  it "documents the 'iidea:clean' task" do
+    Rake::Task.tasks.detect{|task| task.to_s == "iidea:clean"}.comment.should_not be_nil
+  end
+end

data/spec/buildr/intellij_idea/template_spec.rb

@@ -0,0 +1,234 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+IPR_TEMPLATE_NAME = "project.template.iml"
+
+IPR_TEMPLATE = <<PROJECT_XML
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="SvnBranchConfigurationManager">
+    <option name="mySupportsUserInfoFilter" value="false" />
+  </component>
+</project>
+PROJECT_XML
+
+IPR_EXISTING = <<PROJECT_XML
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AntConfiguration">
+    <defaultAnt bundledAnt="true" />
+  </component>
+  <component name="SvnBranchConfigurationManager">
+    <option name="mySupportsUserInfoFilter" value="true" />
+  </component>
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/existing.iml" filepath="$PROJECT_DIR$/existing.iml" />
+    </modules>
+  </component>
+</project>
+PROJECT_XML
+
+IPR_FROM_TEMPLATE_XPATH = <<XPATH
+/project/component[@name='SvnBranchConfigurationManager']/option[@name = 'mySupportsUserInfoFilter' and @value = 'false']
+XPATH
+
+IPR_FROM_EXISTING_XPATH = <<XPATH
+/project/component[@name='AntConfiguration']
+XPATH
+
+IPR_FROM_EXISTING_SHADOWING_TEMPLATE_XPATH = <<XPATH
+/project/component[@name='SvnBranchConfigurationManager']/option[@name = 'mySupportsUserInfoFilter' and @value = 'true']
+XPATH
+
+IPR_FROM_EXISTING_SHADOWING_GENERATED_XPATH = <<XPATH
+/project/component[@name='ProjectModuleManager']/modules/module[@fileurl = 'file://$PROJECT_DIR$/existing.iml']
+XPATH
+
+IPR_FROM_GENERATED_XPATH = <<XPATH
+/project/component[@name='ProjectModuleManager']/modules/module[@fileurl = 'file://$PROJECT_DIR$/foo.iml']
+XPATH
+
+IML_TEMPLATE_NAME = "module.template.iml"
+
+IML_TEMPLATE = <<PROJECT_XML
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="JRUBY" name="JRuby">
+      <configuration number="0">
+        <JRUBY_FACET_CONFIG_ID NAME="JRUBY_SDK_NAME" VALUE="JRuby SDK 1.4.0RC1" />
+      </configuration>
+    </facet>
+  </component>
+</module>
+PROJECT_XML
+
+IML_EXISTING = <<PROJECT_XML
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="FunkyPlugin"/>
+  <component name="FacetManager">
+    <facet type="SCALA" name="Scala"/>
+  </component>
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$"/>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="module" module-name="buildr-bnd" exported="" />
+  </component>
+</module>
+PROJECT_XML
+
+IML_FROM_TEMPLATE_XPATH = <<XPATH
+/module/component[@name='FacetManager']/facet[@type = 'JRUBY']
+XPATH
+
+IML_FROM_EXISTING_XPATH = <<XPATH
+/module/component[@name='FunkyPlugin']
+XPATH
+
+IML_FROM_EXISTING_SHADOWING_TEMPLATE_XPATH = <<XPATH
+/module/component[@name='FacetManager']/facet[@type = 'SCALA']
+XPATH
+
+IML_FROM_EXISTING_SHADOWING_GENERATED_XPATH = <<XPATH
+/module/component[@name='NewModuleRootManager']/orderEntry[@module-name = 'buildr-bnd']
+XPATH
+
+IML_FROM_GENERATED_XPATH = <<XPATH
+/module/component[@name='NewModuleRootManager']/orderEntry[@type = 'module-library']
+XPATH
+
+describe "iidea:generate" do
+
+  describe "with existing project files" do
+    before do
+      write "foo.ipr", IPR_EXISTING
+      write "foo.iml", IML_EXISTING
+      artifact('group:id:jar:1.0') { |t| write t.to_s }
+      @foo = define "foo" do
+        ipr.template = nil
+        iml.template = nil
+        compile.with 'group:id:jar:1.0'
+      end
+      invoke_generate_task
+    end
+
+    it "replaces ProjectModuleManager component in existing ipr file" do
+      xml_document(@foo._("foo.ipr")).should have_xpath(IPR_FROM_GENERATED_XPATH)
+      xml_document(@foo._("foo.ipr")).should_not have_xpath(IPR_FROM_EXISTING_SHADOWING_GENERATED_XPATH)
+    end
+
+    it "merges component in existing ipr file" do
+      xml_document(@foo._("foo.ipr")).should have_xpath(IPR_FROM_EXISTING_XPATH)
+    end
+
+    it "replaces NewModuleRootManager component in existing iml file" do
+      xml_document(@foo._("foo.iml")).should have_xpath(IML_FROM_GENERATED_XPATH)
+      xml_document(@foo._("foo.iml")).should_not have_xpath(IML_FROM_EXISTING_SHADOWING_GENERATED_XPATH)
+    end
+
+    it "merges component in existing iml file" do
+      xml_document(@foo._("foo.iml")).should have_xpath(IML_FROM_EXISTING_XPATH)
+    end
+  end
+
+  describe "with an iml template" do
+    before do
+      write IML_TEMPLATE_NAME, IML_TEMPLATE
+      artifact('group:id:jar:1.0') { |t| write t.to_s }
+      @foo = define "foo" do
+        ipr.template = nil
+        iml.template = IML_TEMPLATE_NAME
+        compile.with 'group:id:jar:1.0'
+      end
+      invoke_generate_task
+    end
+
+    it "replaces generated components" do
+      xml_document(@foo._("foo.iml")).should have_xpath(IML_FROM_GENERATED_XPATH)
+    end
+
+    it "merges component in iml template" do
+      xml_document(@foo._("foo.iml")).should have_xpath(IML_FROM_TEMPLATE_XPATH)
+    end
+  end
+
+  describe "with an iml template and existing iml" do
+    before do
+      write IML_TEMPLATE_NAME, IML_TEMPLATE
+      write "foo.iml", IML_EXISTING
+      artifact('group:id:jar:1.0') { |t| write t.to_s }
+      @foo = define "foo" do
+        ipr.template = nil
+        iml.template = IML_TEMPLATE_NAME
+        compile.with 'group:id:jar:1.0'
+      end
+      invoke_generate_task
+    end
+
+    it "replaces generated components" do
+      xml_document(@foo._("foo.iml")).should have_xpath(IML_FROM_GENERATED_XPATH)
+    end
+
+    it "merges component in iml template" do
+      xml_document(@foo._("foo.iml")).should have_xpath(IML_FROM_TEMPLATE_XPATH)
+    end
+
+    it "merges components not in iml template and not generated by task" do
+      xml_document(@foo._("foo.iml")).should have_xpath(IML_FROM_EXISTING_XPATH)
+      xml_document(@foo._("foo.iml")).should_not have_xpath(IML_FROM_EXISTING_SHADOWING_TEMPLATE_XPATH)
+      xml_document(@foo._("foo.iml")).should_not have_xpath(IML_FROM_EXISTING_SHADOWING_GENERATED_XPATH)
+    end
+  end
+
+  describe "with an ipr template" do
+    before do
+      write IPR_TEMPLATE_NAME, IPR_TEMPLATE
+      artifact('group:id:jar:1.0') { |t| write t.to_s }
+      @foo = define "foo" do
+        ipr.template = IPR_TEMPLATE_NAME
+        iml.template = nil
+        compile.with 'group:id:jar:1.0'
+      end
+      invoke_generate_task
+    end
+
+    it "replaces generated component in ipr template" do
+      xml_document(@foo._("foo.ipr")).should have_xpath(IPR_FROM_GENERATED_XPATH)
+    end
+
+    it "merges component in ipr template" do
+      xml_document(@foo._("foo.ipr")).should have_xpath(IPR_FROM_TEMPLATE_XPATH)
+    end
+  end
+
+  describe "with an ipr template and existing ipr" do
+    before do
+      write IPR_TEMPLATE_NAME, IPR_TEMPLATE
+      write "foo.ipr", IPR_EXISTING
+      artifact('group:id:jar:1.0') { |t| write t.to_s }
+      @foo = define "foo" do
+        ipr.template = IPR_TEMPLATE_NAME
+        iml.template = nil
+        compile.with 'group:id:jar:1.0'
+      end
+      invoke_generate_task
+    end
+
+    it "replaces generated component in ipr template" do
+      xml_document(@foo._("foo.ipr")).should have_xpath(IPR_FROM_GENERATED_XPATH)
+    end
+
+    it "merges component in ipr template" do
+      xml_document(@foo._("foo.ipr")).should have_xpath(IPR_FROM_TEMPLATE_XPATH)
+    end
+
+    it "merges components not in ipr template and not generated by task" do
+      xml_document(@foo._("foo.ipr")).should have_xpath(IPR_FROM_EXISTING_XPATH)
+      xml_document(@foo._("foo.ipr")).should_not have_xpath(IPR_FROM_EXISTING_SHADOWING_GENERATED_XPATH)
+      xml_document(@foo._("foo.ipr")).should_not have_xpath(IPR_FROM_EXISTING_SHADOWING_TEMPLATE_XPATH)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+require 'spec'
+require File.expand_path(File.dirname(__FILE__) + '/xpath_matchers.rb')
+
+DEFAULT_BUILDR_DIR=File.expand_path(File.dirname(__FILE__) + '/../../buildr')
+BUILDR_DIR=ENV['BUILDR_DIR'] || DEFAULT_BUILDR_DIR
+
+unless File.exist?("#{BUILDR_DIR}/buildr.gemspec")
+  raise "Unable to find buildr.gemspec in #{BUILDR_DIR == DEFAULT_BUILDR_DIR ? 'guessed' : 'specified'} $BUILD_DIR (#{BUILDR_DIR})"
+end
+
+require 'rubygems'
+
+# For testing we use the gem requirements specified on the buildr.gemspec
+Gem::Specification.load(File.expand_path("#{BUILDR_DIR}/buildr.gemspec", File.dirname(__FILE__))).
+    dependencies.each { |dep| gem dep.name, dep.requirement.to_s }
+
+
+# hook into buildr's spec_helpers load process
+unless defined?(SpecHelpers)
+  module SandboxHook
+    def SandboxHook.included(spec_helpers)
+      $LOAD_PATH.unshift(File.dirname(__FILE__))
+      $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+      require 'buildr_iidea'
+    end
+  end
+
+  require "#{BUILDR_DIR}/spec/spec_helpers.rb"
+
+  module SpecHelpers
+
+    def invoke_generate_task
+      task('iidea:generate').invoke
+    end
+
+    def invoke_clean_task
+      task('iidea:clean').invoke
+    end
+
+    def root_project_filename(project)
+      project._("#{project.name}#{Buildr::IntellijIdea::IdeaFile::DEFAULT_SUFFIX}.ipr")
+    end
+
+    def root_project_xml(project)
+      xml_document(root_project_filename(project))
+    end
+
+    def root_module_filename(project)
+      project._("#{project.name}#{Buildr::IntellijIdea::IdeaFile::DEFAULT_SUFFIX}.iml")
+    end
+
+    def root_module_xml(project)
+      xml_document(root_module_filename(project))
+    end
+
+    def subproject_module_filename(project, sub_project_name)
+      project._("#{sub_project_name}/#{sub_project_name}#{Buildr::IntellijIdea::IdeaFile::DEFAULT_SUFFIX}.iml")
+    end
+
+    def subproject_module_xml(project, sub_project_name)
+      xml_document(subproject_module_filename(project, sub_project_name))
+    end
+
+    def xml_document(filename)
+      File.should be_exist(filename)
+      REXML::Document.new(File.read(filename))
+    end
+
+    def xpath_to_module
+      "/project/component[@name='ProjectModuleManager']/modules/module"
+    end
+
+  end
+
+end

data/spec/xpath_matchers.rb

@@ -0,0 +1,109 @@
+# Note: That this helper has been derived from examples on the web and in particular
+# the example at http://blog.wolfman.com/articles/2008/1/2/xpath-matchers-for-rspec
+
+require 'rexml/document'
+require 'rexml/element'
+
+module Spec
+  module Matchers
+
+    # check if the xpath exists one or more times
+    class HaveXpath
+      def initialize(xpath)
+        @xpath = xpath
+      end
+
+      def matches?(response)
+        @response = response
+        doc = response.is_a?(REXML::Document) ? response : REXML::Document.new(@response)
+        match = REXML::XPath.match(doc, @xpath)
+        not match.empty?
+      end
+
+      def failure_message
+        "Did not find expected xpath #{@xpath}"
+      end
+
+      def negative_failure_message
+        "Did find unexpected xpath #{@xpath}"
+      end
+
+      def description
+        "match the xpath expression #{@xpath}"
+      end
+    end
+
+    def have_xpath(xpath)
+      HaveXpath.new(xpath)
+    end
+
+    # check if the xpath has the specified value
+    # value is a string and there must be a single result to match its
+    # equality against
+    class MatchXpath
+      def initialize(xpath, val)
+        @xpath = xpath
+        @val= val
+      end
+
+      def matches?(response)
+        @response = response
+        doc = response.is_a?(REXML::Document) ? response : REXML::Document.new(@response)
+        ok = true
+        REXML::XPath.each(doc, @xpath) do |e|
+          @actual_val = case e
+          when REXML::Attribute
+            e.to_s
+          when REXML::Element
+            e.text
+          else
+            e.to_s
+          end
+          return false unless @val == @actual_val
+        end
+        return ok
+      end
+
+      def failure_message
+        "The xpath #{@xpath} did not have the value '#{@val}' It was '#{@actual_val}'"
+      end
+
+      def description
+        "match the xpath expression #{@xpath} with #{@val}"
+      end
+    end
+
+    def match_xpath(xpath, val)
+      MatchXpath.new(xpath, val)
+    end
+
+    # checks if the given xpath occurs num times
+    class HaveNodes  #:nodoc:
+      def initialize(xpath, num)
+        @xpath= xpath
+        @num = num
+      end
+
+      def matches?(response)
+        @response = response
+        doc = response.is_a?(REXML::Document) ? response : REXML::Document.new(@response)
+        match = REXML::XPath.match(doc, @xpath)
+        @num_found= match.size
+        @num_found == @num
+      end
+
+      def failure_message
+        "Did not find expected number of nodes #{@num} in xpath #{@xpath} Found #{@num_found}"
+      end
+
+      def description
+        "match the number of nodes #{@num}"
+      end
+    end
+
+    def have_nodes(xpath, num)
+      HaveNodes.new(xpath, num)
+    end
+
+  end
+end