mini_portile 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.1.0 / 2011-03-08
+
+* Initial release. Welcome to this world!

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Luis Lavena.
+
+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.rdoc

@@ -0,0 +1,147 @@
+= MiniPortile
+
+* {Source Code}[https://github.com/luislavena/mini_portile]
+* {Bug Reports}[https://github.com/luislavena/mini_portile/issues]
+
+This project is a minimalistic, simplistic and stupid implementation of a port
+/recipe system <b>for developers</b>.
+
+== Another port system, srsly?
+
+No, is not a general port system, is not aimed to take over apt, macports or
+anything like that.
+
+The rationale is simple.
+
+You create a library A that uses B at runtime or compile time. Target audience
+of your library might have different versions of B installed than yours.
+
+You know, <em>Works on my machine</em> is not what you expect from one
+developer to another.
+
+Developers having problems report them back to you, and what you do then?
+Compile B locally, replacing your existing installation of B or simply hacking
+things around so nothing breaks.
+
+All this, manually.
+
+Computers are tools, are meant to help us, not the other way around.
+
+What if I tell you the above scenario can be simplified with something like
+this:
+
+  rake compile B_VERSION=1.2.3
+
+And your library will use the version of B you specified. Done.
+
+== You make it sound easy, where is the catch?
+
+You got me, there is a catch. At this time (and highly likely will be always)
+MiniPortile is only compatible with GCC compilers and autoconf/configure-based
+projects.
+
+It assumes the library you want to build contains a <tt>configure</tt> script,
+which all the autoconf-based libraries do.
+
+=== How to use
+
+Now that you know the catch, and you're still reading this, let me show you a
+quick example:
+
+  require "mini_portile"
+  recipe = MiniPortile.new("libiconv", "1.13.1")
+  recipe.files = ["http://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.13.1.tar.gz"]
+  recipe.cook
+  recipe.activate
+
+That's all. <tt>cook</tt> will download, extract, configure and compile the
+library into a namespaced structure. <tt>activate</tt> ensures GCC find this
+library and prefers it over a system-wide installation.
+
+=== Structure
+
+At this time, if you haven't digged into the code yet, are wondering <em>what
+is all that structure talk about?</em>.
+
+MiniPortile follows the principle of <b>convention over configuration</b> and
+established a folder structure where is going to place files and perform work.
+
+Take the above example, and let's draw some picture:
+
+  mylib
+    |-- ports
+    |   |-- archives
+    |   |   `-- libiconv-1.13.1.tar.gz
+    |   `-- <platform>
+    |       `-- libiconv
+    |           `-- 1.13.1
+    |               |-- bin
+    |               |-- include
+    |               `-- lib
+    `-- tmp
+        `-- <platform>
+            `-- ports
+
+In above structure, <tt>platform</tt> refers to the architecture that represents
+the operating system you're using (e.g. i686-linux, i386-mingw32, etc).
+
+Inside this folder, MiniPortile will store the artifacts that result from the
+compilation process. As you cans see, it versions out the library so you can
+run multiple version combination without compromising these overlap each other.
+
+<tt>archives</tt> is where downloaded source files are stored. It is recommended
+you avoid trashing that folder so no further downloads will be required (save
+bandwidth, save the world).
+
+The <tt>tmp</tt> is where compilation is performed and can be safely discarded.
+
+=== How can I combine this with my compilation task?
+
+In the simplified proposal, the idea is that using Rake, your <tt>compile</tt>
+task depends on MiniPortile compilation and most important, activation.
+
+Take the following as a simplification of how you can use MiniPortile with
+Rake:
+
+  file ".libiconv.1.13.1.installed" do |f|
+    recipe = MiniPortile.new("libiconv", "1.13.1")
+    recipe.files = ["http://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.13.1.tar.gz"]
+    recipe.cook
+    touch f.name
+  end
+
+  task :libiconv => [".libiconv.1.13.1.installed"] do
+    recipe = MiniPortile.new("libiconv", "1.13.1")
+    recipe.activate
+  end
+
+  task :compile => [:libiconv] do
+    # ...
+  end
+
+This example will:
+
+* Compile the library only once (using a timestamp file)
+* Ensure compiled library gets activated every time
+* Make compile task depend on compiled library activation
+
+For your homework, you can make libiconv version be taken from <tt>ENV</tt>
+variables.
+
+=== Supported scenarios
+
+As mentioned before, MiniPortile requires a GCC compiler toolchain. This has
+been tested against Ubuntu, OSX and even Windows (RubyInstaller with DevKit)
+
+== Disclaimer
+
+If you have any trouble, don't hesitate to contact the author. As always,
+I'm not going to say <em>Use at your own risk</em> because I don't want this
+library to be risky.
+
+If you trip on something, I'll share the liability by repairing things
+as quickly as I can. Your responsibility is to report the inadequacies.
+
+== License
+
+This library is licensed under MIT license. Please see LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,44 @@
+require "rake/clean"
+require "rubygems/package_task"
+
+GEM_SPEC = Gem::Specification.new do |s|
+  # basic information
+  s.name        = "mini_portile"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+
+  # description and details
+  s.summary     = "Simplistic port-like solution for developers"
+  s.description = "Provide a standard and simplified way to build and package\nRuby extensions (C, Java) using Rake as glue."
+
+  # requirements
+  s.required_ruby_version = ">= 1.8.6"
+  s.required_rubygems_version = ">= 1.3.5"
+
+  # dependencies (add_dependency)
+  # development dependencies (add_development_dependency)
+
+  # components, files and paths
+  s.files = FileList["lib/**/*.rb", "Rakefile", "*.{rdoc,txt}"]
+
+  s.require_path = 'lib'
+
+  # documentation
+  s.has_rdoc = true
+  s.rdoc_options << '--main'  << 'README.rdoc' << '--title' << 'MiniPortile -- Documentation'
+
+  s.extra_rdoc_files = %w(README.rdoc History.txt LICENSE.txt)
+
+  # project information
+  s.homepage          = 'http://github.com/luislavena/mini_portile'
+  s.licenses          = ['MIT']
+
+  # author and contributors
+  s.author      = 'Luis Lavena'
+  s.email       = 'luislavena@gmail.com'
+end
+
+Gem::PackageTask.new(GEM_SPEC) do |pkg|
+  pkg.need_tar = false
+  pkg.need_zip = false
+end

data/lib/mini_portile.rb

@@ -0,0 +1,256 @@
+require 'rbconfig'
+require 'net/http'
+require 'fileutils'
+require 'tempfile'
+
+class MiniPortile
+  attr_reader :name, :version, :target
+  attr_accessor :host, :files, :logger, :config_options
+
+  def initialize(name, version)
+    @name = name
+    @version = version
+    @target = 'ports'
+    @files = []
+    @logger = STDOUT
+    @config_options = []
+
+    @host = RbConfig::CONFIG['arch']
+  end
+
+  def download
+    @files.each do |url|
+      filename = File.basename(url)
+      download_file(url, File.join(archives_path, filename))
+    end
+  end
+
+  def extract
+    @files.each do |url|
+      filename = File.basename(url)
+      extract_file(File.join(archives_path, filename), tmp_path)
+    end
+  end
+
+  def configure
+    return if configured?
+
+    prefix  = File.expand_path(port_path)
+    options = [
+      "--disable-shared",   # disable generation of shared object
+      "--enable-static",    # build static library
+      "--host=#{@host}",    # build for specific target (host)
+      "--prefix=#{prefix}"  # installation target
+    ].concat(@config_options).join(' ')
+
+    execute('configure', %Q(sh configure #{options}))
+  end
+
+  def compile
+    execute('compile', 'make')
+  end
+
+  def install
+    return if installed?
+    execute('install', %Q(make install))
+  end
+
+  def downloaded?
+    missing = @files.detect do |url|
+      filename = File.basename(url)
+      !File.exist?(File.join(archives_path, filename))
+    end
+
+    missing ? false : true
+  end
+
+  def configured?
+    configure = File.join(work_path, 'configure')
+    makefile  = File.join(work_path, 'Makefile')
+
+    newer?(makefile, configure)
+  end
+
+  def installed?
+    makefile  = File.join(work_path, 'Makefile')
+    target_dir = Dir.glob("#{port_path}/*").find { |d| File.directory?(d) }
+
+    newer?(target_dir, makefile)
+  end
+
+  def cook
+    download unless downloaded?
+    extract
+    configure unless configured?
+    compile
+    install unless installed?
+
+    return true
+  end
+
+  def activate
+    vars = {
+      'PATH'          => File.join(port_path, 'bin'),
+      'CPATH'         => File.join(port_path, 'include'),
+      'LIBRARY_PATH'  => File.join(port_path, 'lib')
+    }.reject { |env, path| !File.directory?(path) }
+
+    output "Activating #{@name} #{@version} (from #{port_path})..."
+    vars.each do |var, path|
+      full_path = File.expand_path(path)
+
+      # turn into a valid Windows path (if required)
+      full_path.gsub!(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
+
+      # save current variable value
+      old_value = ENV[var] || ''
+
+      unless old_value.include?(full_path)
+        ENV[var] = "#{full_path}#{File::PATH_SEPARATOR}#{old_value}"
+      end
+    end
+  end
+
+private
+
+  def tmp_path
+    @tmp_path ||= "tmp/#{@host}/ports/#{@name}/#{@version}"
+  end
+
+  def port_path
+    @port_path ||= "#{@target}/#{@host}/#{@name}/#{@version}"
+  end
+
+  def archives_path
+    @archives_path ||= "#{@target}/archives"
+  end
+
+  def work_path
+    @work_path ||= begin
+      Dir.glob("#{tmp_path}/*").find { |d| File.directory?(d) }
+    end
+  end
+
+  def log_file(action)
+    File.join(tmp_path, "#{action}.log")
+  end
+
+  def extract_file(file, target)
+    filename = File.basename(file)
+    FileUtils.mkdir_p target
+
+    message "Extracting #{filename} into #{target}... "
+    result = `tar xf #{file} -C #{target}`
+    if $?.success?
+      output "OK"
+    else
+      output "ERROR"
+      output result
+      raise "Failed to complete extract task"
+    end
+  end
+
+  def execute(action, command)
+    log        = log_file(action)
+    log_out    = File.expand_path(log)
+    redirected = command << " >#{log_out} 2>&1"
+
+    Dir.chdir work_path do
+      message "Running '#{action}' for #{@name} #{@version}... "
+      system redirected
+      if $?.success?
+        output "OK"
+        return true
+      else
+        output "ERROR, review '#{log}' to see what happened."
+        raise "Failed to complete #{action} task"
+      end
+    end
+  end
+
+  def newer?(target, checkpoint)
+    if (target && File.exist?(target)) && (checkpoint && File.exist?(checkpoint))
+      File.mtime(target) > File.mtime(checkpoint)
+    else
+      false
+    end
+  end
+
+  # print out a message with the logger
+  def message(text)
+    @logger.print text
+    @logger.flush
+  end
+
+  # print out a message using the logger but return to a new line
+  def output(text = "")
+    @logger.puts text
+    @logger.flush
+  end
+
+  # Slighly modified from RubyInstaller uri_ext, Rubinius configure
+  # and adaptations of Wayne's RailsInstaller
+  def download_file(url, full_path, count = 3)
+    return if File.exist?(full_path)
+    filename = File.basename(full_path)
+
+    begin
+
+      if ENV['http_proxy']
+        protocol, userinfo, host, port  = URI::split(ENV['http_proxy'])
+        proxy_user, proxy_pass = userinfo.split(/:/) if userinfo
+        http = Net::HTTP::Proxy(host, port, proxy_user, proxy_pass)
+      else
+        http = Net::HTTP
+      end
+
+      message "Downloading #{filename} "
+      http.get_response(URI.parse(url)) do |response|
+        case response
+        when Net::HTTPNotFound
+          output "404 - Not Found"
+          return false
+
+        when Net::HTTPClientError
+          output "Error: Client Error: #{response.inspect}"
+          return false
+
+        when Net::HTTPRedirection
+          raise "Too many redirections for the original URL, halting." if count <= 0
+          url = response["location"]
+          return download_file(url, full_path, count - 1)
+
+        when Net::HTTPOK
+          temp_file = Tempfile.new("download-#{filename}")
+          temp_file.binmode
+
+          size = 0
+          progress = 0
+          total = response.header["Content-Length"].to_i
+
+          response.read_body do |chunk|
+            temp_file << chunk
+            size += chunk.size
+            new_progress = (size * 100) / total
+            unless new_progress == progress
+              message "\rDownloading %s (%3d%%) " % [filename, new_progress]
+            end
+            progress = new_progress
+          end
+
+          output
+
+          temp_file.close
+          File.unlink full_path if File.exists?(full_path)
+          FileUtils.mkdir_p File.dirname(full_path)
+          FileUtils.mv temp_file.path, full_path, :force => true
+        end
+      end
+
+    rescue Exception => e
+      File.unlink full_path if File.exists?(full_path)
+      output "ERROR: #{e.message}"
+      raise "Failed to complete download task"
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: mini_portile
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Luis Lavena
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: |-
+  Provide a standard and simplified way to build and package
+  Ruby extensions (C, Java) using Rake as glue.
+email: luislavena@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- History.txt
+- LICENSE.txt
+files: 
+- lib/mini_portile.rb
+- Rakefile
+- README.rdoc
+- History.txt
+- LICENSE.txt
+has_rdoc: true
+homepage: http://github.com/luislavena/mini_portile
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- MiniPortile -- Documentation
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 59
+      segments: 
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 17
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Simplistic port-like solution for developers
+test_files: []
+