inqlude 0.7.0 → 0.7.1

data/lib/verifier.rb

@@ -17,7 +17,7 @@
 class Verifier
 
   class Result
-    attr_accessor :valid, :errors, :name
+    attr_accessor :errors, :name
     
     def initialize
       @valid = false
@@ -25,7 +25,7 @@ class Verifier
     end
     
     def valid?
-      @valid
+      @errors.empty?
     end
 
     def print_result
@@ -43,79 +43,54 @@ class Verifier
   
   def initialize settings
     @settings = settings
-
-    @allowed_keys = [ "$schema", "name", "version", "release_date",
-      "summary", "urls", "licenses", "description", "authors", "maturity",
-      "platforms", "packages", "keywords", "dependencies", "filename",
-      "libraryname", "display_name", "schema_type", "schema_version", "group" ]
   end
 
   def verify manifest
     @result = Result.new
 
-    if !manifest["filename"]
+    if !manifest.filename
       @result.errors.push "Unable to determine filename"
       @result.name = "<unknown>"
     else
-      @result.name = manifest["filename"]
+      @result.name = manifest.filename
     end
-    if !manifest["libraryname"]
+    if !manifest.libraryname
       @result.errors.push "Unable to determine libraryname"
     end
-    if manifest["$schema"]
-      schema_type = manifest["schema_type"]
-      if schema_type != "generic" && schema_type != "release" &&
-         schema_type != "proprietary-release"
-        @result.errors.push "Unknown schema type '#{schema_type}'"
-      end
-    else
-      @result.errors.push "Unable to find $schema attribute"
-    end
 
     if @result.errors.empty?
-      filename = manifest["filename"]
-      expected_filename = ""
-      schema_type = manifest["schema_type"]
-      if schema_type == "generic"
-        expected_filename = "#{manifest["libraryname"]}.manifest"
-      elsif schema_type == "release" || schema_type == "proprietary-release"
-        expected_filename = "#{manifest["libraryname"]}.#{manifest["release_date"]}.manifest"
-      end
+      filename = manifest.filename
       
-      if filename != expected_filename
-        @result.errors.push "Expected file name: #{expected_filename}"
+      if filename != manifest.expected_filename
+        @result.errors.push "Expected file name: #{manifest.expected_filename}"
       end
 
-      if manifest["release_date"] == "1970-01-01"
-        @result.errors.push "Invalid release date: #{manifest["release_date"]}"
+      if manifest.release_date == "1970-01-01"
+        @result.errors.push "Invalid release date: #{manifest.release_date}"
       end
 
-      manifest.keys.each do |key|
-        if !@allowed_keys.include? key
-          @result.errors.push "Illegal entry: #{key}"
-        end
-      end
-
-      schema_name = "#{manifest["schema_type"]}-manifest-v#{manifest["schema_version"]}"
+      schema_name = manifest.schema_name
       schema_file = File.expand_path("../../schema/#{schema_name}", __FILE__)
 
-      errors = JSON::Validator.fully_validate(schema_file, manifest)
+      errors = JSON::Validator.fully_validate(schema_file, manifest.to_json)
       errors.each do |error|
         @result.errors.push "Schema validation error: #{error}"
       end
     end
-    
-    if @result.errors.empty?
-      @result.valid = true
-      return @result
-    else
-      @result.valid = false
-      return @result
-    end
+
+    @result
   end
 
   def verify_file filename
-    manifest = Manifest.parse_file filename
+    begin
+      manifest = Manifest.parse_file filename
+    rescue VerificationError => e
+      @result = Result.new
+      @result.name = filename
+      @result.errors.push e
+      return @result
+    end
+
     verify manifest
   end
 

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Inqlude
 
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 
 end

data/lib/view.rb

@@ -36,6 +36,9 @@ class View
     assert_dir "#{output_dir}/schema"
     system "cp #{schema_dir}/* #{output_dir}/schema"
 
+    create_inqlude_all(output_dir)
+
+
     @root = ""
 
     render_template "index", output_dir
@@ -72,6 +75,12 @@ class View
     end
   end
 
+  def create_inqlude_all(output_dir)
+    File.open(File.join(output_dir, "inqlude-all.json"), "w") do |f|
+      f.write(@manifest_handler.generate_inqlude_all)
+    end
+  end
+
   def render_template name, output_dir, file_name = nil
     layout = template "layout"
     layout_engine = Haml::Engine.new layout
@@ -99,12 +108,8 @@ class View
     "<link href='#{@root}public/inqlude.css' rel='stylesheet' type='text/css' />"
   end
 
-  def m attr, subattr = nil
-    if subattr
-      @manifest[ attr ][ subattr ]
-    else
-      @manifest[ attr ]
-    end
+  def m
+    @manifest
   end
 
   def link_to_manifest name
@@ -123,7 +128,7 @@ class View
   end
 
   def list_attribute attribute
-    attr = m attribute
+    attr = @manifest.send(attribute)
     return "" if !attr || attr.size == 0
 
     # We assume attribute is plural formed by adding an 's'
@@ -151,13 +156,13 @@ class View
   end
 
   def version_content
-    if @manifest["schema_type"] == "generic"
-      raise "Can't get version for generic manifest '#{@manifest["name"]}'"
+    if @manifest.class == ManifestGeneric
+      raise InqludeError.new("Can't get version for generic manifest '#{@manifest.name}'")
     end
-    out = @manifest["version"]
-    out += " (#{@manifest["maturity"]})"
+    out = @manifest.version
+    out += " (#{@manifest.maturity})"
     out += "<span class='release-date'>"
-    out += "released on #{@manifest["release_date"]}"
+    out += "released on #{@manifest.release_date}"
     out += "</span>"
     if !old_versions.empty?
       out += "<span class='old-versions'>"
@@ -179,10 +184,10 @@ class View
   end
 
   def link_item key, label
-    if m( "urls", key )
+    if m.urls.send(key)
       out = "<li><a href=\""
-      out += m( "urls", key )
-      out += "\">#{label}</a>"
+      out += m.urls.send(key)
+      out += "\">#{label}</a></li>"
       return out
     else
       return ""
@@ -191,7 +196,7 @@ class View
 
   def custom_urls
     out = ""
-    urls = m "urls", "custom"
+    urls = @manifest.urls.custom
     if urls && !urls.empty?
       urls.each do |text,url|
         out += "<li><a href=\"#{url}\">#{text}</a></li>"
@@ -201,9 +206,6 @@ class View
   end
   
   def libraries maturity = nil
-    if @manifest_handler.libraries(maturity).empty?
-      @manifest_handler.read_remote
-    end
     @manifest_handler.libraries(maturity)
   end
   
@@ -231,9 +233,10 @@ class View
   end
 
   def more_urls?
-    if @manifest["urls"]
-      @manifest["urls"].each do |name,url|
-        if name != "homepage" && name != "screenshots" && name != "logo" && name != "description_source"
+    @manifest.urls.class.all_keys.each do |key, type|
+      if key != :homepage && key != :screenshots && key != :logo &&
+         key != :description_source
+        if @manifest.urls.send(key)
           return true
         end
       end
@@ -243,18 +246,18 @@ class View
   
   def editor_url
     url = "https://github.com/cornelius/inqlude-data/blob/master/"
-    url += @manifest["name"]
-    url += "/#{@manifest["name"]}.#{@manifest["release_date"]}.manifest"
+    url += @manifest.name
+    url += "/#{@manifest.name}.#{@manifest.release_date}.manifest"
     url
   end
 
   def old_versions
-    versions = @library.versions.reject{ |v| v == @manifest["version"] }
+    versions = @library.versions.reject{ |v| v == @manifest.version }
     versions.reverse
   end
 
   def render_description
-    doc = Kramdown::Document.new(@manifest["description"])
+    doc = Kramdown::Document.new(@manifest.description)
     doc.to_html
   end
 

data/manifest-format.md

@@ -109,6 +109,10 @@ All URLs are represented as a key specifying the type of the URL and the
 actual URL itself. Arbitrary types can be defined. Some types are used for
 specific purposes and get special treatment.
 
+All these URLs are meant to be consumed by humans, so they should work and make
+sense when shown in a web browser. Other than that they don't have very strict
+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
@@ -123,6 +127,8 @@ The following types are recognized:
 * "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*
@@ -214,3 +220,12 @@ entry.
 
 Each entry contains the package_name, repository, and source_rpm attributes.
 The repository contains an 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.
+
+At the moment only the value "kde-frameworks" is used.

data/spec/data/inqlude-all-karchive.json

@@ -0,0 +1,31 @@
+[
+  {
+    "$schema": "http://inqlude.org/schema/release-manifest-v1#",
+    "name": "karchive",
+    "display_name": "KArchive",
+    "release_date": "2014-03-04",
+    "version": "4.97.0",
+    "summary": "Reading, creating, and manipulating file archives",
+    "urls": {
+      "homepage": "https://projects.kde.org/projects/frameworks/karchive",
+      "download": "ftp://ftp.kde.org/pub/kde/stable/karchive/",
+      "vcs": "https://projects.kde.org/projects/frameworks/karchive/repository",
+      "mailing_list": "https://mail.kde.org/mailman/listinfo/kde-frameworks-devel"
+    },
+    "licenses": [
+      "LGPLv2.1+"
+    ],
+    "description": "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.",
+    "authors": [
+      "The KDE Community"
+    ],
+    "maturity": "alpha",
+    "platforms": [
+      "Linux"
+    ],
+    "packages": {
+      "source": "ftp://ftp.kde.org/pub/kde/stable/karchive/karchive-4.97.0.tar.bz2"
+    },
+    "group": "kde-frameworks"
+  }
+]

data/spec/data/inqlude-all.json

@@ -0,0 +1,120 @@
+[
+  {
+    "$schema": "http://inqlude.org/schema/release-manifest-v1#",
+    "name": "awesomelib",
+    "release_date": "2013-09-08",
+    "version": "0.2.0",
+    "summary": "Awesome library",
+    "urls": {
+      "homepage": "http://example.com",
+      "download": "http://example.com/download"
+    },
+    "licenses": [
+      "LGPLv2.1+",
+      "Commercial"
+    ],
+    "description": "This is an awesome library.",
+    "authors": [
+      "Cornelius Schumacher <schumacher@kde.org>"
+    ],
+    "maturity": "stable",
+    "platforms": [
+      "Linux"
+    ],
+    "packages": {
+      "source": "ftp://example.com/download/awesomelib-0.2.0.tar.gz"
+    },
+    "group": "kde-frameworks"
+  },
+  {
+    "$schema": "http://inqlude.org/schema/release-manifest-v1#",
+    "name": "bleedingedge",
+    "release_date": "2012-01-01",
+    "version": "edge",
+    "summary": "Bleeding edge version of a library",
+    "urls": {
+      "homepage": "http://example.org",
+      "download": "http://example.org/download"
+    },
+    "licenses": [
+      "GPLv3"
+    ],
+    "description": "This is an awesome library. It's bleeding edge.",
+    "authors": [
+      "Cornelius Schumacher <schumacher@kde.org>"
+    ],
+    "maturity": "edge",
+    "platforms": [
+      "Linux"
+    ],
+    "packages": {
+      "source": "ftp://example.org/download/bleedingedge-latest.tar.gz"
+    },
+    "group": "kde-frameworks"
+  },
+  {
+    "$schema": "http://inqlude.org/schema/generic-manifest-v1#",
+    "name": "commercial",
+    "summary": "Commercial library",
+    "urls": {
+      "homepage": "http://commercial.example.org"
+    },
+    "licenses": [
+      "Commercial"
+    ],
+    "description": "Library only available under commercial license.",
+    "authors": [
+      "John Doe <doe@example.org>"
+    ],
+    "maturity": "stable",
+    "platforms": [
+      "Linux",
+      "Windows"
+    ]
+  },
+  {
+    "$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"
+    ]
+  },
+  {
+    "$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/invalid-schema.manifest

@@ -0,0 +1,4 @@
+{
+  "$schema": "http://inqlude.org/schema/invalid-manifest-v1#",
+  "name": "invalid-schema"
+}