gembuild 1.0.0

data/lib/gembuild/exceptions.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+# Gembuild: create Arch Linux PKGBUILDs for ruby gems.
+# Copyright (C) 2015  Mario Finelli <mario@finel.li>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Gembuild
+  # Exception raised when rubygems.org returns a 404 error.
+  class GemNotFoundError < StandardError; end
+
+  # Exception raised when a non-string pkgbuild is passed.
+  class InvalidPkgbuildError < StandardError; end
+
+  # Exception raised when no gemname is specified.
+  class UndefinedGemNameError < StandardError; end
+
+  # Exception raised when no pkgname is specified.
+  class UndefinedPkgnameError < StandardError; end
+end

data/lib/gembuild/gem_scraper.rb

@@ -0,0 +1,205 @@
+# encoding: utf-8
+
+# Gembuild: create Arch Linux PKGBUILDs for ruby gems.
+# Copyright (C) 2015  Mario Finelli <mario@finel.li>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'mechanize'
+require 'nokogiri'
+
+module Gembuild
+  # This class is used to query for various information from rubygems.org.
+  #
+  # @!attribute [r] agent
+  #   @return [Mechanize] the Mechanize agent
+  # @!attribute [r] deps
+  #   @return [String] the rubygems URL for getting dependency information
+  # @!attribute [r] gem
+  #   @return [String] the rubygems URL for the frontend
+  # @!attribute [r] gemname
+  #   @return [String] the rubygem about which to query
+  # @!attribute [r] url
+  #   @return [String] the rubygems URL to get version information
+  class GemScraper
+    attr_reader :agent, :deps, :gem, :gemname, :url
+
+    # Creates a new GemScraper instance
+    #
+    # @raise [Gembuild::UndefinedGemName] if the gemname is nil or empty
+    #
+    # @example Create a new GemScraper object
+    #   Gembuild::GemScraper.new('mina')
+    #   # => #<Gembuild::GemScraper:0x00000002f8a500
+    #   #  @agent=
+    #   #   #<Mechanize
+    #   #    #<Mechanize::CookieJar:0x00000002f8a410
+    #   #     @store=
+    #   #      #<HTTP::CookieJar::HashStore:0x00000002f8a370
+    #   #       @gc_index=0,
+    #   #       @gc_threshold=150,
+    #   #       @jar={},
+    #   #       @logger=nil,
+    #   #       @mon_count=0,
+    #   #       @mon_mutex=#<Mutex:0x00000002f8a320>,
+    #   #       @mon_owner=nil>>
+    #   #    nil>,
+    #   #  @deps="https://rubygems.org/api/v1/dependencies?gems=mina",
+    #   #  @gem="https://rubygems.org/gems/mina",
+    #   #  @gemname="mina",
+    #   #  @url="https://rubygems.org/api/v1/versions/mina.json">
+    #
+    # @param gemname [String] The gem about which to query.
+    # @return [Gembuild::GemScraper] a new GemScraper instance
+    def initialize(gemname)
+      fail Gembuild::UndefinedGemNameError if gemname.nil? || gemname.empty?
+
+      @gemname = gemname
+      @agent = Mechanize.new
+
+      @url = "https://rubygems.org/api/v1/versions/#{gemname}.json"
+      @deps = "https://rubygems.org/api/v1/dependencies?gems=#{gemname}"
+      @gem = "https://rubygems.org/gems/#{gemname}"
+    end
+
+    # Query the rubygems version api for the latest version.
+    #
+    # @raise [Gembuild::GemNotFoundError] if the page returns a 404 (not
+    #   found) error.
+    #
+    # @example Query rubygems.org for version information
+    #   s = Gembuild::GemScraper.new('mina')
+    #   s.query_latest_version
+    #   # => {:authors=>"Rico Sta. Cruz, Michael Galero",
+    #   #  :built_at=>"2015-07-08T00:00:00.000Z",
+    #   #  :created_at=>"2015-07-08T13:13:33.292Z",
+    #   #  :description=>"Really fast deployer and server automation tool.",
+    #   #  :downloads_count=>18709,
+    #   #  :metadata=>{},
+    #   #  :number=>"0.3.7",
+    #   #  :summary=>"Really fast deployer and server automation tool.",
+    #   #  :platform=>"ruby",
+    #   #  :ruby_version=>">= 0",
+    #   #  :prerelease=>false,
+    #   #  :licenses=>[],
+    #   #  :requirements=>[],
+    #   #  :sha=>
+    #   #   "bd1fa2b56ed1aded882a12f6365a04496f5cf8a14c07f8c4f1f3cfc944ef34f6"
+    #   # }
+    #
+    # @return [Hash] the information about the latest version of the gem
+    def query_latest_version
+      response = JSON.parse(agent.get(url).body, symbolize_names: true)
+
+      # Skip any release marked as a "prerelease"
+      response.shift while response.first[:prerelease]
+
+      response.first
+    rescue Mechanize::ResponseCodeError, Net::HTTPNotFound
+      raise Gembuild::GemNotFoundError
+    end
+
+    # Gets the version number from the parsed response.
+    #
+    # @param response [Hash] The JSON parsed results from rubygems.org.
+    # @return [Gem::Version] the current version of the gem
+    def get_version_from_response(response)
+      Gem::Version.new(response.fetch(:number))
+    end
+
+    # Gets a well-formed gem description from the parsed response.
+    #
+    # @param response [Hash] The JSON parsed results from rubygems.org.
+    # @return [String] the gem description or summary ending in a full-stop
+    def format_description_from_response(response)
+      description = response.fetch(:description)
+      description = response.fetch(:summary) if description.empty?
+
+      # Replace any newlines or tabs (which would mess up a PKGBUILD) with
+      # spaces. Then, make sure there is no
+      description = description.gsub(/[[:space:]]+/, ' ').strip
+
+      # Ensure that the description ends in a full-stop.
+      description += '.' unless description[-1, 1] == '.'
+
+      description
+    end
+
+    # Gets the sha256 checksum returned from the rubygems.org API.
+    #
+    # @param response [Hash] The JSON parsed results from rubygems.org.
+    # @return [String] the sha256 sum of the gem file
+    def get_checksum_from_response(response)
+      response.fetch(:sha)
+    end
+
+    # Get the array of licenses under which the gem is licensed.
+    #
+    # @param response [Hash] The JSON parsed results from rubygems.org.
+    # @return [Array] the licenses for the gem
+    def get_licenses_from_response(response)
+      response.fetch(:licenses)
+    end
+
+    # Get all other gem dependencies for the given version.
+    #
+    # @param version [String|Gem::Version] The version for which to get the
+    #   dependencies.
+    # @return [Array] list of other gems upon which the gem depends
+    def get_dependencies_for_version(version)
+      version = Gem::Version.new(version) if version.is_a?(String)
+
+      payload = Marshal.load(agent.get(deps).body)
+
+      dependencies = payload.find do |v|
+        Gem::Version.new(v[:number]) == version
+      end
+
+      dependencies[:dependencies].map(&:first)
+    end
+
+    # Scrape the rubygems.org frontend for the gem's homepage URL.
+    #
+    # @return [String] the homepage URL of the gem
+    def scrape_frontend_for_homepage_url
+      html = agent.get(gem).body
+      links = Nokogiri::HTML(html).css('a')
+
+      homepage_link = links.find do |a|
+        a.text.strip == 'Homepage'
+      end
+
+      homepage_link[:href]
+    end
+
+    # Quick method to get all important information in a single hash for
+    # later processing.
+    #
+    # @return [Hash] hash containing all the information available from the
+    #   rubygems.org APIs and website
+    def scrape!
+      response = query_latest_version
+      version = get_version_from_response(response)
+
+      {
+        version: version,
+        description: format_description_from_response(response),
+        checksum: get_checksum_from_response(response),
+        license: get_licenses_from_response(response),
+        dependencies: get_dependencies_for_version(version),
+        homepage: scrape_frontend_for_homepage_url
+      }
+    end
+  end
+end

data/lib/gembuild/pkgbuild.erb

@@ -0,0 +1,32 @@
+# Generated with gembuild (https://github.com/mfinelli/gembuild)
+# Maintainer: <%= maintainer %>
+<% unless contributor.count.zero? -%><% contributor.each do |c| -%>
+# Contributor: <%= c %>
+<% end -%><% end -%>
+
+_gemname=<%= gemname %>
+pkgname=ruby-$_gemname
+pkgver=<%= pkgver %>
+pkgrel=<%= pkgrel %>
+<% unless epoch.zero? -%>
+epoch=<%= epoch %>
+<% end -%>
+pkgdesc='<%= description %>'
+arch=('<%= arch.join("' '") %>')
+url='<%= url %>'
+<% unless license.count.zero? -%>
+license=('<%= license.join("' '") %>')
+<% end -%>
+options=(<%= options.join(' ') %>)
+noextract=(<%= noextract.join(' ') %>)
+depends=('<%= depends.join("' '") %>')
+makedepends=('<%= makedepends.join("' '") %>')
+source=("<%= source.join("\" \"") %>")
+<%= checksum_type %>sums=('<%= checksum %>')
+
+package() {
+  cd "$srcdir"
+  local _gemdir="$(ruby -e'puts Gem.default_dir')"
+
+  gem install --ignore-dependencies --no-user-install -i "$pkgdir/$_gemdir" -n "$pkgdir/usr/bin" $_gemname-$pkgver.gem
+}

data/lib/gembuild/pkgbuild.rb

@@ -0,0 +1,283 @@
+# encoding: utf-8
+
+# Gembuild: create Arch Linux PKGBUILDs for ruby gems.
+# Copyright (C) 2015  Mario Finelli <mario@finel.li>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'erb'
+
+module Gembuild
+  # Class used to create a PKGBUILD file for a rubygem.
+  #
+  # @!attribute [rw] arch
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#arch
+  #   @return [Array] the supported architectures
+  # @!attribute [rw] checksum
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#sha256sums
+  #   @return [String] the sha256 sum of the gemfile
+  # @!attribute [rw] checksum_type
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#sha256sums
+  #   @return [String] the type of checksum (will always be sha256)
+  # @!attribute [rw] contributor
+  #   @return [Array] an array of the contributors to the pkgbuild
+  # @!attribute [rw] depends
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#depends
+  #   @return [Array] an array of the package's dependencies (always ruby
+  #     plus any other gems listed as dependencies)
+  # @!attribute [rw] description
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#pkgdesc
+  #   @return [String] the package description
+  # @!attribute [rw] epoch
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#epoch
+  #   @return [Fixnum] the package's epoch value
+  # @!attribute [rw] gemname
+  #   @return [String] the ruby gem for which to generate a PKGBUILD
+  # @!attribute [rw] license
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#license
+  #   @return [Array] an array of licenses for the gem
+  # @!attribute [rw] maintainer
+  #   @return [String] the package's maintainer
+  # @!attribute [rw] makedepends
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#makedepends
+  #   @return [Array] a list of the dependencies needed to build the package
+  #     (normally just the package rubygems)
+  # @!attribute [rw] noextract
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#noextract
+  #   @return [Array] a list of sources not to extract with bsdtar (namely,
+  #     the gemfile)
+  # @!attribute [rw] options
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#options
+  #   @return [Array] a list of options to pass to makepkg
+  # @!attribute [rw] pkgname
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#pkgname
+  #   @return [String] the name of the package (usually ruby-gem)
+  # @!attribute [rw] pkgrel
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#pkgrel
+  #   @return [Fixnum] the release number of the package
+  # @!attribute [rw] pkgver
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#pkgver
+  #   @return [Gem::Version] the version of the gem
+  # @!attribute [rw] source
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#source
+  #   @return [Array] a list of sources
+  # @!attribute [rw] url
+  #   @see https://wiki.archlinux.org/index.php/PKGBUILD#url
+  #   @return [String] the URL of the homepage of the gem
+  class Pkgbuild
+    attr_accessor :arch, :checksum, :checksum_type, :contributor, :depends,
+                  :description, :epoch, :gemname, :license, :maintainer,
+                  :makedepends, :noextract, :options, :pkgname, :pkgrel,
+                  :pkgver, :source, :url
+
+    # Create a new Pkgbuild instance.
+    #
+    # @raise [Gembuild::InvalidPkgbuildError] if something other than a
+    #   string or nil is passed as the existing pkgbuild
+    #
+    # @param gemname [String] The rubygem for which to create a PKGBUILD.
+    # @param existing_pkgbuild [nil, String] An old PKGBUILD that can be
+    #   parsed for maintainer and contributor information.
+    # @return [Gembuild::Pkgbuild] a new Pkgbuild instance
+    def initialize(gemname, existing_pkgbuild = nil)
+      unless existing_pkgbuild.nil? || existing_pkgbuild.is_a?(String)
+        fail Gembuild::InvalidPkgbuildError
+      end
+
+      @gemname = gemname
+      @pkgname = "ruby-#{@gemname}"
+
+      set_package_defaults
+
+      no_parse_pkgbuild = existing_pkgbuild.nil? || existing_pkgbuild.empty?
+      parse_existing_pkgbuild(existing_pkgbuild) unless no_parse_pkgbuild
+    end
+
+    # Parse the old pkgbuild (if it exists) to get information about old
+    # maintainers or contributors or about other dependencies that have been
+    # added but that can not be scraped from rubygems.org.
+    #
+    # @param pkgbuild [String] The old PKGBUILD to parse.
+    # @return [Hash] a hash containing the values scraped from the PKGBUILD
+    def parse_existing_pkgbuild(pkgbuild)
+      pkgbuild.match(/^# Maintainer: (.*)$/) { |m| @maintainer = m[1] }
+
+      @contributor = pkgbuild.scan(/^# Contributor: (.*)$/).flatten
+
+      deps = parse_existing_dependencies(pkgbuild)
+      deps.each do |dep|
+        @depends << dep
+      end
+
+      { maintainer: maintainer, contributor: contributor, depends: deps }
+    end
+
+    # Create a new Pkgbuild instance with all information from the scraped
+    # sources assigned.
+    #
+    # @param gemname [String] The rubygem for which to create a Pkgbuild.
+    # @param existing_pkgbuild [String, nil] An old PKGBUILD that can be
+    #   parsed for maintainer information.
+    # @return [Gembuild::Pkgbuild] a new Pkgbuild instance
+    def self.create(gemname, existing_pkgbuild = nil)
+      pkgbuild = Pkgbuild.new(gemname, existing_pkgbuild)
+
+      pkgbuild.fetch_maintainer
+
+      gem_details = Gembuild::GemScraper.new(gemname).scrape!
+      aur_details = Gembuild::AurScraper.new(pkgbuild.pkgname).scrape!
+
+      pkgbuild.assign_gem_details(gem_details)
+      pkgbuild.assign_aur_details(aur_details)
+
+      pkgbuild
+    end
+
+    # Generate a PKGBUILD from the class using the pkgbuild erb template.
+    #
+    # @return [String] the PKGBUILD
+    def render
+      ERB.new(template, 0, '-').result(binding)
+    end
+
+    # Get the PKGBUILD erb template.
+    #
+    # @return [String] the pkgbuild erb template
+    def template
+      File.read(File.join(File.dirname(__FILE__), 'pkgbuild.erb'))
+    end
+
+    # Write the PKGBUILD to disk.
+    #
+    # @param path [String] The directory to write the PKGBUILD.
+    # @return [Fixnum] the number of bytes written
+    def write(path = '')
+      File.write(File.join(File.expand_path(path), 'PKGBUILD'), render)
+    end
+
+    # Obfuscate the maintainer/contributors' email addresses to (help to)
+    # prevent spam.
+    #
+    # @param contact_information [String] The maintainer or contributor
+    #   byline.
+    # @return [String] the information with the @s and .s exchanged
+    def format_contact_information(contact_information)
+      contact_information.gsub('@', ' at ').gsub('.', ' dot ')
+    end
+
+    # Set the correct maintainer for the PKGBUILD.
+    #
+    # If the current maintainer is nil (no old pkgbuild was passed), then do
+    # nothing. If there is a maintainer then compare it to the configured
+    # maintainer and if they are different then make the old maintainer a
+    # contributor before setting the correct maintainer. If the maintainer is
+    # nil then just set the confgured maintainer.
+    #
+    # @return [String] the pkgbuild maintainer
+    def fetch_maintainer
+      configured_maintainer = Gembuild.configure
+      m = "#{configured_maintainer[:name]} <#{configured_maintainer[:email]}>"
+      new_maintainer = format_contact_information(m)
+
+      unless maintainer.nil? || new_maintainer == maintainer
+        @contributor.unshift(maintainer)
+      end
+
+      @maintainer = new_maintainer
+    end
+
+    # Add the data scraped from rubygems.org to the pkgbuild.
+    #
+    # @param details [Hash] The results from GemScraper scrape.
+    # @return [void]
+    def assign_gem_details(details)
+      @pkgver = details.fetch(:version)
+      @description = details.fetch(:description)
+      @checksum = details.fetch(:checksum)
+      @license = details.fetch(:license)
+      @url = details.fetch(:homepage)
+
+      details.fetch(:dependencies).each do |dependency|
+        @depends << "ruby-#{dependency}"
+      end
+    end
+
+    # Assign version information based on the information gathered from the
+    # AUR.
+    #
+    # @param details [Hash, nil] The results from AurScraper scrape or nil if
+    #   the package does not yet exist on the AUR.
+    # @return [void]
+    def assign_aur_details(details)
+      if details.nil?
+        @epoch = 0
+        @pkgrel = 1
+      else
+        perform_version_reconciliation(details)
+      end
+    end
+
+    private
+
+    # Set the static variables of a new pkgbuild.
+    #
+    # @return [nil]
+    def set_package_defaults
+      @checksum_type = 'sha256'
+      @arch = ['any']
+      @makedepends = ['rubygems']
+      @depends = ['ruby']
+      @source = ['https://rubygems.org/downloads/$_gemname-$pkgver.gem']
+      @noextract = ['$_gemname-$pkgver.gem']
+      @options = ['!emptydirs']
+      @contributor = []
+
+      nil
+    end
+
+    # Scrape dependencies from an existing pkgbuild.
+    #
+    # @param pkgbuild [String] The PKGBUILD to search.
+    # @return [Array] all existing dependencies that are not ruby or gems
+    def parse_existing_dependencies(pkgbuild)
+      match = pkgbuild.match(/^depends=\((.*?)\)$/m)[1]
+
+      # First step is to remove the leading and trailing quotes. Then convert
+      # all whitespace (newlines, tabs, multiple spaces, etc.) to single
+      # spaces. Then, make sure that strings are quoted with ' not ".
+      # Finally, split the packages into an array.
+      deps = match[1..-2].gsub(/[[:space:]]+/, ' ').tr('"', "'").split("' '")
+
+      deps.reject { |e| e.match(/^ruby/) }
+    rescue
+      []
+    end
+
+    # Assign the correct pkgrel and epoch depending on the current pkgver on
+    # the AUR and the version of the gem from rubygems.org.
+    #
+    # @param details [Hash] The results from AurScraper scrape
+    # @return [void]
+    def perform_version_reconciliation(details)
+      @epoch = details.fetch(:epoch)
+      @pkgrel = 1
+
+      if pkgver < details.fetch(:pkgver)
+        @epoch += 1
+      elsif @pkgver == details.fetch(:pkgver)
+        @pkgrel = details.fetch(:pkgrel) + 1
+      end
+    end
+  end
+end