inqlude 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfb73e8e83eb6e2b8e86b2e7289be7934d3c5967
-  data.tar.gz: 43279f4302b345f134218d48aebb844031c9b8a2
+  metadata.gz: b71cfe26a50e95a5925b48324ff91b084b0bcd7e
+  data.tar.gz: 3a07f9ec5fd189e2d258f5de6871dccb8cc44ab0
 SHA512:
-  metadata.gz: d177de51fd1b3d7161adad5eef36ff8bdb47e7aeae565f48a6728ba8beefd2be19537bba03bd0134c2a24e5df102717492de7cfa1196d24f214c2e72e3f77eca
-  data.tar.gz: 8638a6c79f6c7400f577e010b7273022130d51d9ea7457d2e0bc5db48ba124098cdb4da83d85f0d5946512e32529781fdc2bb9a597a4a9e4b2f85871db42790e
+  metadata.gz: 0665295254b87ab55b65dcd8e95c5e9406f467186684e551e989b2955bd460f92f2c62873dbed355a94f76f23a7bee76124c59e7eae38cda6bff462329fac7bc
+  data.tar.gz: 704e0a8c7584a2c4ba13524dc5b8c1e62c593341bccb70d2a10171225c4bc8c974e380bb7a8df9867cacaa8bc281263776a0ce7b7985da31827f6cd5817d1508

data/.rspec

@@ -1 +1,2 @@
 --color
+--format=doc

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
 rvm:
-  - "2.1.9"
-  - "2.2.5"
-  - "2.3.1"
+- 2.1.9
+- 2.2.5
+- 2.3.1
 script: bundle exec rspec spec
+addons:
+  code_climate:
+    repo_token:
+      secure: x4ET3gWdfwTC66ExUDoYFdJ3AvCTbms7dokF7RaUrf7xnr3PInHnRgzZP7hICkEYW4t20JPjwiJUUdifk5XUcMSlQ5AAPKjFXP4wyQYPvpizI5FvRsX0a62/Fv1juXxs9hPFmXITqN861iT1rkqC383evyR9KxPDZMOi0VEOjAs=

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log of Inqlude
 
+## Version 0.9.0
+
+* Put out progress when creating release manifests
+* Prototype for new layout of the website as alternative view template
+* Better error when view templates directory does not exist
+* Show topics in view
+* Add validation for display_name attribute
+* Gracefully fail in --version when Qt is not installed
+
 ## Version 0.8.0
 
 * Add topic attribute to manifest specification and adapt validator to allow topic attribute as an optional parameter. The validator reports missing topics as a warning for each manifest which does not have a topic attribute, but not fail.

data/Gemfile

@@ -1,3 +1,7 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+gem "travis", group: :test, require: nil
+gem "nokogiri"

data/README.md

@@ -1,6 +1,10 @@
 # Inqlude - the Qt library archive
 
+[![Gem Version](https://badge.fury.io/rb/inqlude.svg)](https://badge.fury.io/rb/inqlude)
 [![Build Status](https://travis-ci.org/cornelius/inqlude.svg?branch=master)](https://travis-ci.org/cornelius/inqlude)
+[![Dependency Status](https://dependencyci.com/github/cornelius/inqlude/badge)](https://dependencyci.com/github/cornelius/inqlude)
+[![Code Climate](https://codeclimate.com/github/cornelius/inqlude/badges/gpa.svg)](https://codeclimate.com/github/cornelius/inqlude)
+[![Test Coverage](https://codeclimate.com/github/cornelius/inqlude/badges/coverage.svg)](https://codeclimate.com/github/cornelius/inqlude/coverage)
 
 ## Overview
 

data/lib/cli.rb

@@ -26,29 +26,10 @@ class Cli < Thor
     @@settings = s
   end
 
-  def self.distro
-    @@distro if @@distro
-
-    @@distro = Distro.detect
-    if !@@distro
-      STDERR.puts "Warning: unable to detect distro."
-    end
-  end
-
   desc "global", "Global options", :hide => true
   def global
     if options[:version]
-      puts "Inqlude: #{@@settings.version}"
-
-      qmake_out = `qmake -v`
-      qmake_out =~ /Qt version (.*) in/
-      puts "Qt: #{$1}"
-
-      if self.distro
-        puts "OS: #{self.distro.name} #{self.distro.version}"
-      else
-        puts "OS: unknown"
-      end
+      CliController.print_versions(Distro.detect)
     else
       Cli.help shell
     end
@@ -68,7 +49,7 @@ class Cli < Thor
         puts library.name + " (" + library.versions.join(", ") + ")"
       end
     else
-      manifests = self.distro.installed handler
+      manifests = Distro.detect.installed handler
       manifests.each do |manifest|
         puts manifest["name"]
       end
@@ -85,20 +66,37 @@ class Cli < Thor
 actual domain."
   method_option :disable_search, :type => :boolean,
     :desc => "Disable Google based search."
+  method_option :templates, :type => :string, :aliases => "-t", :default => "one-column",
+    :desc => "Switch templates", :required => false
   def view
     process_global_options options
 
+    output_dir = options[:output_dir]
+    
     if options[:manifest_dir]
       @@settings.manifest_path = options[:manifest_dir]
     end
 
     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]
+    
+    view.templates = options[:templates]
+
+    if !view.template_directory_exists?
+      STDERR.puts "Error: Templates directory doesn't exist"
+      exit 1
+    else
+      puts "Creating web site in '#{output_dir}' from '#{manifest_handler.settings.manifest_path}'"
+
+      view.enable_disqus = options[:enable_disqus]
+      view.enable_search = !options[:disable_search]
+
+      view.create output_dir
+    end
+
   end
 
   desc "show <library_name>", "Show library details"
@@ -273,7 +271,7 @@ actual domain."
     if !manifest
       STDERR.puts "Manifest for '#{name}' not found"
     else
-      self.distro.uninstall manifest
+      Distro.detect.uninstall manifest
     end
   end
 
@@ -286,7 +284,7 @@ actual domain."
     if !manifest
       STDERR.puts "Manifest for '#{name}' not found"
     else
-      self.distro.install manifest, :dry_run => options[:dry_run]
+      Distro.detect.install manifest, :dry_run => options[:dry_run]
     end
   end
 

data/lib/cli_controller.rb

@@ -0,0 +1,24 @@
+class CliController
+  def self.print_versions(distro)
+    puts "Inqlude: #{Inqlude::VERSION}"
+
+    if find_executable("qmake")
+      qmake_out = `qmake -v`
+      qmake_out =~ /Qt version (.*) in/
+      puts "Qt: #{$1}"
+    else
+      puts "Qt: not found"
+    end
+
+    if distro
+      puts "OS: #{distro.name} #{distro.version}"
+    else
+      puts "OS: unknown"
+    end
+  end
+
+  def self.find_executable(executable)
+    `which #{executable}`
+    $?.success?
+  end
+end

data/lib/inqlude.rb

@@ -29,3 +29,4 @@ require_relative("manifest")
 require_relative("kde_frameworks_creator")
 require_relative("kde_frameworks_release")
 require_relative("downloader")
+require_relative("cli_controller")

data/lib/kde_frameworks_release.rb

@@ -40,23 +40,28 @@ class KdeFrameworksRelease
   end
 
   def read_generic_manifests
+    puts "Reading generic manifests from '#{@handler.settings.manifest_path}'..."
     @generic_manifests = Array.new
     @handler.read_remote
     @handler.group("kde-frameworks").each do |library|
       @generic_manifests.push library.generic_manifest
     end
+    puts "Read #{@generic_manifests.count} manifests."
     @generic_manifests
   end
 
   def write_release_manifests release_date, version
+    puts "Writing release manifests for version '#{version}'..."
     @generic_manifests.each do |generic_manifest|
       release_manifest = KdeFrameworksRelease.create_release_manifest(
         generic_manifest, release_date, version )
       path = @handler.manifest_path( release_manifest )
       File.open( path, "w" ) do |file|
+        puts "  #{path}"
         file.write release_manifest.to_json
       end
-    end    
+    end
+    puts "Written #{@generic_manifests.count} manifests."
   end
   
 end

data/lib/manifest_handler.rb

@@ -53,7 +53,28 @@ class ManifestHandler
       manifest.licenses.include? "Commercial"
     end
   end
-  
+
+  def latest_libraries
+    releases = Array.new
+    is_kde_added = false
+
+    libraries.select do |library|
+      if library.latest_manifest.has_version? && library.latest_manifest.group != "kde-frameworks"
+        releases.push library
+      elsif library.latest_manifest.has_version? && library.latest_manifest.group == "kde-frameworks"
+        if !is_kde_added
+          is_kde_added = true
+          releases.push library
+        end
+      end
+    end
+
+    releases.sort! {|a,b| a.latest_manifest.release_date <=> b.latest_manifest.release_date}
+    releases.reverse!
+
+    return releases[0 .. 4]
+  end
+
   def group name
     return @libraries.select do |l|
       manifest = l.latest_manifest
@@ -79,6 +100,28 @@ class ManifestHandler
     raise InqludeError.new("Unable to find manifest '#{name}'")
   end
 
+  def topic name
+    return @libraries.select do |l|
+      manifest = l.latest_manifest
+      if manifest.topics
+        manifest.topics.include? name
+      end
+    end
+  end
+
+  def no_of_libraries topic
+    count =0;
+    @libraries.each do |l|
+      topics = l.latest_manifest.topics
+      if topics
+        if l.latest_manifest.topics.include? topic
+          count = count + 1
+        end
+      end
+    end
+    count
+  end
+
   def read_remote
     @libraries.clear
     @manifests.clear

data/lib/verifier.rb

@@ -88,6 +88,10 @@ class Verifier
         @result.errors.push "Schema validation error: #{error}"
       end
 
+      if manifest.display_name.nil?
+        @result.warnings.push "Warning: missing `display_name` attribute"
+      end
+
       topics =  manifest.topics
       if topics.nil?
         @result.warnings.push "Warning: missing `topics` attribute"

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Inqlude
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/view.rb

@@ -16,7 +16,7 @@
 
 class View
 
-  attr_accessor :enable_disqus,:enable_search,:manifest,:library,:group_name
+  attr_accessor :enable_disqus,:enable_search,:manifest,:library,:group_name,:templates
   attr_reader :root
   
   def initialize handler
@@ -24,11 +24,13 @@ class View
   end
 
   def create output_dir
-    puts "Creating web site in '#{output_dir}' from '#{@manifest_handler.settings.manifest_path}'"
-    
     assert_dir output_dir
 
     system "cp #{view_dir}/favicon.ico #{output_dir}"
+
+    if templates == "two-column"
+      system "cp #{view_dir}/ios.ico #{output_dir}"
+    end
     
     assert_dir "#{output_dir}/public"
     system "cp #{view_dir}/public/* #{output_dir}/public/"
@@ -38,19 +40,15 @@ class View
 
     create_inqlude_all(output_dir)
 
-
     @root = ""
 
-    render_template "index", 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
-    
+    Dir.glob("#{view_dir}*.html.haml") do |file|
+      template_name = (File.basename file).split(".").first
+
+      if !["layout","group","library"].include? template_name
+        render_template template_name, output_dir
+      end
+    end
 
     groups_path = "#{output_dir}/groups/"
     assert_dir groups_path
@@ -73,6 +71,19 @@ class View
       file_name = "libraries/" + library.name
       render_template "library", output_dir, file_name
     end
+
+    if templates == 'two-column'
+      topics_path = "#{output_dir}/topics/"
+      assert_dir topics_path
+
+      @root = "../"
+
+      topics.each do |topic|
+        @topic = topic
+        file_name = "topics/" + topic
+        render_template "topic", output_dir, file_name
+      end
+    end
   end
 
   def create_inqlude_all(output_dir)
@@ -81,6 +92,10 @@ class View
     end
   end
 
+  def template_directory_exists?
+    File.directory?(view_dir) ? true : false
+  end
+
   def render_template name, output_dir, file_name = nil
     layout = template "layout"
     layout_engine = Haml::Engine.new layout
@@ -112,10 +127,18 @@ class View
     @manifest
   end
 
+  def t
+    @topic
+  end
+
   def link_to_manifest name
     "<a href=\"#{@root}libraries/#{name}.html\">#{name}</a>"
   end
 
+  def link_to_library name, display_name
+    "<a href=\"#{@root}libraries/#{name}.html\">#{display_name}</a>"
+  end
+
   def link url
     "<a href=\"#{url}\" target=\"_blank\">#{url}</a>"
   end
@@ -127,6 +150,14 @@ class View
     "<a href=\"#{url}\">#{title}</a>"
   end
 
+  def link_to_group name, display_name
+    "<a href=\"#{@root}groups/#{name}.html\">#{display_name}</a>"
+  end
+
+  def link_to_topic name
+    "<a href=\"#{@root}topics/#{name}.html\">#{name}</a>"
+  end
+
   def list_attribute attribute
     attr = @manifest.send(attribute)
     return "" if !attr || attr.size == 0
@@ -217,6 +248,10 @@ class View
     @manifest_handler.commercial_libraries
   end
 
+  def latest_libraries
+    @manifest_handler.latest_libraries
+  end
+
   def group_title
     if @group_name == "kde-frameworks"
       return "KDE Frameworks"
@@ -227,6 +262,14 @@ class View
   def group
     @manifest_handler.group(@group_name)
   end
+
+  def topic name
+    @manifest_handler.topic(name)
+  end
+
+  def no_of_libraries topic
+    @manifest_handler.no_of_libraries(topic)
+  end
   
   def disqus_enabled?
     @enable_disqus
@@ -261,6 +304,10 @@ class View
     doc.to_html
   end
 
+  def topics
+    ['API', 'Artwork', 'Bindings', 'Communication', 'Data', 'Desktop', 'Development', 'Graphics', 'Logging', 'Mobile', 'Multimedia', 'Printing', 'QML', 'Scripting', 'Security', 'Text', 'Web', 'Widgets']
+  end
+
   private
   
   def assert_dir name
@@ -272,7 +319,7 @@ class View
   end
 
   def view_dir
-    File.expand_path( File.dirname( __FILE__ ) + "/../view/" ) + "/"
+    File.expand_path( File.dirname( __FILE__ ) + "/../view/#{templates}" ) + "/"
   end
 
   def schema_dir