reapack-index 1.0 → 1.1beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 964b4eb388703e4a06e0ca2ccf5a6844f4042b63
-  data.tar.gz: b6d72c01fc0fb7429df1d9aa48934edb6e84ede6
+  metadata.gz: 74ff4d70819b98251948bbe5a7e7767e7b9e3b0c
+  data.tar.gz: 1887659545c7d20019c17e740a1aaa48f078ae6f
 SHA512:
-  metadata.gz: ef2e717131435f7062eccaad5a9957f5326f11b24b81cf838aabd45d685335dd2705ffa5bc022c20e3c77e6a587630c35ad45af4dbe812f055cefec170a0769b
-  data.tar.gz: a92eb953f094cfb2dc1c1d4fde180576d9cd7213eace67bd376a153073aa635c25de15d51539c57136b9fa6faf4831580a6c401fa4e6b235bd023b55021b0dba
+  metadata.gz: 1f47b75ad09e4f08962a52b6ea2ac13e94778086fd7107d9fe550d48516e19553417ddbf281796143c83d64a78c5afa198375abba74419fd30ecf749b638c341
+  data.tar.gz: 11f2b3596583affdc178428867a03a8bf094ae2701c84f2db4cca1d96d6bad479dda5adc6a368df7d1e31b8841efced68cfa16fa420524616951e89bcdea5e82

data/README.md

@@ -34,11 +34,13 @@ Modes:
 Indexer options:
     -a, --[no-]amend                 Reindex existing versions
     -i, --ignore PATH                Don't check or index any file starting with PATH
-    -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
+        --[no-]strict                Enable strict validation mode
+    -U, --url-template TEMPLATE=auto Set the template for implicit download links
 Repository metadata:
     -n, --name NAME                  Set the name shown in ReaPack for this repository
     -l, --link LINK                  Add or remove a website link
+        --screenshot-link LINK       Add or remove a screenshot link
         --donation-link LINK         Add or remove a donation link
         --ls-links                   Display the link list then exit
     -A, --about=FILE                 Set the about content from a file

data/lib/reapack/index.rb

@@ -36,12 +36,13 @@ class ReaPack::Index
     extension: %w{ext},
     effect: %w{jsfx},
     data: %w{data},
+    theme: %w{theme},
   }.freeze
 
   FS_ROOT = File.expand_path('/').freeze
 
   attr_reader :path, :url_template, :cdetector
-  attr_accessor :amend, :commit, :files, :time
+  attr_accessor :amend, :commit, :files, :time, :strict
 
   class << self
     def is_type?(input)
@@ -107,6 +108,7 @@ class ReaPack::Index
     return unless type
 
     mh = MetaHeader.parse contents
+    mh.strict = @strict
 
     if mh[:noindex]
       remove path
@@ -171,12 +173,7 @@ class ReaPack::Index
       return
     end
 
-    separator = input.index('=')
-    if separator&.< input.index('://')
-      input = [input[0...separator], input[separator+1..-1]]
-    end
-
-    link = @metadata.push_link type, *input
+    link = @metadata.push_link type, *Link.split(input)
 
     if link.is_new?
       log_change "new #{type} link"
@@ -185,15 +182,15 @@ class ReaPack::Index
     end
   end
 
-  def description
-    @metadata.description
+  def about
+    @metadata.about
   end
 
-  def description=(content)
-    old = @metadata.description
-    @metadata.description = content
+  def about=(content)
+    old = @metadata.about
+    @metadata.about = content
 
-    log_change 'modified metadata' if old != @metadata.description
+    log_change 'modified metadata' if old != @metadata.about
   end
 
   def url_template=(tpl)

data/lib/reapack/index/cli.rb

@@ -17,6 +17,7 @@ class ReaPack::Index::CLI
 
     @index = ReaPack::Index.new expand_path(@opts[:output])
     @index.amend = @opts[:amend]
+    @index.strict = @opts[:strict]
     set_url_template
   rescue Rugged::OSError, Rugged::RepositoryError, ReaPack::Index::Error => e
     $stderr.puts e.message
@@ -36,7 +37,7 @@ class ReaPack::Index::CLI
     end
 
     if @opts[:dump_about]
-      print @index.description
+      print @index.about
       return true
     end
 
@@ -145,6 +146,8 @@ private
           '--link'
         when :donation
           '--donation-link'
+        when :screenshot
+          '--screenshot-link'
         end
 
         warn "#{opt}: " + e.message
@@ -181,14 +184,14 @@ private
     path = @opts[:about]
 
     unless path
-      @index.description = String.new if @opts[:rmabout]
+      @index.about = String.new if @opts[:rmabout]
       return
     end
 
     log "converting #{path} into RTF..."
 
     # look for the file in the working directory, not on the repository root
-    @index.description = File.read(path)
+    @index.about = File.read(path)
   rescue Errno::ENOENT => e
     warn '--about: ' + e.message.sub(' @ rb_sysopen', '')
   rescue ReaPack::Index::Error => e

data/lib/reapack/index/cli/options.rb

@@ -8,16 +8,17 @@ class ReaPack::Index::CLI
 
   DEFAULTS = {
     check: false,
-    scan: [],
-    rebuild: false,
-    verbose: false,
-    warnings: true,
-    progress: true,
-    quiet: false,
     commit: nil,
-    output: './index.xml',
     ignore: [],
+    output: './index.xml',
+    progress: true,
+    quiet: false,
+    rebuild: false,
+    scan: [],
+    strict: false,
     url_template: 'auto',
+    verbose: false,
+    warnings: true,
   }.freeze
 
   def read_config
@@ -80,16 +81,20 @@ class ReaPack::Index::CLI
         opts[:ignore] << expand_path(path)
       end
 
-      op.on '-U', "--url-template TEMPLATE=#{DEFAULTS[:url_template]}",
-          'Set the template for implicit download links' do |tpl|
-        opts[:url_template] = tpl.strip
-      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 '--[no-]strict', 'Enable strict validation mode' do |bool|
+        opts[:strict] = bool
+      end
+
+      op.on '-U', "--url-template TEMPLATE=#{DEFAULTS[:url_template]}",
+          'Set the template for implicit download links' do |tpl|
+        opts[:url_template] = tpl.strip
+      end
+
       op.separator 'Repository metadata:'
 
       op.on '-n', '--name NAME', 'Set the name shown in ReaPack for this repository' do |name|
@@ -101,6 +106,11 @@ class ReaPack::Index::CLI
         opts[:links] << [:website, link.strip]
       end
 
+      op.on '--screenshot-link LINK', 'Add or remove a screenshot link' do |link|
+        opts[:links] ||= Array.new
+        opts[:links] << [:screenshot, link.strip]
+      end
+
       op.on '--donation-link LINK', 'Add or remove a donation link' do |link|
         opts[:links] ||= Array.new
         opts[:links] << [:donation, link.strip]

data/lib/reapack/index/gem_version.rb

@@ -1,5 +1,5 @@
 module ReaPack
   class Index
-    VERSION = '1.0'
+    VERSION = '1.1beta1'
   end
 end

data/lib/reapack/index/git.rb

@@ -1,7 +1,7 @@
 class ReaPack::Index
   class Git
     def initialize(path)
-      @repo = Rugged::Repository.discover path
+      @repo = Rugged::Repository.discover path.encode(Encoding::UTF_8)
     end
 
     def empty?

data/lib/reapack/index/metadata.rb

@@ -9,6 +9,10 @@ class ReaPack::Index
       @root = parent.element_children.find {|node| node.name == TAG }
     end
 
+    def modified?
+      !!@dirty
+    end
+
     def links(type)
       Link.find_all(type, @root).map {|node| Link.from_node node }
         .select {|link| link.url.index('http') == 0 }
@@ -54,6 +58,8 @@ class ReaPack::Index
         node.content = url
       end
 
+      @dirty = true if link.modified?
+
       link
     end
 
@@ -64,9 +70,23 @@ class ReaPack::Index
 
       node.remove
       auto_remove
+
+      @dirty = true
+    end
+
+    def replace_links(type)
+      was_dirty = @dirty
+
+      old_links = hash_links Link.find_all(type, @root)
+        .each {|node| node.remove }
+
+      yield
+
+      new_links = hash_links Link.find_all(type, @root)
+      @dirty = old_links != new_links unless was_dirty
     end
 
-    def description
+    def about
       cdata = nil
 
       if @root
@@ -77,18 +97,24 @@ class ReaPack::Index
       cdata ? cdata.content : String.new
     end
 
-    def description=(content)
-      return if content == description
+    def about=(content)
+      content = content.to_s
+
+      if !content.empty? && !content.start_with?("{\\rtf")
+        content = make_rtf content
+      end
+
+      return if content == self.about
 
       make_root
       desc = @root.element_children.find {|node| node.name == DESC }
 
+      @dirty = true
+
       if content.empty?
         desc.remove
         auto_remove
         return
-      elsif content.index("{\\rtf") != 0
-        content = make_rtf content
       end
 
       if desc
@@ -125,6 +151,10 @@ class ReaPack::Index
         "Try again after installing pandoc from <http://pandoc.org/>."
       ].join("\n")
     end
+
+    def hash_links(nodes)
+      nodes.map {|node| [node[Link::REL], node[Link::URL]] }
+    end
   end
 
   class Link
@@ -133,7 +163,17 @@ class ReaPack::Index
     URL = 'href'.freeze
 
     # the first type will be the default one
-    VALID_TYPES = [:website, :donation].freeze
+    VALID_TYPES = [:website, :screenshot, :donation].freeze
+
+    LINK_REGEX = /\A(.+?)(?:\s|=)(\w+?:\/\/.+)\Z/.freeze
+
+    def self.split(input)
+      if input =~ LINK_REGEX
+        [$1, $2]
+      else
+        [input]
+      end
+    end
 
     def self.from_node(node)
       name, url = node.text.to_s, node[URL].to_s

data/lib/reapack/index/package.rb

@@ -7,14 +7,17 @@ class ReaPack::Index
     @tag = 'reapack'.freeze
 
     TYPE_ATTR = 'type'.freeze
+    DESC_ATTR = 'desc'.freeze
 
     def initialize(node)
       super
-      read_versions
+      @metadata = Metadata.new node
     end
 
+    attr_reader :metadata
+
     def modified?
-      super || @versions.values.any? {|ver| ver.modified? }
+      super || versions.any? {|ver| ver.modified? } || @metadata.modified?
     end
 
     def category
@@ -38,11 +41,31 @@ class ReaPack::Index
       @dirty = true
     end
 
+    def description
+      @node[DESC_ATTR].to_s
+    end
+
+    def description=(new_desc)
+      new_desc ||= String.new
+
+      return if description == new_desc
+
+      if new_desc.empty?
+        @node.remove_attribute DESC_ATTR
+      else
+        @node[DESC_ATTR] = new_desc
+      end
+
+      @dirty = true
+    end
+
     def has_version?(name)
+      read_versions
       @versions.has_key? name
     end
 
     def versions
+      read_versions
       @versions.values
     end
 
@@ -62,11 +85,13 @@ class ReaPack::Index
 
   private
     def read_versions
-      @versions ||= {}
+      @versions || begin
+        @versions = {}
 
-      Version.find_all(@node).each {|ver|
-        @versions[ver.name] = ver
-      }
+        Version.find_all(@node).each {|ver|
+          @versions[ver.name] = ver
+        }
+      end
     end
   end
 end

data/lib/reapack/index/scanner.rb

@@ -8,34 +8,58 @@ class ReaPack::Index
       end
     }
 
+    VERSION_SEGMENT_MAX = (2 ** 16) - 1
+
+    SIMPLE_TAG = [MetaHeader::VALUE, MetaHeader::SINGLELINE].freeze
+
     HEADER_RULES = {
       # package-wide tags
-      :version => [
-        MetaHeader::REQUIRED, MetaHeader::VALUE, MetaHeader::SINGLELINE, /\A\d/],
+      version: [
+        MetaHeader::REQUIRED, MetaHeader::VALUE, MetaHeader::SINGLELINE, /\A\d/,
+        proc {|v|
+          s = v.scan(/\d+/).find {|s| s.to_i > VERSION_SEGMENT_MAX }
+          'segment overflow (%d > %d)' % [s, VERSION_SEGMENT_MAX] if s
+        }
+      ],
+      description: SIMPLE_TAG,
+      about: MetaHeader::VALUE,
+      website: MetaHeader::VALUE,
+      screenshot: MetaHeader::VALUE,
+      donation: MetaHeader::VALUE,
 
       # version-specific tags
-      :author => [MetaHeader::VALUE, MetaHeader::SINGLELINE],
-      :changelog => [MetaHeader::VALUE],
-      :provides => [MetaHeader::VALUE, PROVIDES_VALIDATOR],
-      :noindex => [MetaHeader::BOOLEAN],
-      :metapackage => [MetaHeader::BOOLEAN],
+      author: SIMPLE_TAG,
+      changelog: MetaHeader::VALUE,
+      provides: [MetaHeader::VALUE, PROVIDES_VALIDATOR],
+      noindex: MetaHeader::BOOLEAN,
+      metapackage: MetaHeader::BOOLEAN,
+    }.freeze
+
+    HEADER_ALIASES = {
+      [:reascript_name, :desc] => :description,
     }.freeze
 
-    META_TYPES = [:extension, :data].freeze
+    META_TYPES = [:extension, :data, :theme].freeze
 
     def initialize(cat, pkg, mh, index)
       @cat, @pkg, @mh, @index = cat, pkg, mh, index
-
-      @mh[:metapackage] = META_TYPES.include?(pkg.type) if mh[:metapackage].nil?
-
       @cselector = @index.cdetector[pkg.path]
     end
 
     def run
+      @mh.alias HEADER_ALIASES
+
       if errors = @mh.validate(HEADER_RULES)
         raise Error, errors.join("\n")
       end
 
+      @pkg.description = @mh[:description]
+      @pkg.metadata.about = @mh[:about]
+
+      eval_links :website
+      eval_links :screenshot
+      eval_links :donation
+
       @pkg.version @mh[:version] do |ver|
         next unless ver.is_new? || @index.amend
 
@@ -49,7 +73,7 @@ class ReaPack::Index
           @cselector.clear
           sources = parse_provides @mh[:provides]
 
-          if !@mh[:metapackage] && sources.none? {|src| src.file.nil? }
+          if !metapackage? && sources.none? {|src| src.file.nil? }
             # add the package itself as a main source
             src = Source.new make_url(@pkg.path), true
             sources.unshift src
@@ -114,7 +138,7 @@ class ReaPack::Index
             line.url_template ? expanded : file
 
           if file == @pkg.path
-            src.main = !@mh[:metapackage] if line.main.nil?
+            src.main = !metapackage? if line.main.nil?
           else
             if line.url_template
               src.file = file
@@ -127,5 +151,22 @@ class ReaPack::Index
         }
       }.flatten
     end
+
+    def eval_links(type)
+      @pkg.metadata.replace_links type do
+        @mh[type].to_s.lines {|l|
+          l.chomp!
+          @pkg.metadata.push_link type, *Link.split(l)
+        }
+      end
+    end
+
+    def metapackage?
+      @metapackage ||= if @mh[:metapackage].nil?
+        META_TYPES.include? @pkg.type
+      else
+        @mh[:metapackage]
+      end
+    end
   end
 end