inqlude 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0224ffe44586e1ff0a7c20230442433a0143b087
-  data.tar.gz: e83375ed1990a411ac5229cd73bb390b029bfda2
+  metadata.gz: dfb73e8e83eb6e2b8e86b2e7289be7934d3c5967
+  data.tar.gz: 43279f4302b345f134218d48aebb844031c9b8a2
 SHA512:
-  metadata.gz: 69fd8daf47555415e889c364aa31465e26664aa8fef2a46a35791f504a721bab8799187f5ee169563130a321e29fec82989337d5a14a5f70f1638da1f5ff2620
-  data.tar.gz: 3ae968eb4d5a6d295cff30794cd46f5bc0b8a125d95a6fe20eba188b40421dab480087d6350b5c93caea1504d0fdae99467cf60012da8b7620b461332f58cf60
+  metadata.gz: d177de51fd1b3d7161adad5eef36ff8bdb47e7aeae565f48a6728ba8beefd2be19537bba03bd0134c2a24e5df102717492de7cfa1196d24f214c2e72e3f77eca
+  data.tar.gz: 8638a6c79f6c7400f577e010b7273022130d51d9ea7457d2e0bc5db48ba124098cdb4da83d85f0d5946512e32529781fdc2bb9a597a4a9e4b2f85871db42790e

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.1.9"
+  - "2.2.5"
+  - "2.3.1"
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change log of Inqlude
 
+## Version 0.8.0
+
+* Add topic attribute to manifest specification and adapt validator to allow topic attribute as an optional parameter. The validator reports missing topics as a warning for each manifest which does not have a topic attribute, but not fail.
+As a result, libraries can be categorized under multiple topics. The validator reports an error for each manifest with invalid topics attribute. As a result, the list of topics is kept small and typographical errors are prevented.
+* Initialize distro only when needed. This should remove "distro not recognized" warnings in cases where the distro is not needed
+* Clarify documentation of `vcs` URL
+
 ## Version 0.7.4
 
 * Support links to OS X packages in manifests

data/README.md

@@ -1,5 +1,7 @@
 # Inqlude - the Qt library archive
 
+[![Build Status](https://travis-ci.org/cornelius/inqlude.svg?branch=master)](https://travis-ci.org/cornelius/inqlude)
+
 ## Overview
 
 Inqlude is a tool to handle Qt based libraries. It provides developers using Qt

data/bin/inqlude

@@ -18,13 +18,7 @@
 
 require File.expand_path('../../lib/inqlude',__FILE__)
 
-distro = Distro.detect
-if !distro
-  STDERR.puts "Warning: unable to detect distro."
-end
-
 Cli.settings = Settings.new
-Cli.distro = distro
 
 Cli.check_unknown_options!
 Cli.start ARGV

data/lib/cli.rb

@@ -26,8 +26,13 @@ class Cli < Thor
     @@settings = s
   end
 
-  def self.distro= d
-    @@distro = d
+  def self.distro
+    @@distro if @@distro
+
+    @@distro = Distro.detect
+    if !@@distro
+      STDERR.puts "Warning: unable to detect distro."
+    end
   end
 
   desc "global", "Global options", :hide => true
@@ -39,8 +44,8 @@ class Cli < Thor
       qmake_out =~ /Qt version (.*) in/
       puts "Qt: #{$1}"
 
-      if @@distro
-        puts "OS: #{@@distro.name} #{@@distro.version}"
+      if self.distro
+        puts "OS: #{self.distro.name} #{self.distro.version}"
       else
         puts "OS: unknown"
       end
@@ -63,7 +68,7 @@ class Cli < Thor
         puts library.name + " (" + library.versions.join(", ") + ")"
       end
     else
-      manifests = @@distro.installed handler
+      manifests = self.distro.installed handler
       manifests.each do |manifest|
         puts manifest["name"]
       end
@@ -123,6 +128,7 @@ actual domain."
       handler = ManifestHandler.new @@settings
       handler.read_remote
       count_ok = 0
+      count_warning = 0
       handler.libraries.each do |library|
         library.manifests.each do |manifest|
           result = v.verify manifest
@@ -132,11 +138,15 @@ actual domain."
           else
             errors.push result
           end
+          if result.has_warnings?
+            count_warning +=1
+          end
         end
       end
       puts
       puts "#{handler.manifests.count} manifests checked. #{count_ok} ok, " +
-        "#{errors.count} with error."
+        "#{errors.count} with error, " +
+        "#{count_warning} #{count_warning == 1 ? "has warning." : "have warnings."}"
       if !errors.empty?
         puts
         puts "Errors:"
@@ -263,7 +273,7 @@ actual domain."
     if !manifest
       STDERR.puts "Manifest for '#{name}' not found"
     else
-      @@distro.uninstall manifest
+      self.distro.uninstall manifest
     end
   end
 
@@ -276,7 +286,7 @@ actual domain."
     if !manifest
       STDERR.puts "Manifest for '#{name}' not found"
     else
-      @@distro.install manifest, :dry_run => options[:dry_run]
+      self.distro.install manifest, :dry_run => options[:dry_run]
     end
   end
 

data/lib/manifest.rb

@@ -38,6 +38,7 @@ class Manifest < JsonObject
   attribute :release_date
   attribute :version
   attribute :summary
+  attribute :topics
   attribute :urls do
     attribute :homepage
     attribute :api_docs

data/lib/verifier.rb

@@ -17,17 +17,23 @@
 class Verifier
 
   class Result
-    attr_accessor :errors, :name
+    attr_accessor :errors, :warnings, :name
     
     def initialize
       @valid = false
+      @safe = false
       @errors = Array.new
+      @warnings = Array.new
     end
     
     def valid?
       @errors.empty?
     end
 
+    def has_warnings?
+      !@warnings.empty?
+    end
+
     def print_result
       print "Verify manifest #{@name}..."
       if valid?
@@ -38,6 +44,11 @@ class Verifier
           puts "  #{error}"
         end
       end
+      if has_warnings?
+        @warnings.each do |warning|
+          puts "  #{warning}"
+        end
+      end
     end
   end
   
@@ -76,6 +87,17 @@ class Verifier
       errors.each do |error|
         @result.errors.push "Schema validation error: #{error}"
       end
+
+      topics =  manifest.topics
+      if topics.nil?
+        @result.warnings.push "Warning: missing `topics` attribute"
+      else
+        valid_topics = ['API', 'Artwork', 'Bindings', 'Communication', 'Data', 'Desktop', 'Development', 'Graphics', 'Logging', 'Mobile', 'Multimedia', 'Printing', 'QML', 'Scripting', 'Security', 'Text', 'Web', 'Widgets']
+        invalid_topics = topics - valid_topics
+        if !invalid_topics.empty?
+          @result.errors.push ("Invalid topics " + "'#{invalid_topics.join("', '")}'" + ". Valid topics are " + "'#{valid_topics.join("', '")}'")
+        end
+      end
     end
 
     @result

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Inqlude
-  VERSION = "0.7.4"
+  VERSION = "0.8.0"
 end

data/manifest-format.md

@@ -115,21 +115,18 @@ requirements. They are not necessarily meant to be read programmatically.
 
 The following types are recognized:
 
-* "homepage": Home page of the library. This is the main URL used as entry point
-  for looking up information about the library. All manifests should contain
-  a homepage URL.
-* "download": Download area where the source code of the library can be
-  downloaded. This is not the download of the specific version of the library.
-  This is described in the packages section.
-* "vcs": URL of the source code repository where the library is developed.
-* "tutorial": URL to tutorial-style documentation how to use the library.
-* "api_docs": URL to reference documentation of the API of the library.
-* "description_source": If the description text is taken from another source
-  this URL points to the source.
-* "announcement": Link to release announcement
-* "mailing_list": Mailing list for discussing the library
-* "contact": Contact information
-* "custom": Array of pairs of title and URL of custom links
+Attribute            | Description
+---------------------|----------------
+`homepage`           | Home page of the library. This is the main URL used as entry point for looking up information about the library. All manifests should contain a homepage URL.
+`download`           | Download area where the source code of the library can be downloaded. This is not the download of the specific version of the library. This is described in the packages section.
+`vcs`                | URL of the source code repository where the library is developed. This should point to the home of the repo, not to a specific release.
+`tutorial`           | URL to tutorial-style documentation how to use the library.
+`api_docs`           | URL to reference documentation of the API of the library.
+`description_source` | If the description text is taken from another source this URL points to the source.
+`announcement`       | Link to release announcement
+`mailing_list`       | Mailing list for discussing the library
+`contact`            | Contact information
+`custom`             | Array of pairs of title and URL of custom links
 
 *the homepage is a mandatory url attribute*
 

data/schema/generic-manifest-v1

@@ -10,6 +10,13 @@
     "summary": {
       "type": "string"
     },
+    "topics": {
+      "type": "array",
+      "items": {
+       "type": "string"
+      },
+      "minItems": 1
+    },
     "urls": {
       "type": "object",
       "properties": {

data/schema/proprietary-release-manifest-v1

@@ -16,6 +16,13 @@
     "summary": {
       "type": "string"
     },
+    "topics": {
+      "type": "array",
+      "items": {
+       "type": "string"
+      },
+      "minItems": 1
+    },
     "urls": {
       "type": "object",
       "properties": {

data/schema/release-manifest-v1

@@ -16,6 +16,13 @@
     "summary": {
       "type": "string"
     },
+    "topics": {
+      "type": "array",
+      "items": {
+       "type": "string"
+      },
+      "minItems": 1
+    },
     "urls": {
       "type": "object",
       "properties": {

data/spec/data/inqlude-all.json

@@ -5,6 +5,9 @@
     "release_date": "2013-09-08",
     "version": "0.2.0",
     "summary": "Awesome library",
+    "topics": [
+      "API"
+    ],
     "urls": {
       "homepage": "http://example.com",
       "download": "http://example.com/download"
@@ -76,6 +79,9 @@
     "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
     "name": "newlib",
     "summary": "A new lib under heavy development",
+    "topics": [
+      "Bindings"
+    ],
     "urls": {
       "homepage": "http://new.example.org",
       "download": "http://new.example.org/download"

data/spec/data/{awesomelib → manifests/awesomelib}/awesomelib.2013-09-08.manifest

@@ -4,6 +4,9 @@
   "release_date": "2013-09-08",
   "version": "0.2.0",
   "summary": "Awesome library",
+  "topics": [
+    "API"
+  ],
   "urls": {
     "homepage": "http://example.com",
     "download": "http://example.com/download"

data/spec/data/{newlib → manifests/newlib}/newlib.manifest

@@ -2,6 +2,9 @@
   "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
   "name": "newlib",
   "summary": "A new lib under heavy development",
+  "topics": [
+    "Bindings"
+  ],
   "urls": {
     "homepage": "http://new.example.org",
     "download": "http://new.example.org/download"

data/spec/data/missing-topics/miss-topics/miss-topics.manifest

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
+  "name": "miss-topics",  
+  "summary": "Missing topics",
+  "urls": {
+    "homepage": "http://missing-topics.org",
+    "download": "http://missing-topics.org/download"
+  },
+  "licenses": [
+    "GPLv3"
+  ],
+  "description": "This is a library with topics missing.",
+  "authors": [
+    "Cornelius Schumacher <schumacher@kde.org>"
+  ],
+  "platforms": [
+    "Linux",
+    "Windows"
+  ]
+}

data/spec/data/missing-topics/no-topics/no-topics.manifest

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
+  "name": "no-topics",
+  "summary": "No topics",
+  "urls": {
+    "homepage": "http://no-topics.org",
+    "download": "http://no-topics.org/download"
+  },
+  "licenses": [
+    "GPLv3"
+  ],
+  "description": "This is a library with no topics.",
+  "authors": [
+    "Cornelius Schumacher <schumacher@kde.org>"
+  ],
+  "platforms": [
+    "Linux",
+    "Windows"
+  ]
+}

data/spec/integration/cli_general_spec.rb

@@ -22,9 +22,7 @@ describe "Command line interface" do
     use_given_filesystem
 
     it "recognizes --offline option" do
-      dir = given_directory do
-        given_directory_from_data("awesomelib")
-      end
+      dir = given_directory_from_data("manifests")
 
       # This doesn't make much sense to a user, but that's what it is right now.
       # It will go away when we switched to GLI

data/spec/integration/cli_list_spec.rb

@@ -11,8 +11,8 @@ describe "Command line interface" do
     it "lists libraries" do
 
       dir = given_directory do
-        given_directory_from_data("awesomelib")
-        given_directory_from_data("newlib")
+        given_directory_from_data("awesomelib", from: "manifests/awesomelib")
+        given_directory_from_data("newlib", from: "manifests/newlib")
       end
 
       result = run_command(args: ["list", "--remote", "--offline",

data/spec/integration/cli_verify_spec.rb

@@ -10,7 +10,7 @@ describe "Command line interface" do
   describe "verify" do
     it "verifies single manifest" do
       dir = given_directory do
-        given_directory_from_data("awesomelib")
+        given_directory_from_data("awesomelib", from: "manifests/awesomelib")
       end
 
       result = run_command(args: ["verify",
@@ -20,8 +20,8 @@ describe "Command line interface" do
 
     it "verifies all manifests" do
       dir = given_directory do
-        given_directory_from_data("awesomelib")
-        given_directory_from_data("newlib")
+        given_directory_from_data("awesomelib", from: "manifests/awesomelib")
+        given_directory_from_data("newlib", from: "manifests/newlib")
       end
 
       result = run_command(args: ["verify", "--offline", "--manifest_dir=#{dir}"])
@@ -29,14 +29,14 @@ describe "Command line interface" do
 Verify manifest awesomelib.2013-09-08.manifest...ok
 Verify manifest newlib.manifest...ok
 
-2 manifests checked. 2 ok, 0 with error.
+2 manifests checked. 2 ok, 0 with error, 0 have warnings.
 EOT
       expect(result).to exit_with_success(expected_output)
     end
 
     it "verifies all manifests with syntax error" do
       dir = given_directory do
-        given_directory_from_data("awesomelib")
+        given_directory_from_data("awesomelib", from: "manifests/awesomelib")
         given_directory("newlib") do
           given_dummy_file("newlib.manifest")
         end
@@ -48,7 +48,7 @@ EOT
 
     it "verifies all manifests with schema error" do
       dir = given_directory do
-        given_directory_from_data("awesomelib")
+        given_directory_from_data("awesomelib", from: "manifests/awesomelib")
         given_directory_from_data("broken")
       end
 
@@ -63,8 +63,9 @@ Verify manifest broken.manifest...error
   Schema validation error: The property '#/' did not contain a required property of 'licenses' in schema http://inqlude.org/schema/generic-manifest-v1#
   Schema validation error: The property '#/' did not contain a required property of 'description' in schema http://inqlude.org/schema/generic-manifest-v1#
   Schema validation error: The property '#/' did not contain a required property of 'platforms' in schema http://inqlude.org/schema/generic-manifest-v1#
+  Warning: missing `topics` attribute
 
-2 manifests checked. 1 ok, 1 with error.
+2 manifests checked. 1 ok, 1 with error, 1 has warning.
 
 Errors:
   broken.manifest
@@ -78,5 +79,41 @@ Errors:
 EOT
       expect(result).to exit_with_error(1,"",expected_output)
     end
+
+    it "verifies manifests with one warning" do
+      dir = given_directory do
+        given_directory_from_data("awesomelib", from: "manifests/awesomelib")
+        given_directory_from_data("miss-topics", from: "missing-topics/miss-topics")
+      end
+
+      result = run_command(args: ["verify", "--offline", "--manifest_dir=#{dir}"])
+      expected_output = <<EOT
+Verify manifest awesomelib.2013-09-08.manifest...ok
+Verify manifest miss-topics.manifest...ok
+  Warning: missing `topics` attribute
+
+2 manifests checked. 2 ok, 0 with error, 1 has warning.
+EOT
+      expect(result).to exit_with_success(expected_output)
+    end
+
+    it "verifies manifests with multiple warnings" do
+      dir = given_directory do
+        given_directory_from_data("miss-topics", from: "missing-topics/miss-topics")
+        given_directory_from_data("no-topics", from: "missing-topics/no-topics")
+      end
+
+      result = run_command(args: ["verify", "--offline", "--manifest_dir=#{dir}"])
+      expected_output = <<EOT
+Verify manifest miss-topics.manifest...ok
+  Warning: missing `topics` attribute
+Verify manifest no-topics.manifest...ok
+  Warning: missing `topics` attribute
+
+2 manifests checked. 2 ok, 0 with error, 2 have warnings.
+EOT
+      expect(result).to exit_with_success(expected_output)
+    end
+
   end
 end