inqlude 0.0.3 → 0.0.4

data/TODO

@@ -1,20 +1,16 @@
 * Smarter match for source RPMs, which contain more than one library
-* Install a library
 * Show documentation of an library
 * Add "How to use" data
-* Generate web page of all libraries
 * Define maturity scale
 * Retrieve data from qt-apps and kde-apps
 * "How to package libraries"
 * Add tags for searching
-* Sync local repo with remote repo
 * Look for local search
-* Only look at devel packages when creating RPM based list
 * Get manifests from build service
 * Add option to verify given or all manifests
 * Add show option for showing library details
 * List libraries with available packages
 * Update manifest data to have complete package data
-* Add tests
 * Properly identify repository (use vendor?)
 * One-click install for SUSE systems
+* Don't duplicate partials in views

data/bin/inqlude

@@ -19,14 +19,6 @@
 
 require File.expand_path('../../lib/inqlude',__FILE__)
 
-def get_involved text, id = nil
-  puts "You can help and get involved:"
-  puts text
-  if id
-    puts "More info: https://github.com/cornelius/inqlude/issues/#{id}"
-  end
-end
-
 distro = Distro.detect
 if !distro
   STDERR.puts "Warning: unable to detect distro."

data/lib/cli.rb

@@ -79,12 +79,12 @@ class Cli < Thor
 
   desc "show <library_name>", "Show library details"
   def show name
-    get_involved "Add command for showing library details"
+    Upstream.get_involved "Add command for showing library details", 1
   end
 
   desc "verify", "Verify manifests"
   def verify
-    get_involved "Add command for verifying manifests"
+    Upstream.get_involved "Add command for verifying manifests", 2
   end
 
   desc "create", "Create manifest"
@@ -111,20 +111,29 @@ class Cli < Thor
 
   desc "get_involved", "Information about how to get involved"
   def get_involved
-    puts
-    puts "If you would like to help with development of the Inqlude tool,"
-    puts "have a look at the git repository, in particular the list of open"
-    puts "issues: https://github.com/cornelius/inqlude/issues"
-    puts
-    puts "If you would like to contribute information about a Qt based"
-    puts "library, have a look at the git repository containing the library"
-    puts "meta data: https://github.com/cornelius/inqlude_data"
-    puts
-    puts "Your help is appreciated."
-    puts
-    puts "If you have questions or comments, please let me know:"
-    puts "Cornelius Schumacher <schumacher@kde.org>"
-    puts
+    Upstream.print_info
+  end
+
+  desc "uninstall", "Uninstall library"
+  def uninstall name
+    handler = ManifestHandler.new @@settings
+    manifest = handler.manifest name
+    if !manifest
+      STDERR.puts "Manifest for '#{name}' not found"
+    else
+      @@distro.uninstall manifest
+    end
+  end
+
+  desc "install", "Install library"
+  def install name
+    handler = ManifestHandler.new @@settings
+    manifest = handler.manifest name
+    if !manifest
+      STDERR.puts "Manifest for '#{name}' not found"
+    else
+      @@distro.install manifest
+    end
   end
 
 end

data/lib/distros/suse.rb

@@ -57,10 +57,51 @@ class Suse
         unknown -= 1
       end
     end
-    
-    STDERR.puts "Warning: #{unknown} libraries don't have package information"
-    
+
+    if unknown > 0
+      STDERR.puts "Warning: #{unknown} libraries don't have package information"
+    end  
+  
     installed
   end
 
+  def uninstall manifest
+    package_name = get_package_name manifest
+    if package_name
+      system "sudo zypper rm #{package_name}"
+    end
+  end
+
+  def install manifest
+    package_name = get_package_name manifest
+    if package_name
+      system "sudo zypper install #{package_name}"
+    end
+  end
+
+  def get_package_name manifest
+    package_section = manifest["packages"]
+    if !package_section
+      STDERR.puts "No packages section in metadata"
+    else
+      name_section = package_section[name]
+      if !name_section
+        STDERR.puts "No section '#{name}' found in packages section."
+      else
+        version_section = name_section[version]
+        if !version_section
+          STDERR.puts "No section '#{version}' found in section '#{name}'"
+        else
+          package_name = version_section["package_name"]
+          if !package_name || package_name.empty?
+            STDERR.puts "No package name found"
+          else
+            return package_name
+          end
+        end
+      end
+    end
+    nil
+  end
+
 end

data/lib/inqlude.rb

@@ -11,3 +11,4 @@ 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__)

data/lib/manifest_handler.rb

@@ -24,12 +24,36 @@ class ManifestHandler
     @manifests = Array.new
   end
 
+  def manifest name
+    read_remote
+    @manifests.each do |manifest|
+      if manifest["name"] == name
+        return manifest
+      end
+    end
+    nil
+  end
+
   def read_remote
-    Dir.glob( "#{@settings.manifest_dir}/*.manifest" ).sort.each do |filename|
+    fetch_remote
+  
+    Dir.glob( "#{@settings.manifest_path}/*.manifest" ).sort.each do |filename|
       File.open filename do |file|
         manifests.push JSON file.read
       end
     end
   end
 
+  def fetch_remote
+    if !File.exists? @settings.manifest_path + "/.git"
+      if File.exists? @settings.manifest_path
+        system "rm -r #{@settings.manifest_path}"
+      end
+      system "git clone https://github.com/cornelius/inqlude_data.git " +
+        "#{@settings.manifest_path}"
+    else
+      system "cd #{@settings.manifest_path}; git pull"
+    end
+  end
+
 end

data/lib/rpm_manifestizer.rb

@@ -173,7 +173,7 @@ class RpmManifestizer
 
   def create_source_cache
     puts "Creating cache of RPM meta data"
-    get_involved "Create more friendly progress display for cache creation"
+    Upstream.get_involved "Create more friendly progress display for cache creation", 3
     sources = Hash.new
     IO.popen "rpmqpack" do |f|
       while line = f.gets do

data/lib/settings.rb

@@ -16,8 +16,8 @@
 
 class Settings
 
-  def manifest_dir
-    local_dir "manifests"
+  def manifest_path
+    local_path "manifests"
   end
 
   def cache_dir
@@ -30,10 +30,14 @@ class Settings
 
   private
 
-  def local_dir dirname
+  def local_path dirname
     home = ENV["HOME"] + "/.inqlude/"
     Dir::mkdir home unless File.exists? home
-    path = home + dirname
+    home + dirname
+  end
+
+  def local_dir dirname
+    path = local_path dirname
     Dir::mkdir path unless File.exists? path
     path
   end

data/lib/upstream.rb

@@ -0,0 +1,44 @@
+# Copyright (C) 2011 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 Upstream
+
+  def self.get_involved text, id = nil
+    puts "You can help and get involved:"
+    puts text
+    if id
+      puts "More info: https://github.com/cornelius/inqlude/issues/#{id}"
+    end
+  end
+
+  def self.print_info
+    puts
+    puts "If you would like to help with development of the Inqlude tool,"
+    puts "have a look at the git repository, in particular the list of open"
+    puts "issues: https://github.com/cornelius/inqlude/issues"
+    puts
+    puts "If you would like to contribute information about a Qt based"
+    puts "library, have a look at the git repository containing the library"
+    puts "meta data: https://github.com/cornelius/inqlude_data"
+    puts
+    puts "Your help is appreciated."
+    puts
+    puts "If you have questions or comments, please let me know:"
+    puts "Cornelius Schumacher <schumacher@kde.org>"
+    puts
+  end
+
+end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Inqlude
 
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
 end

data/lib/view.rb

@@ -28,12 +28,10 @@ class View
     assert_dir "#{output_dir}/public"
     system "cp #{view_dir}/public/* #{output_dir}/public/"
 
-    index = template "index"
-    engine = Haml::Engine.new index
-
-    File.open "#{output_dir}/index.html", "w" do |file|
-      file.puts engine.render( binding )
-    end
+    render_template "index", output_dir
+    render_template "about", output_dir
+    render_template "get", output_dir
+    render_template "contribute", output_dir
 
     library_path = "#{output_dir}/libraries/"
     assert_dir library_path
@@ -46,7 +44,15 @@ class View
         file.puts engine.render( binding )
       end
     end
+  end
+
+  def render_template name, output_dir
+    page = template name
+    engine = Haml::Engine.new page
 
+    File.open "#{output_dir}/#{name}.html", "w" do |file|
+      file.puts engine.render( binding )
+    end
   end
 
   def m attr
@@ -61,6 +67,13 @@ class View
     "<a href=\"#{url}\" target=\"_blank\">#{url}</a>"
   end
 
+  def link_to title, url
+    if url !~ /^mailto:/ && url !~ /^http:/
+      url += ".html"
+    end
+    "<a href=\"#{url}\">#{title}</a>"
+  end
+
   def manifests
     if @manifest_handler.manifests.empty?
       @manifest_handler.read_remote

data/view/about.html.haml

@@ -0,0 +1,46 @@
+%head
+  %link{ :rel => "stylesheet", :type => "text/css",
+         :href => "public/inqlude.css" }
+  <link href='http://fonts.googleapis.com/css?family=Droid+Sans' rel='stylesheet' type='text/css'>
+%body
+  .header.center
+    %h1
+      %span.logo><
+        \#in
+      %span.logo.green><
+        q
+      %span.logo><
+        lude
+      %span.subtitle
+        The Qt library archive
+
+  .menu.center
+    %span.menu_items
+      = link_to "How to get libraries", "get"
+      |
+      = link_to "How to contribute", "contribute"
+      |
+      = link_to "About", "about"
+
+  .content.center
+    %p
+      Inqlude is the independent archive of Qt based libraries. Its mission is
+      to make it as easy as possible for developers using Qt to find and use
+      libraries, in particular 3rd party ones.
+    %p
+      Inqlude comes with a command line client for handling libraries. See the
+      = link_to "instructions how to get libraries", "get"
+      for more details.
+    %p
+      Inqlude tries to be a complete archive of all available Qt based
+      libraries. If you notice that there is some information missing, outdated
+      or inaccurate, please consider contributing the missing data. See the
+      = link_to "instructions how to contribute", "contribute"
+      for more details.
+    %p
+      %em
+        Note that Inqlude is currently a proof-of-concept. It's not ready for
+        production use yet. Feedback and input is appreciated.
+    %p
+      If you have questions of comments please feel free to contact
+      = link_to( "Cornelius Schumacher", "mailto:schumacher@kde.org" ) + "."

data/view/contribute.html.haml

@@ -0,0 +1,57 @@
+%head
+  %link{ :rel => "stylesheet", :type => "text/css",
+         :href => "public/inqlude.css" }
+  <link href='http://fonts.googleapis.com/css?family=Droid+Sans' rel='stylesheet' type='text/css'>
+%body
+  .header.center
+    %h1
+      %span.logo><
+        \#in
+      %span.logo.green><
+        q
+      %span.logo><
+        lude
+      %span.subtitle
+        The Qt library archive
+
+  .menu.center
+    %span.menu_items
+      = link_to "How to get libraries", "get"
+      |
+      = link_to "How to contribute", "contribute"
+      |
+      = link_to "About", "about"
+
+  .content.center
+    %h2 Contributing data about libraries
+    
+    %p
+      To get a complete overview about all available Qt based libraries, we need
+      to collect data about these libraries. This includes descriptions,
+      instructions how to use them, as well as links to sources or installable
+      packages.
+    %p
+      The meta data used by Inqlude is collected in a git repository at
+      = link( "http://github.com/cornelius/inqlude_data" ) + "."
+      It contains a manifest file in JSON format for each library, which has the
+      meta data in a structured machine-readable form. JSON is easy enough for
+      humans to read and edit as well.
+    %p
+      You can contribute meta data by providing patches to the inqlude_data
+      repository. Use the github mechanisms or just send patches by email.
+      Contributions are welcome.
+    
+    %h2 Contributing to the Inqlude tools
+    
+    %p
+      The command line tool is developed in another git repository at
+      = link( "http://github.com/cornelius/inqlude" ) + "."
+      It's still in a proof-of-concept state, so there is quite a bit work left.
+      Have a look at the
+      = link_to "list of open issues", "http://github.com/cornelius/inqlude/issues"
+      or read the source and come up with your own ideas what to improve.
+    %p
+      Especially welcome are contributions for adding support for native
+      package systems on the variety of Linux distributions and other systems
+      out there.
+      

data/view/get.html.haml

@@ -0,0 +1,67 @@
+%head
+  %link{ :rel => "stylesheet", :type => "text/css",
+         :href => "public/inqlude.css" }
+  <link href='http://fonts.googleapis.com/css?family=Droid+Sans' rel='stylesheet' type='text/css'>
+%body
+  .header.center
+    %h1
+      %span.logo><
+        \#in
+      %span.logo.green><
+        q
+      %span.logo><
+        lude
+      %span.subtitle
+        The Qt library archive
+
+  .menu.center
+    %span.menu_items
+      = link_to "How to get libraries", "get"
+      |
+      = link_to "How to contribute", "contribute"
+      |
+      = link_to "About", "about"
+
+  .content.center
+    %p
+      This page is about how to use Inqlude as a user, a developer using Qt
+      based libraries in her projects.
+    %p
+      First you can just use the web site. Find the information about libraries
+      here, and get the libraries manually with the provided links. This works,
+      but there is a more convenient way.
+    %p
+      You can also use the command line client. This client makes it easy to get
+      the libraries you need with just a few commands, without having to know
+      URLs, or how libraries are packages.
+    %p
+      First you need to get the command line client. It's available as a Ruby
+      gem, so when you have rubygems installed you can simply do a
+      .code
+        sudo gem install inqlude
+      (For instructions how to get rubygems, see
+      = link_to( "rubygems.org", "http://rubygems.org" ) + ")."
+    %p
+      Once you have the client, you can get help about the available commands
+      with
+      .code
+        inqlude
+      get a list of available libraries with
+      .code
+        inqlude list -r
+
+      install a library with 
+      .code
+        inqlude install <library_name>
+
+      and get a list of installed libraries with
+      .code
+        inqlude list
+    %p
+      The command line client uses your native package management system. In
+      case there is no meta data available for your system, the client falls
+      back to handling sources. Please consider helping to get your system
+      supported by contributing meta data or implementing a backend for your
+      system. See the
+      = link_to "instructions how to contribute", "contribute"
+      for more details.

data/view/index.html.haml

@@ -15,6 +15,12 @@
         The Qt library archive
 
   .menu.center
+    %span.menu_items
+      = link_to "How to get libraries", "get"
+      |
+      = link_to "How to contribute", "contribute"
+      |
+      = link_to "About", "about"
 
   .content.center
     %table

data/view/library.html.haml

@@ -15,6 +15,12 @@
         The Qt library archive
 
   .menu.center
+    %span.menu_items
+      = link_to "How to get libraries", "get"
+      |
+      = link_to "How to contribute", "contribute"
+      |
+      = link_to "About", "about"
 
   .content.center
     %h2

data/view/public/inqlude.css

@@ -40,8 +40,19 @@ h1 .subtitle {
 
 .menu {
   width: 85%;
-  height: 20px;
   background-color: green;
+  padding-top: 4px;
+  padding-bottom: 6px;
+  padding-right: 10px;
+  text-align: right;
+}
+
+.menu_items {
+  color: white;
+}
+
+.menu_items a {
+  color: white;
 }
 
 .content {
@@ -50,6 +61,14 @@ h1 .subtitle {
   padding: 10px;
 }
 
+.code {
+  background-color: black;
+  color: white;
+  padding: 10px;
+  font-family: monospace;
+  margin: 6px;
+}  
+
 table {
   margin: auto;
 }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: inqlude
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Cornelius Schumacher
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-13 00:00:00 +02:00
+date: 2011-06-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,10 +106,14 @@ files:
 - lib/manifest_handler.rb
 - lib/rpm_manifestizer.rb
 - lib/settings.rb
+- lib/upstream.rb
 - lib/version.rb
 - lib/view.rb
 - test/rpm_manifestizer_test.rb
 - test/test_helper.rb
+- view/about.html.haml
+- view/contribute.html.haml
+- view/get.html.haml
 - view/index.html.haml
 - view/library.html.haml
 - view/public/inqlude.css