jekyll-fdroid 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4b78b9f00daf8c96e99905e33a38149b2ea0f2e
-  data.tar.gz: 841d3465e9c14da0bd3bda315672d6d0c2b5f7c4
+  metadata.gz: 5223ec6f44fa3c3131928d083cee93e06c28045b
+  data.tar.gz: 1acae1bbdda2af1529df4d8fc955e27d6e428514
 SHA512:
-  metadata.gz: 4cb43683d09abcf6a5cf4fb0b4168bcb61582017f632aa2d7b92d509bb9ac16bc215c2eaf93c55f0d312468d1a8a6343827e8542786f064293b26f2ae87ce73f
-  data.tar.gz: bffd6df0de24f340df08d420e3b38aa0372f6476a2de610cd5fde5bcf8bbfeec47dfee23edf0e6d12559dcbc8dc695578e909b5706ff0639bcd6b91fd8db8141
+  metadata.gz: 52dd3848f495b9cf4a2c973faf5f3324e90bdacacbd21545e63a93a455771c4d1522739aba09968727e8e48f4d7bc496320142138ec9425cc7ce420fcad98bf6
+  data.tar.gz: c6227570b89a1c4edad316e55678bca5bd1278f28511d3474f41f58d6eda57bcd625c760626bebde750f80a960b6dd8fb828a08c87ca82ca1bc62e10d6469e78

data/lib/fdroid/App.rb

@@ -0,0 +1,248 @@
+# F-Droid's Jekyll Plugin
+#
+# Copyright (C) 2017 Nico Alt
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative './Package'
+
+module FDroid
+  class App
+    def initialize(app, packages, locale)
+      # Sort packages in reverse-chronological order
+      @packages = packages.map { |p| Package.new(p) }
+      @app = app
+      @locale = locale
+      @available_locales = app.key?('localized') ? App.available_locales(locale, app['localized']) : nil
+    end
+
+    def package_name
+      field 'packageName'
+    end
+
+    def to_s
+      package_name
+    end
+
+    def icon
+      localized = App.localized_graphic_path(@available_locales, @app['localized'], 'icon')
+      if localized
+        "#{package_name}/#{localized}"
+      else
+        "icons-640/#{field('icon')}"
+      end
+    end
+
+    def name
+      App.localized(@available_locales, @app['localized'], 'name') || field('name')
+    end
+
+    def summary
+      App.localized(@available_locales, @app['localized'], 'summary') || field('summary')
+    end
+
+    def description
+      desc = App.localized(@available_locales, @app['localized'], 'description') || field('description')
+
+      if desc != nil
+        desc = App.process_app_description(desc)
+      end
+
+      return desc
+    end
+
+    def suggested_version_code
+      code = field('suggestedVersionCode')
+      if code != nil
+        code = Integer(code)
+      end
+      return code
+    end
+
+
+    # Generates a hash of dumb strings to be used in templates.
+    # If a specific value is not present, then it will have a nil value.
+    # If a value can be localized, then it will choose the most appropriate
+    # translation based on @available_locales and @locale.
+    # The 'packages' key is an array of Package.to_data hashes.
+    # @return [Hash]
+    def to_data
+      {
+          # These fields are taken as is from the metadata. If not present, they are
+          'package_name' => package_name,
+          'author_email' => field('authorEmail'),
+          'author_name' => field('authorName'),
+          'author_website' => field('authorWebSite'),
+          'bitcoin' => field('bitcoin'),
+          'donate' => field('donate'),
+          'flattr' => field('flattr'),
+          'categories' => field('categories'),
+          'anti_features' => field('anti_features'),
+          'suggested_version_code' => suggested_version_code,
+          'suggested_version_name' => @packages.detect { |p| p.version_code == suggested_version_code }&.version_name,
+          'issue_tracker' => field('issueTracker'),
+          'changelog' => field('changelog'),
+          'license' => field('license'),
+          'source_code' => field('sourceCode'),
+          'website' => field('webSite'),
+          'added' => field('added'),
+          'last_updated' => field('lastUpdated'),
+          'whats_new' => App.process_app_description(App.localized(@available_locales, @app['localized'], 'whatsNew')),
+
+          'icon' => icon,
+          'title' => name,
+          'summary' => summary,
+
+          'description' => description,
+          'feature_graphic' => App.localized_graphic_path(@available_locales, @app['localized'], 'featureGraphic'),
+          'phone_screenshots' => App.localized_graphic_list_paths(@available_locales, @app['localized'], 'phoneScreenshots'),
+          'seven_inch_screenshots' => App.localized_graphic_list_paths(@available_locales, @app['localized'], 'sevenInchScreenshots'),
+
+          'packages' => @packages.sort.reverse.map { |p| p.to_data },
+
+          'beautiful_url' => "/packages/#{package_name}"
+      }
+    end
+
+    # Any transformations which are required to turn the "description" into something which is
+    # displayable via HTML is done here (e.g. replacing "fdroid.app:" schemes, formatting new lines,
+    # etc.
+    def self.process_app_description(string)
+      if string == nil
+        return nil
+      end
+
+      string = self.replace_fdroid_app_links(string)
+      self.format_description_to_html(string)
+    end
+
+    # Finds all "fdroid.app:" schemes in a particular string, and replaces with "/packages/".
+    # @param [string]  string
+    # @return [string]
+    def self.replace_fdroid_app_links(string)
+      string.gsub /fdroid\.app:([\w._]*)/, '/packages/\1'
+    end
+
+    # Ensure double newlines "\n\n" are converted to "<br />" tags.
+    def self.format_description_to_html(string)
+      string
+        .gsub("\n\n", '<br />')
+        .gsub(/\r?\n/, ' ')
+    end
+
+    # @param [string] available_locales
+    # @param [string] localized
+    # @param [string] field
+    # @return [string]
+    def self.localized(available_locales, localized, field)
+      return nil unless available_locales != nil
+
+      available_locales.each do |l|
+        if localized[l].key?(field)
+          return localized[l][field]
+        end
+      end
+
+      return nil
+    end
+    
+    # Prefixes the result with "chosen_locale/" before returning.
+    # @see localized
+    def self.localized_graphic_path(available_locales, localized, field)
+      return nil unless available_locales != nil
+      
+      available_locales.each do |l|
+        if localized[l].key?(field)
+          return "#{l}/#{localized[l][field]}"
+        end
+      end
+      
+      return nil
+    end
+    
+    # Similar to localized_graphic_path, but prefixes each item in the resulting array
+    # with "chosen_locale/field/".
+    # @see localized
+    # @see localized_graphic_path
+    def self.localized_graphic_list_paths(available_locales, localized, field)
+      return nil unless available_locales != nil
+      
+      available_locales.each do |l|
+        if localized[l].key?(field)
+          return localized[l][field].map { |val| "#{l}/#{field}/#{val}" }
+        end
+      end
+      
+      return nil
+    end
+
+    # Given the desired_locale, searches through the list of localized_data entries
+    # and finds those with keys which match either:
+    #  * The desired locale exactly
+    #  * The same language as the desired locale (but different region)
+    #  * Any English language (so if the desired language is not there it will suffice)
+    #
+    # These will be sorted in order of preference:
+    #  * Exact matches (language and region)
+    #  * Language portion matches but region is absent/doesn't match.
+    #  * en-US
+    #  * en
+    #  * en-*
+    #
+    # It is intentionally liberal in searching for either "_" or "-" to separate language
+    # and region, because they both mean (in different context) to split langugae on the
+    # left, and region on the right, and it is cheap to do so.
+    #
+    # @param [string]  desired_locale
+    # @param [Hash]  localized_data
+    # @return [Array]
+    def self.available_locales(desired_locale, localized_data)
+      parts = desired_locale.split(/[_-]/)
+      desired_lang = parts[0]
+
+      locales = localized_data.keys.select do |available_locale|
+        parts = available_locale.split(/[_-]/)
+        available_lang = parts[0]
+        available_lang == desired_lang || available_lang == 'en'
+      end
+
+      measure_locale_goodness = lambda do |locale|
+        parts = locale.split(/[_-]/)
+        lang = parts[0]
+        region = parts.length > 1 ? parts[1] : nil
+        if locale == desired_locale
+          return 1
+        elsif lang == desired_lang
+          return 2
+        elsif locale == 'en-US'
+          return 3
+        elsif lang == 'en' && region.nil?
+          return 4
+        elsif lang == 'en'
+          return 5
+        end
+      end
+
+      locales.sort do |a, b|
+        measure_locale_goodness.call(a) <=> measure_locale_goodness.call(b)
+      end
+    end
+
+    private
+
+    def field(name)
+      @app.key?(name) ? @app[name] : nil
+    end
+  end
+end

data/lib/fdroid/IndexV1.rb

@@ -0,0 +1,75 @@
+# F-Droid's Jekyll Plugin
+#
+# Copyright (C) 2017 Nico Alt
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'tmpdir'
+require 'open-uri'
+require 'net/http'
+require 'json'
+require 'zip'
+require_relative './App'
+require_relative './Repo'
+
+module FDroid
+  class IndexV1
+    attr_reader :apps, :repo
+
+    @@downloaded_repos = {}
+
+    # Download and parse an index, returning a new instance of IndexV1.
+    # @param [string]  repo
+    # @param [string]  locale
+    # @return [FDroid::IndexV1]
+    def self.download(repo, locale)
+      repo = URI.parse "#{repo}/index-v1.jar"
+      index = download_index repo
+      IndexV1.new(JSON.parse(index), locale)
+    end
+
+    # Make a network request, download the index-v1.jar file from the repo, unzip and get the contents
+    # of the index-v1.json file.
+    # @param [string]  repo
+    # @return [Hash]
+    def self.download_index(repo)
+      if @@downloaded_repos.has_key? repo
+        return @@downloaded_repos[repo]
+      end
+
+      Dir.mktmpdir do |dir|
+        jar = File.join dir, 'index-v1.jar'
+        open(jar, 'wb') do |file|
+          file.write(Net::HTTP.get(repo))
+        end
+
+        Zip::File.open(jar) do |zip_file|
+          entry = zip_file.glob('index-v1.json').first
+          @@downloaded_repos[repo] = entry.get_input_stream.read
+          next @@downloaded_repos[repo]
+        end
+      end
+    end
+
+    def initialize(index, locale)
+      @apps = index['apps'].map do |app_json|
+        packages_json = index['packages'][app_json['packageName']]
+        App.new(app_json, packages_json, locale)
+      end
+
+      @repo = Repo.new(index['repo'])
+    end
+
+  end
+end

data/lib/fdroid/Package.rb

@@ -0,0 +1,75 @@
+# F-Droid's Jekyll Plugin
+#
+# Copyright (C) 2017 Nico Alt
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative './Permission'
+
+module FDroid
+  class Package
+    def initialize(package)
+      @package = package
+    end
+
+    def <=> (other)
+      self.version_code <=> other.version_code
+    end
+
+    def version_code
+      @package['versionCode']
+    end
+
+    def version_name
+      @package['versionName']
+    end
+
+    def to_data
+      added = nil
+      if @package['added'] != nil then
+        added = Date.strptime("#{@package['added'] / 1000}", '%s')
+      end
+
+      {
+        'version_name' => version_name,
+        'version_code' => version_code,
+        'added' => added,
+        'apk_name' => @package['apkName'],
+        'hash' => @package['hash'],
+        'hash_type' => @package['hashType'],
+        'min_sdk_version' => @package['minSdkVersion'],
+        'max_sdk_version' => @package['maxSdkVersion'],
+        'target_sdk_version' => @package['targetSdkVersion'],
+        'native_code' => @package['nativecode'],
+        'sig' => @package['sig'],
+        'size' => @package['size'],
+        'uses_permission' => permission,
+      }
+    end
+
+    def permission
+      if @package['uses-permission'] == nil then
+        []
+      else
+        @package['uses-permission'].map {|perm| Permission.new(perm).to_data }
+      end
+    end
+
+    private
+
+    def field(name)
+      @app.key?(name) ? name : nil
+    end
+  end
+end

data/lib/fdroid/{FDroidIndex.rb → Permission.rb}

@@ -15,12 +15,18 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require 'nokogiri'
-require 'open-uri'
+module FDroid
+  class Permission
+    def initialize(permission)
+      @permission = permission[0]
+      @min_sdk = permission[1]
+    end
 
-class FDroidIndex
-	def getIndex(repo)
-		index = open(URI.parse(repo + '/index.xml')).read
-		Nokogiri::XML(index).xpath('fdroid').xpath('application')
-	end
-end
+    def to_data
+      {
+          'permission' => @permission,
+          'min_sdk' => @min_sdk,
+      }
+    end
+  end
+end

data/lib/fdroid/Repo.rb

@@ -0,0 +1,45 @@
+# F-Droid's Jekyll Plugin
+#
+# Copyright (C) 2017 Peter Serwylo
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module FDroid
+  class Repo
+    def initialize(repo)
+      @repo = repo
+    end
+
+    def name
+      @repo['name']
+    end
+    
+    def address
+      @repo['address']
+    end
+
+    def icon_url
+      "#{self.address}/icons/#{@repo['icon']}"
+    end
+
+    def description
+      @repo['description']
+    end
+    
+    def date
+      added = Date.strptime("#{@repo['timestamp'] / 1000}", '%s')
+    end
+
+  end
+end

data/lib/jekyll-fdroid.rb

@@ -15,7 +15,7 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require "fdroid/FDroidIndex"
+require "fdroid/IndexV1"
 require "jekyll/ReadYamlPage"
 require "jekyll/FDroidBrowsingPage"
 require "jekyll/FDroidFilters"
@@ -24,6 +24,7 @@ require "jekyll/FDroidLatestPackagesTag"
 require "jekyll/FDroidPackageDetailGenerator"
 require "jekyll/FDroidPackageDetailPage"
 require "jekyll/FDroidSearchAutocompleteTag"
+require "jekyll/FDroidRepoInfoTag"
 require "lunr/LunrIndexer"
 require "lunr/SearchIndexFile"
 require "lunr/Javascript"

data/lib/jekyll/FDroidPackageDetailGenerator.rb

@@ -44,13 +44,13 @@ module Jekyll
 				end
 				site.config["pagination"]["enabled"] = true
 
-				packages = FDroidIndex.new.getIndex(site.config["fdroid-repo"])
+				index = FDroid::IndexV1.download(site.config["fdroid-repo"], site.active_lang || 'en_US')
 
-				Jekyll::LunrJsSearch::Indexer.new.generate(site, packages)
+				Jekyll::LunrJsSearch::Indexer.new.generate(site, index.apps)
 
 				# Generate detail page for every package
 				site.collections["packages"] = Collection.new(site, "packages")
-				packages.each do |package|
+				index.apps.each do |package|
 					# This page needs to be created twice, once for site.pages, and once for site.collections.
 					# If not, then the i18n code in jekyll-polyglot will end up processing the page twice, as
 					# it iterates over all pages and all packages. The end result is a double prefix for "/en/en"

data/lib/jekyll/FDroidPackageDetailPage.rb

@@ -17,112 +17,29 @@
 
 module Jekyll
 
-	class FDroidPackageDetailPage < ReadYamlPage
-		def initialize(site, base, package)
-			$package = package
-			@site = site
-			@base = base
-			@dir = "packages"
-			@name = $package.at_xpath('id').content + "/index.html"
-
-			self.process(@name)
-			self.read_yaml(getLayoutDir(), 'package.html')
-
-			getGeneralFrontMatterData
-			getPackagesFrontMatterData
-		end
-
-		def getLayoutDir()
-			layout_dir_override = File.join(site.source, "_layouts")
-			if File.exists? File.join(layout_dir_override, "package.html")
-				return layout_dir_override
-			else
-				return File.expand_path "../../_layouts", File.dirname(__FILE__)
-			end
-		end
-
-		def getGeneralFrontMatterData
-			# Hash with relation between Jekyll and XML variable name
-			assignments = {
-				"added" => "added",
-				"antifeatures" => "antifeatures",
-				"bitcoin" => "bitcoin",
-				"categories" => "categories",
-				"changelog" => "changelog",
-				"description" => "desc",
-				"donate" => "donate",
-				"flattr" => "flattr",
-				"icon" => "icon",
-				"issueTracker" => "tracker",
-				"lastUpdated" => "lastupdated",
-				"license" => "license",
-				"suggestedVersionCode" => "marketvercode",
-				"suggestedVersion" => "marketversion",
-				"package" => "id",
-				"sourceCode" => "source",
-				"summary" => "summary",
-				"title" => "name",
-				"webSite" => "web"
-				}
-			# Add information from XML to front matter
-			assignments.each do |jekyll, xml|
-				addGeneralFrontMatterData(jekyll, xml)
-			end
-			self.data["description"] = processFdroidAppLinks(self.data["description"])
-			self.data["beautifulURL"] = "/packages/" + self.data["package"]
-		end
-
-		def processFdroidAppLinks(string)
-			string.gsub(/fdroid\.app:([\w._]*)/, '/packages/\1')
-		end
-
-		def addGeneralFrontMatterData(jekyll, xml)
-			xmlData = $package.at_xpath(xml)
-			if xmlData != nil
-				self.data[jekyll] = xmlData.content
-			end
-		end
-
-		# Hash with relation between Jekyll and XML variable names for the package metadata
-		@@jekyllToXmlPackageAssignments = {
-			"added" => "added",
-			"apkName" => "apkname",
-			"hash" => "hash",
-			"nativeCode" => "nativecode",
-			"maxSDKVersion" => "maxsdkver",
-			"permissions" => "permissions",
-			"sdkVersion" => "sdkver",
-			"sig" => "sig",
-			"size" => "size",
-			"srcName" => "srcname",
-			"targetSdkVersion" => "targetSdkVersion",
-			"version" => "version",
-			"versionCode" => "versioncode",
-		}
-
-		def getPackagesFrontMatterData
-			self.data["packages"] = $package.xpath('package').map { |package| getPackageFromXml(package) }
-		end
-
-		def getPackageFromXml(packageXml)
-			packageInformation = Hash.new
-			
-			# Add information from XML to front matter
-			@@jekyllToXmlPackageAssignments.each do |jekyll, xml|
-				xmlData = packageXml.at_xpath(xml)
-				if xmlData == nil
-					next
-				end
-
-				# nativeCode and permissions can be comma separated arrays
-				if ["nativeCode", "permissions"].include? jekyll
-					packageInformation[jekyll] = xmlData.content.split(",")
-				else
-					packageInformation[jekyll] = xmlData.content
-				end
-			end
-
-			return packageInformation
-		end
-	end
+  class FDroidPackageDetailPage < ReadYamlPage
+
+    # @param [Jekyll::Site]  site
+    # @param [string]  base
+    # @param [FDfroid::App]  package
+    def initialize(site, base, package)
+      @site = site
+      @base = base
+      @dir = 'packages'
+      @name = "#{package.package_name}/index.html"
+
+      self.process(@name)
+      self.read_yaml(get_layout_dir, 'package.html')
+      self.data.update(package.to_data)
+    end
+
+    def get_layout_dir()
+      layout_dir_override = File.join(site.source, '_layouts')
+      if File.exists? File.join(layout_dir_override, 'package.html')
+        layout_dir_override
+      else
+        File.expand_path '../../_layouts', File.dirname(__FILE__)
+      end
+    end
+  end
 end

data/lib/jekyll/FDroidRepoInfoTag.rb

@@ -0,0 +1,39 @@
+# F-Droid's Jekyll Plugin
+#
+# Copyright (C) 2017 Peter Serwylo
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative '../fdroid/IndexV1'
+
+module Jekyll
+
+	# Used to output the repo name/timestamp used to generate this F-Droid site.
+	class FDroidRepoInfoTag < Liquid::Tag
+
+		def initialize(tag_name, text, tokens)
+			super
+		end
+
+		def render(context)
+			site = context.registers[:site]
+			url = site.config['fdroid-repo']
+			index = FDroid::IndexV1.download(url, 'en')
+
+			"#{index.repo.name} #{index.repo.date}"
+		end
+	end
+end
+
+Liquid::Template.register_tag('fdroid_repo_info', Jekyll::FDroidRepoInfoTag)

data/lib/jekyll/FDroidSearchAutocompleteTag.rb

@@ -17,29 +17,76 @@
 
 module Jekyll
 
-	class FDroidSearchTemplateableAutocompleteBlock < Liquid::Block
-		def self.render_template(context, template)
-			context['result_item_template'] = template
+	class SearchForm
+		def self.render_form(context, search_form_template_path, result_item_template_contents)
+			context['result_item_template'] = result_item_template_contents
 			context['search_id'] = rand(1000000)
 
-			path = "../../_layouts/search-autocomplete.html"
-			template = Liquid::Template.parse(IO.read((File.expand_path path, File.dirname(__FILE__))))
+			template = Liquid::Template.parse(IO.read((File.expand_path( search_form_template_path, File.dirname(__FILE__)))))
 			template.render(context)
 		end
+	end
+
+	# As the user types, a list of results is shown below the text input (floating above other content).
+	# When an item is selected, it will navigate to that packages page.
+	# Designed to be used in a sidebar widget.
+
+	class DropDownWithTemplate < Liquid::Block
+		def render(context)
+			search_form_template_path = "../../_layouts/search-autocomplete.html"
+			SearchForm.render_form(context, search_form_template_path, super.to_s)
+		end
+    end
+
+	class DefaultDropDown < Liquid::Tag
+		def render(context)
+			search_form_template_path = "../../_layouts/search-autocomplete.html"
+
+			result_item_template_path = "../../_includes/search-autocomplete-default-result-template.html"
+			result_item_template = IO.read((File.expand_path(result_item_template_path, File.dirname(__FILE__))))
+
+			SearchForm.render_form(context, search_form_template_path, result_item_template)
+		end
+	end
+
+	# As the user types, a div is populated with search results.
+	# Differs from DropDownAutocomplete in that once you move focus away from the text input, the results
+	# are still displayed.
+	# Designed for a fully fledged search form on its own page.
 
+	# For each result result, this will render the template found between
+	# the {% fdroid_search_full_with_template %}{% endfdroid_search_full_with_template %} tags.
+	class FullSearchWithTemplate < Liquid::Block
 		def render(context)
-			FDroidSearchTemplateableAutocompleteBlock.render_template(context, super.to_s)
+			search_form_template_path = "../../_layouts/search-full.html"
+			SearchForm.render_form(context, search_form_template_path, super.to_s)
+		end
+	end
+
+	# For each search result, this will render the contents of
+	# "_includes/search-full-default-result-template.html" from this plugin.
+	class DefaultFullSearch < Liquid::Tag
+		def initialize(tag_name, argument, tokens)
+			super
+			@empty_search_id = argument.strip
 		end
-  end
 
-	class FDroidSearchAutocompleteTag < Liquid::Tag
 		def render(context)
-			path = "../../_includes/search-autocomplete-default-result-template.html"
-			result_item_template = IO.read((File.expand_path path, File.dirname(__FILE__)))
-			FDroidSearchTemplateableAutocompleteBlock.render_template(context, result_item_template)
+			search_form_template_path = "../../_layouts/search-full.html"
+
+			result_item_template_path = "../../_includes/search-full-default-result-template.html"
+			result_item_template = IO.read((File.expand_path(result_item_template_path, File.dirname(__FILE__))))
+
+			context['empty_search_id'] = @empty_search_id
+			SearchForm.render_form(context, search_form_template_path, result_item_template)
 		end
 	end
 end
 
-Liquid::Template.register_tag('fdroid_search_autocomplete', Jekyll::FDroidSearchAutocompleteTag)
-Liquid::Template.register_tag('fdroid_search_autocomplete_with_template', Jekyll::FDroidSearchTemplateableAutocompleteBlock)
+Liquid::Template.register_tag('fdroid_search_autocomplete', Jekyll::DefaultDropDown)
+Liquid::Template.register_tag('fdroid_search_autocomplete_with_template', Jekyll::DropDownWithTemplate)
+
+# You can optionally specify the ID of a div where the results are to be rendered as the argument to these tags.
+# Note that if you do so, it will hide all elements from this div when rendering it.
+Liquid::Template.register_tag('fdroid_search_full', Jekyll::DefaultFullSearch)
+Liquid::Template.register_tag('fdroid_search_full_with_template', Jekyll::FullSearchWithTemplate)

data/lib/lunr/LunrIndexer.rb

@@ -13,97 +13,90 @@ require 'uri'
 require 'v8'
 
 module Jekyll
-	module LunrJsSearch
-		class Indexer
-			def generate(site, packages)
-				@js_dir = 'js'
-
-				ctx = V8::Context.new
-				ctx.load(Indexer.path_to_asset('bower_components/lunr.js/lunr.js'))
-
-				ctx['indexer'] = proc do |this|
-					this.ref('id')
-					this.field('name')
-					this.field('summary')
-				end
-
-				ctx.eval('builder = new lunr.Builder')
-				ctx.eval('builder.pipeline.add(lunr.trimmer, lunr.stopWordFilter)')
-				ctx.eval('indexer.call(builder, builder)')
-
-				@lunr_version = ctx.eval('lunr.version')
-				@docs = {}
-
-				Jekyll.logger.info "Lunr:", "Creating search index (lunr.js version #{@lunr_version})..."
-
-				@site = site
-
-				packages.each_with_index do |package, i|
-					package_name = package['id']
-					name = Indexer.content_from_xml(package, 'name')
-					icon = Indexer.content_from_xml(package, 'icon')
-					summary = Indexer.content_from_xml(package, 'summary')
-
-					doc = {
-							'id' => i,
-							'packageName' => package_name,
-							'icon' => icon,
-							'name' => name,
-							'summary' => summary
-					}
-
-					ctx['builder'].add(doc)
-					@docs[i] = doc
-
-					Jekyll.logger.debug "Lunr:", package_name
-				end
-
-				@index = ctx.eval('builder.build()')
-
-				FileUtils.mkdir_p(File.join(site.dest, @js_dir))
-				filename = File.join(@js_dir, 'index.json')
-
-				total = {
-						"docs" => @docs,
-						"index" => @index.to_hash
-				}
-
-				filepath = File.join(site.dest, filename)
-				File.open(filepath, "w") { |f| f.write(JSON.dump(total)) }
-				Jekyll.logger.info "Lunr:", "Index ready (lunr.js v#{@lunr_version})"
-				added_files = [filename]
-
-				site_js = File.join(site.dest, @js_dir)
-				extras = [
-						'assets/fdroid-search-autocomplete.js',
-						'bower_components/lunr.js/lunr.js',
-						'bower_components/mustache.js/mustache.min.js',
-						'bower_components/awesomplete/awesomplete.min.js',
-						'bower_components/awesomplete/awesomplete.css'
-				]
-				Jekyll.logger.info "Lunr:", "Added required assets to #{@js_dir}"
-				extras.each do |path|
-					src = Indexer.path_to_asset(path)
-					Jekyll.logger.debug "Lunr:", "Copying asset from #{src} to #{site_js}"
-					FileUtils.cp(src, site_js)
-					added_files.push(File.join(@js_dir, File.basename(src)))
-				end
-
-				# Keep the written files from being cleaned by Jekyll
-				added_files.each do |filename|
-					site.static_files << SearchIndexFile.new(site, site.dest, "/", filename)
-				end
-			end
-
-			def self.path_to_asset(path)
-				return File.join(File.dirname(__FILE__), "../../#{path}")
-			end
-
-			def self.content_from_xml(xml_node, element_name)
-				xml_data = xml_node.at_xpath(element_name)
-				return xml_data == nil ? nil : xml_data.content
-			end
-
-		end
-	end
+  module LunrJsSearch
+    class Indexer
+
+      # @param [Jekyll::Site]  site
+      # @param [Array<App>]  packages
+      # @return [Object]
+      def generate(site, packages)
+        @js_dir = 'js'
+
+        ctx = V8::Context.new
+        ctx.load(Indexer.path_to_asset('bower_components/lunr.js/lunr.js'))
+
+        ctx['indexer'] = proc do |this|
+          this.ref('id')
+          this.field('name')
+          this.field('summary')
+        end
+
+        ctx.eval('builder = new lunr.Builder')
+        ctx.eval('builder.pipeline.add(lunr.trimmer, lunr.stopWordFilter)')
+        ctx.eval('indexer.call(builder, builder)')
+
+        @lunr_version = ctx.eval('lunr.version')
+        @docs = {}
+
+        Jekyll.logger.info "Lunr:", "Creating search index (lunr.js version #{@lunr_version})..."
+
+        @site = site
+
+        packages.each_with_index do |package, i|
+          doc = {
+              'id' => i,
+              'packageName' => package.package_name,
+              'icon' => package.icon,
+              'name' => package.name,
+              'summary' => package.summary
+          }
+
+          ctx['builder'].add(doc)
+          @docs[i] = doc
+
+          Jekyll.logger.debug "Lunr:", package.package_name
+        end
+
+        @index = ctx.eval('builder.build()')
+
+        FileUtils.mkdir_p(File.join(site.dest, @js_dir))
+        filename = File.join(@js_dir, 'index.json')
+
+        total = {
+            "docs" => @docs,
+            "index" => @index.to_hash
+        }
+
+        filepath = File.join(site.dest, filename)
+        File.open(filepath, "w") {|f| f.write(JSON.dump(total))}
+        Jekyll.logger.info "Lunr:", "Index ready (lunr.js v#{@lunr_version})"
+        added_files = [filename]
+
+        site_js = File.join(site.dest, @js_dir)
+        extras = [
+            'assets/fdroid-search-autocomplete.js',
+            'bower_components/lunr.js/lunr.js',
+            'bower_components/mustache.js/mustache.min.js',
+            'bower_components/awesomplete/awesomplete.min.js',
+            'bower_components/awesomplete/awesomplete.css'
+        ]
+        Jekyll.logger.info "Lunr:", "Added required assets to #{@js_dir}"
+        extras.each do |path|
+          src = Indexer.path_to_asset(path)
+          Jekyll.logger.debug "Lunr:", "Copying asset from #{src} to #{site_js}"
+          FileUtils.cp(src, site_js)
+          added_files.push(File.join(@js_dir, File.basename(src)))
+        end
+
+        # Keep the written files from being cleaned by Jekyll
+        added_files.each do |filename|
+          site.static_files << SearchIndexFile.new(site, site.dest, "/", filename)
+        end
+      end
+
+      def self.path_to_asset(path)
+        return File.join(File.dirname(__FILE__), "../../#{path}")
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-fdroid
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nico Alt
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2017-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: jekyll-include-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jekyll-include-cache
+  name: jekyll-paginate-v2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: therubyracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,40 +67,44 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jekyll-paginate-v2
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: 1.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: 1.8.5
 - !ruby/object:Gem::Dependency
-  name: therubyracer
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0'
 description: Browse packages of a F-Droid repository.
 email: nicoalt@posteo.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/fdroid/FDroidIndex.rb
+- lib/fdroid/App.rb
+- lib/fdroid/IndexV1.rb
+- lib/fdroid/Package.rb
+- lib/fdroid/Permission.rb
+- lib/fdroid/Repo.rb
 - lib/jekyll-fdroid.rb
 - lib/jekyll/FDroidBrowsingPage.rb
 - lib/jekyll/FDroidFilters.rb
@@ -80,6 +112,7 @@ files:
 - lib/jekyll/FDroidLatestPackagesTag.rb
 - lib/jekyll/FDroidPackageDetailGenerator.rb
 - lib/jekyll/FDroidPackageDetailPage.rb
+- lib/jekyll/FDroidRepoInfoTag.rb
 - lib/jekyll/FDroidSearchAutocompleteTag.rb
 - lib/jekyll/ReadYamlPage.rb
 - lib/lunr/Javascript.rb