buildr-iidea 0.0.2

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/NOTICE

@@ -0,0 +1,16 @@
+= COPYRIGHT NOTICES
+
+Copyright 2010 Peter Donald
+
+Copyright 2010 Rhett Sutphin
+
+Apache Buildr
+Copyright 2007-2009 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+Copyright 2007 Intalio
+
+This product includes software developed by Intalio
+http://www.intalio.com

data/README.rdoc

@@ -0,0 +1,286 @@
+= Intellij IDEA support for buildr
+
+This extension provides tasks to generate Intellij IDEA project files by issuing:
+
+  $ buildr iidea:generate
+
+This task will generate an .iml file for every project (or subproject) and a .ipr
+that you can directly open for the root project.
+
+The generated project files can be removed by issuing;
+
+  $ buildr iidea:clean
+
+The iidea task generates the project files based on the settings of each project and
+extension specific settings. The main and test source trees are added to the .iml
+file for each project as are the respective resource directories. The target and report
+directories are excluded from the project. If the project files exist on the filesystem
+the extension will replace specific component sections in the xml with the generated
+component configurations.
+
+Dependencies come in two forms. Dependencies on other projects and dependencies on
+external jars. Dependencies on other projects are added as module dependencies in the
+.iml while jars are added as regular file dependencies. Dependencies are exported from
+the .iml file if they are compile dependencies.
+
+== Installation
+
+The extension is packaged as a gem named "buildr-iidea", consult the ruby gems installation
+steps but typically it is either
+
+  sudo gem install buildr-iidea
+
+for MRI ruby or
+
+  jgem install buildr-iidea
+
+for jruby.
+
+The user then needs to add the following require into the build file:
+
+  require 'buildr_iidea'
+
+== Idea Specific Directives
+
+The extension specific settings of subprojects inherit the parent projects settings
+unless overwritten.
+
+=== Project file naming
+
+The extension will use the last element of the projects name when generating the .ipr
+and .iml files. i.e. A project named "foo" will generate "foo.iml" and "foo.ipr" while
+a project named "foo:bar" will generate "bar/bar.iml" and no ipr. (The .ipr project
+files are only generated for base project). The name can be modified by setting the
+"ipr.suffix" or "iml.suffix" settins which specifies the suffix appended to the
+filenames. The user can also overide the name completely by setting "ipr.id" or "iml.id".
+
+==== Example: Setting id
+
+  define "foo" do
+    ipr.id = "beep"
+    define "bar" do
+      iml.id = "baz"
+    end
+  end
+
+Will generate:
+
+  beep.ipr
+  foo.iml
+  bar/baz.iml
+
+==== Example: Setting suffix
+
+  define "foo" do
+    ipr.suffix = "-suffix1"
+    iml.suffix = "-suffix2"
+    define "bar"
+  end
+
+Will generate:
+
+  foo-suffix1.ipr
+  foo-suffix2.iml
+  bar/bar-suffix2.iml
+
+=== VCS Integration
+
+The extension will attempt to guess the VCS type of the project by looking for a .svn
+or .git directory in the base projects directory. If either of these are set it will
+configure the component as appropriate. Otherwise the user will need to manually specify
+the project to one of either 'Git' or 'svn' using the ipr.vcs setting.
+
+==== Example
+
+  define "foo" do
+    ipr.vcs = 'Git'
+  end
+
+=== Dependency generation
+
+When file dependencies are inserted into an .iml file absolute paths are used by default.
+The user can override this by setting the "iml.local_repository_env_override" setting.
+If set to nil absolute paths are used. If set to a non-null value the path to the local
+maven repository will be replaced with the specified environment variable.
+
+==== Example: Setting local_repository_env_override
+
+  define "foo" do
+    iml.local_repository_env_override = "MAVEN_REPOSITORY"
+    compile.with 'group:id:jar:1.0'
+  end
+
+Will generate a dependency with a path like:
+
+  jar://$MAVEN_REPOSITORY$/group/id/1.0/id-1.0.jar!/
+
+rather than the default
+
+  jar:///home/peter/.m2/repository/group/id/1.0/id-1.0.jar!/
+
+=== Module Facets
+
+Facets are IDEAs mechanism for adding support for languages, tools and frameworks other than
+core java. A facet can be added to a project so that it can be deployed as a web application
+or a hibernate application. A facet can also be used t provide support for other languages
+such as ruby and scala. The extension makes it possible to generate .iml with the appropriate
+facets via the "iml.add_facet" method. It should be noted that facets are NOT inherited by 
+subprojects.
+
+==== Example
+
+This example adds the web facet to a project.
+
+  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
+  end
+
+=== Custom Component Sections
+
+If the extension does not provide capability to generate configuration for a particular
+IDEA plugin the user can provide their own configuration data via the "ipr.add_component"
+or "iml.add_component" methods.
+
+==== Example: Adding .ipr specific component
+
+This example changes the compiler configuration for project.
+
+  define "foo" do
+    ipr.add_component("CompilerConfiguration") do |component|
+      component.option :name => 'DEFAULT_COMPILER', :value => 'Javac'
+      component.option :name => 'DEPLOY_AFTER_MAKE', :value => '0'
+      component.resourceExtensions do |xml|
+        xml.entry :name => '.+\.nonexistent'
+      end
+      component.wildcardResourceExtensions do |xml|
+        xml.entry :name => '?*.nonexistent'
+      end
+    end
+  end
+
+==== Example: Adding .iml specific component
+
+This example adds the web facet to a project. Note: This overrides the facets defined by
+the "iml.add_facet" method.
+
+  define "foo" do
+    iml.add_component("FacetManager") do |component|
+      component.facet :type => 'web', :name => '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
+    end
+  end
+
+=== Templates
+
+The underlying project files are xml the contain elements for a number of "components".
+The extension will load any existing project files and replace or add any component
+elements that are generated by the extension. The extension also allows the user to specify
+a template with either ipr.template or iml.template settings. If a template is specified
+it will be loaded and any component elements in these documents will be merged into the base
+document prior to merging in generated sections. Templates are useful if you want to enforce
+certain configuration options (i.e. project specific code style).
+
+==== Example
+
+  define "foo" do
+    ipr.template = 'project.ipr.template'
+    iml.template = 'module.ipr.template'
+  end
+
+=== Groups
+
+IDEA provides the facility to organise modules into groups. By default the extension does not
+do this but it can be enabled by iml.group setting. If that setting is set to true then the
+.iml file will be placed in a group based on the parent projects name. If the setting is a string
+then that is used as the name of the group.
+
+==== Example
+
+  define "foo" do
+    iml.group = true
+    define 'bar' do
+      define 'baz'
+    end
+    define 'rab' do
+      iml.group = "MyGroup"
+    end
+  end
+
+Will place the generated .imls in the following groups:
+
+  foo.iml                => ''
+  bar/bar.iml            => 'foo'
+  bar/baz/baz.iml        => 'foo/bar'
+  rab/rab.iml            => 'MyGroup'
+
+=== Add Extra .iml files to .ipr
+
+The 'ipr.extra_modules' setting makes it possible to add extra modules to the generated iml file.
+The setting is an array of filenames relative to the base project directory.
+
+==== Example
+
+  define "foo" do
+    ipr.extra_modules << 'other.iml'
+    ipr.extra_modules << 'other_other.iml'
+  end
+
+Will add the 'other.iml' and 'other_other.iml' files to the .ipr project files.
+
+== Compatibility
+
+It's been tested with IDEA 9.x.
+
+== Future Work
+
+The following is a list of feature requests for future versions of the extension. Feel free to
+jump in and supply a patch if you have gone ahead and implemented the feature.
+
+=== Auto-generate Web Facet
+
+Any project that defines a war package should have a web facet autogenerated for it.
+
+=== Auto-generate Scala Facet
+
+Any project that contains scala source code should have a scala facet autogenerated for it.
+
+=== Support generation of IDEA files into separate hierarchy
+
+Add the ability for the module and project files to be generated off into a different
+directory hierarchy. i.e. Generate project modules into .idea_project in projects base
+directory.
+
+=== Populate SOURCES and JAVADOC for dependencies
+
+Add tasks 'iidea:deps:sources:download' and 'iidea:deps:javadoc:download' that downloads
+missing :classifier => 'sources' and :classifier => 'javadoc' dependencies for all the
+:classifier => 'jar' dependencies in the project. When generating the project files the task
+should populate the SOURCES and JAVADOC if the relevant artifact is present in the local
+repository.
+
+=== Fix tests to work when installed as a gem
+
+The library should determine whether it is installed as a gem and if so use the gem to
+invoke the the tests. See http://rubygems.rubyforge.org/rubygems-update/Gem.html#M000228
+for a possible interface to determine if currently installed as a gem.