meta-build 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39d82dbf36468d0637db3a2e447dff8b1c748373
+  data.tar.gz: e78d79d92b8b36fe55a19ca930b4f0d57ce69ac4
+SHA512:
+  metadata.gz: eadbb55ec968f9ebaa2feb5719b7c0b562a431c8d2c1a46d0bcf90bb48a69bdc1cc1e30403ffd28d5eaa9a1805c91196c8ae02bc277f1cc6eb7b3898c0e5dd9e
+  data.tar.gz: 4b56a8ac55129df308cf7911b1f102aed937268fb87196f4a7117cbb918f114629fb7f775ab5aca3149e258dd6a1145c15d64357421138731ccd384672437c35

data/bin/meta-build

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'meta-build'
+require 'meta_build/command_line'
+require 'yaml'
+
+options = {}
+release = {
+  'gem' => MetaBuild::GEM,
+  'version' => MetaBuild::VERSION,
+  'date' => MetaBuild::DATE
+}
+
+OptionParser.new do |opts|
+  opts.banner = "#{release['gem']}: Extract metadata from build artifacts"
+  opts.define_head "Usage: #{release['gem']} [options]"
+  opts.separator ""
+  opts.separator "Examples:"
+  opts.separator " #{release['gem']} -f file/path/to/artifact -o target/output/directory"
+  opts.separator " #{release['gem']} -f file/path/to/artifact -o target/output/directory"
+  opts.separator " #{release['gem']} -f file/path/to/artifact -o target/output/directory -r"
+  opts.separator " #{release['gem']} -f file/path/to/artifact -o target/output/directory -rc"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on('-f', '--file [artifact file path]', 'Example: --file path/to/target/artifact.ear') do |file|
+    options[:compressed_file] = file
+  end
+
+  opts.on('-o', '--output-dir [directory path]', 'Example: --output-dir tmp/target') do |directory|
+    options[:output_dir] = directory
+  end
+
+  opts.on('-n', '--name [target file simple name]', 'Example: --name pretty_file_name') do |name|
+    options[:name] = name
+  end
+
+  opts.on('-r', '--replace-file') do
+    options[:replace_files] = true
+  end
+
+  opts.on('-c', '--create-dir') do
+    options[:create_dir] = true
+  end
+  
+  opts.on('-v', '--version') do
+    puts "#{release['gem']} #{release['version']} (#{release['date']})"
+    exit 0
+  end
+end.parse!
+
+begin
+  MetaBuild::CommandLine.execute(options)
+rescue Exception => ex     
+  puts "[ERROR] #{ex}" unless ex.instance_of? SystemExit
+  exit -1
+end

data/lib/meta-build.rb

@@ -0,0 +1 @@
+require 'meta_build/app'

data/lib/meta_build/app.rb

@@ -0,0 +1,78 @@
+module MetaBuild
+
+  class App
+
+    require 'fileutils'
+    require 'zip'
+    require 'json'
+    require 'tmpdir'
+
+    require 'meta_build/version'
+    require 'meta_build/exceptions'
+    require 'meta_build/helper/app_helper'
+    require 'meta_build/helper/properties_helper'
+    require 'meta_build/helper/zip_helper'
+    require 'meta_build/extractor/base_extractor'
+    require 'meta_build/extractor/ear_extractor'
+    require 'meta_build/extractor/war_extractor'
+    require 'meta_build/extractor/jar_extractor'
+    require 'meta_build/extractor/extractor_factory'
+    require 'meta_build/parser/base_parser'
+    require 'meta_build/parser/ear_parser'
+    require 'meta_build/parser/war_parser'
+    require 'meta_build/parser/jar_parser'
+    require 'meta_build/parser/parser_factory'
+    require 'meta_build/builder/meta_builder'
+
+    attr_reader :compressed_file, :output_dir, :name, :replace_files, :create_dir
+
+    def initialize(options = {})
+      message = MetaBuild::Helper::AppHelper.validate_options options
+      if message
+        raise "[ERROR] #{message}"
+      end
+
+      @compressed_file = options[:compressed_file]
+      @output_dir = options[:output_dir]
+      @name = MetaBuild::Helper::AppHelper.set_target_name(options[:name], options[:compressed_file])
+      @replace_files = options[:replace_files] ||= false
+      @create_dir = options[:create_dir] ||= false
+    end
+
+    def extract_metadata
+      _configure_prerequisites
+
+      hash = MetaBuild::Builder::MetaBuilder.build file: @compressed_file
+      
+      FileUtils.makedirs @output_dir unless File.exist? @output_dir
+      target_file = File.join(@output_dir, @name)
+
+      if File.exist?(target_file) && (!@replace_files)
+        puts "[ERROR] The file #{target_file} already exist. You might want to call this feature with the parameter [-r, --replace-file]"
+        exit 1
+      end
+
+      File.open(target_file, 'w') { |io| io.write hash.to_json }
+
+      FileUtils.remove_dir MetaBuild::Helper::AppHelper.work_dir, true
+    end
+
+    private
+      def _configure_prerequisites
+        _notify_create_dir
+        _notify_truncate_dir
+      end
+
+      def _notify_create_dir
+        return unless @create_dir
+        FileUtils.remove_dir @output_dir, true
+      end
+
+      def _notify_truncate_dir
+        return unless @replace_files
+        FileUtils.remove Dir.glob("#{@output_dir}/**/*")
+      end
+
+  end
+
+end

data/lib/meta_build/builder/meta_builder.rb

@@ -0,0 +1,36 @@
+module MetaBuild
+  module Builder
+
+    class MetaBuilder
+      class << self
+
+        def build(options = {})
+          metadata = nil
+
+          extractor = MetaBuild::Extractor::ExtractorFactory.build options
+          extractor.extract
+
+          options[:source_path] = extractor.tmp_dir
+          parser = MetaBuild::Parser::ParserFactory.build options
+          hash = parser.parse
+
+          metadata = hash
+          artifacts = Dir.glob("#{extractor.tmp_dir}/**/*.war").concat Dir.glob("#{extractor.tmp_dir}/**/*.jar")
+          metadata['dependencies'] = { 'wars' => [], 'jars' => [] } if artifacts.size > 0
+
+          artifacts.each do |artifact|
+            if artifact.end_with? 'war'
+              metadata['dependencies']['wars'] << self.build(file: artifact)
+            else
+              metadata['dependencies']['jars'] << self.build(file: artifact)
+            end
+          end
+          
+          metadata
+        end
+
+      end
+    end
+
+  end
+end

data/lib/meta_build/command_line.rb

@@ -0,0 +1,27 @@
+module MetaBuild
+  class CommandLine
+
+    def self.execute(options = {})
+      new(options).run
+    end
+
+    def initialize(options = {})
+      message = MetaBuild::Helper::AppHelper.validate_options options
+      if message
+        puts "[ERROR] #{message}"
+        exit 1
+      end
+
+      @options = options
+
+      @options[:name] = MetaBuild::Helper::AppHelper.set_target_name(@options[:name], @options[:compressed_file])
+      @options[:replace_files] ||= false
+      @options[:create_dir] ||= false
+    end
+
+    def run
+      MetaBuild::App.new(@options).extract_metadata
+    end
+
+  end
+end

data/lib/meta_build/exceptions.rb

@@ -0,0 +1,5 @@
+module MetaBuild
+  module Exceptions
+    class MetaBuildException < StandardError; end
+  end
+end

data/lib/meta_build/extractor/base_extractor.rb

@@ -0,0 +1,31 @@
+module MetaBuild
+  module Extractor
+
+    class BaseExtractor
+
+      attr_accessor :file, :parent
+      attr_reader :artifact
+
+      def initialize(options = {})
+        @parent = options[:parent]
+        @file = File.absolute_path options[:file]
+
+        @artifact = File.basename @file.sub /\.(ear|war|jar)\z/, ''
+      end
+
+      def extract
+        raise MetaBuild::Exceptions::MetaBuildException.new "#{self.class}.extract must be overridden."
+      end
+
+      def tmp_dir
+        @temp ||= File.join Dir.tmpdir, 'meta-build', 'artifacts', @parent.to_s, @artifact
+      end
+
+      def create_tmp_dir
+        FileUtils.mkdir_p tmp_dir unless File.exist? tmp_dir
+      end
+
+    end
+
+  end
+end

data/lib/meta_build/extractor/ear_extractor.rb

@@ -0,0 +1,14 @@
+module MetaBuild
+  module Extractor
+
+    class EarExtractor < BaseExtractor
+
+      def extract
+        self.create_tmp_dir
+        MetaBuild::Helper::ZipHelper.extract @file, '', self.tmp_dir
+      end
+
+    end
+
+  end
+end

data/lib/meta_build/extractor/extractor_factory.rb

@@ -0,0 +1,21 @@
+module MetaBuild
+  module Extractor
+
+    class ExtractorFactory
+      class << self
+
+        def build(options = {})
+          ext = File.extname(options[:file]).sub /\A\./, ''
+          case ext
+            when 'ear' then EarExtractor.new options
+            when 'war' then WarExtractor.new options
+            when 'jar' then JarExtractor.new options
+            else raise MetaBuild::Exceptions::MetaBuildException.new "Could not find suitable extractor to '#{ext.upcase}' type."
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/lib/meta_build/extractor/jar_extractor.rb

@@ -0,0 +1,14 @@
+module MetaBuild
+  module Extractor
+
+    class JarExtractor < BaseExtractor
+
+      def extract
+        self.create_tmp_dir
+        MetaBuild::Helper::ZipHelper.extract @file, 'META-INF', self.tmp_dir
+      end
+
+    end
+
+  end
+end

data/lib/meta_build/extractor/war_extractor.rb

@@ -0,0 +1,18 @@
+module MetaBuild
+  module Extractor
+
+    class WarExtractor < BaseExtractor
+
+      EXPECTED_PATHS = %w(META-INF WEB-INF/lib public)
+
+      def extract
+        self.create_tmp_dir
+        EXPECTED_PATHS.each do |path|
+          MetaBuild::Helper::ZipHelper.extract @file, path, self.tmp_dir
+        end
+      end
+
+    end
+
+  end
+end

data/lib/meta_build/helper/app_helper.rb

@@ -0,0 +1,42 @@
+module MetaBuild
+  module Helper
+
+    class AppHelper
+      class << self
+
+        def validate_options(options)
+          if options[:compressed_file].to_s.empty?
+            return "Parameter [-f, --file] is required."
+          elsif !File.exist?(options[:compressed_file])
+            return "File denoted by the path '#{options[:compressed_file]}' does not exist."
+          end
+
+          if options[:output_dir].to_s.empty?
+            return "Parameter [-o, --output-dir] is required."
+          elsif (!File.exist?(options[:output_dir])) && (options[:create_dir] != true)
+            return "Directory #{options[:output_dir]} does not exist. You might want to call this feature with the parameter [-c, --create-dir]"
+          end
+        end
+
+        def set_target_name(name = '', source_file)
+          name ||= ''
+
+          if name.empty?
+            name = source_file.split(File::SEPARATOR).last
+            name.sub! /\.\w+\z/, '.json'
+          elsif !name.end_with?('.json')
+            name << '.json'
+          end
+
+          name
+        end
+
+        def work_dir
+          File.join Dir.tmpdir, 'meta-build'
+        end
+
+      end
+    end
+
+  end
+end

data/lib/meta_build/helper/properties_helper.rb

@@ -0,0 +1,26 @@
+module MetaBuild
+  module Helper
+
+    class PropertiesHelper
+      class << self
+
+        def load(file)
+          return unless File.exist? file.to_s
+          props = Hash.new
+
+          File.readlines(file).each do |line|
+            line.strip!
+            next if (line.start_with? '#') || (line.empty?)
+
+            kv = line.split '='
+            props[kv.first.rstrip] = kv.last.lstrip
+          end
+
+          props
+        end
+
+      end
+    end
+
+  end
+end

data/lib/meta_build/helper/zip_helper.rb

@@ -0,0 +1,30 @@
+module MetaBuild
+  module Helper
+
+    class ZipHelper
+      class << self
+
+        def extract(file, path, target)
+          Zip::File.open(file) do |zip_file|
+            zip_file.each do |entry|              
+              next unless entry.name.start_with? path
+
+              target_file = File.join(target, entry.name)
+              if entry.directory?
+                FileUtils.makedirs target_file
+                next
+              end
+
+              dir = File.dirname target_file
+              FileUtils.makedirs dir unless  File.exist? dir
+
+              File.open(target_file, 'wb') { |io| io.write entry.get_input_stream.read }
+            end
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/lib/meta_build/parser/base_parser.rb

@@ -0,0 +1,40 @@
+module MetaBuild
+  module Parser
+
+    class BaseParser
+
+      attr_accessor :source_path
+
+      def initialize(options = {})
+        @source_path = options[:source_path]
+      end
+
+      def parse
+        raise MetaBuild::Exceptions::MetaBuildException.new "#{self.class}.parse must be overridden."
+      end
+
+      protected
+        def _parse
+          path = "#{@source_path}/META-INF/maven/**/pom.properties"
+          hash = MetaBuild::Helper::PropertiesHelper.load Dir.glob(path).first
+
+          if hash.nil?
+            captures = /([-\w\d]+)-([\w\d\.]+)\z/.match(@source_path).captures
+            hash = {
+              'artifactId' => captures.first,
+              'version' => captures.last
+            }
+          end
+
+          data_json = "#{@source_path}/META-INF/data.json"
+          if File.exist? data_json
+            meta_inf = JSON.parse File.read(data_json)
+            hash.merge! meta_inf
+          end
+
+          hash
+        end
+    end
+
+  end
+end

data/lib/meta_build/parser/ear_parser.rb

@@ -0,0 +1,16 @@
+module MetaBuild
+  module Parser
+
+    class EarParser < BaseParser
+
+      def parse
+        hash = self._parse
+        hash['type'] = 'ear'
+
+        hash
+      end
+
+    end
+
+  end
+end

data/lib/meta_build/parser/jar_parser.rb

@@ -0,0 +1,16 @@
+module MetaBuild
+  module Parser
+
+    class JarParser < BaseParser
+
+      def parse
+        hash = self._parse
+        hash['type'] = 'jar'
+
+        hash
+      end
+
+    end
+
+  end
+end

data/lib/meta_build/parser/parser_factory.rb

@@ -0,0 +1,21 @@
+module MetaBuild
+  module Parser
+
+    class ParserFactory
+      class << self
+
+        def build(options = {})
+          ext = File.extname(options[:file]).sub /\A\./, ''
+          case ext
+            when 'ear' then EarParser.new options
+            when 'war' then WarParser.new options
+            when 'jar' then JarParser.new options
+            else raise MetaBuild::Exceptions::MetaBuildException.new "Could not find suitable parser to '#{ext.upcase}' type."
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/lib/meta_build/parser/war_parser.rb

@@ -0,0 +1,48 @@
+module MetaBuild
+  module Parser
+
+    class WarParser < BaseParser
+
+      MODULES = {
+        'siefdau-web' => 'sdau',
+        'rdoc-web' => 'rdoc',
+        'cobra-web' => 'cobra',
+        'tdecis-web' => 'tdcs',
+        'precadin-web' => 'pcad',
+        'mpct-web' => 'overlay',
+        'sic-web' => 'sic'
+      }
+
+      def parse
+        path = "#{@source_path}/META-INF/maven/**/pom.properties"
+        hash = Hash.new
+
+        Dir.glob(path).each do |pom|
+          pieces = pom.split(File::SEPARATOR)
+          _module = pieces[pieces.size - 2]
+          hash[MODULES[_module]] = MetaBuild::Helper::PropertiesHelper.load(pom)
+        end
+
+        path = "#{@source_path}/public/**/data.json"
+
+        Dir.glob(path).each do |data_json|
+          meta_inf = JSON.parse File.read(data_json)
+          
+          pieces = data_json.split(File::SEPARATOR)
+          _module = pieces[pieces.size - 2]
+          _module = MODULES['mpct-web'] if _module == 'public'
+
+          if hash[_module]
+            hash[_module].merge! meta_inf
+          else
+            hash[_module] = meta_inf
+          end
+        end
+
+        hash
+      end
+
+    end
+
+  end
+end

data/lib/meta_build/version.rb

@@ -0,0 +1,5 @@
+module MetaBuild
+  GEM ||= 'meta-build'
+  VERSION ||= '0.1.0'
+  DATE ||= '2016-08-25'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: meta-build
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aurealino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Biblioteca Ruby para extração de meta-informações dos artefatos de construção
+  do SIC.
+email: aureliano.franca@serpro.gov.br
+executables:
+- meta-build
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/meta-build
+- lib/meta-build.rb
+- lib/meta_build/app.rb
+- lib/meta_build/builder/meta_builder.rb
+- lib/meta_build/command_line.rb
+- lib/meta_build/exceptions.rb
+- lib/meta_build/extractor/base_extractor.rb
+- lib/meta_build/extractor/ear_extractor.rb
+- lib/meta_build/extractor/extractor_factory.rb
+- lib/meta_build/extractor/jar_extractor.rb
+- lib/meta_build/extractor/war_extractor.rb
+- lib/meta_build/helper/app_helper.rb
+- lib/meta_build/helper/properties_helper.rb
+- lib/meta_build/helper/zip_helper.rb
+- lib/meta_build/parser/base_parser.rb
+- lib/meta_build/parser/ear_parser.rb
+- lib/meta_build/parser/jar_parser.rb
+- lib/meta_build/parser/parser_factory.rb
+- lib/meta_build/parser/war_parser.rb
+- lib/meta_build/version.rb
+homepage: https://git.serpro/sic/meta-build
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: meta-build-0.1.0 Biblioteca para extração de meta-informações do SIC.
+test_files: []