inqlude 0.8.0 → 0.9.0

data/spec/unit/kde_frameworks_release_spec.rb

@@ -1,9 +1,7 @@
 require File.expand_path('../spec_helper', __FILE__)
 
 describe KdeFrameworksRelease do
-
   include GivenFilesystemSpecHelpers
-
   use_given_filesystem
 
   context "given KDE generic manifests" do
@@ -28,49 +26,64 @@ describe KdeFrameworksRelease do
 
     it "reads generic manifests" do
       k = KdeFrameworksRelease.new @manifest_handler
-      k.read_generic_manifests
 
-      expect( k.generic_manifests.count ).to eq 2
-      expect( k.generic_manifests[0].name ).to eq "karchive"
-      expect( k.generic_manifests[1].name ).to eq "kservice"
+      expected_output = <<EOT
+Reading generic manifests from '#{@manifest_dir}'...
+Read 2 manifests.
+EOT
+
+      expect {
+        k.read_generic_manifests
+      }.to output(expected_output).to_stdout
+
+      expect(k.generic_manifests.count).to eq 2
+      expect(k.generic_manifests[0].name).to eq "karchive"
+      expect(k.generic_manifests[1].name).to eq "kservice"
     end
 
     it "writes release manifests" do
       k = KdeFrameworksRelease.new @manifest_handler
-      k.read_generic_manifests
+      expect {
+        k.read_generic_manifests
+      }.to output.to_stdout
+
+      expected_output = <<EOT
+Writing release manifests for version '4.9.90'...
+  #{@manifest_dir}/karchive/karchive.2014-02-01.manifest
+  #{@manifest_dir}/kservice/kservice.2014-02-01.manifest
+Written 2 manifests.
+EOT
 
-      k.write_release_manifests( "2014-02-01", "4.9.90" )
+      expect {
+        k.write_release_manifests("2014-02-01", "4.9.90")
+      }.to output(expected_output).to_stdout
 
-      manifest_path = File.join( @manifest_dir,
-                                 "karchive/karchive.2014-02-01.manifest" )
-      expect( File.exists? manifest_path ).to be true
+      manifest_path = File.join(@manifest_dir,"karchive/karchive.2014-02-01.manifest")
+      expect(File.exists? manifest_path).to be true
 
-      manifest_path = File.join( @manifest_dir,
-                                 "kservice/kservice.2014-02-01.manifest" )
-      expect( File.exists? manifest_path ).to be true
+      manifest_path = File.join(@manifest_dir,"kservice/kservice.2014-02-01.manifest")
+      expect(File.exists? manifest_path).to be true
 
-      manifest = Manifest.parse_file( manifest_path )
+      manifest = Manifest.parse_file(manifest_path)
       expect(manifest.class).to be ManifestRelease
-      expect( manifest.name ).to eq "kservice"
-      expect( manifest.version ).to eq "4.9.90"
-      expect( manifest.release_date ).to eq "2014-02-01"
+      expect(manifest.name).to eq "kservice"
+      expect(manifest.version).to eq "4.9.90"
+      expect(manifest.release_date).to eq "2014-02-01"
     end
   end
 
   it "creates release manifest from generic manifest" do
-    generic_manifest = Manifest.parse_file(
-      given_file("karchive-generic.manifest") )
+    generic_manifest = Manifest.parse_file(given_file("karchive-generic.manifest"))
     date = "2014-11-06"
     version = "5.4.0"
     release_manifest = KdeFrameworksRelease.create_release_manifest(
       generic_manifest, date, version)
-    expected_json = File.read( given_file("karchive-release-5.4.manifest") )
+    expected_json = File.read(given_file("karchive-release-5.4.manifest"))
     expected_json.chomp! # Remove newline added by File.read
-    expect( release_manifest.to_json ).to eq expected_json
+    expect(release_manifest.to_json).to eq expected_json
   end
 
   it "strips patch release" do
     expect(KdeFrameworksRelease.strip_patch_release("5.4.0")).to eq "5.4"
   end
-
 end

data/spec/unit/manifest_handler_spec.rb

@@ -87,6 +87,12 @@ describe ManifestHandler do
       expect( libraries[1].manifests.last.name ).to eq "commercial"
     end
 
+    it "returns latest libraries" do
+      libraries = mh.latest_libraries
+      expect(libraries.first.manifests.last.name).to eq "proprietarylib"
+      expect(libraries).not_to include "newlib"
+    end
+
   end
 
   describe "#group" do
@@ -97,6 +103,14 @@ describe ManifestHandler do
     end
   end
 
+  describe "#topic" do
+    it "returns all libraries of a topic" do
+      libraries = mh.topic("API")
+      expect( libraries.count ).to eq 2
+      expect( libraries.first.manifests.last.name ).to eq "awesomelib"
+    end
+  end
+
   describe "#library" do
 
     it "returns one library" do
@@ -145,7 +159,7 @@ describe ManifestHandler do
   end
 
   it "generates inqlude-all.json" do
-    expected_json = File.read(test_data_path("inqlude-all.json"))
+    expected_json = File.read(test_data_path("inqlude-all.json")).chomp
     expect(mh.generate_inqlude_all).to eq expected_json
   end
 end

data/spec/unit/manifest_spec.rb

@@ -68,7 +68,7 @@ describe Manifest do
   it "writes JSON for release manifest" do
     filename = File.join settings.manifest_path, awesomelib_manifest_file
     manifest = Manifest.parse_file filename
-    expect( manifest.to_json ).to eq File.read( filename )
+    expect( manifest.to_json ).to eq File.read( filename ).chomp
   end
 
   it "writes JSON for generic manifest" do

data/spec/unit/spec_helper.rb

@@ -1,11 +1,21 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'given_filesystem/spec_helpers'
 
 require_relative "../../lib/inqlude"
 
+require "nokogiri"
+require "open-uri"
+
 def test_data_path file_name
   File.expand_path(File.join('../../data/', file_name), __FILE__)
 end
 
+def stubs_path(context)
+  File.expand_path(File.join('../../stubs/', context), __FILE__)
+end
+
 def create_manifest name, release_date, version
   m = ManifestRelease.new
   m.name = name

data/spec/unit/view_spec.rb

@@ -44,6 +44,15 @@ describe View do
       expect(v.commercial_libraries.count).to eq mh.commercial_libraries.count
       expect(v.commercial_libraries.first.name).to eq mh.commercial_libraries.first.name
     end
+
+    it "returns list of latest libraries" do
+      mh = ManifestHandler.new settings
+      mh.read_remote
+      v = View.new mh
+
+      expect(v.latest_libraries.count).to eq mh.latest_libraries.count
+      expect(v.latest_libraries.first.name).to eq mh.latest_libraries.first.name
+    end
     
     it "returns group" do
       mh = ManifestHandler.new settings
@@ -54,6 +63,15 @@ describe View do
       expect(v.group.count).to eq mh.group("kde-frameworks").count
       expect(v.group.first.name).to eq mh.group("kde-frameworks").first.name
     end
+
+    it "returns topic" do
+      mh = ManifestHandler.new settings
+      mh.read_remote
+      v = View.new mh
+
+      expect(v.topic("API").count).to eq 2
+      expect(v.topic("API").first.name).to eq 'awesomelib'
+    end
   end
   
   context "generic manifest and one release" do
@@ -173,4 +191,54 @@ EOT
     end
   end
 
+  context "templates" do
+    include_context "manifest_files"
+
+    include GivenFilesystemSpecHelpers
+
+    use_given_filesystem
+
+    before(:each) do
+      mh = ManifestHandler.new(settings)
+      mh.read_remote
+
+      v = View.new mh
+      v.templates = "one-column"
+
+      dir = given_directory
+
+      v.create(dir)
+      @path = File.join(dir, "index.html")
+    end
+
+    it "generates templates" do
+      expect(File.exists?(@path)).to be true
+    end
+
+    it "checks content" do
+      html_data = File.read(@path)
+
+      nokogiri_object = Nokogiri::HTML(html_data)
+      paragraphs_content = nokogiri_object.xpath("//p").to_s
+
+      expected_content =
+      '<p>
+        The goal of Inqlude is to provide a comprehensive listing of all
+        existing libraries for developers of Qt applications. If you are creating
+        applications using the <a href="http://qt-project.org">Qt toolkit</a>, and
+        are looking for libraries, components
+        or modules to use, Inqlude is the place where you find all information and
+        pointers to get started.
+      </p><p>
+        This is a young project, we are still collecting information, and are
+        building up the web site and the tools around it. If you would like to get
+        involved, read more about <a href="contribute.html">how to contribute</a>, or go
+        to the mailing list
+        <a href="https://mail.kde.org/mailman/listinfo/inqlude">inqlude.kde.org</a>
+        to directly talk to us. See you there.
+      </p>'
+
+      expect(paragraphs_content).to eq(expected_content)
+    end
+  end
 end

data/topics/Manifest_updater/README.md

@@ -0,0 +1,19 @@
+**This directory contains a node.js program to update the manifests with topics from 
+the file `topics.csv`.** 
+
+Follow the instructions given below to run the program.
+
+* Install node.js and npm.
+* Copy the library folders that contain the manifest files required to be updated 
+and paste them at `manifests` directory and `update_manifests` directory. 
+* Run `npm install` from this directory.
+* Then run `node app.js` from this directory.
+* You will find the updated manifests at `update_manifests` directory.
+
+
+**Note:**
+* You should have the `topics.csv` file in the same directory that contains `app.js`.
+* Having the manifest files at `manifests` directory is adequate, but make sure that 
+you have the same library folder structure at both `manifests` directory and 
+`update_manifests` directory.
+* Also make sure that you have the details for the required update activity at `topics.csv`.

data/topics/Manifest_updater/app.js

@@ -0,0 +1,43 @@
+var fs = require('fs');
+var recursive = require('recursive-readdir');
+
+var parse = require('csv-parse');
+var csvAr;
+
+var parser = parse({delimiter: ','}, function(err, data){
+    csvAr = data;
+});
+
+fs.createReadStream(__dirname+'/topics.csv').pipe(parser);
+
+recursive('manifests', function (err, files) {
+  for (var i = files.length - 1; i >= 0; i--) {
+    var fi = files[i];
+    var data = fs.readFileSync(fi, 'utf8');
+    var manifest = JSON.parse(data);
+    var name = manifest.name;
+    var sel = csvAr.filter(function(d) {
+         return d[0] == name;
+    })[0];
+
+    if(!sel){
+      console.log(fi);
+    }
+    var sel1 = sel;
+    
+    sel1 = sel.slice(1);
+    for (var j = 0; j < sel1.length ; j++) {
+       if(sel1[j] === ''){
+         sel1 = sel1.slice(0,j);
+         break;
+       }
+    }
+    
+    manifest.topics = sel1;
+    var data1 = JSON.stringify(manifest, null, 2) + '\n';
+    
+    var fi2 = 'update_'+ fi;
+    fs.writeFileSync(fi2, data1);
+  }
+});
+

data/topics/Manifest_updater/manifests/example/example.manifest

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
+  "name": "example",
+  "summary": "An example library",  
+  "urls": {
+    "homepage": "http://example.org",
+    "download": "http://example.org/download"
+  },
+  "licenses": [
+    "GPLv3"
+  ],
+  "description": "This is an example library",
+  "authors": [
+    "Nanduni Nimalsiri <nandunibw@gmail.com>"
+  ],
+  "platforms": [
+    "Linux",
+    "Windows"
+  ]
+}

data/topics/Manifest_updater/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "Nanduni",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "csv-parse": "^1.1.3",
+    "recursive-readdir": "^2.0.0"
+  }
+}

data/topics/Manifest_updater/topics.csv

@@ -0,0 +1 @@
+example,API,QML,

data/topics/Manifest_updater/update_manifests/example/example.manifest

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
+  "name": "example",
+  "summary": "An example library",
+  "urls": {
+    "homepage": "http://example.org",
+    "download": "http://example.org/download"
+  },
+  "licenses": [
+    "GPLv3"
+  ],
+  "description": "This is an example library",
+  "authors": [
+    "Nanduni Nimalsiri <nandunibw@gmail.com>"
+  ],
+  "platforms": [
+    "Linux",
+    "Windows"
+  ],
+  "topics": [
+    "API",
+    "QML"
+  ]
+}

data/topics/topics.csv

@@ -100,6 +100,7 @@ libqtlua,Scripting,,
 libqxt,Development,Widgets,
 libsystemd-qt,Bindings,,
 libtmdbqt,API,Data,
+limereport,Printing,,
 log4qt,Development,Logging,
 log4qt-fork,Development,Logging,
 lxqt_wallet,Security,,
@@ -168,9 +169,11 @@ qtoptimization,Development,,
 qtorm,Web,Data,
 qtrest,Communication,API,
 qtrpt,Printing,,
+qtsharp,Development,,
 qtspeech,Bindings,Multimedia,
 qtuio,Mobile,,
 qtuiotouch,Mobile,,
+qtunits,Data,,
 qtvkontakte,Mobile,,
 qtwebapp,Web,,
 qtwebkit,Web,,

data/view/{library.html.haml → one-column/library.html.haml}

@@ -10,7 +10,7 @@
 = list_attribute "platforms"
 = list_attribute "authors"
 = list_attribute_content "Home page", link( m.urls.homepage )
-
+= list_attribute "topics"
 = render_description
 
 - if more_urls?

data/view/two-column/about.html.haml

@@ -0,0 +1,34 @@
+%home
+  = link_to "Home", "index"
+
+%h3 About Inqlude
+
+%p
+  The goal of Inqlude is to provide a comprehensive listing of all
+  existing libraries for developers of Qt applications. If you are creating
+  applications using the Qt toolkit, and are looking for libraries, components
+  or modules to use, Inqlude is the place where you find all information and
+  pointers to get started.
+%p
+  Inqlude comes with a command line client for handling libraries. See the
+  = link_to "instructions how to get libraries", "get"
+  for more details.
+%p
+  Inqlude aims to be a complete archive of all available Qt based
+  libraries. If you notice that there is some information missing, outdated
+  or inaccurate, please consider contributing the missing data. See the
+  = link_to "instructions how to contribute", "contribute"
+  for more details.
+%p
+  %em
+    Note that Inqlude is currently in alpha state. It's not ready for full
+    production use yet. Data is still incomplete, and the tools are
+    limited. Feedback and input is appreciated.
+%p
+  If you have questions of comments please feel free to write to the Inqlude
+  mailing list #{link_to "inqlude@kde.org", "mailto:inqlude@kde.org"}.
+%p
+  Inqlude was created by
+  = link_to "Cornelius Schumacher", "mailto:schumacher@kde.org"
+  with the help of many others, and is a proud  member of the KDE family.
+%br