inqlude 0.8.0 → 0.9.0

data/manifest-format.md

@@ -12,7 +12,7 @@ path, but by default the inqlude command line tool assumes the path
 
 The manifest directory is under version control by git.
 
-Each library reprented in the Inqlude system has its own sub-directory in the
+Each library represented in the Inqlude system has its own sub-directory in the
 manifest directory. The name of the sub-directory is the name of the library.
 See there for more information about its specification and how it's used.
 
@@ -38,7 +38,7 @@ This is a reference to the schema which is used in the manifest file. The
 schema follows the [JSON Schema](http://json-schema.org) specification.
 
 The schema comes in three flavors: "generic", "release", and
-"proprietary-release". They differe in what fields are required, the meaning of
+"proprietary-release". They differ in what fields are required, the meaning of
 fields is the same in all. "generic" is a subset of "proprietary-release", which
 is a subset of "release".
 
@@ -74,13 +74,23 @@ other library and a "-qt" suffix. For example the Qt bindings to PackageKit
 are named "packagekit-qt" in Inqlude.
 
 It's used as internal handle by the tools and shows up where it
-needs to be processed by software, e.g. as an identifier as paramezer of the
+needs to be processed by software, e.g. as an identifier as parameter of the
 command line tool or as part of the URL on the web site. The name has to be
 identical with the value of the name attribute of the manifest files
 representing the different versions of the library.
 
 *name is a mandatory attribute*
 
+### display_name
+
+The real name of the library that is displayed in the website. 
+
+This holds the name in a way formatted for best human readability. This can contain
+characters which are upper-case, lower-case, alphanumeric, symbols and
+special signs.  
+
+*display_name is an optional attribute*
+
 ### release_date
 
 Date, when the version was released
@@ -101,6 +111,21 @@ This is the main description of the library used in summary lists etc.
 
 *summary is a mandatory attribute*
 
+### topics
+
+Array of strings identifying the topics to which the library belongs.
+
+Topics are used to categorize libraries. Each library has at least one topic, 
+but can have more than one. 
+
+At the moment valid topics are:
+
+"API", "Artwork", "Bindings", "Communication", "Data", "Desktop", "Development", 
+"Graphics", "Logging", "Mobile", "Multimedia", "Printing", "QML", "Scripting", 
+"Security", "Text", "Web", "Widgets"
+
+*topics is an optional attribute, preferred to have at least one topic*
+
 ### urls
 
 List of URLs relevant to the library
@@ -216,13 +241,13 @@ openSUSE binary packages. For each version of openSUSE there is a separate
 entry.
 
 Each entry contains the package_name, repository, and source_rpm attributes.
-The repository contains an url and a name sub-attribute.
+The repository contains a url and a name sub-attribute.
 
 ### group
 
 Name of a group
 
 The group optionally specifies the name of a group of libraries the library
-described my the manifest belongs to.
+described by the manifest belongs to.
 
 At the moment only the value "kde-frameworks" is used.

data/spec/data/inqlude-all.json

@@ -2,6 +2,7 @@
   {
     "$schema": "http://inqlude.org/schema/release-manifest-v1#",
     "name": "awesomelib",
+    "display_name": "Awesomelib",
     "release_date": "2013-09-08",
     "version": "0.2.0",
     "summary": "Awesome library",
@@ -10,7 +11,8 @@
     ],
     "urls": {
       "homepage": "http://example.com",
-      "download": "http://example.com/download"
+      "download": "http://example.com/download",
+      "vcs": "http://example.com/git"
     },
     "licenses": [
       "LGPLv2.1+",
@@ -35,6 +37,9 @@
     "release_date": "2012-01-01",
     "version": "edge",
     "summary": "Bleeding edge version of a library",
+    "topics": [
+      "API"
+    ],
     "urls": {
       "homepage": "http://example.org",
       "download": "http://example.org/download"
@@ -59,6 +64,9 @@
     "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
     "name": "commercial",
     "summary": "Commercial library",
+    "topics": [
+      "Data"
+    ],
     "urls": {
       "homepage": "http://commercial.example.org"
     },
@@ -78,6 +86,7 @@
   {
     "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
     "name": "newlib",
+    "display_name": "Newlib",
     "summary": "A new lib under heavy development",
     "topics": [
       "Bindings"
@@ -123,4 +132,4 @@
       "OS X"
     ]
   }
-]
+]

data/spec/data/manifests/awesomelib/awesomelib.2013-09-08.manifest

@@ -1,6 +1,7 @@
 {
   "$schema": "http://inqlude.org/schema/release-manifest-v1#",
   "name": "awesomelib",
+  "display_name": "Awesomelib",
   "release_date": "2013-09-08",
   "version": "0.2.0",
   "summary": "Awesome library",
@@ -9,7 +10,8 @@
   ],
   "urls": {
     "homepage": "http://example.com",
-    "download": "http://example.com/download"
+    "download": "http://example.com/download",
+    "vcs": "http://example.com/git"
   },
   "licenses": [
     "LGPLv2.1+",
@@ -27,4 +29,4 @@
     "source": "ftp://example.com/download/awesomelib-0.2.0.tar.gz"
   },
   "group": "kde-frameworks"
-}
+}

data/spec/data/manifests/bleedingedge/bleedingedge.2012-01-01.manifest

@@ -4,6 +4,9 @@
   "release_date": "2012-01-01",
   "version": "edge",
   "summary": "Bleeding edge version of a library",
+  "topics": [
+    "API"
+  ],
   "urls": {
     "homepage": "http://example.org",
     "download": "http://example.org/download"

data/spec/data/manifests/commercial/commercial.manifest

@@ -2,6 +2,9 @@
   "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
   "name": "commercial",
   "summary": "Commercial library",
+  "topics": [
+    "Data"
+  ],
   "urls": {
     "homepage": "http://commercial.example.org"
   },

data/spec/data/manifests/newlib/newlib.manifest

@@ -1,6 +1,7 @@
 {
   "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
   "name": "newlib",
+  "display_name": "Newlib",
   "summary": "A new lib under heavy development",
   "topics": [
     "Bindings"

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

@@ -1,6 +1,7 @@
 {
   "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
-  "name": "miss-topics",  
+  "name": "miss-topics",
+  "display_name": "Miss-topics",
   "summary": "Missing topics",
   "urls": {
     "homepage": "http://missing-topics.org",

data/spec/integration/cli_verify_spec.rb

@@ -63,6 +63,7 @@ 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 `display_name` attribute
   Warning: missing `topics` attribute
 
 2 manifests checked. 1 ok, 1 with error, 1 has warning.
@@ -108,6 +109,7 @@ EOT
 Verify manifest miss-topics.manifest...ok
   Warning: missing `topics` attribute
 Verify manifest no-topics.manifest...ok
+  Warning: missing `display_name` attribute
   Warning: missing `topics` attribute
 
 2 manifests checked. 2 ok, 0 with error, 2 have warnings.

data/spec/integration/cli_view_spec.rb

@@ -24,5 +24,107 @@ describe "Command line interface" do
       expect(File.exist?(File.join(output_dir, "libraries", "awesomelib.html"))).to be(true)
       expect(File.exist?(File.join(output_dir, "libraries", "newlib.html"))).to be(true)
     end
+
+    it "checks templates direstory" do
+      dir = given_directory do
+        given_directory_from_data("awesomelib", from: "manifests/awesomelib")
+        given_directory_from_data("newlib", from: "manifests/newlib")
+      end
+
+      output_dir = given_directory
+
+      result = run_command(args: ["view", "--offline", "--manifest_dir=#{dir}",
+        "--output-dir=#{output_dir}", "--templates=one-column"])
+      expect(result).to exit_with_success(/Creating web site/)
+
+      result = run_command(args: ["view", "--offline", "--manifest_dir=#{dir}",
+        "--output-dir=#{output_dir}", "--templates=unreal-template"])
+      expected_output = <<EOT
+Error: Templates directory doesn't exist
+EOT
+      expect(result).to exit_with_error(1, expected_output)
+    end
+
+    it "generates templates" do
+      dir = given_directory do
+        given_directory_from_data("awesomelib", from: "manifests/awesomelib")
+        given_directory_from_data("newlib", from: "manifests/newlib")
+      end
+
+      output_dir = given_directory
+
+      result = run_command(args: ["view", "--offline", "--manifest_dir=#{dir}",
+        "--output-dir=#{output_dir}", "--templates=one-column"])
+      expect(result).to exit_with_success(/Creating web site/)
+
+      expect(File.exist?(File.join(output_dir, "index.html"))).to be(true)
+      expect(File.exist?(File.join(output_dir, "libraries", "awesomelib.html"))).to be(true)
+      expect(File.exist?(File.join(output_dir, "libraries", "newlib.html"))).to be(true)
+    end
+    
+    context "inqlude-all.json" do
+      before(:each) do
+        @manifest_dir = given_directory do
+          given_directory_from_data("awesomelib", from: "manifests/awesomelib")
+          given_directory_from_data("newlib", from: "manifests/newlib")
+        end
+
+        @output_dir = given_directory
+
+        run_command(args: ["view",  "--offline", "--manifest_dir=#{@manifest_dir}",
+          "--output-dir=#{@output_dir}"])
+      end
+
+      it "checks number of manifests" do
+        data = File.read(File.join(@output_dir, 'inqlude-all.json'))
+        parsed_data = JSON.parse(data);
+
+        settings = Settings.new
+        settings.manifest_path = @manifest_dir
+        settings.offline = true
+        handler = ManifestHandler.new settings
+        handler.read_remote
+
+        expect(handler.libraries.length).to eq parsed_data.length
+      end
+
+      it "checks content" do
+        data = File.read(File.join(@output_dir, 'inqlude-all.json'))
+        parsed_data = JSON.parse(data);
+        for element in parsed_data do
+          if element["name"] == "awesomelib"
+            library = element
+            break
+          end
+        end
+        
+        expect(library).to be
+
+        settings = Settings.new
+        handler = ManifestHandler.new settings
+        settings.manifest_path = @manifest_dir
+        settings.offline = true
+        handler.read_remote
+
+        manifest = handler.library("awesomelib").latest_manifest
+
+        expect(manifest.display_name).to eq "Awesomelib"
+        expect(manifest.release_date).to eq "2013-09-08"
+        expect(manifest.version).to eq "0.2.0"
+        expect(manifest.summary).to eq "Awesome library"
+        expect(manifest.topics).to eq ["API"]
+
+        expect(manifest.urls.homepage).to eq "http://example.com"
+        expect(manifest.urls.download).to eq "http://example.com/download"
+        expect(manifest.urls.vcs).to eq "http://example.com/git"
+
+        expect(manifest.licenses).to eq ["LGPLv2.1+", "Commercial"]
+        expect(manifest.description).to eq "This is an awesome library."
+        expect(manifest.authors).to eq ["Cornelius Schumacher <schumacher@kde.org>"]
+        expect(manifest.maturity).to eq "stable"
+
+        expect(manifest.packages.source).to eq "ftp://example.com/download/awesomelib-0.2.0.tar.gz"
+      end
+    end
   end
 end

data/spec/integration/spec_helper.rb

@@ -1,2 +1,5 @@
 require "cli_tester"
 require "given_filesystem/spec_helpers"
+require "json"
+
+require_relative "../../lib/inqlude"

data/spec/online/cli_view_spec.rb

@@ -0,0 +1,64 @@
+require_relative "spec_helper"
+
+include CliTester
+
+describe "Command line interface" do
+  include GivenFilesystemSpecHelpers
+
+  use_given_filesystem
+
+  describe "view" do
+    before(:each) do
+      @output_dir = given_directory
+      run_command(args: ["view", "--output-dir=#{@output_dir}"])
+    end
+
+    it "generates inqlude-all.json from online data" do
+      data = File.read(File.join(@output_dir, 'inqlude-all.json'))
+      parsed_data = JSON.parse(data);
+
+      settings = Settings.new
+      handler = ManifestHandler.new settings
+      handler.read_remote
+
+      expect(handler.libraries.length).to eq parsed_data.length
+
+      for element in parsed_data do
+        if element["name"] == "baloo"
+        library = element
+        break
+        end
+      end
+
+      manifest = handler.library("baloo").latest_manifest
+
+      expect(manifest.display_name).to eq library["display_name"]
+      expect(manifest.release_date).to eq library["release_date"]
+      expect(manifest.version).to eq library["version"]
+      expect(manifest.summary).to eq library["summary"]
+      expect(manifest.topics).to eq library["topics"]
+
+      expect(manifest.urls.homepage).to eq library["urls"]["homepage"]
+      expect(manifest.urls.api_docs).to eq library["urls"]["api_docs"]
+      expect(manifest.urls.download).to eq library["urls"]["download"]
+      expect(manifest.urls.tutorial).to eq library["urls"]["tutorial"]
+      expect(manifest.urls.vcs).to eq library["urls"]["vcs"]
+      expect(manifest.urls.description_source).to eq library["urls"]["description_source"]
+      expect(manifest.urls.announcement).to eq library["urls"]["announcement"]
+      expect(manifest.urls.mailing_list).to eq library["urls"]["mailing_list"]
+      expect(manifest.urls.contact).to eq library["urls"]["contact"]
+      expect(manifest.urls.custom).to eq library["urls"]["custom"]
+
+      expect(manifest.licenses).to eq library["licenses"]
+      expect(manifest.description).to eq library["description"]
+      expect(manifest.authors).to eq library["authors"]
+      expect(manifest.maturity).to eq library["maturity"]
+
+      expect(manifest.packages.source).to eq library["packages"]["source"]
+      expect(manifest.packages.openSUSE).to eq library["packages"]["openSUSE"]
+      expect(manifest.packages.windows).to eq library["packages"]["windows"]
+      expect(manifest.packages.ubuntu).to eq library["packages"]["ubuntu"]
+      expect(manifest.packages.osx).to eq library["packages"]["osx"]
+    end
+  end
+end

data/spec/online/spec_helper.rb

@@ -0,0 +1,5 @@
+require "cli_tester"
+require "given_filesystem/spec_helpers"
+require "json"
+
+require_relative "../../lib/inqlude"

data/spec/stubs/qmake/qmake

@@ -0,0 +1,2 @@
+echo QMake version 2.01a
+echo Using Qt version 4.8.6 in /usr/lib64hello

data/spec/unit/cli_controller_spec.rb

@@ -0,0 +1,51 @@
+require_relative "spec_helper"
+
+class DistroUnknown
+  def name
+    "<unknown distro>"
+  end
+
+  def version
+    "<unknown version>"
+  end
+end
+
+describe CliController do
+  let(:distro) {DistroUnknown.new}
+
+  describe ".print_versions" do
+    context "with qmake installed" do
+      before do
+        ENV["PATH"] = stubs_path("qmake") + ":" + ENV["PATH"]
+      end
+
+      it "prints versions" do
+        expected_output = <<EOT
+Inqlude: #{Inqlude::VERSION}
+Qt: 4.8.6
+OS: <unknown distro> <unknown version>
+EOT
+        expect {
+          CliController.print_versions(distro)
+        }.to output(expected_output).to_stdout
+      end
+    end
+
+    context "without qmake installed" do
+      before do
+        allow(CliController).to receive(:find_executable).with("qmake").and_return(false)
+      end
+
+      it "prints versions" do
+        expected_output = <<EOT
+Inqlude: #{Inqlude::VERSION}
+Qt: not found
+OS: <unknown distro> <unknown version>
+EOT
+        expect {
+          CliController.print_versions(distro)
+        }.to output(expected_output).to_stdout
+      end
+    end
+  end
+end