maven_pom 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.8.7
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in maven_pom.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 FINN.no AS
+
+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,45 @@
+# MavenPom
+
+[![Build Status](https://secure.travis-ci.org/finn-no/maven_pom.png)](http://travis-ci.org/finn-no/maven_pom)
+
+Tiny library to work with Maven's pom.xml files from Ruby.
+
+The code was extracted and gemified from an internal project. The API and functionality is based on that project's relatively simple needs. For instance, it does not care about artifact versions and won't check the validity of the poms.
+
+The project is also in "patches only" mode.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'maven_pom'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install maven_pom
+
+## Usage
+
+    pom = MavenPom.from("path/to/some/pom.xml")
+
+    pom.packaging     #=> "pom"
+    pom.parent        #=> "com.example:parent"
+    pom.key           #=> "com.example:this"
+    pom.dependencies  #=> ["com.example:foo", "com.example:bar"]
+
+    # topological sort - should roughly match e.g. reactor order
+    MavenPom.sort [pom1, pom2, pom3]
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes and add tests for it. This is important so I don't break it in a future version unintentionally.
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

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

data/lib/maven_pom/error.rb

@@ -0,0 +1,7 @@
+module MavenPom
+  class MissingGroupIdError < StandardError
+  end
+
+  class CyclicDependencyError < StandardError
+  end
+end

data/lib/maven_pom/pom.rb

@@ -0,0 +1,83 @@
+module MavenPom
+  class Pom
+    attr_reader :uri
+
+    def initialize(str, uri)
+      @pom = Nokogiri.XML(str)
+      @uri = uri
+    end
+
+    def as_json(opts = nil)
+      {
+        :key       => key,
+        :name      => name,
+        :parent    => parent,
+        :packaging => packaging
+      }
+    end
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+
+    def packaging
+      @pom.css("project > packaging").text
+    end
+
+    def name
+      @pom.css("project > name").text.strip
+    end
+
+    def build_plugins
+      @pom.css("plugins > plugin").map do |node|
+        dependency_name_from(node)
+      end
+    end
+
+    def parent
+      parent = @pom.css("project > parent").first
+
+      if parent
+        gid = parent.css("groupId").text
+        aid = parent.css("artifactId").text
+
+        "#{gid}:#{aid}"
+      end
+    end
+
+    def group_id
+      gid = @pom.css("project > groupId").text
+      gid = @pom.css("project > parent > groupId").text if gid.empty?
+
+      if gid.empty?
+        raise MissingGroupIdError, "could not find groupId in pom (uri=#{uri.inspect})"
+      end
+
+      gid
+    end
+
+    def artifact_id
+      @pom.css("project > artifactId").text
+    end
+
+    def key
+      @key ||= "#{group_id}:#{artifact_id}"
+    end
+
+    def dependencies
+      @pom.css("dependencies > dependency").map do |node|
+        dependency_name_from(node)
+      end
+    end
+
+    def dependency_name_from(node)
+      gid = node.css("groupId").text
+      aid = node.css("artifactId").text
+
+      gid = group_id if gid == "${project.groupId}" # ugh
+
+      "#{gid}:#{aid}"
+    end
+
+  end # Pom
+end # Maven

data/lib/maven_pom/sorter.rb

@@ -0,0 +1,51 @@
+require 'rgl/adjacency'
+require 'rgl/topsort'
+require 'rgl/dot'
+
+module MavenPom
+  class Sorter
+    attr_reader :dag
+
+    def initialize(poms)
+      @poms = poms
+      build_graph
+    end
+
+    def sort
+      sorted_keys = @dag.topsort_iterator.to_a.reverse
+      sorted_keys.map { |key| @map[key] }.compact
+    end
+
+    private
+
+    def build_graph
+      @dag = RGL::DirectedAdjacencyGraph.new
+      @map = {}
+
+      @poms.each do |pom|
+        @map[pom.key] = pom
+        @dag.add_vertex(pom.key)
+      end
+
+      @dag.vertices.each do |key|
+        pom = @map.fetch(key)
+        pom.dependencies.each do |dep|
+          @dag.add_edge key, dep
+        end
+
+        if parent = pom.parent
+          @dag.add_edge key, parent
+        end
+
+        pom.build_plugins.each do |plugin|
+          @dag.add_edge key, plugin
+        end
+      end
+
+      unless @dag.acyclic?
+        raise CyclicDependencyError, "dependency graph has cycles"
+      end
+    end
+  end
+end
+

data/lib/maven_pom/version.rb

@@ -0,0 +1,3 @@
+module MavenPom
+  VERSION = "0.0.1"
+end

data/lib/maven_pom.rb

@@ -0,0 +1,16 @@
+require 'nokogiri'
+
+require "maven_pom/version"
+require "maven_pom/error"
+require "maven_pom/pom"
+require "maven_pom/sorter"
+
+module MavenPom
+  def self.from(path)
+    Pom.new File.read(path), path
+  end
+
+  def self.sort(poms)
+    Sorter.new(poms).sort
+  end
+end

data/maven_pom.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/maven_pom/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jari Bakken"]
+  gem.email         = ["jari.bakken@finn.no"]
+  gem.description   = %q{Tiny library to work with Maven's pom.xml files from Ruby.}
+  gem.summary       = %q{Tiny library to work with Maven's pom.xml files from Ruby.}
+  gem.homepage      = "http://github.com/finn-no/maven_pom"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "maven_pom"
+  gem.require_paths = ["lib"]
+  gem.version       = MavenPom::VERSION
+
+  gem.add_dependency "nokogiri", "~> 1.5.0"
+  gem.add_dependency "rgl", "~> 0.4.0"
+  gem.add_development_dependency "rspec", "~> 2.0"
+end

data/spec/fixtures/child.xml

@@ -0,0 +1,87 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+                      http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>com.example</groupId>
+    <artifactId>parent</artifactId>
+  </parent>
+
+  <groupId>com.example</groupId>
+  <artifactId>child</artifactId>
+  <version>1.0.0</version>
+  <packaging>pom</packaging>
+
+  <dependencies>
+    <dependency>
+        <groupId>com.example</groupId>
+         <artifactId>example-dep-1</artifactId>
+         <version>4.0</version>
+         <type>jar</type>
+         <scope>test</scope>
+         <optional>true</optional>
+     </dependency>
+    <dependency>
+        <groupId>com.example</groupId>
+         <artifactId>example-dep-2</artifactId>
+         <version>4.0</version>
+         <type>jar</type>
+         <scope>test</scope>
+         <optional>true</optional>
+     </dependency>
+  </dependencies>
+
+  <profiles>
+     <profile>
+       <id>release-profile</id>
+
+       <activation>
+         <property>
+           <name>performRelease</name>
+           <value>true</value>
+         </property>
+       </activation>
+
+       <build>
+         <plugins>
+           <plugin>
+             <inherited>true</inherited>
+             <groupId>org.apache.maven.plugins</groupId>
+             <artifactId>maven-source-plugin</artifactId>
+             <executions>
+               <execution>
+                 <id>attach-sources</id>
+                 <goals>
+                   <goal>jar</goal>
+                 </goals>
+               </execution>
+             </executions>
+           </plugin>
+           <plugin>
+             <inherited>true</inherited>
+             <groupId>org.apache.maven.plugins</groupId>
+             <artifactId>maven-javadoc-plugin</artifactId>
+             <executions>
+               <execution>
+                 <id>attach-javadocs</id>
+                 <goals>
+                   <goal>jar</goal>
+                 </goals>
+               </execution>
+             </executions>
+           </plugin>
+           <plugin>
+             <inherited>true</inherited>
+             <groupId>org.apache.maven.plugins</groupId>
+             <artifactId>maven-deploy-plugin</artifactId>
+             <configuration>
+               <updateReleaseInfo>true</updateReleaseInfo>
+             </configuration>
+           </plugin>
+         </plugins>
+       </build>
+     </profile>
+   </profiles>
+</project>

data/spec/fixtures/pom.xml

@@ -0,0 +1,33 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+                      http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.example</groupId>
+  <artifactId>example</artifactId>
+  <version>1.0.0</version>
+  <packaging>pom</packaging>
+
+  <dependencies>
+
+    <dependency>
+        <groupId>com.example</groupId>
+         <artifactId>example-dep-1</artifactId>
+         <version>4.0</version>
+         <type>jar</type>
+         <scope>test</scope>
+         <optional>true</optional>
+     </dependency>
+
+    <dependency>
+         <groupId>${project.groupId}</groupId>
+         <artifactId>example-dep-2</artifactId>
+         <version>4.0</version>
+         <type>jar</type>
+         <scope>test</scope>
+         <optional>true</optional>
+     </dependency>
+
+  </dependencies>
+</project>

data/spec/fixtures/war.xml

@@ -0,0 +1,12 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+                      http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.example</groupId>
+  <artifactId>example-war</artifactId>
+  <version>1.0.0</version>
+  <packaging>war</packaging>
+
+</project>

data/spec/pom_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module MavenPom
+  describe Pom do
+    let(:pom_module) { Pom.new fixture("pom.xml"), "some/pom/path/pom.xml" }
+    let(:war_module) { Pom.new fixture("war.xml"), "some/war/path/pom.xml" }
+    let(:child_module) { Pom.new fixture("child.xml"), "some/child/path/pom.xml" }
+
+    it "knows the module's packaging" do
+      pom_module.packaging.should == 'pom'
+      war_module.packaging.should == 'war'
+    end
+
+    it "knows the module's dependencies" do
+      pom_module.dependencies.should == [
+        "com.example:example-dep-1",
+        "com.example:example-dep-2" # uses ${project.groupId}
+      ]
+    end
+
+    it "knows the module's parent" do
+      child_module.parent.should == "com.example:parent"
+    end
+
+    it "knows the module's build plugins" do
+      child_module.build_plugins.should == [
+        "org.apache.maven.plugins:maven-source-plugin",
+        "org.apache.maven.plugins:maven-javadoc-plugin",
+        "org.apache.maven.plugins:maven-deploy-plugin"
+      ]
+    end
+
+    it "knows the group_id and artifact_id" do
+      war_module.group_id.should == "com.example"
+      war_module.artifact_id.should == "example-war"
+    end
+
+    it "finds the parent's group_id if none is specified" do
+      child_module.group_id.should == "com.example"
+      child_module.artifact_id.should == "child"
+    end
+
+    it "has a key" do
+      war_module.key.should == "com.example:example-war"
+    end
+  end
+end

data/spec/sorter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+module MavenPom
+  describe Sorter do
+    let(:poms) {
+      [
+        mock(Pom,
+          :key => "no.finntech:control",
+          :dependencies => ["no.finntech:kernel", "no.finntech:base"],
+          :parent => nil
+        ),
+        mock(Pom,
+          :key => "no.finntech:kernel",
+          :dependencies => [],
+          :parent => "no.finntech:iad"
+        ),
+        mock(Pom,
+          :key => "no.finntech:base",
+          :dependencies => ["no.finntech:kernel"],
+          :parent => "no.finntech:iad"
+        ),
+        mock(Pom,
+          :key => "no.finntech:iad",
+          :dependencies => [],
+          :parent => nil
+        )
+      ].each { |e| e.stub(:build_plugins => []) }
+    }
+
+    it "does a topological sort of the given maven modules" do
+      sorted = Sorter.new(poms).sort.map { |e| e.key }
+
+      sorted.should == [
+        "no.finntech:iad",
+        "no.finntech:kernel",
+        "no.finntech:base",
+        "no.finntech:control"
+      ]
+    end
+
+    it "has a shortcut on the module" do
+      MavenPom.sort(poms).should be_kind_of(Array)
+    end
+
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'maven_pom'
+
+module SpecHelper
+  def fixture(name)
+    File.read File.expand_path("../fixtures/#{name}", __FILE__)
+  end
+end
+
+RSpec.configure do |c|
+  c.include(SpecHelper)
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: maven_pom
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jari Bakken
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  prerelease: false
+  name: nokogiri
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  prerelease: false
+  name: rgl
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  prerelease: false
+  name: rspec
+  version_requirements: *id003
+description: Tiny library to work with Maven's pom.xml files from Ruby.
+email: 
+- jari.bakken@finn.no
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/maven_pom.rb
+- lib/maven_pom/error.rb
+- lib/maven_pom/pom.rb
+- lib/maven_pom/sorter.rb
+- lib/maven_pom/version.rb
+- maven_pom.gemspec
+- spec/fixtures/child.xml
+- spec/fixtures/pom.xml
+- spec/fixtures/war.xml
+- spec/pom_spec.rb
+- spec/sorter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/finn-no/maven_pom
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Tiny library to work with Maven's pom.xml files from Ruby.
+test_files: 
+- spec/fixtures/child.xml
+- spec/fixtures/pom.xml
+- spec/fixtures/war.xml
+- spec/pom_spec.rb
+- spec/sorter_spec.rb
+- spec/spec_helper.rb