reapack-index 1.0beta4 → 1.0rc2

data/test/data/index.xml

@@ -1,11 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
-<index version="1" commit="f572d396fae9206628714fb2ce00f72e94f2258f">
+<index version="1" commit="f572d396fae9206628714fb2ce00f72e94f2258f" name="Test">
   <category name="Category Name">
     <reapack name="Hello World.lua" type="script">
       <version name="1.0" author="cfillion">
         <changelog><![CDATA[Fixed a division by zero error.]]></changelog>
-        <source platform="all">https://google.com/Category%20Name/Hello%20World.lua</source>
+        <source>https://google.com/Category%20Name/Hello%20World.lua</source>
       </version>
     </reapack>
   </category>
+  <description>
+    <link>https://github.com/cfillion/reapack-index</link>
+  </description>
 </index>

data/test/index/test_provides.rb

@@ -7,7 +7,7 @@ class TestIndex::Provides < MiniTest::Test
 
   def test_simple
     index = ReaPack::Index.new @dummy_path
-    index.url_template = 'http://host/$path'
+    index.url_template = 'http://host/$path?$package'
 
     index.files = [
       'Category/script.lua',
@@ -28,9 +28,9 @@ class TestIndex::Provides < MiniTest::Test
   <category name="Category">
     <reapack name="script.lua" type="script">
       <version name="1.0">
-        <source platform="all">http://host/Category/script.lua</source>
-        <source platform="windows" file="../Resources/unicode.dat">http://host/Resources/unicode.dat</source>
-        <source platform="all" file="test.png">http://host/Category/test.png</source>
+        <source main="true">http://host/Category/script.lua?Category/script.lua</source>
+        <source platform="windows" file="../Resources/unicode.dat">http://host/Resources/unicode.dat?Category/script.lua</source>
+        <source file="test.png">http://host/Category/test.png?Category/script.lua</source>
       </version>
     </reapack>
   </category>
@@ -75,8 +75,8 @@ class TestIndex::Provides < MiniTest::Test
   <category name="Category">
     <reapack name="script.lua" type="script">
       <version name="1.0">
-        <source platform="darwin">http://host/Category/script.lua</source>
-        <source platform="win64">http://host/Category/script.lua</source>
+        <source main="true" platform="darwin">http://host/Category/script.lua</source>
+        <source main="true" platform="win64">http://host/Category/script.lua</source>
       </version>
     </reapack>
   </category>
@@ -142,7 +142,7 @@ class TestIndex::Provides < MiniTest::Test
     index.scan index.files.first, <<-IN
       @version 1.0
       @provides
-        [windows] Data/*
+        [windows] Data/{a,b}.*
         test*
     IN
 
@@ -152,10 +152,10 @@ class TestIndex::Provides < MiniTest::Test
   <category name="Category">
     <reapack name="script.lua" type="script">
       <version name="1.0">
-        <source platform="all">http://host/Category/script.lua</source>
+        <source main="true">http://host/Category/script.lua</source>
         <source platform="windows" file="Data/a.dat">http://host/Category/Data/a.dat</source>
         <source platform="windows" file="Data/b.dat">http://host/Category/Data/b.dat</source>
-        <source platform="all" file="test.txt">http://host/Category/test.txt</source>
+        <source file="test.txt">http://host/Category/test.txt</source>
       </version>
     </reapack>
   </category>
@@ -262,7 +262,7 @@ class TestIndex::Provides < MiniTest::Test
   <category name="Other">
     <reapack name="test1.lua" type="script">
       <version name="1.0">
-        <source platform="all" file="background.png">http://irrelevant</source>
+        <source file="background.png">http://irrelevant</source>
       </version>
     </reapack>
   </category>
@@ -299,4 +299,58 @@ class TestIndex::Provides < MiniTest::Test
       @provides file
     IN
   end
+
+  def test_main
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = [
+      'Category/script.lua',
+      'Category/a.dat',
+      'Category/b.dat',
+    ]
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @provides
+        [main] a.dat
+        [nomain] .
+        [nomain] b.dat
+    IN
+
+    expected = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<index version="1">
+  <category name="Category">
+    <reapack name="script.lua" type="script">
+      <version name="1.0">
+        <source main="true" file="a.dat">http://host/Category/a.dat</source>
+        <source>http://host/Category/script.lua</source>
+        <source file="b.dat">http://host/Category/b.dat</source>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    index.write!
+    assert_equal expected, File.read(index.path)
+  end
+
+  def test_main_self
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = [
+      'Category/script.lua',
+      'Category/a.dat',
+      'Category/b.dat',
+    ]
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @provides .
+    IN
+
+    index.write!
+    assert_match 'main="true"', File.read(index.path)
+  end
 end

data/test/index/test_scan.rb

@@ -44,7 +44,7 @@ class TestIndex::Scan < MiniTest::Test
     <reapack name="Instrument Track.lua" type="script">
       <version name="1.0">
         <changelog><![CDATA[Hello World]]></changelog>
-        <source platform="all">http://host/Category/Path/Instrument%20Track.lua</source>
+        <source main="true">http://host/Category/Path/Instrument%20Track.lua</source>
       </version>
     </reapack>
   </category>
@@ -109,22 +109,11 @@ class TestIndex::Scan < MiniTest::Test
     assert index.modified?, 'index is not modified'
     assert_equal '1 modified package, 1 modified version', index.changelog
 
-    expected = <<-XML
-<?xml version="1.0" encoding="utf-8"?>
-<index version="1" commit="#{@commit}">
-  <category name="Category Name">
-    <reapack name="Hello World.lua" type="script">
-      <version name="1.0">
-        <changelog><![CDATA[New Changelog!]]></changelog>
-        <source platform="all">http://google.com/Category%20Name/Hello%20World.lua</source>
-      </version>
-    </reapack>
-  </category>
-</index>
-    XML
-
     index.write @dummy_path
-    assert_equal expected, File.read(@dummy_path)
+    contents = File.read @dummy_path
+
+    assert_match @commit, contents
+    assert_match 'New Changelog!', contents
   end
 
   def test_edit_version_amend_unmodified
@@ -144,33 +133,6 @@ class TestIndex::Scan < MiniTest::Test
     assert_empty index.changelog
   end
 
-  def test_missing_version
-    index = ReaPack::Index.new @dummy_path
-    index.url_template = 'http://host/$path'
-    index.files = ['cat/test.lua']
-
-    error = assert_raises ReaPack::Index::Error do
-      index.scan index.files.first, 'no version tag here'
-    end
-
-    assert_equal "missing tag 'version'", error.message
-  end
-
-  def test_empty_changelog
-    index = ReaPack::Index.new @dummy_path
-    index.url_template = 'http://host/$path'
-    index.files = ['cat/test.lua']
-
-    error = assert_raises ReaPack::Index::Error do
-      index.scan index.files.first, <<-IN
-        @version 1.0
-        @changelog
-      IN
-    end
-
-    assert_equal "missing value for tag 'changelog'", error.message
-  end
-
   def test_author
     index = ReaPack::Index.new @dummy_path
     index.url_template = 'http://host/$path'
@@ -185,38 +147,6 @@ class TestIndex::Scan < MiniTest::Test
     assert_match '<version name="1.0" author="cfillion">', File.read(index.path)
   end
 
-  def test_author_boolean
-    index = ReaPack::Index.new @dummy_path
-    index.url_template = 'http://host/$path'
-    index.files = ['cat/test.lua']
-
-    error = assert_raises ReaPack::Index::Error do
-      index.scan index.files.first, <<-IN
-        @version 1.0
-        @author
-      IN
-    end
-
-    assert_equal "missing value for tag 'author'", error.message
-  end
-
-  def test_author_multiline
-    index = ReaPack::Index.new @dummy_path
-    index.url_template = 'http://host/$path'
-    index.files = ['cat/test.lua']
-
-    error = assert_raises ReaPack::Index::Error do
-      index.scan index.files.first, <<-IN
-        @version 1.0
-        @author
-          hello
-          world
-      IN
-    end
-
-    assert_equal "tag 'author' must be singleline", error.message
-  end
-
   def test_noindex
     index = ReaPack::Index.new @real_path
 
@@ -234,13 +164,23 @@ class TestIndex::Scan < MiniTest::Test
     assert_equal true, index.modified?
     assert_equal '1 removed package', index.changelog
 
-    expected = <<-XML
-<?xml version="1.0" encoding="utf-8"?>
-<index version="1" commit="#{@commit}"/>
-    XML
-
     index.write @dummy_path
-    assert_equal expected, File.read(@dummy_path)
+    contents = File.read @dummy_path
+
+    assert_match @commit, contents
+    refute_match '<category', contents
+  end
+
+  def test_metapackage
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Category/script.lua', 'Category/test']
+
+    error = assert_raises ReaPack::Index::Error do
+      index.scan index.files.first, "@version 1.0\n@metapackage"
+    end
+
+    assert_equal 'no files provided', error.message
   end
 
   def test_version_time
@@ -272,7 +212,7 @@ class TestIndex::Scan < MiniTest::Test
   <category name="Extensions">
     <reapack name="reapack.ext" type="extension">
       <version name="1.0">
-        <source platform="all" file="reaper_reapack.so">http://example.com/reaper_reapack.so</source>
+        <source file="reaper_reapack.so">http://example.com/reaper_reapack.so</source>
       </version>
     </reapack>
   </category>
@@ -296,7 +236,7 @@ class TestIndex::Scan < MiniTest::Test
   <category name="Dynamics">
     <reapack name="super_compressor.jsfx" type="effect">
       <version name="1.0">
-        <source platform="all">http://host/Dynamics/super_compressor.jsfx</source>
+        <source main="true">http://host/Dynamics/super_compressor.jsfx</source>
       </version>
     </reapack>
   </category>
@@ -320,7 +260,7 @@ class TestIndex::Scan < MiniTest::Test
   <category name="Grooves">
     <reapack name="sws.data" type="data">
       <version name="1.0">
-        <source platform="all" file="sws/test.mid">http://host/Grooves/sws/test.mid</source>
+        <source file="sws/test.mid">http://host/Grooves/sws/test.mid</source>
       </version>
     </reapack>
   </category>

data/test/test_cdetector.rb

@@ -3,94 +3,98 @@ class TestConflictDetector < MiniTest::Test
 
   def test_unique
     cd = ReaPack::Index::ConflictDetector.new
-    cd['grp', 'pkg'].push :all, 'file1.lua'
-    cd['grp', 'pkg'].push :all, 'file2.lua'
+    cd['pkg'].push :grp, :all, 'file1.lua'
+    cd['pkg'].push :grp, :all, 'file2.lua'
 
-    assert_nil cd.resolve('grp', 'pkg')
-    assert_nil cd.resolve('grp')
+    assert_nil cd['pkg'].resolve
+    assert_nil cd.resolve(:grp, 'pkg')
+    assert_nil cd.resolve(:grp)
   end
 
   def test_duplicates
     cd = ReaPack::Index::ConflictDetector.new
-    cd['grp', 'pkg'].push :all, 'file1.lua'
-    cd['grp', 'pkg'].push :all, 'file1.lua'
-    cd['grp', 'pkg'].push :all, 'file2.lua'
-    cd['grp', 'pkg'].push :all, 'file2.lua'
-
-    assert_equal ["duplicate file 'file1.lua'", "duplicate file 'file2.lua'"],
-      cd.resolve('grp', 'pkg')
+    cd['pkg'].push :grp, :all, 'file1.lua'
+    cd['pkg'].push :grp, :all, 'file1.lua'
+    cd['pkg'].push :grp, :all, 'file2.lua'
+    cd['pkg'].push :grp, :all, 'file2.lua'
+
+    expected = ["duplicate file 'file1.lua'", "duplicate file 'file2.lua'"]
+    assert_equal expected, cd['pkg'].resolve
+    assert_equal expected, cd.resolve(:grp, 'pkg')
+    assert_equal expected, cd.resolve(:grp)
   end
 
   def test_same_platform
     cd = ReaPack::Index::ConflictDetector.new
-    cd['grp', 'test'].push :windows, 'file.lua'
-    cd['grp', 'test'].push :windows, 'file.lua'
+    cd['test'].push :grp, :windows, 'file.lua'
+    cd['test'].push :grp, :windows, 'file.lua'
 
-    assert_equal ["duplicate file 'file.lua' on windows"], cd.resolve('grp')
-    assert_nil cd.resolve('other bucket')
+    assert_equal ["duplicate file 'file.lua' on windows"], cd.resolve(:grp)
+    assert_nil cd.resolve(:other_bucket)
   end
 
   def test_unmatching_platform
     cd = ReaPack::Index::ConflictDetector.new
-    cd['grp', 'test'].push :darwin, 'file.lua'
-    cd['grp', 'test'].push :windows, 'file.lua'
+    cd['test'].push :grp, :darwin, 'file.lua'
+    cd['test'].push :grp, :windows, 'file.lua'
 
-    assert_nil cd.resolve('grp')
+    assert_nil cd.resolve(:grp)
   end
 
   def test_subplatform
     cd = ReaPack::Index::ConflictDetector.new
-    cd['grp', 'test'].push :all, 'file.lua'
-    cd['grp', 'test'].push :windows, 'file.lua'
+    cd['test'].push :grp, :all, 'file.lua'
+    cd['test'].push :grp, :windows, 'file.lua'
 
-    assert_equal ["duplicate file 'file.lua' on windows"], cd.resolve('grp')
+    assert_equal ["duplicate file 'file.lua' on windows"], cd.resolve(:grp)
   end
 
   def test_subsubplatform
     cd = ReaPack::Index::ConflictDetector.new
-    cd['grp', 'test'].push :all, 'file.lua'
-    cd['grp', 'test'].push :win32, 'file.lua'
+    cd['test'].push :grp, :all, 'file.lua'
+    cd['test'].push :grp, :win32, 'file.lua'
 
-    assert_equal ["duplicate file 'file.lua' on win32"], cd.resolve('grp')
+    assert_equal ["duplicate file 'file.lua' on win32"], cd.resolve(:grp)
   end
 
   def test_conflicts
     cd = ReaPack::Index::ConflictDetector.new
-    cd['grp', 'package1.lua'].push :all, 'file1.lua'
+    cd['package1.lua'].push :grp, :all, 'file1.lua'
 
-    cd['grp', 'package2.lua'].push :all, 'file1.lua'
-    cd['grp', 'package2.lua'].push :all, 'file2.lua'
+    cd['package2.lua'].push :grp, :all, 'file1.lua'
+    cd['package2.lua'].push :grp, :all, 'file2.lua'
 
-    cd['grp', 'package3.lua'].push :windows, 'file2.lua'
+    cd['package3.lua'].push :grp, :windows, 'file2.lua'
 
-    cd['grp', 'package4.lua'].push :darwin, 'file1.lua'
+    cd['package4.lua'].push :grp, :darwin, 'file1.lua'
 
-    assert_nil cd.resolve('grp', 'not_specified.lua'), 'id = not_specified'
+    assert_nil cd.resolve(:grp, 'not_specified.lua'), 'id = not_specified'
 
     assert_equal ["'file1.lua' conflicts with 'package2.lua'"],
-      cd.resolve('grp', 'package1.lua'), 'id = package1'
+      cd.resolve(:grp, 'package1.lua'), 'id = package1'
+    assert_equal cd.resolve(:grp, 'package1.lua'), cd['package1.lua'].resolve
 
     assert_equal ["'file1.lua' conflicts with 'package1.lua'",
                   "'file2.lua' conflicts with 'package3.lua' on windows"],
-      cd.resolve('grp', 'package2.lua'), 'id = package2'
+      cd.resolve(:grp, 'package2.lua'), 'id = package2'
 
     assert_equal ["'file2.lua' conflicts with 'package2.lua'"],
-      cd.resolve('grp', 'package3.lua'), 'id = package3'
+      cd.resolve(:grp, 'package3.lua'), 'id = package3'
 
     # this conflict might happen on every platform,
     # so it should not be reported it as darwin-only
     assert_equal ["'file1.lua' conflicts with 'package1.lua'"],
-      cd.resolve('grp', 'package4.lua'), 'id = package4'
+      cd.resolve(:grp, 'package4.lua'), 'id = package4'
   end
 
   def test_conflicts_bidirectional
     cd1 = ReaPack::Index::ConflictDetector.new
 
-    a1 = cd1['grp', 'a']
-    a1.push :all, 'file.lua'
+    a1 = cd1['a']
+    a1.push :grp, :all, 'file.lua'
 
-    b1 = cd1['grp', 'b']
-    b1.push :windows, 'file.lua'
+    b1 = cd1['b']
+    b1.push :grp, :windows, 'file.lua'
 
     assert_equal ["'file.lua' conflicts with 'b' on windows"],
       a1.resolve, 'id = a'
@@ -98,73 +102,90 @@ class TestConflictDetector < MiniTest::Test
       b1.resolve, 'id = b'
 
     cd2 = ReaPack::Index::ConflictDetector.new
-    a2 = cd1['grp', 'a']
-    a2.push :windows, 'file.lua'
+    a2 = cd1['a']
+    a2.push :grp, :windows, 'file.lua'
 
-    b2 = cd1['grp', 'b']
-    b2.push :all, 'file.lua'
+    b2 = cd1['b']
+    b2.push :grp, :all, 'file.lua'
 
     assert_equal a1.resolve, a2.resolve
     assert_equal b1.resolve, b2.resolve
   end
 
-  def test_conflicts_platform_selection
+  def test_platform_selection
     cd1 = ReaPack::Index::ConflictDetector.new
-    cd1['grp', 'a'].push :all, 'file.lua'
-    cd1['grp', 'b'].push :windows, 'file.lua'
-    cd1['grp', 'c'].push :win32, 'file.lua'
+    cd1['a'].push :grp1, :all, 'file.lua'
+    cd1['b'].push :grp1, :windows, 'file.lua'
+    cd1['c'].push :grp1, :win32, 'file.lua'
 
     assert_equal ["'file.lua' conflicts with 'b' on windows"],
-      cd1.resolve('grp', 'a'), 'id = a'
+      cd1.resolve(:grp1, 'a'), 'id = a (grp1)'
+
+    cd1['a'].push :grp2, :all, 'file.lua'
+    cd1['b'].push :grp2, :darwin, 'file.lua'
+    cd1['c'].push :grp2, :win32, 'file.lua'
+
+    assert_equal ["'file.lua' conflicts with 'b' on darwin"],
+      cd1.resolve(:grp2, 'a'), 'id = a (grp2)'
   end
 
   def test_duplicate_platform_selection
     cd = ReaPack::Index::ConflictDetector.new
-    cd['grp', 'test'].push :windows, 'file.lua'
-    cd['grp', 'test'].push :all, 'file.lua'
-    assert_equal ["duplicate file 'file.lua' on windows"], cd.resolve('grp')
+    cd['test'].push :grp, :windows, 'file.lua'
+    cd['test'].push :grp, :all, 'file.lua'
+    assert_equal ["duplicate file 'file.lua' on windows"], cd.resolve(:grp)
 
-    cd['grp', 'test'].push :all, 'file.lua'
-    assert_equal ["duplicate file 'file.lua'"], cd.resolve('grp')
+    cd['test'].push :grp, :all, 'file.lua'
+    assert_equal ["duplicate file 'file.lua'"], cd.resolve(:grp)
   end
 
   def test_platform_same_level
     cd1 = ReaPack::Index::ConflictDetector.new
-    cd1['grp', 'test'].push :all, 'file.lua'
-    cd1['grp', 'test'].push :win32, 'file.lua' # win32 first
-    cd1['grp', 'test'].push :darwin32, 'file.lua'
+    cd1['test'].push :grp, :all, 'file.lua'
+    cd1['test'].push :grp, :win32, 'file.lua' # win32 first
+    cd1['test'].push :grp, :darwin32, 'file.lua'
 
-    assert_equal ["duplicate file 'file.lua' on win32"], cd1.resolve('grp')
+    assert_equal ["duplicate file 'file.lua' on win32"], cd1.resolve(:grp)
 
     cd2 = ReaPack::Index::ConflictDetector.new
-    cd2['grp', 'test'].push :all, 'file.lua'
-    cd2['grp', 'test'].push :darwin32, 'file.lua' # darwin32 first
-    cd2['grp', 'test'].push :win32, 'file.lua'
+    cd2['test'].push :grp, :all, 'file.lua'
+    cd2['test'].push :grp, :darwin32, 'file.lua' # darwin32 first
+    cd2['test'].push :grp, :win32, 'file.lua'
 
-    assert_equal cd1.resolve('grp'), cd2.resolve('grp')
+    assert_equal cd1.resolve(:grp), cd2.resolve(:grp)
   end
 
   def test_remove_by_key
     cd = ReaPack::Index::ConflictDetector.new
-    cd['grp', 'test'].push :all, 'file'
+    cd['test'].push :grp, :all, 'file'
 
-    cd['grp', 'test'].clear
-    cd['grp', 'test'].push :all, 'file'
+    cd['test'].clear
+    cd['test'].push :grp, :all, 'file'
 
-    assert_equal nil, cd.resolve('grp', 'test')
+    assert_equal nil, cd.resolve(:grp, 'test')
   end
 
   def test_clone
     cd1 = ReaPack::Index::ConflictDetector.new
-    cd1['grp', 'test'].push :all, 'file'
+    cd1['test'].push :grp, :all, 'file'
 
     cd2 = cd1.clone
 
-    cd1['grp', 'test'].push :all, 'file'
-    assert_nil cd2.resolve('grp')
+    cd1['test'].push :grp, :all, 'file'
+    assert_nil cd2.resolve(:grp)
+
+    cd2['test'].push :grp, :all, 'file'
+    refute_nil cd2.resolve(:grp)
+  end
+
+  def test_clear
+    cd = ReaPack::Index::ConflictDetector.new
+    cd['test'].push :grp, :all, 'file'
+
+    cd.clear
+    cd['test'].push :grp, :all, 'file'
 
-    cd2['grp', 'test'].push :all, 'file'
-    refute_nil cd2.resolve('grp')
+    assert_equal nil, cd.resolve(:grp, 'test')
   end
 
   def test_load_xml
@@ -194,6 +215,21 @@ class TestConflictDetector < MiniTest::Test
         <source platform="all" file="../Other/test1.lua">http://cross/category</source>
       </version>
     </reapack>
+    <reapack name="no_platform.lua" type="script">
+      <version name="1.0">
+        <source file="picture">http://cross/category</source>
+      </version>
+    </reapack>
+    <reapack name="weird_platform.lua" type="script">
+      <version name="1.0">
+        <source platform="bacon" file="picture">http://cross/category</source>
+      </version>
+    </reapack>
+    <reapack name="explicit_type.lua" type="script">
+      <version name="1.0">
+        <source type="effect" file="picture">http://cross/category</source>
+      </version>
+    </reapack>
   </category>
 </index>
     XML
@@ -203,12 +239,25 @@ class TestConflictDetector < MiniTest::Test
 
     assert_equal ["'Other/test1.lua' conflicts with 'Other/test2.lua'",
                   "duplicate file 'Other/background.png' on win32"],
-      cd.resolve(:script, 'Other/test1.lua'), 'test1'
+      cd['Other/test1.lua'].resolve, 'test1'
 
     assert_equal ["'Other/test1.lua' conflicts with 'Other/test1.lua'"],
-      cd.resolve(:script, 'Other/test2.lua'), 'test2'
+      cd['Other/test2.lua'].resolve, 'test2'
 
     assert_equal ["'Other/test1.lua' conflicts with 'Other/test1.lua'"],
-      cd.resolve(:script, 'Scripts/test3.lua'), 'test3'
+      cd['Scripts/test3.lua'].resolve, 'test3'
+
+    cd['Scripts/no_platform.lua'].resolve
+    cd['Scripts/weird_platform.lua'].resolve
+
+    assert_nil cd['Scripts/explicit_type.lua'].resolve
+  end
+
+  def test_unknown_platform
+    cd = ReaPack::Index::ConflictDetector.new
+    cd['test1'].push :grp, :unknown, 'file'
+    cd['test2'].push :grp, :all, 'file'
+
+    assert_equal ["'file' conflicts with 'test2'"], cd['test1'].resolve
   end
 end