inqlude 0.0.8 → 0.7.0

data/.gitignore

@@ -1,2 +1,3 @@
 html
 *.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README

@@ -1,5 +1,7 @@
 # Inqlude - the Qt library archive
 
+## Overview
+
 Inqlude is a tool to handle Qt based libraries. It provides developers using Qt
 with an easy way to find, install, and use libraries, in particular 3rd party
 libraries. A public version of the library runs at http://inqlude.org.
@@ -22,7 +24,39 @@ the native tools.
 There also is an option to generate an HTML overview of all available libraries.
 This can be hosted or used locally.
 
+## KDE Frameworks
+
+The KDE Frameworks provide more than fifty libraries, which can be used to
+write Qt application. Inqlude has some special tooling to deal with the data
+from KDE Frameworks
+
+To checkout all frameworks from source, you can use
+
+```bash
+kde-checkout-list.pl --component=frameworks --clone
+```
+
+This creates a `frameworks` directory with a checkout of all git repositories
+part of [KDE Frameworks](https://projects.kde.org/projects/frameworks).
+
+You can update the generic meta data of the frameworks in Inqlude with
+
+```bash
+inqlude create_kde_frameworks <frameworks-checkout-dir> <inqlude-data-dir>
+```
+
+To create release manifests for a KDE Frameworks release runs
+
+```bash
+inqlude release_kde_frameworks <release_date> <version>
+```
+
+## License
+
 Inqlude is licensed under the GPL.
 
+## Contact
+
 If you have questions or comments, please contact Cornelius Schumacher
-<schumacher@kde.org>.
+<schumacher@kde.org> or write to the
+[Inqlude mailing list](mailto:inqlude@kde.org).

data/TODO

@@ -1,37 +1,64 @@
-# Alpha (first announcement, ready for early adopters)
+# 0.7 (Alpha) (first announcement, ready for early adopters)
 
-* Update get involved
+* Release it
 
-# Beta (ready for contributors of meta data)
 
-* Document manifest format
+# 0.8 (Alpha) (second announcement, ready for contributors)
+
+* Create ROADMAP.md
+* Define milestones on GitHub and reference issues
+* Move all issues from this file to GitHub
+* Add Upstream.get_involved for all issues where possible
+
+* 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
+
 * Define maturity scale
 * State policy for inclusion of libraries (at least one stable release, no qt3,
   open source, provides a Qt API, published API docs)
 * Handle binding consistently (suffix -qt, common description, maybe special
   tags in meta data for bound library)
 
-* Check validity of links
-* Add option to verify given manifest
-* Add show option for showing library details
+* Show Qt5 compability  High Priority #20
+* Check links  Medium Priority #11
+* Add command for showing library details  High Priority #1
 
-* Look for latest versions of libraries
-* Make sure all manifests have a download link
-* Add links to upstream source code repositories for all libraries
+* Turn alpha ribbon into beta ribbon on web site
+
+* Release it
 
-* Add download section on library page with source code download and links to
-  packages e.g. openSUSE 1-click install
-* Show release date on library page
-* Add page with older versions of each library
 
 # 1.0 (ready for end users of the web site)
 
+* Show latest releases on web page  Medium Priority #22
+* Make layout responsive  Medium Priority Web site #6
+* Align summaries on development page vertically  Low Priority Web site #19
+
 * Add "How to use" data
 * Add tags for searching
+
 * Update manifest data to have complete package data
 * Check existence of packages
+* Link to Open Build Service  Low Priority #9
+
+* Remove beta ribbon on web site
+
+* Release it
+
 
-# Later (ready for end users of the command line tool)
+# 2.0 (ready for end users of the command line tool)
 
 * Smarter match for source RPMs, which contain more than one library
 * Retrieve data from qt-apps and kde-apps
@@ -40,3 +67,11 @@
 * Get manifests from build service
 * List libraries with available packages
 * Properly identify repository (use vendor?)
+
+* Release it
+
+
+# Later
+
+* Create more friendly progress display for cache creation  Low Priority #3
+* Add some quality indication  Low Priority #17

data/inqlude.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Cornelius Schumacher']
   s.email       = ['schumacher@kde.org']
-  s.homepage    = "https://github.com/cornelius/inqlude"
+  s.homepage    = "http://inqlude.org"
   s.summary     = "Command line tool for handling Qt based libraries"
   s.description = "Inqlude is the command line interface for accessing the independent Qt library archive."
 
@@ -18,8 +18,13 @@ Gem::Specification.new do |s|
   s.add_dependency "thor", ">=0.14.0"
   s.add_dependency "json", ">=1.5.1"
   s.add_dependency "haml", ">=3.1.1"
+  s.add_dependency "json-schema", ">= 2.1.3"
+  s.add_dependency "kramdown"
+  s.add_dependency "xdg"
+
+  s.add_development_dependency "rspec", "~>3"
+  s.add_development_dependency "given_filesystem"
 
-  s.add_development_dependency "test-unit", "1.2.3"
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
   s.require_path = 'lib'

data/lib/cli.rb

@@ -98,11 +98,18 @@ actual domain."
   end
 
   desc "verify [filename]", "Verify all manifests or specific file if filename is given"
+  method_option :check_links, :type => :boolean,
+    :desc => "Check links for reachability."
   def verify filename=nil
     process_global_options options
 
     v = Verifier.new @@settings
 
+    if options[:check_links]
+      Upstream.get_involved "Implement --check-links option", 11
+      exit 1
+    end
+    
     if filename
       result = v.verify_file filename
       result.print_result
@@ -127,6 +134,18 @@ actual domain."
     end
   end
 
+  desc "review <repo>", "Review pull requests on GitHub. Use 'username:branch' as repo parameter."
+  def review repo, action = nil
+    if !action
+      GitHubTool.review repo
+    elsif action == "accept"
+      GitHubTool.accept repo
+    else
+      STDERR.puts "Unknown review action: '#{action}'"
+      exit 1
+    end
+  end
+  
   desc "system_scan", "Scan system for installed Qt libraries and create manifests"
   method_option :dry_run, :type => :boolean,
     :desc => "Dry run. Don't write files."
@@ -149,24 +168,69 @@ actual domain."
     m.process_all_rpms
   end
 
-  desc "create <manifest_name> <version> <release_date>", "Create new or updated manifest"
+  desc "create <manifest_name> [version] [release_date]", "Create new or updated manifest"
   method_option :kf5, :type => :boolean,
     :desc => "Create KDE Framworks 5 template", :required => false
-  def create name, version, release_date
+  def create name, version=nil, release_date=nil
     @@settings.manifest_path = "."
     creator = Creator.new @@settings, name
     if creator.is_new?
+      if !version && release_date || version && !release_date
+        STDERR.puts "You need to specify both, version and release date"
+        exit 1
+      end
+      if version && release_date
+        if options[:kf5]
+          creator.create_kf5 version, release_date
+        else
+          creator.create version, release_date
+        end
+      else
+        creator.create_generic
+      end
+    else
+      if !version || !release_date
+        STDERR.puts "Updating manifest requires version and release_date"
+        exit 1
+      end
       creator.validate_directory
       creator.update version, release_date
+    end
+  end
+
+  desc "create_kde_frameworks <frameworks-git-checkout> <output_dir>",
+    "Create manifests from git checkout of KDE frameworks module in given directory"
+  method_option "show-warnings", :type => :boolean,
+    :desc => "Show warnings about missing data", :required => false
+  method_option "ignore-errors-homepage", :type => :boolean,
+    :desc => "Ignore errors about missing home page", :required => false
+  def create_kde_frameworks checkout_dir, output_dir
+    k = KdeFrameworksCreator.new
+    if options["ignore-errors-homepage"]
+      k.parse_checkout checkout_dir, :ignore_errors => [ "link_home_page" ]
     else
-      if options[:kf5]
-        creator.create_kf5 version, release_date
-      else
-        creator.create version, release_date
+      k.parse_checkout checkout_dir
+    end
+    k.create_manifests output_dir
+    k.errors.each do |error|
+      puts "#{error[:name]}: #{error[:issue]}"
+    end
+    if options["show-warnings"]
+      k.warnings.each do |warning|
+        puts "#{warning[:name]}: #{warning[:issue]} (#{warning[:details]})"
       end
     end
   end
   
+  desc "release_kde_frameworks <release_date> <version>",
+    "Create release manifests for KDE frameworks release"
+  def release_kde_frameworks release_date, version
+    handler = ManifestHandler.new @@settings
+    k = KdeFrameworksRelease.new handler
+    k.read_generic_manifests
+    k.write_release_manifests release_date, version
+  end
+  
   desc "get_involved", "Information about how to get involved"
   def get_involved
     Upstream.print_info

data/lib/creator.rb

@@ -24,7 +24,7 @@ class Creator
   end
 
   def is_new?
-    return File.exists? @dir
+    return !File.exists?( @dir )
   end
   
   def validate_directory
@@ -47,22 +47,22 @@ class Creator
     m["release_date"] = release_date
     
     File.open( filename, "w" ) do |file|
-      file.puts JSON.pretty_generate(m)
+      file.puts Manifest.to_json(m)
     end
   end
 
   def create_dir
-    Dir.mkdir File.join(@settings.manifest_path,@name)
+    FileUtils.mkdir_p File.join(@settings.manifest_path,@name)
   end
 
   def create_manifest version, release_date
     m = Hash.new
-    m["schema_version"] = 1
+    m["$schema"] = Manifest.release_schema_id
     m["name"] = @name
     m["version"] = version
     m["release_date"] = release_date
     m["summary"] = ""
-    m["urls"] = { "homepage" => "", "vcs" => "" }
+    m["urls"] = { "homepage" => "", "vcs" => "", "download" => "" }
     m["licenses"] = [ "" ]
     m["description"] = ""
     if version == "edge"
@@ -70,20 +70,44 @@ class Creator
     else
       m["maturity"] = "stable"
     end
+    m["authors"] = [ "" ]
     m["platforms"] = [ "Linux" ]
     m["packages"] = { "source" => "" }
     m
   end
 
   def write_manifest manifest
-    filename = File.join @settings.manifest_path, @name,
-      "#{@name}.#{manifest["release_date"]}.manifest"
+    filename = File.join @settings.manifest_path, @name, @name
+    if manifest["release_date"]
+      filename += ".#{manifest["release_date"]}"
+    end
+    filename += ".manifest"
 
     File.open( filename, "w" ) do |file|
-      file.puts JSON.pretty_generate(manifest)
+      file.puts Manifest.to_json(manifest)
     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
+  end
+
+  def create_generic
+    create_dir
+    m = create_generic_manifest
+    write_manifest m
+  end
+  
   def create version, release_date
     create_dir
     m = create_manifest version, release_date

data/lib/git_hub_tool.rb

@@ -0,0 +1,92 @@
+# Copyright (C) 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
+# 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 GitHubTool
+  
+  def self.review repo
+    puts "Reviewing repo '#{repo}'"
+    
+    check_directory
+    if `git status` !~ /^# On branch master/
+      STDERR.puts "You need to be on the master branch"
+      exit 1
+    end
+
+    user,branch = parse_repo repo
+    
+    run "git checkout -b #{user}-#{branch} master"
+    begin
+      run "git pull git@github.com:#{user}/inqlude-data.git #{branch}"
+    rescue
+      run "git checkout master"
+      run "git branch -d #{user}-#{branch}"
+    end
+  end
+
+  def self.accept repo
+    check_directory
+
+    user,branch = parse_repo repo
+
+    branchname = "#{user}-#{branch}"
+    
+    if `git status` !~ /^# On branch #{branchname}/
+      STDERR.puts "You need to be on the #{branchname} branch"
+      exit 1
+    end
+    
+    run "git checkout master"
+    run "git merge #{branchname}"
+    run "git push origin master"
+    run "git branch -d #{branchname}"
+  end
+  
+  def self.check_directory
+    current_dir = File.basename Dir.pwd
+    if current_dir != "inqlude-data"
+      STDERR.puts "inqlude review needs to be run in the inqlude-data directory"
+      exit 1
+    end
+    if !File.exists? ".git"
+      STDERR.puts "inqlude-data directory needs to be a git checkout"
+      exit 1
+    end
+  end
+
+  def self.parse_repo repo
+    user = repo.split(":")[0]
+    branch = repo.split(":")[1]
+    
+    if !user
+      STDERR.puts "Unable to extract user from repo parameter"
+      exit 1
+    end
+    if !branch
+      STDERR.puts "Unable to extract branch from repo parameter"
+      exit 1
+    end
+    
+    return user,branch
+  end
+  
+  def self.run cmd
+    puts "Running: #{cmd}"
+    if !system cmd
+      raise "Command failed"
+    end
+  end
+  
+end