gembuild 1.0.0

data/README.md

@@ -0,0 +1,80 @@
+# Gembuild
+
+[![Build Status](https://travis-ci.org/mfinelli/gembuild.svg?branch=master)](https://travis-ci.org/mfinelli/gembuild)
+[![Coverage Status](https://coveralls.io/repos/mfinelli/gembuild/badge.svg?branch=master&service=github)](https://coveralls.io/github/mfinelli/gembuild?branch=master)
+[![Code Climate](https://codeclimate.com/github/mfinelli/gembuild/badges/gpa.svg)](https://codeclimate.com/github/mfinelli/gembuild)
+[![Inline Documentation](https://inch-ci.org/github/mfinelli/gembuild.svg)](https://inch-ci.org/github/mfinelli/gembuild)
+
+Create PKGBUILDs for ruby gems.
+
+## Configuration
+
+Upon first run the gem will prompt for your name and email address to use in
+the maintainer field in PKGBUILDs and to use as the git author. If you have
+already configured git it will confirm the values that it finds. It will also
+ask where to store package repositories. All information is then saved in
+`~/.gembuild` which is just a simple YAML file and can be easily changed
+using your favorite text editor.
+
+## Usage
+
+Simple usage to create/update a package for a gem:
+
+```shell
+$ bundle exec bin/gembuild mina
+```
+
+This will checkout the AUR package for `ruby-mina`, fetch the latest version
+of the gem and update the PKGBUILD accordingly, and then regenerate the
+metadata using `mksrcinfo` and commit all changes.
+
+### Advanced Usage
+
+There are four main parts: the AUR scraper, the rubygems scraper, the
+PKGBUILD and the project.
+
+#### AUR Scraper
+
+The AUR scraper is used to get version information about a package currently
+on the AUR.
+
+```ruby
+s = Gembuild::AurScraper.new('ruby-mina')
+s.scrape!
+```
+
+#### RubyGems Scraper
+
+The RubyGems scraper gets the rest of the information needed for the PKGBUILD
+by making several queries to rubygems.org. **N.B. that it skips any version
+marked as a "prerelease".**
+
+```ruby
+s = Gembuild::GemScraper.neW('mina')
+s.scrape!
+```
+
+#### PKGBUILD
+
+The `Pkgbuild` class is actually responsible for creating a PKGBUILD for a
+gem.
+
+```ruby
+Gembuild::Pkgbuild.create('mina')
+```
+
+#### Project
+
+The `Project` class is what checks out the repository from the AUR,
+configures git for it, makes sure there is a `.gitignore` and commits all
+changes after creating or updating the PKGBUILD.
+
+```ruby
+Gembuild::Project.new('mina').clone_and_commit!
+```
+
+## License
+
+This project is licensed under the GPLv3 or any later version. For more
+information please see the LICENSE file included with the project or
+[https://www.gnu.org/licenses](https://www.gnu.org/licenses/gpl.html).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rspec'
+end
+YARD::Rake::YardocTask.new(:yard)
+
+# Checking the spec files on travis causes an error and the build to fail.
+# task default: [:rubocop, :spec]
+task default: :spec

data/bin/gembuild

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems' unless Object.const_defined?(:Gem)
+require 'bundler'
+Bundler.require
+
+require 'gembuild'
+
+Gembuild::Project.new(ARGV[0]).clone_and_commit!

data/gembuild.gemspec

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gembuild/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gembuild'
+  spec.version       = Gembuild::VERSION
+  spec.authors       = ['Mario Finelli']
+  spec.email         = ['mario@finel.li']
+
+  spec.summary       = 'Generate PKGBUILDs for ruby gems.'
+  spec.description   = 'Generate PKGBUILDs for ruby gems.'
+  spec.homepage      = 'https://github.com/mfinelli/gembuild'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.licenses      = ['GPL-3.0+']
+
+  spec.add_dependency 'mechanize'
+  spec.add_dependency 'nokogiri'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'mutant-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubycritic'
+  spec.add_development_dependency 'ruby-lint'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
+end

data/lib/gembuild.rb

@@ -0,0 +1,142 @@
+# 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 'English'
+
+require 'gembuild/aur_scraper'
+require 'gembuild/exceptions'
+require 'gembuild/gem_scraper'
+require 'gembuild/pkgbuild'
+require 'gembuild/project'
+require 'gembuild/version'
+
+# Create Arch Linux PKGBUILDs for ruby gems.
+module Gembuild
+  class << self
+    # The path to the gembuild configuration file.
+    #
+    # @return [String] real path to the configuration file
+    def conf_file
+      File.expand_path(File.join('~', '.gembuild'))
+    end
+
+    # Read from the configuration file if it exists, otherwise prompt for the
+    # configuration and save it to file.
+    #
+    # @return [Hash] the configuration options: maintainer name and email
+    #   address and where to checkout packages
+    def configure
+      unless File.file?(conf_file)
+        name = fetch_git_global_name
+        email = fetch_git_global_email
+        pkgdir = fetch_pkgdir
+
+        File.write(
+          conf_file,
+          { name: name, email: email, pkgdir: pkgdir }.to_yaml
+        )
+      end
+
+      YAML.load_file(conf_file)
+    end
+
+    # Attempt to read the global git name, prompting the user for the name if
+    # unsuccessful.
+    #
+    # @return [String] the name to use as package maintainer
+    def fetch_git_global_name
+      name = `git config --global user.name`.strip
+
+      if $CHILD_STATUS.success?
+        if prompt_for_confirmation(name)
+          return name
+        else
+          prompt_for_git_name
+        end
+      else
+        prompt_for_git_name('Could not detect name from git configuration.')
+      end
+    end
+
+    # Attempt to read the global git email, prompting the user for the email
+    # if unsuccessful.
+    #
+    # @return [String] the email to use as package maintainer
+    def fetch_git_global_email
+      email = `git config --global user.email`.strip
+
+      if $CHILD_STATUS.success?
+        if prompt_for_confirmation(email)
+          return email
+        else
+          prompt_for_git_email
+        end
+      else
+        prompt_for_git_email('Could not detect email from git configuration.')
+      end
+    end
+
+    # Prompt the user for the name to use.
+    #
+    # This method is only called if reading the global git configuration was
+    # unsuccessful or the user specified that it was incorrect.
+    #
+    # @param msg [String, nil] An optional message to display before
+    #   prompting.
+    # @return [String] the name to use as package maintainer
+    def prompt_for_git_name(msg = nil)
+      puts msg unless msg.nil? || msg.empty?
+      puts 'Please enter desired name: '
+      gets.chomp
+    end
+
+    # Prompt the user for the email to use.
+    #
+    # This method is only called if reading the global git configuration was
+    # unsuccessful or the user specified that it was incorrect.
+    #
+    # @param msg [String, nil] An optional message to display before
+    #   prompting.
+    # @return [String] the email address to use as package maintainer
+    def prompt_for_git_email(msg = nil)
+      puts msg unless msg.nil? || msg.empty?
+      puts 'Please enter desired email: '
+      gets.chomp
+    end
+
+    # Ask the user to confirm the detected value.
+    #
+    # @param detected [String] The value that was detected.
+    # @return [Boolean] whether or not the value is correct
+    def prompt_for_confirmation(detected)
+      puts "Detected \"#{detected}\", is this correct? (y/n)"
+      response = gets.chomp.downcase[0, 1]
+
+      response == 'y'
+    end
+
+    # Prompt the user for the location where they would like to store
+    # checked-out packages.
+    #
+    # @return [String] the filepath where to store package repositories
+    def fetch_pkgdir
+      puts 'Where should projects be checked out?'
+      File.expand_path(gets.chomp)
+    end
+  end
+end

data/lib/gembuild/aur_scraper.rb

@@ -0,0 +1,159 @@
+# 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'
+
+module Gembuild
+  # This class is used to query the AUR for information about a package.
+  #
+  # @!attribute [r] agent
+  #   @return [Mechanize] the Mechanize agent
+  # @!attribute [r] pkgname
+  #   @return [String] the package about which to query the AUR
+  # @!attribute [r] url
+  #   @return [String] the AUR url for the package
+  class AurScraper
+    attr_reader :agent, :pkgname, :url
+
+    # Creates a new AurScraper instance.
+    #
+    # @raise [Gembuild::UndefinedPkgnameError] if the pkgname is nil or empty
+    #
+    # @example Create new AurScraper object
+    #   Gembuild::AurScraper.new('ruby-mina')
+    #   # => #<Gembuild::AurScraper:0x000000040659b0
+    #   #  @agent=
+    #   #   #<Mechanize
+    #   #    #<Mechanize::CookieJar:0x000000040658c0
+    #   #     @store=
+    #   #      #<HTTP::CookieJar::HashStore:0x000000040813b8
+    #   #       @gc_index=0,
+    #   #       @gc_threshold=150,
+    #   #       @jar={},
+    #   #       @logger=nil,
+    #   #       @mon_count=0,
+    #   #       @mon_mutex=#<Mutex:0x00000004081368>,
+    #   #       @mon_owner=nil>>
+    #   #    nil>,
+    #   #  @pkgname="ruby-mina",
+    #   #  @url="https://aur.archlinux.org/rpc.php?type=info&arg=ruby-mina">
+    #
+    # @param pkgname [String] The name of the package about which to query.
+    # @return [Gembuild::AurScraper] a new AurScraper instance
+    def initialize(pkgname)
+      fail Gembuild::UndefinedPkgnameError if pkgname.nil? || pkgname.empty?
+
+      @agent = Mechanize.new
+      @pkgname = pkgname
+
+      @url = "https://aur.archlinux.org/rpc.php?type=info&arg=#{pkgname}"
+    end
+
+    # Query the AUR for information about a package and then parse the JSON
+    # results.
+    #
+    # @example Query the AUR about a package
+    #   s = Gembuild::AurScraper.new('ruby-mina')
+    #   r = s.query_aur
+    #   #=> {:version=>1,
+    #   # :type=>"info",
+    #   # :resultcount=>1,
+    #   # :results=>
+    #   #  {:ID=>238062,
+    #   #   :Name=>"ruby-mina",
+    #   #   :PackageBaseID=>101492,
+    #   #   :PackageBase=>"ruby-mina",
+    #   #   :Version=>"0.3.7-1",
+    #   #   :Description=>"Really fast deployer and server automation tool.",
+    #   #   :URL=>"http://github.com/nadarei/mina",
+    #   #   :NumVotes=>0,
+    #   #   :OutOfDate=>nil,
+    #   #   :Maintainer=>"supermario",
+    #   #   :FirstSubmitted=>1444354070,
+    #   #   :LastModified=>1444354135,
+    #   #   :License=>"MIT",
+    #   #   :URLPath=>"/cgit/aur.git/snapshot/ruby-mina.tar.gz",
+    #   #   :CategoryID=>1}}
+    #
+    # @return [Hash] the information about the package
+    def query_aur
+      JSON.parse(agent.get(url).body, symbolize_names: true)
+    end
+
+    # Determine whether the package already exists on the AUR by the number of
+    # results returned.
+    #
+    # @example Check if package exists on the AUR
+    #   s = Gembuild::AurScraper.new('ruby-mina')
+    #   r = s.query_aur
+    #   s.package_exists?(r) #=> true
+    #
+    # @param response [Hash] The JSON parsed response from the AUR.
+    # @return [Boolean] whether or not the package exists already on the AUR
+    def package_exists?(response)
+      response[:results].count.zero? ? false : true
+    end
+
+    # Parse the version from the AUR response.
+    #
+    # A version string is expected to either look like 0.1.2-3 or like
+    # 1:2.3.4-5. So the strategy is to first split on the dash to get the
+    # package release number. Then with the remaining string attempt a split
+    # on the colon. If there is only one part then it means that there is no
+    # epoch (or rather that the epoch is zero). If there are two parts then we
+    # use the first as the epoch value. Finally, whatever is left is the
+    # actual version of the gem.
+    #
+    # @example Get package version from the AUR
+    #   s = Gembuild::AurScraper.new('ruby-mina')
+    #   r = s.query_aur
+    #   s.get_version_hash(r)
+    #   #=> {:epoch=>0, :pkgver=>Gem::Version.new("0.3.7"), :pkgrel=>1}
+    #
+    # @param response [Hash] The JSON parsed response from the AUR.
+    # @return [Hash] a hash of the different version parts
+    def get_version_hash(response)
+      version = response[:results][:Version].split('-')
+
+      pkgrel = version.pop.to_i
+      version = version.join
+
+      version = version.split(':')
+      epoch = version.count == 1 ? 0 : version.shift.to_i
+      version = Gem::Version.new(version.join)
+
+      { epoch: epoch, pkgver: version, pkgrel: pkgrel }
+    end
+
+    # Query the AUR and returned the parsed results.
+    #
+    # @example Query the AUR for information about a package
+    #   s = Gembuild::AurScraper.new('ruby-mina')
+    #   s.scrape!
+    #   #=> {:epoch=>0, :pkgver=>Gem::Version.new("0.3.7"), :pkgrel=>1}
+    #
+    # @return [nil, Hash] the version hash or nil if the package doesn't exist
+    def scrape!
+      response = query_aur
+
+      return nil unless package_exists?(response)
+
+      get_version_hash(response)
+    end
+  end
+end