reapack-index 1.0 → 1.1beta1

data/lib/reapack/index/version.rb

@@ -42,7 +42,6 @@ class ReaPack::Index
 
     def time=(new_time)
       return if new_time == time
-
       if new_time.nil?
         @node.remove_attribute TIME
       else
@@ -61,7 +60,7 @@ class ReaPack::Index
       yield
 
       new_sources = hash_sources children(Source::TAG)
-      @dirty = was_dirty || old_sources != new_sources
+      @dirty = old_sources != new_sources unless was_dirty
 
       raise Error, 'no files provided' if new_sources.empty?
     end
@@ -74,8 +73,8 @@ class ReaPack::Index
 
   private
     def hash_sources(nodes)
-      nodes.map {|src|
-        [src[Source::PLATFORM] || 'all', src[Source::FILE], src.content]
+      nodes.map {|node|
+        [node[Source::PLATFORM] || 'all', node[Source::FILE], node.content]
       }
     end
   end

data/reapack-index.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'addressable', '~> 2.4'
   spec.add_runtime_dependency 'colorize', '~> 0.7'
   spec.add_runtime_dependency 'gitable', '~> 0.3'
-  spec.add_runtime_dependency 'metaheader', '~> 1.2.1'
+  spec.add_runtime_dependency 'metaheader', '~> 1.3beta1'
   spec.add_runtime_dependency 'nokogiri', '~> 1.6.8'
   spec.add_runtime_dependency 'pandoc-ruby', '~> 2.0'
   spec.add_runtime_dependency 'rugged', '~> 0.24'

data/setup/reapack-index.nsi

@@ -2,11 +2,11 @@
 !include Sections.nsh
 !include StrRep.nsh
 
-!define VERSION "1.0rc3"
+!define VERSION "1.1beta1"
 !define NAME "ReaPack Index ${VERSION}"
 !define LONG_VERSION "0.1.0.0"
 
-!define RUBY_VERSION "2.3.1"
+!define RUBY_VERSION "2.3.0"
 !define RUBYINSTALLER_FILE "rubyinstaller-${RUBY_VERSION}.exe"
 !define RUBYINSTALLER_URL \
   "http://dl.bintray.com/oneclick/rubyinstaller/${RUBYINSTALLER_FILE}"

data/test/cli/test_metadata.rb

@@ -26,8 +26,20 @@ class TestCLI::Metadata < MiniTest::Test
     end
   end
 
+  def test_screenshot_link
+    wrapper ['--screenshot-link', 'Link Label http://cfillion.tk'] do
+      assert_output "1 new screenshot link, empty index\n" do
+        assert_equal true, @cli.run
+      end
+
+      assert_match 'rel="screenshot" href="http://cfillion.tk">Link Label</link>',
+        read_index
+    end
+  end
+
   def test_invalid_link
     wrapper ['--link', 'shinsekai yori', '--donation-link', 'hello world',
+             '--screenshot-link', 'chunky bacon',
              '--link', 'http://cfillion.tk'] do
       stdout, stderr = capture_io do
         assert_equal true, @cli.run
@@ -36,6 +48,7 @@ class TestCLI::Metadata < MiniTest::Test
       assert_equal "1 new website link, empty index\n", stdout
       assert_match /warning: --link: invalid link 'shinsekai yori'/i, stderr
       assert_match /warning: --donation-link: invalid link 'hello world'/i, stderr
+      assert_match /warning: --screenshot-link: invalid link 'chunky bacon'/i, stderr
       assert_match 'rel="website">http://cfillion.tk</link>', read_index
     end
   end

data/test/cli/test_scan.rb

@@ -426,4 +426,18 @@ processing [a-f0-9]{7}: third commit
   def test_no_arguments
     wrapper ['--scan'] do; end
   end
+
+  def test_strict_mode
+    wrapper do
+      refute @cli.index.strict
+    end
+
+    wrapper ['--no-strict'] do
+      refute @cli.index.strict
+    end
+
+    wrapper ['--strict'] do
+      assert @cli.index.strict
+    end
+  end
 end

data/test/data/index.xml

@@ -2,7 +2,7 @@
 <index version="1" commit="f572d396fae9206628714fb2ce00f72e94f2258f" name="Test">
   <category name="Category Name">
     <reapack name="Hello World.lua" type="script">
-      <version name="1.0" author="cfillion">
+      <version name="1.0" author="cfillion" time="2015-01-01T00:00:00Z">
         <changelog><![CDATA[Fixed a division by zero error.]]></changelog>
         <source>https://google.com/Category%20Name/Hello%20World.lua</source>
       </version>

data/test/index/test_metadata.rb

@@ -70,21 +70,21 @@ class TestIndex::Metadata < MiniTest::Test
     assert_equal '1 new website link, 1 removed website link, empty index', index.changelog
   end
 
-  def test_description
+  def test_about
     index = ReaPack::Index.new @dummy_path
     index.write!
 
-    assert_empty index.description
+    assert_empty index.about
     assert_equal false, index.modified?
 
-    index.description = 'Hello World'
-    refute_empty index.description
+    index.about = 'Hello World'
+    refute_empty index.about
     assert_equal true, index.modified?
     assert_equal '1 modified metadata', index.changelog
 
     index.write!
 
-    index.description = 'Hello World'
+    index.about = 'Hello World'
     assert_equal false, index.modified?
   end
 

data/test/index/test_scan.rb

@@ -68,85 +68,6 @@ class TestIndex::Scan < MiniTest::Test
     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
-
-    index.write @dummy_path
-    contents = File.read @dummy_path
-
-    assert_match @commit, contents
-    assert_match 'New Changelog!', contents
-  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_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_noindex
     index = ReaPack::Index.new @real_path
 
@@ -171,37 +92,17 @@ class TestIndex::Scan < MiniTest::Test
     refute_match '<category', contents
   end
 
-  def test_metapackage_on
+  def test_strict_mode
     index = ReaPack::Index.new @dummy_path
+    index.strict = true
     index.url_template = 'http://host/$path'
     index.files = ['Category/script.lua']
 
     error = assert_raises ReaPack::Index::Error do
-      index.scan index.files.first, "@version 1.0\n@metapackage"
+      index.scan index.files.first, "@version 1.0\n@qwerty"
     end
 
-    assert_equal 'no files provided', error.message
-  end
-
-  def test_metapackage_off
-    index = ReaPack::Index.new @dummy_path
-    index.url_template = 'http://host/$path'
-    index.files = ['Category/extension.ext']
-
-    index.scan index.files.first, "@version 1.0\n@metapackage false"
-  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)
+    assert_equal "unknown tag 'qwerty'", error.message
   end
 
   def test_extension
@@ -278,4 +179,31 @@ class TestIndex::Scan < MiniTest::Test
     index.write!
     assert_equal expected, File.read(index.path)
   end
+
+  def test_theme
+    index = ReaPack::Index.new @dummy_path
+    index.url_template = 'http://host/$path'
+    index.files = ['Themes/Default_4.0 + width.theme']
+
+    index.scan index.files.first, <<-IN
+    @version 1.0
+    @provides Default_4.0_width.ReaperThemeZip http://stash.reaper.fm/27310/$path
+    IN
+
+    expected = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<index version="1">
+  <category name="Themes">
+    <reapack name="Default_4.0 + width.theme" type="theme">
+      <version name="1.0">
+        <source file="Default_4.0_width.ReaperThemeZip">http://stash.reaper.fm/27310/Default_4.0_width.ReaperThemeZip</source>
+      </version>
+    </reapack>
+  </category>
+</index>
+    XML
+
+    index.write!
+    assert_equal expected, File.read(index.path)
+  end
 end

data/test/scanner/test_makeurl.rb

@@ -0,0 +1,102 @@
+require File.expand_path '../../helper', __FILE__
+
+TestScanner ||= Class.new MiniTest::Test
+
+class TestScanner::TestMakeUrl < MiniTest::Test
+  def setup
+    @cat = MiniTest::Mock.new
+
+    @pkg = MiniTest::Mock.new
+    @pkg.expect :path, 'Hello/World.lua'
+    @pkg.expect :path, 'Hello/World.lua'
+
+    @ver = MiniTest::Mock.new
+    @ver.expect :name, '1.0'
+
+    @cdetector = MiniTest::Mock.new
+    @cdetector.expect :[], nil, ['Hello/World.lua']
+
+    @index = MiniTest::Mock.new
+    @index.expect :cdetector, @cdetector
+
+    @scanner = ReaPack::Index::Scanner.new @cat, @pkg, nil, @index
+    @scanner.instance_variable_set :@ver, @ver
+  end
+
+  def teardown
+    [@cat, @pkg, @ver, @index, @cdetector].each {|mock| mock.verify }
+  end
+
+  def test_path
+    @index.expect :files, ['Category/script.lua']
+    @index.expect :url_template, '$path'
+    @index.expect :commit, 'C0FF33'
+
+    assert_equal 'Category/script.lua', @scanner.make_url('Category/script.lua')
+  end
+
+  def test_commit
+    @index.expect :files, ['Hello/World.lua']
+    @index.expect :url_template, '$commit'
+    @index.expect :commit, 'C0FF33'
+
+    assert_equal 'C0FF33', @scanner.make_url('Hello/World.lua')
+  end
+
+  def test_defaut_branch
+    @index.expect :commit, nil
+
+    assert_match 'master', @scanner.make_url('Category/script.lua', '$commit')
+  end
+
+  def test_version
+    @index.expect :files, ['Category/script.lua']
+    @index.expect :url_template, '$version'
+    @index.expect :commit, 'C0FF33'
+
+    assert_equal '1.0', @scanner.make_url('Category/script.lua')
+  end
+
+  def test_package
+    @index.expect :files, ['Category/script.lua']
+    @index.expect :url_template, '$package'
+    @index.expect :commit, 'C0FF33'
+
+    assert_equal 'Hello/World.lua', @scanner.make_url('Category/script.lua')
+  end
+
+  def test_without_template
+    @index.expect :commit, nil
+    @scanner.make_url 'script.lua', 'ok if explicit template'
+
+    @index.expect :url_template, nil
+    error = assert_raises ReaPack::Index::Error do
+      @scanner.make_url 'script.lua'
+    end
+
+    assert_match /url template/i, error.message
+  end
+
+  def test_unlisted
+    @index.expect :commit, nil
+    @index.expect :files, []
+    @index.expect :url_template, 'http://implicit/url/template'
+
+    @scanner.make_url 'unlisted.lua', 'ok with explicit url template'
+
+    error = assert_raises ReaPack::Index::Error do
+      @scanner.make_url 'unlisted.lua'
+    end
+
+    assert_equal "file not found 'unlisted.lua'", error.message
+  end
+
+  def test_repeat
+    @index.expect :files, ['Category/script.lua']
+    @index.expect :url_template, '$path $path'
+    @index.expect :commit, 'C0FF33'
+
+    assert_equal 'Category/script.lua Category/script.lua',
+      @scanner.make_url('Category/script.lua')
+  end
+end

data/test/scanner/test_validation.rb

@@ -0,0 +1,126 @@
+require File.expand_path '../../helper', __FILE__
+
+TestScanner ||= Class.new MiniTest::Test
+
+class TestScanner::TestValidation < MiniTest::Test
+  def setup
+    @pkg = MiniTest::Mock.new
+    @pkg.expect :type, :script
+    @pkg.expect :path, 'cat/test'
+
+    @mh = MetaHeader.new String.new
+    @mh[:version] = '1.0'
+
+    @index = MiniTest::Mock.new
+    @index.expect :cdetector, ReaPack::Index::ConflictDetector.new
+
+    @scanner = ReaPack::Index::Scanner.new nil, @pkg, @mh, @index
+  end
+
+  def test_validation
+    mh_mock = MiniTest::Mock.new
+    mh_mock.expect :alias, nil, [Hash]
+    mh_mock.expect :validate, ['first', 'second'], [Hash]
+
+    @scanner.instance_variable_set :@mh, mh_mock
+
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+
+    assert_equal "first\nsecond", error.message
+    mh_mock.verify
+  end
+
+  def test_version
+    @mh.delete :version
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "missing tag 'version'", error.message
+
+    @mh[:version] = 'no.numbers'
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "invalid value for tag 'version'", error.message
+
+    @mh[:version] = 'v1.0'
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "invalid value for tag 'version'", error.message
+
+    @mh[:version] = true
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "missing value for tag 'version'", error.message
+
+    @mh[:version] = "hello\nworld"
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "tag 'version' must be singleline", error.message
+
+    @mh[:version] = '1.99999'
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "invalid value for tag 'version': segment overflow (99999 > 65535)",
+      error.message
+  end
+
+  def test_author
+    @mh[:author] = true
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "missing value for tag 'author'", error.message
+
+    @mh[:author] = "hello\nworld"
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "tag 'author' must be singleline", error.message
+  end
+
+  def test_changelog
+    @mh[:changelog] = true
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "missing value for tag 'changelog'", error.message
+  end
+
+  def test_provides
+    @mh[:provides] = true
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "missing value for tag 'provides'", error.message
+
+    @mh[:provides] = '[hello] world'
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "invalid value for tag 'provides': unknown option 'hello'",
+      error.message
+  end
+
+  def test_index
+    @mh[:noindex] = 'value'
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "tag 'noindex' cannot have a value", error.message
+  end
+
+  def test_metapackage
+    @mh[:metapackage] = 'value'
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "tag 'metapackage' cannot have a value", error.message
+  end
+
+  def test_description
+    @mh[:description] = true
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "missing value for tag 'description'", error.message
+
+    @mh[:description] = "hello\nworld"
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "tag 'description' must be singleline", error.message
+  end
+
+  def test_about
+    @mh[:about] = true
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "missing value for tag 'about'", error.message
+  end
+
+  def test_screenshot
+    @mh[:screenshot] = true
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "missing value for tag 'screenshot'", error.message
+  end
+
+  def test_donation
+    @mh[:donation] = true
+    error = assert_raises(ReaPack::Index::Error) { @scanner.run }
+    assert_equal "missing value for tag 'donation'", error.message
+  end
+end