reapack-index 1.0beta3 → 1.0beta4

data/test/index/test_provides.rb

@@ -0,0 +1,302 @@
+require File.expand_path '../../helper', __FILE__
+
+TestIndex ||= Class.new MiniTest::Test
+
+class TestIndex::Provides < MiniTest::Test
+  include IndexHelper
+
+  def test_simple
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+
+    index.files = [
+      'Category/script.lua',
+      'Resources/unicode.dat',
+      'Category/test.png',
+    ]
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @provides
+        [windows] ../Resources/unicode.dat
+        test.png
+    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 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>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    index.write!
+    assert_equal expected, File.read(index.path)
+  end
+
+  def test_not_found
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Category/script.lua']
+
+    error = assert_raises ReaPack::Index::Error do
+     index.scan index.files.first, <<-IN
+       @version 1.0
+       @provides
+         test.png
+     IN
+    end
+
+    assert_equal "file not found 'test.png'", error.message
+  end
+
+  def test_mainfile_platform
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Category/script.lua']
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @provides
+        [darwin] .
+        [win64] script.lua
+    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 platform="darwin">http://host/Category/script.lua</source>
+        <source platform="win64">http://host/Category/script.lua</source>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    index.write!
+    assert_equal expected, File.read(index.path)
+  end
+
+  def test_invalid_options
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+
+    error = assert_raises ReaPack::Index::Error do
+      index.scan 'cat/test.lua', <<-IN
+        @version 1.0
+        @provides
+          [hello] test.png
+      IN
+    end
+  end
+
+  def test_custom_url
+    index = ReaPack::Index.new @dummy_path
+    index.files = ['Category/script.lua']
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @provides
+        script.lua http://google.com/download/$commit/$version/$path
+    IN
+
+    index.write!
+    assert_match 'http://google.com/download/master/1.0/Category/script.lua',
+      File.read(index.path)
+  end
+
+  def test_empty_tag
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Category/hello.lua']
+
+    error = assert_raises ReaPack::Index::Error do
+      index.scan index.files.first, <<-IN
+        @version 1.0
+        @provides
+      IN
+    end
+  end
+
+  def test_glob
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = [
+      'Category/script.lua',
+      'Category/Data/a.dat',
+      'Category/Data/b.dat',
+      'Category/test.txt',
+      'Category/test/d.dat', # should not be matched by test*
+    ]
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @provides
+        [windows] Data/*
+        test*
+    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 platform="all">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>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    index.write!
+    assert_equal expected, File.read(index.path)
+  end
+
+  def test_duplicate
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['cat/script.lua', 'cat/test.png']
+
+    error = assert_raises ReaPack::Index::Error do
+     index.scan index.files.first, <<-IN
+       @version 1.0
+       @provides
+         test.png
+         test.png http://url.com
+     IN
+    end
+
+    assert_equal "duplicate file 'cat/test.png'", error.message
+  end
+
+  def test_conflicts
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['cat/script1.lua', 'cat/script2.lua', 'cat/script3.lua',
+                   'cat/file1', 'cat/file2']
+
+    index.scan index.files[0], <<-IN
+      @version 1.0
+      @provides file1
+    IN
+
+    error = assert_raises ReaPack::Index::Error do
+     index.scan index.files[1], <<-IN
+       @version 1.0
+       @provides
+         file1
+         file2
+     IN
+    end
+
+    assert_equal "'cat/file1' conflicts with 'cat/script1.lua'",
+      error.message
+
+    # did script2.lua did leave any trace behind?
+    index.scan index.files[2], <<-IN
+      @version 1.0
+      @provides file2
+    IN
+  end
+
+  def test_duplicate_other_package
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['cat/script1.lua', 'cat/script2.lua']
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+    IN
+
+    error = assert_raises ReaPack::Index::Error do
+     index.scan index.files.last, <<-IN
+       @version 1.0
+       @provides script1.lua
+     IN
+    end
+
+    assert_equal "'cat/script1.lua' conflicts with 'cat/script1.lua'",
+      error.message
+  end
+
+  def test_duplicate_cross_directory
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Category1/script1.lua', 'Category2/script2.lua',
+                   'Category1/file']
+
+    index.scan index.files[0], <<-IN
+      @version 1.0
+      @provides file
+    IN
+
+    error = assert_raises ReaPack::Index::Error do
+     index.scan index.files[1], <<-IN
+       @version 1.0
+       @provides ../Category1/file
+     IN
+    end
+
+    assert_equal "'Category1/file' conflicts with 'Category1/script1.lua'",
+      error.message
+  end
+
+  def test_conflict_with_existing
+    File.write @dummy_path, <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<index version="1">
+  <category name="Other">
+    <reapack name="test1.lua" type="script">
+      <version name="1.0">
+        <source platform="all" file="background.png">http://irrelevant</source>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Other/test2.lua', 'Other/background.png']
+
+    error = assert_raises ReaPack::Index::Error do
+      index.scan index.files.first, <<-IN
+        @version 1.0
+        @provides background.png
+      IN
+    end
+
+    assert_equal "'Other/background.png' conflicts with 'Other/test1.lua'",
+      error.message
+  end
+
+  def test_same_file_cross_type
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['script.lua', 'file', 'effect.jsfx']
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @provides file
+    IN
+
+    index.scan index.files.last, <<-IN
+      @version 1.0
+      @provides file
+    IN
+  end
+end

data/test/index/test_scan.rb

@@ -0,0 +1,333 @@
+require File.expand_path '../../helper', __FILE__
+
+TestIndex ||= Class.new MiniTest::Test
+
+class TestIndex::Scan < MiniTest::Test
+  include IndexHelper
+
+  def test_ignore_unknown_type
+    index = ReaPack::Index.new @dummy_path
+
+    index.scan 'src/main.cpp', String.new
+    index.write!
+
+    expected = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<index version="1"/>
+    XML
+
+    assert_equal expected, File.read(index.path)
+  end
+
+  def test_new_package
+    index = ReaPack::Index.new @dummy_path
+    index.files = ['Category/Path/Instrument Track.lua']
+    index.url_template = 'http://host/$path'
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @changelog Hello World
+    IN
+
+    assert_equal true, index.modified?
+    assert_equal '1 new category, 1 new package, 1 new version', index.changelog
+
+    index.write!
+
+    assert_equal false, index.modified?
+    assert_empty index.changelog
+
+    expected = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<index version="1">
+  <category name="Category/Path">
+    <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>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    assert_equal expected, File.read(index.path)
+  end
+
+  def test_package_in_root
+    index = ReaPack::Index.new @dummy_path
+    index.files = ['script.lua', 'Hello/World']
+    index.url_template = 'http://host/$path'
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @provides Hello/World
+    IN
+
+    index.write!
+    refute_match '<reapack', File.read(index.path)
+  end
+
+  def test_edit_version_amend_off
+    index = ReaPack::Index.new @real_path
+    assert_equal false, index.amend
+
+    index.url_template = 'http://google.com/$path'
+    index.files = ['Category Name/Hello World.lua']
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @changelog New Changelog!
+    IN
+
+    assert_equal false, index.modified?
+    assert_empty index.changelog
+  end
+
+  def test_edit_version_amend_on
+    index = ReaPack::Index.new @real_path
+    index.commit = @commit
+    index.files = ['Category Name/Hello World.lua']
+    index.time = Time.now # must not be added to the index in amend mode
+    index.url_template = 'http://google.com/$path'
+
+    index.amend = true
+    assert_equal true, index.amend
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @changelog Intermediate Changelog!
+    IN
+
+    # when reindexing the same file a second time,
+    # the changelog is expected to only have been bumped a single time
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @changelog New Changelog!
+    IN
+
+    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)
+  end
+
+  def test_edit_version_amend_unmodified
+    index = ReaPack::Index.new @real_path
+    index.amend = true
+
+    index.url_template = 'https://google.com/$path'
+    index.files = ['Category Name/Hello World.lua']
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @author cfillion
+      @changelog Fixed a division by zero error.
+    IN
+
+    assert_equal false, index.modified?
+    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'
+    index.files = ['Category/script.lua']
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @author cfillion
+    IN
+
+    index.write!
+    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
+
+    index.scan 'script.lua', '@noindex'
+
+    assert_equal false, index.modified?
+  end
+
+  def test_noindex_autoremove
+    index = ReaPack::Index.new @real_path
+    index.commit = @commit
+
+    index.scan 'Category Name/Hello World.lua', '@noindex'
+
+    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)
+  end
+
+  def test_version_time
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Category/script.lua']
+    index.time = Time.new 2016, 2, 11, 20, 16, 40, -5 * 3600
+
+    index.scan index.files.first, '@version 1.0'
+
+    index.write!
+    assert_match '<version name="1.0" time="2016-02-12T01:16:40Z">',
+      File.read(index.path)
+  end
+
+  def test_extension
+    index = ReaPack::Index.new @dummy_path
+    index.files = ['Extensions/reapack.ext']
+
+    index.scan index.files.first, <<-IN
+      @version 1.0
+      @provides
+        reaper_reapack.so http://example.com/$path
+    IN
+
+    expected = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<index version="1">
+  <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>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    index.write!
+    assert_equal expected, File.read(index.path)
+  end
+
+  def test_effect
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Dynamics/super_compressor.jsfx']
+
+    index.scan index.files.first, '@version 1.0'
+
+    expected = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<index version="1">
+  <category name="Dynamics">
+    <reapack name="super_compressor.jsfx" type="effect">
+      <version name="1.0">
+        <source platform="all">http://host/Dynamics/super_compressor.jsfx</source>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    index.write!
+    assert_equal expected, File.read(index.path)
+  end
+
+  def test_data
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Grooves/sws.data', 'Grooves/sws/test.mid']
+
+    index.scan index.files.first, "@version 1.0\n@provides sws/*.mid"
+
+    expected = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<index version="1">
+  <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>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    index.write!
+    assert_equal expected, File.read(index.path)
+  end
+end