reapack-index 1.0beta2 → 1.0beta3

data/README.md

@@ -21,13 +21,16 @@ gem install reapack-index
 ### Usage
 
 ```
-reascript-indexer [options] [path-to-your-reascript-repository]
+reapack-index [options] [path-to-your-repository]
 ```
 
 ```
 Options:
     -a, --[no-]amend                 Reindex existing versions
     -c, --check                      Test every package including uncommited changes and exit
+    -i, --ignore PATH                Don't check or index any file starting with PATH
+    -n, --name NAME                  Set the name shown in ReaPack for this repository
+    -U, --url-template TEMPLATE=auto Set the template for implicit download links
     -o, --output FILE=./index.xml    Set the output filename and path for the index
     -l, --link LINK                  Add or remove a website link
         --donation-link LINK         Add or remove a donation link
@@ -64,12 +67,13 @@ This indexer uses metadata found at the start of the files to generate the
 database in ReaPack format.
 See also [MetaHeader](https://github.com/cfillion/metaheader)'s documentation.
 
-Tag not explicitly marked as required are optional.
+All tags are optional unless explicitely marked as required.
 
 ### Package type by extension:
 
-- `.lua`, `.eel`, `.py`: ReaScripts – the package file itself will be used as a source.
-- `.ext`: For REAPER native extensions
+- `.lua`, `.eel`, `.py`: ReaScripts
+- `.jsfx`: JS effects
+- `.ext`: Native extensions (all included files must be explicitely defined)
 
 ### Package Tags
 

data/Rakefile

@@ -4,4 +4,5 @@ require 'rake/testtask'
 task :default => [:test]
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/test_*.rb']
+  t.warning = false
 end

data/lib/reapack/index.rb

@@ -1,7 +1,9 @@
 require 'reapack/index/gem_version'
 
+require 'addressable'
 require 'colorize'
 require 'fileutils'
+require 'gitable'
 require 'io/console'
 require 'metaheader'
 require 'nokogiri'
@@ -11,9 +13,9 @@ require 'pathname'
 require 'rugged'
 require 'shellwords'
 require 'time'
-require 'uri'
 
 require 'reapack/index/cli'
+require 'reapack/index/cli/options'
 require 'reapack/index/metadata'
 require 'reapack/index/named_node'
 require 'reapack/index/package'
@@ -24,12 +26,24 @@ class ReaPack::Index
   Error = Class.new RuntimeError
 
   FILE_TYPES = {
-    'lua' => :script,
-    'eel' => :script,
-    'py'  => :script,
-    'ext' => :extension,
+    'lua'  => :script,
+    'eel'  => :script,
+    'py'   => :script,
+    'ext'  => :extension,
+    'jsfx' => :effect,
   }.freeze
 
+  WITH_MAIN = [:script, :effect].freeze
+
+  PROVIDES_REGEX = /
+    \A
+    ( \[ \s* (?<platform> .+? ) \s* \] )?
+    \s*
+    (?<file> .+?)
+    ( \s+ (?<url> (?:file|https?):\/\/.+ ) )?
+    \z
+  /x.freeze
+
   PROVIDES_VALIDATOR = proc {|value|
     begin
       files = value.lines.map {|l|
@@ -54,27 +68,9 @@ class ReaPack::Index
     :provides => [MetaHeader::OPTIONAL, PROVIDES_VALIDATOR]
   }.freeze
 
-  SOURCE_PATTERNS = {
-    /\Agit@github\.com:([^\/]+)\/(.+)\.git\z/ =>
-      'https://github.com/\1/\2/raw/$commit/$path',
-    /\Ahttps:\/\/github\.com\/([^\/]+)\/(.+)\.git\z/ =>
-      'https://github.com/\1/\2/raw/$commit/$path',
-  }.freeze
-
-  ROOT = File.expand_path('/').freeze
-
-  PROVIDES_REGEX = /
-    \A
-    ( \[ \s* (?<platform> .+? ) \s* \] )?
-    \s*
-    (?<file> .+?)
-    ( \s+ (?<url> (?:file|https?):\/\/.+ ) )?
-    \z
-  /x.freeze
-
-  WITH_MAIN = [:script].freeze
+  FS_ROOT = File.expand_path('/').freeze
 
-  attr_reader :path, :source_pattern
+  attr_reader :path, :url_template
   attr_accessor :amend, :files, :time
 
   def self.type_of(path)
@@ -82,14 +78,6 @@ class ReaPack::Index
     FILE_TYPES[ext]
   end
 
-  def self.source_for(url)
-    SOURCE_PATTERNS.each_pair {|regex, pattern|
-      return url.gsub regex, pattern if url =~ regex
-    }
-
-    nil
-  end
-
   def self.validate_file(path)
     mh = MetaHeader.from_file path
     return if mh[:noindex]
@@ -106,7 +94,7 @@ class ReaPack::Index
     if File.exist? path
       # noblanks: don't preserve the original white spaces
       # so we always output a neat document
-      @doc = Nokogiri::XML File.open(path), &:noblanks
+      @doc = File.open(path) {|file| Nokogiri::XML file, &:noblanks }
     else
       @dirty = true
       @is_new = true
@@ -146,6 +134,9 @@ class ReaPack::Index
     pkg.version mh[:version] do |ver|
       next unless ver.is_new? || @amend
 
+      # store the version name for make_url
+      @currentVersion = ver.name
+
       ver.author = mh[:author]
       ver.time = @time if @time
       ver.changelog = mh[:changelog]
@@ -155,16 +146,10 @@ class ReaPack::Index
 
         if WITH_MAIN.include?(type) && sources.none? {|src| src.file.nil? }
           # add the package itself as a source
-          sources.unshift Source.new nil, nil, url_for(path)
+          sources.unshift Source.new nil, nil, make_url(path)
         end
 
-        sources.each {|src|
-          # the $path variable is interpolated elsewhere
-          # (in url_for for generated urls and make_sources for explicit urls)
-          src.url.sub! '$commit', commit || 'master'
-          src.url.sub! '$version', ver.name
-          ver.add_source src
-        }
+        sources.each {|src| ver.add_source src }
       end
     end
 
@@ -229,20 +214,43 @@ class ReaPack::Index
     log_change 'modified metadata' if old != @metadata.description
   end
 
-  def source_pattern=(pattern)
-    if pattern.nil?
-      raise ArgumentError, 'Cannot use nil as a source pattern'
-    elsif not pattern.include? '$path'
-      raise ArgumentError, '$path not in source pattern'
+  def url_template=(tpl)
+    return @url_template = nil if tpl.nil?
+
+    uri = Addressable::URI.parse tpl
+    uri.normalize!
+
+    unless (uri.request_uri || uri.path).include? '$path'
+      raise Error, "$path placeholder is missing: #{tpl}"
     end
 
-    @source_pattern = pattern
+    unless %w{http https file}.include? uri.scheme
+      raise Addressable::URI::InvalidURIError
+    end
+
+    @url_template = uri.to_s.freeze
+  rescue Addressable::URI::InvalidURIError
+    raise Error, "invalid URL or scheme: #{tpl}"
   end
 
   def version
     @doc.root[:version].to_i
   end
 
+  def name
+    @doc.root[:name].to_s
+  end
+
+  def name=(newName)
+    if !/\A[^~#%&*{}\\:<>?\/+|"]+\Z/.match(newName) || /\A\.+\Z/.match(newName)
+      raise Error, "Invalid name: '#{newName}'"
+    end
+
+    oldName = name
+    @doc.root['name'] = newName
+    log_change 'modified metadata' if oldName != newName
+  end
+
   def commit
     @doc.root[:commit]
   end
@@ -256,6 +264,9 @@ class ReaPack::Index
   end
 
   def write(path)
+    @doc.root.element_children.each {|n| sort n if n.name == 'category' }
+    sort @doc.root
+
     FileUtils.mkdir_p File.dirname(path)
     File.write path, @doc.to_xml
   end
@@ -307,45 +318,47 @@ private
     [cat, pkg]
   end
 
-  def url_for(path)
-    unless @source_pattern
-      raise Error, "source pattern is unset " \
-        "and the package doesn't specify its source url"
-    end
+  def make_url(path, template = nil)
+    if template.nil?
+      raise Error, 'unable to generate a download link' \
+        ' – the url template is unset' unless @url_template
 
-    unless @files.include? path
-      raise Error, "#{path}: No such file or directory"
+      raise Error, "#{path}: No such file or directory" unless @files.include? path
     end
 
-    # other variables are interpolated in scan()
-    @source_pattern.sub('$path', path)
+    (template || @url_template)
+      .sub('$path', path)
+      .sub('$commit', commit || 'master')
+      .sub('$version', @currentVersion || '0.0')
   end
 
-  def parse_provides(provides, base)
-    this_file = File.basename base
-    basedir = dirname base
+  def parse_provides(provides, path)
+    basename = File.basename path
+    basedir = dirname path
 
     provides.to_s.lines.map {|line|
       line.chomp!
 
       m = line.match PROVIDES_REGEX
 
-      platform, file, url = m[:platform], m[:file], m[:url]
-      file = nil if file == this_file || file == '.'
+      platform, file, url_tpl = m[:platform], m[:file], m[:url]
+      file = nil if file == basename || file == '.'
 
-      if url.nil?
-        if file.nil?
-          url = url_for base
-        else
-          path = File.expand_path file, ROOT + basedir.to_s
-          url = url_for path[ROOT.size..-1]
-        end
+      if file.nil?
+        url = make_url path, url_tpl
+      elsif url_tpl.nil?
+        normalized = File.expand_path file, FS_ROOT + basedir.to_s
+        url = make_url normalized[FS_ROOT.size..-1]
       else
-        # for explicit urls which don't go through url_for
-        url.sub! '$path', file || base
+        url = make_url file, url_tpl
       end
 
       Source.new platform, file, url
     }
   end
+
+  def sort(node)
+    sorted = node.children.sort_by{|n| n[:name].to_s }.sort_by {|n| n.name }
+    sorted.each {|n| node << n }
+  end
 end

data/lib/reapack/index/cli.rb

@@ -1,20 +1,4 @@
 class ReaPack::Index::CLI
-  CONFIG_SEARCH = [
-    '~',
-    '.',
-  ].freeze
-
-  PROGRAM_NAME = 'reapack-index'.freeze
-
-  DEFAULTS = {
-    verbose: false,
-    warnings: true,
-    progress: true,
-    quiet: false,
-    commit: nil,
-    output: './index.xml',
-  }.freeze
-
   def initialize(argv = [])
     @opts = parse_options(argv)
     path = argv.last || Dir.pwd
@@ -35,7 +19,7 @@ class ReaPack::Index::CLI
   def run
     return @exit unless @exit.nil?
 
-    @db = ReaPack::Index.new File.expand_path(@opts[:output], @git.workdir)
+    @db = ReaPack::Index.new expand_path(@opts[:output])
     @db.amend = @opts[:amend]
 
     if @opts[:check]
@@ -52,13 +36,16 @@ class ReaPack::Index::CLI
       return true
     end
 
-    if remote = @git.remotes['origin']
-      @db.source_pattern = ReaPack::Index.source_for remote.url
+    begin
+      tpl = @opts[:url_template]
+      is_custom = tpl != DEFAULTS[:url_template]
+
+      @db.url_template = is_custom ? tpl : auto_url_tpl
+    rescue ReaPack::Index::Error => e
+      warn '--url-template: ' + e.message if is_custom
     end
 
-    set_about
-    eval_links
-    scan_commits
+    do_name; do_about; eval_links; scan_commits
 
     unless @db.modified?
       $stderr.puts 'Nothing to do!' unless @opts[:quiet]
@@ -76,17 +63,6 @@ class ReaPack::Index::CLI
   end
 
 private
-  def prompt(question, &block)
-    $stderr.print "#{question} [y/N] "
-    answer = $stdin.getch
-    $stderr.puts answer
-
-    yes = answer.downcase == 'y'
-    block[] if block_given? && yes
-
-    yes
-  end
-
   def scan_commits
     if @git.empty?
       warn 'The current branch does not contains any commit.'
@@ -147,6 +123,7 @@ private
       file = delta.new_file
     end
 
+    return if ignored? expand_path(file[:path])
     return unless ReaPack::Index.type_of file[:path]
 
     log "-> indexing #{status} file #{file[:path]}"
@@ -185,7 +162,14 @@ private
       begin
         @db.eval_link *link
       rescue ReaPack::Index::Error => e
-        warn e.message
+        opt = case link.first
+        when :website
+          '--link'
+        when :donation
+          '--donation-link'
+        end
+
+        warn "#{opt}: " + e.message
       end
     }
   end
@@ -200,7 +184,19 @@ private
     }
   end
 
-  def set_about
+  def do_name
+    @db.name = @opts[:name] if @opts[:name]
+
+    if @db.name.empty?
+      warn "The name of this index is unset. " \
+        "Run the following command with a name of your choice:" \
+        "\n  #{$0} --name 'FooBar Scripts'"
+    end
+  rescue ReaPack::Index::Error => e
+    warn '--name: ' + e.message
+  end
+
+  def do_about
     path = @opts[:about]
 
     unless path
@@ -224,9 +220,13 @@ private
 
     types = ReaPack::Index::FILE_TYPES.keys
     files = Dir.glob "#{Regexp.quote(root)}**/*.{#{types.join ','}}"
+    count = 0
 
     files.sort.each {|file|
+      next if ignored? file
+
       errors = ReaPack::Index.validate_file file
+      count += 1
 
       if errors
         $stderr.print 'F' unless @opts[:quiet]
@@ -251,7 +251,7 @@ private
       $stderr.puts "\n"
 
       $stderr.puts "Finished checks for %d package%s with %d failure%s" % [
-        files.size, files.size == 1 ? '' : 's',
+        count, count == 1 ? '' : 's',
         failures.size, failures.size == 1 ? '' : 's'
       ]
     end
@@ -267,20 +267,25 @@ private
       prompt 'Commit the new index?'
     end
 
-    target = @git.head.target
+    old_index = @git.index
+    target = @git.empty? ? nil : @git.head.target
+
+    if target
+      old_index.read_tree target.tree
+    else
+      old_index.clear
+    end
+
     root = Pathname.new @git.workdir
     file = Pathname.new @db.path
 
-    old_index = @git.index
-    old_index.read_tree target.tree
-
     index = @git.index
     index.add file.relative_path_from(root).to_s
 
     Rugged::Commit.create @git, \
       tree: index.write_tree(@git),
       message: "index: #{changelog}",
-      parents: [target],
+      parents: [target].compact,
       update_ref: 'HEAD'
 
     old_index.write
@@ -288,6 +293,17 @@ private
     $stderr.puts 'commit created'
   end
 
+  def prompt(question, &block)
+    $stderr.print "#{question} [y/N] "
+    answer = $stdin.getch
+    $stderr.puts answer
+
+    yes = answer.downcase == 'y'
+    block[] if block_given? && yes
+
+    yes
+  end
+
   def log(line)
     $stderr.puts line if @opts[:verbose]
   end
@@ -313,125 +329,30 @@ private
     @add_nl = true
   end
 
-  def parse_options(args)
-    opts = Hash.new
-
-    OptionParser.new do |op|
-      op.program_name = PROGRAM_NAME
-      op.version = ReaPack::Index::VERSION
-      op.banner = "Package indexer for ReaPack-based repositories\n" +
-        "Usage: #{PROGRAM_NAME} [options] [directory]"
-
-      op.separator 'Options:'
-
-      op.on '-a', '--[no-]amend', 'Reindex existing versions' do |bool|
-        opts[:amend] = bool
-      end
-
-      op.on '-c', '--check', 'Test every package including uncommited changes and exit' do
-        opts[:check] = true
-      end
-
-      op.on '-o', "--output FILE=#{DEFAULTS[:output]}",
-          'Set the output filename and path for the index' do |file|
-        opts[:output] = file.strip
-      end
-
-      op.on '-l', '--link LINK', 'Add or remove a website link' do |link|
-        opts[:links] ||= Array.new
-        opts[:links] << [:website, link.strip]
-      end
-
-      op.on '--donation-link LINK', 'Add or remove a donation link' do |link|
-        opts[:links] ||= Array.new
-        opts[:links] << [:donation, link]
-      end
-
-      op.on '--ls-links', 'Display the link list then exit' do |link|
-        opts[:lslinks] = true
-      end
-
-      op.on '-A', '--about=FILE', 'Set the about content from a file' do |file|
-        opts[:about] = file.strip
-      end
-
-      op.on '--remove-about', 'Remove the about content from the index' do
-        opts[:rmabout] = true
-      end
-
-      op.on '--dump-about', 'Dump the raw about content in RTF and exit' do
-        opts[:dump_about] = true
-      end
-
-      op.on '--[no-]progress', 'Enable or disable progress information' do |bool|
-        opts[:progress] = bool
-      end
-
-      op.on '-V', '--[no-]verbose', 'Activate diagnosis messages' do |bool|
-        opts[:verbose] = bool
-      end
-
-      op.on '-C', '--[no-]commit', 'Select whether to commit the modified index' do |bool|
-        opts[:commit] = bool
-      end
-
-      op.on '--prompt-commit', 'Ask at runtime whether to commit the index' do
-        opts[:commit] = nil
-      end
-
-      op.on '-W', '--warnings', 'Enable warnings' do
-        opts[:warnings] = true
-      end
-
-      op.on '-w', '--no-warnings', 'Turn off warnings' do
-        opts[:warnings] = false
-      end
-
-      op.on '-q', '--[no-]quiet', 'Disable almost all output' do
-        opts[:warnings] = false
-        opts[:progress] = false
-        opts[:verbose] = false
-        opts[:quiet] = true
-      end
-
-      op.on '--no-config', 'Bypass the configuration files' do
-        opts[:noconfig] = true
-      end
-
-      op.on_tail '-v', '--version', 'Display version information' do
-        puts op.ver
-        @exit = true
-      end
+  def ignored?(path)
+    @opts[:ignore].each {|pattern|
+      return true if path.start_with? pattern
+    }
 
-      op.on_tail '-h', '--help', 'Prints this help' do
-        puts op
-        @exit = true
-      end
-    end.parse! args
+    false
+  end
 
-    opts
-  rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
-    $stderr.puts "#{PROGRAM_NAME}: #{e.message}"
-    $stderr.puts "Try '#{PROGRAM_NAME} --help' for more information."
-    @exit = false
-    opts
+  def expand_path(path)
+    # expand from the repository root or from the current directory if
+    # the repository is not yet initialized
+    File.expand_path path, @git ? @git.workdir : Dir.pwd
   end
 
-  def read_config
-    CONFIG_SEARCH.map {|dir|
-      dir = File.expand_path dir, @git.workdir
-      path = File.expand_path '.reapack-index.conf', dir
+  def auto_url_tpl
+    remote = @git.remotes['origin']
+    return unless remote
 
-      log 'reading configuration from %s' % path
+    uri = Gitable::URI.parse remote.url
+    return unless uri.path =~ /\A\/?(?<user>[^\/]+)\/(?<repo>[^\/]+)\.git\Z/
 
-      unless File.readable? path
-        log 'configuration file is unreadable, skipping'
-        next
-      end
+    tpl = uri.to_web_uri
+    tpl.path += '/raw/$commit/$path'
 
-      opts = Array.new
-      File.foreach(path) {|line| opts << Shellwords.split(line) }
-      opts
-    }.flatten.compact
+    tpl.to_s
   end
 end