inqlude 0.0.8 → 0.7.0

data/spec/data/kservice-generic.manifest

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
+  "name": "kservice",
+  "display_name": "KService",
+  "summary": "Plugin framework for desktop services",
+  "urls": {
+    "homepage": "https://projects.kde.org/projects/frameworks/kservice",
+    "vcs": "https://projects.kde.org/projects/frameworks/kservice/repository",
+    "mailing_list": "https://mail.kde.org/mailman/listinfo/kde-frameworks-devel"
+  },
+  "licenses": [
+    "LGPLv2.1+"
+  ],
+  "description": "\nKService provides a plugin framework for handling desktop services. Services can\nbe applications or libraries. They can be bound to MIME types or handled by\napplication specific code.\n\n",
+  "authors": [
+    "The KDE Community"
+  ],
+  "platforms": [
+    "Linux"
+  ],
+  "group": "kde-frameworks"
+}

data/spec/data/kservice.readme

@@ -0,0 +1,9 @@
+# KService
+
+## Introduction
+
+## Links
+
+- Mailing list: <https://mail.kde.org/mailman/listinfo/kde-frameworks-devel>
+- IRC channel: #kde-devel on Freenode
+- Git repository: <https://projects.kde.org/projects/frameworks/kservice/repository>

data/spec/data/newlib/newlib.manifest

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
+  "name": "newlib",
+  "summary": "A new lib under heavy development",
+  "urls": {
+    "homepage": "http://new.example.org",
+    "download": "http://new.example.org/download"
+  },
+  "licenses": ["GPLv3"],
+  "description": "This is an awesome library. It's new.",
+  "authors": ["Cornelius Schumacher <schumacher@kde.org>"],
+  "platforms": [ "Linux", "Windows" ]
+}

data/spec/data/proprietarylib/proprietarylib.2013-12-22.manifest

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://inqlude.org/schema/proprietary-release-manifest-v1#",
+  "name": "proprietarylib",
+  "release_date": "2013-12-22",
+  "version": "1.2.1",
+  "summary": "Awesome proprietary library",
+  "urls": {
+    "homepage": "http://xyz.example.com",
+    "download": "http://xyz.example.com/download"
+  },
+  "licenses": ["LGPLv2.1+", "Commercial"],
+  "description": "This is an awesome proprietarylibrary.",
+  "authors": ["Cool Company"],
+  "maturity": "stable",
+  "platforms": [ "Linux", "Windows", "OS X" ]
+}

data/spec/data/rendertest-generic.manifest

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
+  "name": "rendertest",
+  "display_name": "RenderTest",
+  "summary": "Test manifest for testing rendering",
+  "urls": {
+    "homepage": "https://example.org",
+    "vcs": "https://example.org/git"
+  },
+  "licenses": [
+    "LGPLv2.1+"
+  ],
+  "description": "This description tests rendering. It tests rendering markdown to HTML.\n\nThis includes:\n\n- Paragraphs\n- Lists\n",
+  "authors": [
+    "Slartibartfass"
+  ],
+  "platforms": [
+    "Linux"
+  ]
+}

data/spec/data/testcontent

@@ -0,0 +1 @@
+This is my test content.

data/spec/kde_frameworks_creator_spec.rb

@@ -0,0 +1,263 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe KdeFrameworksCreator do
+  
+  include GivenFilesystemSpecHelpers
+
+  describe "#framework" do
+    it "raises error on invalid name" do
+      c = KdeFrameworksCreator.new
+      expect{c.framework("invalid-name")}.to raise_error
+    end
+  end
+  
+  describe "#fill_in_data" do
+    it "fills in all data" do
+      c = Creator.new Settings.new, "karchive"
+      manifest = c.create_generic_manifest
+
+      k = KdeFrameworksCreator.new
+      framework = {
+        "title" => "KArchive",
+        "introduction" => "The intro",
+        "link_git_repository" => "http://git.kde.org/karchive"
+      }
+      k.fill_in_data framework, manifest
+      
+      expect( manifest["display_name"] ).to eq "KArchive"
+      expect( manifest["description"] ).to eq "The intro"
+      expect( manifest["urls"]["vcs"] ).to eq "http://git.kde.org/karchive"
+    end
+  end
+
+  context "parse git checkout" do
+    
+    use_given_filesystem
+
+    context "multi-directory checkout" do
+      before(:each) do
+        @checkout_path = given_directory do
+          given_directory "karchive" do
+            given_dummy_file "README.md"
+            given_dummy_file "AUTHORS"
+          end
+          given_directory "threadweaver" do
+            given_dummy_file "README.md"
+            given_dummy_file "AUTHORS"
+          end
+          given_directory "kconfig" do
+            given_dummy_file "README.md"
+            given_dummy_file "AUTHORS"
+          end
+        end
+      end
+
+      it "parses checkout" do
+        c = KdeFrameworksCreator.new
+
+        c.parse_checkout @checkout_path
+        
+        expect( c.frameworks.sort ).to eq ["karchive", "kconfig", "threadweaver"]
+      end
+
+      it "generates manifests" do
+        c = KdeFrameworksCreator.new
+
+        c.parse_checkout @checkout_path
+
+        output_dir = given_directory
+        
+        c.create_manifests output_dir
+                
+        expect( File.exists? File.join(output_dir,"karchive",
+          "karchive.manifest") ).to be true
+        expect( File.exists? File.join(output_dir,"threadweaver",
+          "threadweaver.manifest") ).to be true
+        expect( File.exists? File.join(output_dir,"kconfig",
+          "kconfig.manifest") ).to be true
+      end
+    end
+
+    it "parses README" do
+      c = KdeFrameworksCreator.new
+      
+      framework_path = given_directory "karchive" do
+        given_file "README.md", :from => "karchive.readme"
+      end
+      
+      c.parse_readme framework_path
+
+      karchive = c.framework("karchive")
+      
+      expect( c.errors.count ).to eq 0
+      
+      expect(karchive["title"]).to eq "KArchive"
+      expect(karchive["introduction"]).to eq "KArchive provides classes for easy reading, creation and manipulation of\n\"archive\" formats like ZIP and TAR.\n\nIf also provides transparent compression and decompression of data, like the\nGZip format, via a subclass of QIODevice."
+      expect(karchive["link_mailing_list"]).to eq "https://mail.kde.org/mailman/listinfo/kde-frameworks-devel"
+      expect(karchive["link_git_repository"]).to eq "https://projects.kde.org/projects/frameworks/karchive/repository"
+      expect(karchive["link_home_page"]).to eq "https://projects.kde.org/projects/frameworks/karchive"
+      expect(karchive["summary"]).to eq "Reading, creation, and manipulation of file archives"
+    end
+
+    it "parses AUTHORS" do
+      c = KdeFrameworksCreator.new
+      
+      framework_path = given_directory "karchive" do
+        given_file "AUTHORS", :from => "karchive.authors"
+      end
+
+      c.parse_authors framework_path
+    
+      karchive = c.framework("karchive")
+      
+      expect(karchive["authors"]).to eq [ "Mario Bensi <mbensi@ipsquad.net>",
+        "David Faure <faure@kde.org>" ]
+    end
+    
+    it "generates warnings for missing files" do
+      c = KdeFrameworksCreator.new
+
+      checkout_path = given_directory do
+        given_directory "ki18n" do
+          given_dummy_file "README.md"
+        end
+      end
+      
+      c.parse_checkout checkout_path
+      
+      expect( c.warnings.count ).to eq 1
+      expect( c.warnings.first[:name] ).to eq "ki18n"
+      expect( c.warnings.first[:issue] ).to eq "missing_file"
+      expect( c.warnings.first[:details] ).to eq "AUTHORS"
+    end
+
+    it "generates errors for missing fields" do
+      c = KdeFrameworksCreator.new
+
+      checkout_path = given_directory do
+        given_directory "ki18n" do
+          given_dummy_file "README.md"
+        end
+      end
+      
+      c.parse_checkout checkout_path
+      
+      f = c.framework("ki18n")
+      
+      expect( c.errors.count ).to eq 4
+      
+      error_hash = {}
+      c.errors.each do |error|
+        error_hash[error[:issue]] = error
+      end
+      
+      expect( error_hash.has_key? "missing_title" ).to be true
+      expect( error_hash.has_key? "missing_summary" ).to be true
+      expect( error_hash.has_key? "missing_introduction" ).to be true
+      expect( error_hash.has_key? "missing_link_home_page" ).to be true
+    end
+    
+    it "generates error for missing summary" do
+      c = KdeFrameworksCreator.new
+
+      checkout_path = given_directory do
+        given_directory "kservice" do
+          given_file "README.md", :from => "kservice.readme"
+        end
+      end
+      
+      c.parse_checkout checkout_path
+      
+      f = c.framework("kservice")
+      
+      expect( f["title"] ).to eq "KService"
+      expect( f["summary"] ).to be nil
+      
+      expect( c.errors.count ).to eq 3
+    end
+      
+    it "optionally doesn't generate error for missing summary" do
+      c = KdeFrameworksCreator.new
+
+      checkout_path = given_directory do
+        given_directory "kservice" do
+          given_file "README.md", :from => "kservice.readme"
+        end
+      end
+      
+      c.parse_checkout checkout_path, :ignore_errors => [ "link_home_page" ]
+      
+      f = c.framework("kservice")
+      
+      expect( f["title"] ).to eq "KService"
+      expect( f["summary"] ).to be nil
+      
+      expect( c.errors.count ).to eq 2
+    end
+      
+    context "karchive as full example" do
+      before(:each) do
+        @checkout_path = given_directory do
+          given_directory "karchive" do
+            given_file "README.md", :from => "karchive.readme"
+            given_file "AUTHORS", :from => "karchive.authors"
+          end
+        end
+      end
+        
+      it "parses framework from checkout" do
+        c = KdeFrameworksCreator.new
+
+        c.parse_checkout @checkout_path
+        
+        karchive = c.framework("karchive")
+        expect(karchive["title"]).to eq "KArchive"
+        expect(karchive["link_git_repository"]).to eq "https://projects.kde.org/projects/frameworks/karchive/repository"
+        expect(karchive["authors"]).to eq [ "Mario Bensi <mbensi@ipsquad.net>",
+          "David Faure <faure@kde.org>" ]
+      end
+
+      it "generates manifest" do
+        c = KdeFrameworksCreator.new
+
+        c.parse_checkout @checkout_path
+
+        output_dir = given_directory
+        
+        c.create_manifests output_dir
+                
+        expect( File.exists? File.join(output_dir,"karchive",
+          "karchive.manifest") ).to be true
+        
+        manifest = Manifest.parse_file File.join(output_dir,"karchive",
+          "karchive.manifest")
+        
+        expect( manifest["name"] ).to eq "karchive"
+        expect( manifest["display_name"] ).to eq "KArchive"
+        expect( manifest["urls"]["vcs"] ).to eq "https://projects.kde.org/projects/frameworks/karchive/repository"
+        expect( manifest["urls"]["homepage"] ).to eq "https://projects.kde.org/projects/frameworks/karchive"
+        expect( manifest["description"] ).to eq "KArchive provides classes for easy reading, creation and manipulation of\n\"archive\" formats like ZIP and TAR.\n\nIf also provides transparent compression and decompression of data, like the\nGZip format, via a subclass of QIODevice."
+        expect( manifest["urls"]["mailing_list"] ).to eq "https://mail.kde.org/mailman/listinfo/kde-frameworks-devel"
+        expect( manifest["summary"] ).to eq "Reading, creation, and manipulation of file archives"
+      end
+      
+      it "overwrites existing manifests" do
+        c = KdeFrameworksCreator.new
+
+        c.parse_checkout @checkout_path
+
+        output_dir = given_directory
+        
+        c.create_manifests output_dir
+                
+        expect( File.exists? File.join(output_dir,"karchive",
+          "karchive.manifest") ).to be true
+
+        c.create_manifests output_dir
+                
+        expect( File.exists? File.join(output_dir,"karchive",
+          "karchive.manifest") ).to be true
+      end
+    end
+  end
+end

data/spec/kde_frameworks_release_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe KdeFrameworksRelease do
+  
+  include GivenFilesystemSpecHelpers
+
+  use_given_filesystem
+  
+  context "given KDE generic manifests" do
+    before(:each) do
+      @manifest_dir = given_directory do
+        given_directory("karchive") do
+          given_file("karchive.manifest", :from => "karchive-generic.manifest")
+        end
+        given_directory("kservice") do
+          given_file("kservice.manifest", :from => "kservice-generic.manifest")
+        end
+        given_directory("newlib") do
+          given_file("newlib.manifest", :from => "newlib/newlib.manifest")
+        end
+      end
+      
+      s = Settings.new
+      s.manifest_path = @manifest_dir
+      s.offline = true
+      @manifest_handler = ManifestHandler.new s
+    end
+      
+    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"
+    end
+    
+    it "writes release manifests" do
+      k = KdeFrameworksRelease.new @manifest_handler
+      k.read_generic_manifests
+      
+      k.write_release_manifests( "2014-02-01", "4.9.90" )
+      
+      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 = Manifest.parse_file( manifest_path )
+      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["schema_type"] ).to eq "release"
+    end
+  end
+
+  it "creates release manifest from generic manifest" do
+    generic_manifest = Manifest.parse_file(
+      given_file("karchive-generic.manifest") )
+    date = "2014-07-07"
+    version = "5.0.0"
+    release_manifest = KdeFrameworksRelease.create_release_manifest(
+      generic_manifest, date, version)
+    expected_json = File.read( given_file("karchive-release.manifest") )
+    expected_json.chomp! # Remove newline added by File.read
+    expect( Manifest.to_json(release_manifest) ).to eq expected_json
+  end
+  
+end

data/spec/library_spec.rb

@@ -6,14 +6,66 @@ describe Library do
     versions = [ "1.0", "2.0" ]
 
     manifests = Array.new
+    manifests.push create_generic_manifest "mylib"
     versions.each do |version|
-      manifests.push create_manifest "mylib", version
+      manifests.push create_manifest "mylib", "2014-02-03", version
     end
 
     library = Library.new
     library.manifests = manifests
 
-    library.versions.should == versions
+    expect(library.versions).to eq versions
+  end
+  
+  it "returns generic manifest" do
+    manifests = Array.new
+    manifests.push create_generic_manifest "mylib"
+    manifests.push create_manifest "mylib", "2014-02-03", "1.0"
+    
+    library = Library.new
+    library.manifests = manifests
+    
+    expect( library.generic_manifest["name"] ).to eq "mylib"
+    expect( library.generic_manifest["schema_type"] ).to eq "generic"
+  end
+  
+  it "returns relase manifests" do
+    manifests = Array.new
+    manifests.push create_generic_manifest "mylib"
+    manifests.push create_manifest "mylib", "2014-02-03", "1.0"
+    manifests.push create_manifest "mylib", "2014-03-03", "1.1"
+    
+    library = Library.new
+    library.manifests = manifests
+    
+    expect( library.release_manifests.count ).to eq 2
+    library.release_manifests.each do |release_manifest|
+      expect( release_manifest["schema_type"] ).to eq "release"
+    end
+  end
+  
+  it "returns latest manifest from multiple releases" do
+    manifests = Array.new
+    manifests.push create_generic_manifest "mylib"
+    manifests.push create_manifest "mylib", "2014-02-03", "1.0"
+    manifests.push create_manifest "mylib", "2014-03-03", "1.1"
+    
+    library = Library.new
+    library.manifests = manifests
+    
+    expect( library.latest_manifest["schema_type"] ).to eq "release"
+    expect( library.latest_manifest["version"] ).to eq "1.1"
+  end
+
+  it "returns latest manifest from generic manifest" do
+    manifests = Array.new
+    manifests.push create_generic_manifest "mylib"
+    
+    library = Library.new
+    library.manifests = manifests
+    
+    expect( library.latest_manifest["schema_type"] ).to eq "generic"
+    expect( library.latest_manifest["version"] ).to be nil
   end
 
 end