inqlude 0.0.8 → 0.7.0

data/lib/settings.rb

@@ -16,11 +16,17 @@
 
 class Settings
 
+  include XDG::BaseDir::Mixin
+
+  def subdirectory
+    "inqlude"
+  end
+
   attr_accessor :offline, :manifest_path
 
   def initialize
     @offline = false
-    @manifest_path = local_path "manifests"
+    @manifest_path = File.join(xdg_data_path.to_s, "manifests")
   end
 
   def data_path
@@ -28,24 +34,29 @@ class Settings
   end
   
   def cache_dir
-    local_dir "cache"
+    make_dir(File.join(xdg_cache_path.to_s))
+  end
+
+  def manifest_dir
+    make_dir(@manifest_path)
   end
 
   def version
     Inqlude::VERSION
   end
 
-  private
+  def xdg_data_path
+    data.home
+  end
 
-  def local_path dirname
-    home = ENV["HOME"] + "/.inqlude/"
-    Dir::mkdir home unless File.exists? home
-    home + dirname
+  def xdg_cache_path
+    cache.home
   end
 
-  def local_dir dirname
-    path = local_path dirname
-    Dir::mkdir path unless File.exists? path
+  private
+
+  def make_dir path
+    FileUtils.mkdir_p(path)
     path
   end
 

data/lib/verifier.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011 Cornelius Schumacher <schumacher@kde.org>
+# Copyright (C) 2011-2013 Cornelius Schumacher <schumacher@kde.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -44,32 +44,44 @@ class Verifier
   def initialize settings
     @settings = settings
 
-    @allowed_keys = [ "schema_version", "name", "version", "release_date",
+    @allowed_keys = [ "$schema", "name", "version", "release_date",
       "summary", "urls", "licenses", "description", "authors", "maturity",
       "platforms", "packages", "keywords", "dependencies", "filename",
-      "libraryname" ]
-    @mandatory_keys = [ "schema_version", "name", "version", "release_date",
-      "summary", "urls", "licenses", "description", "maturity",
-      "platforms", "packages" ]
+      "libraryname", "display_name", "schema_type", "schema_version", "group" ]
   end
 
   def verify manifest
     @result = Result.new
 
     if !manifest["filename"]
-      @result.errors = "Unable to determine filename"
+      @result.errors.push "Unable to determine filename"
       @result.name = "<unknown>"
     else
       @result.name = manifest["filename"]
     end
     if !manifest["libraryname"]
-      @result.errors = "Unable to determine 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 = "#{manifest["libraryname"]}.#{manifest["release_date"]}.manifest"
-
+      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
+      
       if filename != expected_filename
         @result.errors.push "Expected file name: #{expected_filename}"
       end
@@ -84,10 +96,12 @@ class Verifier
         end
       end
 
-      @mandatory_keys.each do |key|
-        if !manifest.keys.include? key
-          @result.errors.push "Mandatory attribute is missing: #{key}"
-        end
+      schema_name = "#{manifest["schema_type"]}-manifest-v#{manifest["schema_version"]}"
+      schema_file = File.expand_path("../../schema/#{schema_name}", __FILE__)
+
+      errors = JSON::Validator.fully_validate(schema_file, manifest)
+      errors.each do |error|
+        @result.errors.push "Schema validation error: #{error}"
       end
     end
     
@@ -101,10 +115,7 @@ class Verifier
   end
 
   def verify_file filename
-    manifest = JSON File.read filename
-    manifest["filename"] = filename
-    filename =~ /^(.*?)\./
-    manifest["libraryname"] = $1
+    manifest = Manifest.parse_file filename
     verify manifest
   end
 

data/lib/version.rb

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

data/lib/view.rb

@@ -16,8 +16,7 @@
 
 class View
 
-  attr_accessor :enable_disqus
-  attr_accessor :enable_search
+  attr_accessor :enable_disqus,:enable_search,:manifest,:library,:group_name
   attr_reader :root
   
   def initialize handler
@@ -29,17 +28,36 @@ class View
     
     assert_dir output_dir
 
+    system "cp #{view_dir}/favicon.ico #{output_dir}"
+    
     assert_dir "#{output_dir}/public"
     system "cp #{view_dir}/public/* #{output_dir}/public/"
+    
+    assert_dir "#{output_dir}/schema"
+    system "cp #{schema_dir}/* #{output_dir}/schema"
 
     @root = ""
 
     render_template "index", output_dir
-    render_template "edge", output_dir
+    render_template "development", output_dir
+    render_template "unreleased", output_dir
+    render_template "commercial", output_dir
+    render_template "all", output_dir
     render_template "about", output_dir
     render_template "get", output_dir
     render_template "contribute", output_dir
     render_template "search", output_dir
+    
+
+    groups_path = "#{output_dir}/groups/"
+    assert_dir groups_path
+    
+    @root = "../"
+    
+    @group_name = "kde-frameworks"
+    file_name = "groups/kde-frameworks"
+    render_template "group", output_dir, file_name
+    
 
     library_path = "#{output_dir}/libraries/"
     assert_dir library_path
@@ -48,7 +66,7 @@ class View
 
     @manifest_handler.libraries.each do |library|
       @library = library
-      @manifest = library.manifests.last
+      @manifest = library.latest_manifest
       file_name = "libraries/" + library.name
       render_template "library", output_dir, file_name
     end
@@ -90,7 +108,7 @@ class View
   end
 
   def link_to_manifest name
-    "<a href=\"libraries/#{name}.html\">#{name}</a>"
+    "<a href=\"#{@root}libraries/#{name}.html\">#{name}</a>"
   end
 
   def link url
@@ -133,6 +151,9 @@ class View
   end
 
   def version_content
+    if @manifest["schema_type"] == "generic"
+      raise "Can't get version for generic manifest '#{@manifest["name"]}'"
+    end
     out = @manifest["version"]
     out += " (#{@manifest["maturity"]})"
     out += "<span class='release-date'>"
@@ -185,7 +206,26 @@ class View
     end
     @manifest_handler.libraries(maturity)
   end
+  
+  def unreleased_libraries
+    @manifest_handler.unreleased_libraries
+  end
 
+  def commercial_libraries
+    @manifest_handler.commercial_libraries
+  end
+
+  def group_title
+    if @group_name == "kde-frameworks"
+      return "KDE Frameworks"
+    end
+    ""
+  end
+  
+  def group
+    @manifest_handler.group(@group_name)
+  end
+  
   def disqus_enabled?
     @enable_disqus
   end
@@ -209,14 +249,15 @@ class View
   end
 
   def old_versions
-    versions = Array.new
-    count = @library.manifests.count
-    if count > 1
-      versions = @library.manifests[0..count-2].map {|m| m["version"] }
-    end
+    versions = @library.versions.reject{ |v| v == @manifest["version"] }
     versions.reverse
   end
 
+  def render_description
+    doc = Kramdown::Document.new(@manifest["description"])
+    doc.to_html
+  end
+
   private
   
   def assert_dir name
@@ -231,4 +272,8 @@ class View
     File.expand_path( File.dirname( __FILE__ ) + "/../view/" ) + "/"
   end
 
+  def schema_dir
+    File.expand_path( File.dirname( __FILE__ ) + "/../schema/" ) + "/"
+  end
+
 end

data/manifest-format.md

@@ -32,19 +32,33 @@ concrete file.
 
 These are the attributes:
 
-### schema_version
+### $schema
 
-Version number of the schema used in this manifest
+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.
 
-This is used to make expectations of tools and processing explicit and adapt
-to schema changes.
+The schema comes in three flavors: "generic", "release", and
+"proprietary-release". They differe 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".
+
+Each schema has an identifier. The current identifier for the release schema is
+"http://inqlude.org/schema/release-manifest-v1#". It includes the version
+number. The other identifiers are the same, but instead of "release" they use
+the corresponding sub string identifying the flavor.
+
+The schema and its versioning is used to make expectations of tools and
+processing explicit and adapt to schema changes.
 
 If the schema is changed in a way incompatible with processing tools, the
 schema version number has to be increased.
 
-This document specifies schema version 1.
+As Inqlude currently still is in alpha, changes to the schema are to be expected
+and while we will try to not break things, there might be some incompatible
+changes without changing the version number during development. This will stop,
+when we have reached beta state.
 
-*schema_version is a mandatory attribute*
+*$schema is a mandatory attribute*
 
 ### name
 
@@ -71,13 +85,13 @@ representing the different versions of the library.
 
 Date, when the version was released
 
-*release_date is a mandatory attribute*
+*release_date is a mandatory attribute in the release schemas*
 
 ### version
 
 Version of the release
 
-*version is a mandatory attribute*
+*version is a mandatory attribute in the release schemas*
 
 ### summary
 
@@ -132,8 +146,8 @@ strings for the most often used licenses:
 Full description of the library
 
 The description is a text describing the library. It can be of arbitrary length.
-No special formatting is supported other than using newlines to start a new
-paragraph.
+The text is formatted using
+[Markdown](http://daringfireball.net/projects/markdown/syntax).
 
 *description is a mandatory attribute*
 
@@ -158,7 +172,7 @@ The flag has to be one of the following identifiers:
   recommended for production use
 * "alpha": preview releases, not suitable for production use
 
-*maturity is a mandatory attribute*
+*maturity is a mandatory attribute, it's optional in the generic schema*
 
 ### platforms
 
@@ -190,7 +204,8 @@ package. The following types are supported:
 This is the source code of the release. It has one URL to the file, which
 can be used to download the code.
 
-*source is a mandatory package attribute*
+*source is a mandatory package attribute in the release schema, it's optional
+in the proprietary-release schema*
 
 #### openSUSE
 

data/schema/generic-manifest-v1

@@ -0,0 +1,54 @@
+{
+  "id": "http://inqlude.org/schema/generic-manifest-v1#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Generic Inqlude Manifest Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "summary": {
+      "type": "string"
+    },
+    "urls": {
+      "type": "object",
+      "properties": {
+        "homepage": {
+          "type": "string"
+        },
+        "download": {
+          "type": "string"
+        }
+      },
+      "required": [ "homepage" ]
+    },
+    "licenses": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "minItems": 1
+    },
+    "description": {
+      "type": "string"
+    },
+    "authors": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "platforms": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "minItems": 1
+    },
+    "group": {
+      "type": "string"
+    }
+  },
+  "required": [ "$schema", "name", "summary",
+                "urls", "licenses", "description", "platforms" ]
+}

data/schema/proprietary-release-manifest-v1

@@ -0,0 +1,63 @@
+{
+  "id": "http://inqlude.org/schema/release-manifest-v1#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Inqlude Release Manifest Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "release_date": {
+      "type": "string"
+    },
+    "version": {
+      "type": "string"
+    },
+    "summary": {
+      "type": "string"
+    },
+    "urls": {
+      "type": "object",
+      "properties": {
+        "homepage": {
+          "type": "string"
+        },
+        "download": {
+          "type": "string"
+        }
+      },
+      "required": [ "homepage" ]
+    },
+    "licenses": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "minItems": 1
+    },
+    "description": {
+      "type": "string"
+    },
+    "authors": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "maturity": {
+      "type": "string"
+    },
+    "platforms": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "minItems": 1
+    },
+    "group": {
+      "type": "string"
+    }
+  },
+  "required": [ "$schema", "name", "release_date", "version", "summary",
+                "urls", "licenses", "description", "maturity", "platforms" ]
+}