inqlude 0.7.0 → 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29975395e8bb39f24d4d623ae4b1ee12540143eb
+  data.tar.gz: 7619b8dc07af9e3cd89fdd8c35736c617112f761
+SHA512:
+  metadata.gz: 9572cc4a485616494f4a475edd02e9b6bc41707047951a44c8870091b442dc33f27862ab298a8173963639942ef253a49238d43456a5afd33dd86cd9fba3e145
+  data.tar.gz: 95a40483eb41571935499b36892128d36b2ee76c6ed0646e58c093e828c3e2411bc6f83562b2fa449d83e3b88e0db4ae4211929e8ac0821209c5a3788e4d1d11

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Change log of Inqlude
+
+## Version 0.7.1
+
+* `create_kde_frameworks` command:
+
+    Generate links from name
+
+    The standard links for frameworks such as home page, mailing list,
+    git repository always follow the same scheme. So instead of parsing
+    them from the README.md generate them from the name of the framework.
+
+    This is more flexible, allows to change all links at once, and is
+    compatible with the frameworks where the links have been removed from
+    the READMEs.
+
+* Accept windows and ubuntu as package category
+* Implement `inqlude download`
+* Generate inqlude-all.json on Inqlude website
+
+## Version 0.7.0
+
+* First alpha release

data/TODO

@@ -1,8 +1,3 @@
-# 0.7 (Alpha) (first announcement, ready for early adopters)
-
-* Release it
-
-
 # 0.8 (Alpha) (second announcement, ready for contributors)
 
 * Create ROADMAP.md
@@ -10,20 +5,25 @@
 * Move all issues from this file to GitHub
 * Add Upstream.get_involved for all issues where possible
 
+* Split cli #23
+* Sort out client naming
+
+* Point KDE Frameworks homepages to http://api.kde.org
+
 * Release it
 
 
 # 0.9 (Beta) (ready for contributors of meta data, schema stable)
 
-* Replace manifest hash by Manifest object
-
 * Add display name  High Priority #12
 * Check platform attribute for valid entries  High Priority #18
 * Check maturity for valid values  High Priority #16
-* Link to license text  Medium Priority #14
 * Add a comment field for authors  Medium Priority #15
 * Add attribute for screenshots  Medium Priority #10
 * Add bugtracker URL  Low Priority #7
+* Add vcs:git:clone_url
+* Use SPDX license identifiers (http://spdx.org/licenses/)
+* Link to license text  Medium Priority #14
 
 * Define maturity scale
 * State policy for inclusion of libraries (at least one stable release, no qt3,
@@ -32,11 +32,16 @@
   tags in meta data for bound library)
 
 * Show Qt5 compability  High Priority #20
+
+* Define how to handle dependencies between libraries on inqlude.org
+
 * Check links  Medium Priority #11
 * Add command for showing library details  High Priority #1
 
 * Turn alpha ribbon into beta ribbon on web site
 
+* Commit hook on server to verify the manifests
+
 * Release it
 
 
@@ -67,11 +72,21 @@
 * Get manifests from build service
 * List libraries with available packages
 * Properly identify repository (use vendor?)
+* Dependencies to other libraries
+   * Get from list_dependencies in kde build meta data
+* Qt version information
+   * minimum_qt_version = [ 4.2.1, 5.1.0 ]
+   or
+   * split manifests between Qt 4 and Qt 5 (directory with Qt version suffix)
+* Check installation experience on Mac
+* Check installation experience on Windows
+* User client without dependencies on git and Ruby
+* Integration tests for download/list/etc. functionality
+* Define way to manage local downloads
 
 * Release it
 
 
 # Later
 
-* Create more friendly progress display for cache creation  Low Priority #3
 * Add some quality indication  Low Priority #17

data/accessing-inqlude-data.md

@@ -0,0 +1,55 @@
+# Accessing Inqlude data
+
+The data of the Inqlude library archive is maintained in the
+[inqlude-data](https://github.com/cornelius/inqlude-data) repository. It
+includes the meta data for all libraries collected in Inqlude. There are various
+ways to access this data from a client. They are described in this document.
+
+## Using the git repository
+
+The most direct way is to clone the [meta data git repository](https://github.com/cornelius/inqlude-data) and work on the
+data locally. The repository contains a set of directories with manifests
+following the [Inqlude manifest specification](https://github.com/cornelius/inqlude/blob/master/manifest-format.md).
+The data can be updated with standard git commands such as `git pull`.
+
+## All data in one JSON
+
+There is a JSON file available at http://inqlude.org/inqlude-all.json, which
+contains the data for the latest version of all libraries. This is the most
+convenient way, if you just want to have the current data.
+
+The file is updated whenever the data in the inqlude-data git repository is
+updated.
+
+The file is simply wrapping the manifests in a JSON array:
+
+```json
+[
+  {
+    "$schema": "http://inqlude.org/schema/release-manifest-v1#",
+    "name": "attica",
+    "release_date": "2013-06-12",
+    "version": "0.4.2",
+    ...
+  },
+  {
+    "$schema": "http://inqlude.org/schema/release-manifest-v1#",
+    "name": "avahi-qt",
+    "release_date": "2012-02-15",
+    "version": "0.6.31",
+    ...
+  }
+]
+```
+
+## Using a client
+
+There currently are two clients to access the Inqlude data.
+
+The preferred way to access the data as a user of libraries is the native
+command line client written in C++. Its source is maintained as the
+[inqlude-client project](https://projects.kde.org/projects/playground/sdk/inqlude-client).
+
+The other client is the [Inqlude admin tool](https://github.com/cornelius/inqlude).
+It provides commands to access the meta data. It also has commands to manipulate
+and verify meta data.

data/inqlude.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |s|
   s.add_dependency "xdg"
 
   s.add_development_dependency "rspec", "~>3"
-  s.add_development_dependency "given_filesystem"
+  s.add_development_dependency "given_filesystem",  ">=0.1.2"
+  s.add_development_dependency "cli_tester"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

data/lib/cli.rb

@@ -20,6 +20,7 @@ class Cli < Thor
 
   class_option :version, :type => :boolean, :desc => "Show version"
   class_option :offline, :type => :boolean, :desc => "Work offline"
+  class_option :manifest_dir, :type => :string, :desc => "Manifest directory"
 
   def self.settings= s
     @@settings = s
@@ -86,7 +87,10 @@ actual domain."
       @@settings.manifest_path = options[:manifest_dir]
     end
     
-    view = View.new ManifestHandler.new @@settings
+    manifest_handler = ManifestHandler.new(@@settings)
+    manifest_handler.read_remote
+
+    view = View.new(manifest_handler)
     view.enable_disqus = options[:enable_disqus]
     view.enable_search = !options[:disable_search]
     view.create options[:output_dir]
@@ -110,6 +114,8 @@ actual domain."
       exit 1
     end
     
+    errors = []
+
     if filename
       result = v.verify_file filename
       result.print_result
@@ -117,7 +123,6 @@ actual domain."
       handler = ManifestHandler.new @@settings
       handler.read_remote
       count_ok = 0
-      count_error = 0
       handler.libraries.each do |library|
         library.manifests.each do |manifest|
           result = v.verify manifest
@@ -125,12 +130,23 @@ actual domain."
           if result.valid?
             count_ok += 1
           else
-            count_error += 1
+            errors.push result
           end
         end
       end
+      puts
       puts "#{handler.manifests.count} manifests checked. #{count_ok} ok, " +
-        "#{count_error} with error."
+        "#{errors.count} with error."
+      if !errors.empty?
+        puts
+        puts "Errors:"
+        errors.each do |error|
+          puts "  #{error.name}"
+          error.errors.each do |e|
+            puts "    #{e}"
+          end
+        end
+      end
     end
   end
 
@@ -260,10 +276,26 @@ actual domain."
     end
   end
 
+  desc "download", "Download source code archive"
+  def download(name)
+    handler = ManifestHandler.new(@@settings)
+    handler.read_remote
+    manifest = handler.manifest(name)
+    if !manifest
+      STDERR.outs "Manifest for '#{name}' not found"
+      exit 1
+    else
+      Downloader.new(handler, STDOUT).download(name, Dir.pwd)
+    end
+  end
+
   private
   
   def process_global_options options
     @@settings.offline = options[:offline]
+    if options[:manifest_dir]
+      @@settings.manifest_path = options[:manifest_dir]
+    end
   end
 
 end

data/lib/creator.rb

@@ -41,13 +41,11 @@ class Creator
     mh.read_remote
 
     m = mh.manifest @name
-    m.delete "filename"
-    m.delete "libraryname"
-    m["version"] = version
-    m["release_date"] = release_date
+    m.version = version
+    m.release_date = release_date
     
     File.open( filename, "w" ) do |file|
-      file.puts Manifest.to_json(m)
+      file.puts m.to_json
     end
   end
 
@@ -56,49 +54,36 @@ class Creator
   end
 
   def create_manifest version, release_date
-    m = Hash.new
-    m["$schema"] = Manifest.release_schema_id
-    m["name"] = @name
-    m["version"] = version
-    m["release_date"] = release_date
-    m["summary"] = ""
-    m["urls"] = { "homepage" => "", "vcs" => "", "download" => "" }
-    m["licenses"] = [ "" ]
-    m["description"] = ""
+    m = ManifestRelease.new
+    m.name = @name
+    m.version = version
+    m.release_date = release_date
     if version == "edge"
-      m["maturity"] = "edge"
+      m.maturity = "edge"
     else
-      m["maturity"] = "stable"
+      m.maturity = "stable"
     end
-    m["authors"] = [ "" ]
-    m["platforms"] = [ "Linux" ]
-    m["packages"] = { "source" => "" }
+    m.platforms = [ "Linux" ]
     m
   end
 
   def write_manifest manifest
     filename = File.join @settings.manifest_path, @name, @name
-    if manifest["release_date"]
-      filename += ".#{manifest["release_date"]}"
+    if manifest.release_date
+      filename += ".#{manifest.release_date}"
     end
     filename += ".manifest"
 
     File.open( filename, "w" ) do |file|
-      file.puts Manifest.to_json(manifest)
+      file.puts manifest.to_json
     end
   end
   
   def create_generic_manifest
-    m = Hash.new
-    m["$schema"] = Manifest.generic_schema_id
-    m["name"] = @name
-    m["display_name"] = @name.capitalize
-    m["summary"] = ""
-    m["urls"] = { "homepage" => "", "vcs" => "" }
-    m["licenses"] = [ "" ]
-    m["description"] = ""
-    m["authors"] = [ "" ]
-    m["platforms"] = [ "Linux" ]
+    m = ManifestGeneric.new
+    m.name = @name
+    m.display_name = @name.capitalize
+    m.platforms = [ "Linux" ]
     m
   end
 

data/lib/distros/suse.rb

@@ -46,7 +46,7 @@ class Suse
     installed = Array.new
     handler.manifests.each do |manifest|
       unknown += 1
-      package_section = manifest["packages"]
+      package_section = manifest.packages.openSUSE
       next unless package_section
       name_section = package_section[name]
       next unless name_section
@@ -84,7 +84,7 @@ class Suse
   end
 
   def get_package_name manifest
-    package_section = manifest["packages"]
+    package_section = manifest.packages.openSUSE
     if !package_section
       STDERR.puts "No packages section in metadata"
     else

data/lib/downloader.rb

@@ -0,0 +1,37 @@
+# Copyright (C) 2014 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
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+class Downloader
+  def initialize(handler, output)
+    @handler = handler
+    @output = output
+  end
+
+  def download(name, directory)
+    @output.puts "Downloading #{name}"
+    url = @handler.manifest(name).packages.source
+    @output.puts "  from: #{url}"
+    file_path = File.join(directory, File.basename(url))
+    @output.puts "  to: #{file_path}"
+    File.open(file_path, "w") do |f|
+      f.write(read_from_url(url))
+    end
+  end
+
+  def read_from_url(url)
+    URI.parse(url).open.read
+  end
+end

data/lib/exceptions.rb

@@ -0,0 +1,2 @@
+class VerificationError < StandardError
+end

data/lib/inqlude.rb

@@ -8,18 +8,24 @@ require "json-schema"
 require "kramdown"
 require "xdg"
 
-require File.expand_path('../version', __FILE__)
-require File.expand_path('../cli', __FILE__)
-require File.expand_path('../manifest_handler', __FILE__)
-require File.expand_path('../view', __FILE__)
-require File.expand_path('../distro', __FILE__)
-require File.expand_path('../rpm_manifestizer', __FILE__)
-require File.expand_path('../settings', __FILE__)
-require File.expand_path('../upstream', __FILE__)
-require File.expand_path('../verifier', __FILE__)
-require File.expand_path('../library', __FILE__)
-require File.expand_path('../creator', __FILE__)
-require File.expand_path('../git_hub_tool', __FILE__)
-require File.expand_path('../manifest', __FILE__)
-require File.expand_path('../kde_frameworks_creator', __FILE__)
-require File.expand_path('../kde_frameworks_release', __FILE__)
+class InqludeError < StandardError
+end
+
+require_relative("json_object")
+require_relative("exceptions")
+require_relative("version")
+require_relative("cli")
+require_relative("manifest_handler")
+require_relative("view")
+require_relative("distro")
+require_relative("rpm_manifestizer")
+require_relative("settings")
+require_relative("upstream")
+require_relative("verifier")
+require_relative("library")
+require_relative("creator")
+require_relative("git_hub_tool")
+require_relative("manifest")
+require_relative("kde_frameworks_creator")
+require_relative("kde_frameworks_release")
+require_relative("downloader")