opener-build-tools 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8a5063d6ea876e004378f7547ff3d7f0d71ce4b
+  data.tar.gz: d1e385960745bff993bfb7eb175032cdbb3088e0
+SHA512:
+  metadata.gz: 4cac369bd4b8d7db119756f20dad712f6c1a54bce4bbe4c192dcd01ed0bf20921024e44e9ca17afb07dd0964d51eb37556cd03eb547927689f0db23d2ec28a41
+  data.tar.gz: e96f6091978e2dc2f25fb842d3f0bc9f9eff3ebe0d4183c1b9cc947255ce815938d2686ab53e3351aa76a4c8a573475ab187449e7a46f4a34f28d0f433e742f1

data/README.md

@@ -0,0 +1,32 @@
+# Build Tools
+
+The OpeNER build tools is a Gem that contains a collection of helper methods
+and Rake tasks that ease the process of wrapping and distributing the various
+OpeNER Gems.
+
+## Requirements
+
+* Ruby 1.9.2 or newer
+* Rake
+
+## Usage
+
+Rake tasks can be loaded as any other normal Ruby file:
+
+    require 'opener/build-tools/tasks/python'
+
+The build tools also come with various helper modules such as
+`Opener::BuildTools::Python`. The methods in these modules can be accessed
+either by using the full namespace (e.g.
+`Opener::BuildTools::Python.python_version`) or by including the modules into a
+certain scope.
+
+Using the full namespace:
+
+    Opener::BuildTools::Python.python_version # => "2.7.5"
+
+Including the module:
+
+    include Opener::BuildTools::Python
+
+    python_version # => "2.7.5"

data/lib/opener/build-tools/files.rb

@@ -0,0 +1,34 @@
+module Opener
+  module BuildTools
+    ##
+    # Module that contains various helper methods that makes it easier to work
+    # with collections of files and iterate over them.
+    #
+    module Files
+      module_function
+
+      ##
+      # Returns an Array containing the contents of a given directory,
+      # excluding '.' and '..'.
+      #
+      # @param [String] directory
+      #
+      def directory_contents(directory)
+        return Dir.glob(File.join(directory, '*'))
+      end
+
+      ##
+      # Calls the supplied block for each file in the given directory, ignoring
+      # '.' and '..'.
+      #
+      # @param [String] directory
+      # @yield [String]
+      #
+      def each_file(directory)
+        directory_contents(directory).each do |path|
+          yield path
+        end
+      end
+    end # Files
+  end # BuildTools
+end # Opener

data/lib/opener/build-tools/java.rb

@@ -0,0 +1,21 @@
+module Opener
+  module BuildTools
+    ##
+    # Module that provides helper methods for dealing with Java specific
+    # projects.
+    #
+    module Java
+      module_function
+
+      ##
+      # Returns a String containing the Java version in a RubyGems compatible
+      # format.
+      #
+      # @return [String]
+      #
+      def java_version
+        return `java -version 2>&1`.match(/java\s+version\s+"([\d\.]+)_/)[1]
+      end
+    end # Java
+  end # BuildTools
+end # Opener

data/lib/opener/build-tools/perl.rb

@@ -0,0 +1,39 @@
+module Opener
+  module BuildTools
+    ##
+    # Module that provides helper methods for dealing with Perl specific
+    # projects.
+    #
+    module Perl
+      module_function
+
+      ##
+      # Checks if a given Perl module is installed. If the module can not be
+      # found the current script is terminated.
+      #
+      # @param [String] name The full name of the Perl module.
+      #
+      def require_perl_module(name)
+        print "Checking for Perl module #{name}... "
+
+        output = `perl -M#{name} -e 'print "exists";' 2>&1`.strip
+
+        if output == 'exists'
+          puts 'yes'
+        else
+          abort 'no'
+        end
+      end
+
+      ##
+      # Returns a String containing the Perl version in a RubyGems comparible
+      # format.
+      #
+      # @return [String]
+      #
+      def perl_version
+        `perl --version 2>&1`.match(/\(v([\d\.]+)\)/)[1]
+      end
+    end # Perl
+  end # BuildTools
+end # Opener

data/lib/opener/build-tools/python.rb

@@ -0,0 +1,59 @@
+module Opener
+  module BuildTools
+    ##
+    # Module that contains various helper methods for dealing with Python, Pip
+    # and other Python tools.
+    #
+    module Python
+      module_function
+
+      ##
+      # Returns a String containing the Python version. This only includes the
+      # numerical value, the prefix "Python " is not included.
+      #
+      # @return [String]
+      #
+      def python_version
+        return `python --version 2>&1`.split(/([\d\.]+)/)[1]
+      end
+
+      ##
+      # Returns a String containing the Pip version in a RubyGems compatible
+      # format.
+      #
+      # @return [String]
+      #
+      def pip_version
+        return `pip --version 2>&1`.match(/pip\s+([\d\.]+)/)[1].chomp('.')
+      end
+
+      ##
+      # Installs the packages in the requirements file in a specific directory.
+      #
+      # @param [String] file The requirements file to use.
+      # @param [String] target The target directory to install packages in.
+      #
+      def pip_install(file, target)
+        Rake::FileUtilsExt.sh(
+          "pip install --requirement=#{file} --target=#{target} " \
+            "--ignore-installed"
+        )
+      end
+
+      ##
+      # Installs a set of Python packages in a given directory based on a
+      # requirements file. If the directory is not empty this process is
+      # aborted.
+      #
+      # @param [String] file The requirements file to install.
+      # @param [String] directory The name of the directory to install the
+      #  packages into.
+      #
+      def install_python_packages(requirements, directory)
+        return unless directory_contents(directory).empty?
+
+        pip_install(requirements, directory)
+      end
+    end # Python
+  end # BuildTools
+end # Opener

data/lib/opener/build-tools/requirements.rb

@@ -0,0 +1,74 @@
+module Opener
+  module BuildTools
+    ##
+    # Module that provides various helper methods for ensuring certain
+    # executables exist, version requirements are met and so on.
+    #
+    module Requirements
+      module_function
+
+      ##
+      # Checks if a given executable can be found in $PATH and aborts if this
+      # isn't the case.
+      #
+      # @example
+      #  require_executable('python')
+      #
+      # @param [String] name
+      #
+      def require_executable(name)
+        print "Checking for #{name}... "
+
+        exists = false
+
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |directory|
+          path = File.join(directory, name)
+
+          if File.executable?(path)
+            exists = true
+            break
+          end
+        end
+
+        if exists
+          puts 'yes'
+        else
+          abort 'no'
+        end
+      end
+
+      ##
+      # Checks if the version specified in `current` is greater than or equal
+      # to the version specified in `requirement`.
+      #
+      # @example Ensures that Python's version is >= 2.7.0
+      #  require_version('python', '2.7.5', '2.7.0')
+      #
+      # @param [String] name The name of the executable.
+      # @param [String] current The current version.
+      # @param [String] required The minimum required version.
+      #
+      def require_version(name, current, required)
+        print "Checking for #{name} >= #{required}... "
+
+        if version_greater_than(current, required)
+          puts 'yes'
+        else
+          abort 'no'
+        end
+      end
+
+      ##
+      # Checks if the version string to the left is greater or equal to the
+      # version string on the right.
+      #
+      # @param [String] left
+      # @param [String] right
+      # @return [TrueClass|FalseClass]
+      #
+      def version_greater_than(left, right)
+        return Gem::Version.new(left) >= Gem::Version.new(right)
+      end
+    end # Requirements
+  end # BuildTools
+end # Opener

data/lib/opener/build-tools/tasks/clean.rb

@@ -0,0 +1,17 @@
+##
+# These Rake tasks require the following constants to be predefined:
+#
+# * TMP_DIRECTORY: path to the local tmp/ directory
+#
+
+namespace :clean do
+  desc 'Removes tmp files'
+  task :tmp do
+    sh("rm -f #{File.join(TMP_DIRECTORY, '*.kaf')}")
+  end
+
+  desc 'Removes all built Gem files'
+  task :gems do
+    sh('rm -f pkg/*.gem')
+  end
+end

data/lib/opener/build-tools/tasks/java.rb

@@ -0,0 +1,23 @@
+##
+# The Java Rake tasks require the following constant to be defined:
+#
+# * CORE_DIRECTORY: path containing the Java source code.
+#
+
+namespace :java do
+  desc 'Installs Java packages in core/'
+  task :compile do
+    Dir.chdir(CORE_DIRECTORY) do
+      sh "mvn package"
+    end
+  end
+
+  namespace :clean do
+    desc 'Removes built Java packages'
+    task :packages do
+      Dir.chdir(CORE_DIRECTORY) do
+        sh 'mvn clean'
+      end
+    end
+  end
+end

data/lib/opener/build-tools/tasks/python.rb

@@ -0,0 +1,45 @@
+##
+# The Python Rake tasks require the following constants to be defined:
+#
+# * PRE_BUILD_REQUIREMENTS: pip requirements to be installed before building
+#   the Gem.
+# * PRE_INSTALL_REQUIREMENTS: pip requirements to be installed upon Gem
+#   installation.
+# * PYTHON_SITE_PACKAGES: path to the local site-packages directory, only used
+#   by the `python_packages` task.
+#
+
+namespace :python do
+  desc 'Installs Python packages in core/site-packages'
+  task :compile => :requirements do
+    requirements = {
+      PRE_BUILD_REQUIREMENTS   => 'pre_build',
+      PRE_INSTALL_REQUIREMENTS => 'pre_install'
+    }
+
+    requirements.each do |file, directory|
+      path = File.join(PYTHON_SITE_PACKAGES, directory)
+
+      if File.file?(file)
+        Opener::BuildTools::Python.install_python_packages(file, path)
+      end
+    end
+  end
+
+  namespace :clean do
+    desc 'Removes built Python packages'
+    task :packages do
+      each_file(PYTHON_SITE_PACKAGES) do |group|
+        each_file(group) do |directory|
+          sh("rm -rf #{directory}")
+        end
+      end
+    end
+
+    desc 'Removes Python bytecode files'
+    task :bytecode do
+      sh('find . -name "*.pyc" -delete')
+      sh('find . -name "*.pyo" -delete')
+    end
+  end
+end

data/lib/opener/build-tools/version.rb

@@ -0,0 +1,5 @@
+module Opener
+  module BuildTools
+    VERSION = '1.0.0'
+  end # BuildTools
+end # Opener

data/lib/opener/build-tools.rb

@@ -0,0 +1,8 @@
+require 'rake'
+
+require_relative 'build-tools/version'
+require_relative 'build-tools/python'
+require_relative 'build-tools/java'
+require_relative 'build-tools/perl'
+require_relative 'build-tools/files'
+require_relative 'build-tools/requirements'

data/opener-build-tools.gemspec

@@ -0,0 +1,20 @@
+require File.expand_path('../lib/opener/build-tools/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'opener-build-tools'
+  gem.version     = Opener::BuildTools::VERSION
+  gem.authors     = ['development@olery.com']
+  gem.summary     = 'Various build tools for OpeNER projects.'
+  gem.description = gem.summary
+  gem.homepage    = 'http://opener-project.github.com'
+
+  gem.required_ruby_version = '>= 1.9.2'
+
+  gem.files = Dir.glob([
+    'lib/**/*.*',
+    '*.gemspec',
+    'README.md'
+  ])
+
+  gem.add_dependency 'rake'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: opener-build-tools
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- development@olery.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Various build tools for OpeNER projects.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/opener/build-tools.rb
+- lib/opener/build-tools/files.rb
+- lib/opener/build-tools/java.rb
+- lib/opener/build-tools/perl.rb
+- lib/opener/build-tools/python.rb
+- lib/opener/build-tools/requirements.rb
+- lib/opener/build-tools/tasks/clean.rb
+- lib/opener/build-tools/tasks/java.rb
+- lib/opener/build-tools/tasks/python.rb
+- lib/opener/build-tools/version.rb
+- opener-build-tools.gemspec
+homepage: http://opener-project.github.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Various build tools for OpeNER projects.
+test_files: []
+has_rdoc: