indexer 0.1.0

data/.index

@@ -0,0 +1,54 @@
+---
+type: ruby
+revision: 2013
+sources:
+- README.md
+authors:
+- name: trans
+  email: transfire@gmail.com
+  website: http://trans.gihub.com/
+- name: postmodern
+  website: http://postmodern.github.com/
+organizations: []
+requirements:
+- version: 1.5+
+  name: nokogiri
+- version: 2.0+
+  name: redcarpet
+- groups:
+  - test
+  version: 2.9+
+  development: true
+  name: qed
+- groups:
+  - test
+  version: 0+
+  development: true
+  name: ae
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/indexer
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/indexer
+  label: Source Code
+- type: api
+  uri: http://rubydoc.info/gems/indexer/frames
+  label: API Reference
+repositories: []
+categories:
+- metadata
+load_path:
+- lib
+copyrights:
+- holder: Rubyworks
+  year: '2012'
+  license: BSD-2-Clause
+version: 0.1.0
+summary: Enable Your Project's Metadata
+description: Indexer provides projects with a universal metadata format.
+name: indexer
+title: Indexer
+date: '2012-12-09'

data/HISTORY.md

@@ -0,0 +1,9 @@
+# RELEASE HISTORY
+
+## 0.1.0 / 2012-12-08
+
+Initial release of Indexer.
+
+Changes:
+
+* All of them ;)

data/README.md

@@ -0,0 +1,145 @@
+# <span class="ititle">Indexer</span> (v<span class="iversion">0.1.0</span>)
+
+<b class="isummary">Enable Your Project's Metadata<b>
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/indexer.png)](http://travis-ci.org/rubyworks/indexer)
+
+
+## Description
+
+<p class="idescription">Indexer provides projects with a universal metadata format.</p>
+
+Indexer defines a *canonical*, detailed and strict, project <span class="icategory">metadata</span> specification.
+The strictness of the specification makes the format simple enough for developers to use without an intermediate API.
+Although Indexer also provides a convenience API for working with the specification and its data 
+more loosely when suitable to the usecase. Indexer also specifies a stanadard location for canonized
+metadata to be kept, in a `.index` file.
+
+Indexer provides a tool to import metadata from external sources. Indexer can handle a variety of metadata
+source formats, including YAML, HTML Microformats and Ruby DSL scripts.
+
+
+## Installation
+
+Indexer is a Ruby application, so as long as you have Ruby installed, it is easy to install Indexer via RubyGems.
+
+    $ gem install indexer
+
+
+## Instruction
+
+Indexer is capable of generating a canonical `.index` file from a variety of sources. Being so flexiable, exactly
+how a developer descides to store a project's metadata is a largely a matter of taste. But in general there are
+three overall approaches:
+
+1. Specify the metadata using microformats in a project's README file.
+2. Specify the metadata in one or more static files, often a single YAML file.
+3. Construct the metadata via a Ruby DSL, customizing the generation in any way.
+
+The first choice is, in many respects, the nicest because it does not require any additional files be added
+to a project and it helps to ensure a good README file. On the downside, it requires some HTML be hand-coded
+into the README.
+
+The second approach is a great option in the it is the easiest. One can quickly put together a YAML document
+covering a project's metadata. Since Indexer is very flexible in it's parsing of the YAML, it really is a
+quick and user-friendly way to go. Typically this file will be called `Index.yml`, but there is no name
+requirement. In fact, Indexer will let you split the metadata up over mutliple files, and even use a whole
+directory of files, one per field.
+
+The last approach provides maximum flexablity. Using the Ruby DSL one can literally script the metadata,
+which means it can come from anywhere at all. For example, you might want to pull the project's version
+from the `lib/project/version.rb` file, i.e. Bundler style. The DSL is as intutive and as flexible as 
+using plain YAML, so it's nearly as easy to take this approach. By convention this file is called `Indexfile`
+or `Index.rb`, but it too can be any file path one prefers.
+
+On the Indexer wiki you can find detailed tutorials on a variety of setups, along with thier pros and cons.
+
+As an example of getting started, lets say we want to customize our index metadata via a YAML file,
+but we want to keep the version information is a separate `VERSION` file. That's a common layout so Indexer
+is designed to handle it out of the box. First create the `VERSION` file.
+
+    $ echo '0.1.0' > VERSION
+
+Next we need our YAML file. Indexer makes out life easier by offering us some template generation for 
+common approaches. In this case we use the `-g/--generate` command option, specifying that we want an
+`Index.yml`.
+
+    $ index --generate Index.yml
+
+Now we can edit the `Index.yaml` file to suite our project.
+
+    $ vim Index.yml
+
+Once we have the source files setup, its easy to build the canonical `.index` file using the `index` 
+command line interface. We can simply issue the `index` command with the `-u/--using` command option:
+
+    $ index --using VERSION Index.yml
+
+Indexer will utilize both sources and create the `.index` file.
+
+Over time project metadata tends to evolve and change. To keep the canoncial `.index` file up to date simply
+call the `index` command without any options.
+
+    $ index
+
+By default the `.index` file will not be updated if it has a modification time newer than its source files.
+If need be, use the `-f/--force` option to override this.
+
+That's the quick "one two". For more information on using Indexer, see the Wiki, API documentation, QED specifications
+and the Manpages.
+
+
+## Resources
+
+<ul>
+<li><a class="iresource" href="http://rubyworks.github.com/indexer" name="home">Homepage</a></li>
+<li><a class="iresource" href="http://github.com/rubyworks/indexer" name="code">Source Code</a> (Github)</li>
+<li><a class="iresource" href="http://rubydoc.info/gems/indexer/frames" name="docs">API Reference</a></li>
+<li><a class="irepository" href="http://github.com/rubyworks/indexer/indexer.git" name="upstream">Master Git Repo</a></li>
+</ul>
+
+
+## Requirements
+
+<ul>
+<li class="irequirement">
+  <a class="name" href="http://nokogiri.org/">nokogiri</a> <span class="version">1.5+</span></span>
+</li>
+<li class="irequirement">
+  <a class="name" href="https://github.com/vmg/redcarpet">redcarpet</a> <span class="version">2.0+</span></span>
+</li>
+<li class="irequirement">
+  <a class="name" href="http://rubyworks.github.com/qed/">qed</a> <span class="version">2.9+</span> <span class="groups">(test)</span>
+</li>
+<li class="irequirement">
+  <a class="name" href="http://rubyworks.github.com/ae/">ae</a> <span class="version"></span> <span class="groups">(test)</span>
+</li>
+</ul>
+
+
+## Authors
+
+<ul>
+<li class="iauthor vcard">
+  <div class="nickname">trans</div>
+  <div><a class="email" href="mailto:transfire@gmail.com">transfire@gmail.com</a></div>
+  <div><a class="url" href="http://trans.gihub.com/">http://trans.github.com/</a></div>
+</li>
+<li class="iauthor vcard">
+  <div class="nickname">postmodern</div>
+  <div><a class="url" href="http://postmodern.github.com/">http://postmodern.github.com/</a></div>
+</li>
+</ul>
+
+
+## Copyrights
+
+<ul>
+<li class="icopyright">
+  &copy; <span class="year">2012</span> <span class="holder">Rubyworks</span>
+  <div class="license">
+    <a href="http://www.spdx.org/licenses/BSD-2-Clause" rel="license">BSD-2-Clause License</a>
+  </div>
+</li>
+<ul>
+

data/bin/index

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+#require 'indexer/cli/index'
+#Indexer::CLI::Index.execute
+
+require 'indexer'
+Indexer::Command.run
+

data/data/indexer/r2013/index.kwalify

@@ -0,0 +1,175 @@
+---
+type: map
+mapping:
+  revision
+    type:      int
+    required:  true
+  name:
+    type:      str
+    pattern:   /^\w+$/  # package name
+    required:  true
+  version:
+    type:      str
+    pattern:   /^\d(\.\w+)*/
+    required:  true
+  codename:
+    type:      str
+    pattern:   /[^\n]/  # no newline
+  title
+    type:      str
+    pattern:   /[^\n]/  # no newline
+  date:
+    type:      str
+    pattern:   /^\d{4}-\d{2}-\d{2}(\d{2}){0,3}$/  # utc date
+  created:
+    type:      str
+    pattern:   /^\d{4}-\d{2}-\d{2}(\d{2}){0,3}$/  # utc date
+  summary:
+    type:      str
+    pattern:   /[^\n]/  # no newline
+  description:
+    type:      str
+  authors:
+    type:      seq
+    sequence:
+      - type:      map
+        mapping:
+          name:
+            type:      str
+          email:
+            type:      str
+            pattern:   /@/
+          url:
+            type:      str
+          role:
+            type:      seq
+  suite:
+    type:     str
+    pattern:  /[^\n]/  # no newline
+  organization:
+    type:     str
+    pattern:  /[^\n]/  # no newline
+  copyright:
+    type:     seq
+    sequence:
+      - type:      map
+        mapping:
+          holder:
+            type:      str
+            pattern:   /[^\n]/  # no newline
+          year:
+            type:      str
+            pattern:   /^\d{4}([-,]^\d{4})?$/
+          license:
+            type:      str
+            pattern:   /[^\n]/  # no newline
+  requirements: &requirements
+    type:     seq
+    sequence:
+      - type:      map
+        mapping:
+          name:
+            type:      str
+            pattern:  /[^\n]/  # no newline
+          version:
+            type:      seq
+            sequence:
+              - type:      str
+                pattern:   /^\d(\.\w+)*/
+          group:
+            type:      seq
+            sequence:
+              - type:      str
+                pattern:   /[^\n]/ # no newline
+          development:
+            type:      bool
+          optional:
+            type:      bool
+          engine:
+            type:      seq
+            sequence:
+              - type:      map
+                mapping:
+                  name:
+                    type:      str
+                    pattern:   /[^\n]/ # no newline
+                  version:
+                    type:      str
+                    pattern:   /^\d/
+          platform:
+            type:      seq
+            sequence:
+              - type:      str
+                pattern:   /[^\n]/ # no newline
+          repository:
+            - type:      map
+              mapping:
+                url:
+                  type:      str
+                  pattern:   /[^\n]/ # url
+                scm:
+                  type:      str
+                  pattern:   /[^\n]/ # no newline
+  dependencies: *requirements
+  conflicts:
+    type:     seq
+    sequence:
+      - type:      map
+        mapping:
+          name:
+            type:      str
+            pattern:   /^\w+$/  # package name
+          version:
+            type:      seq
+            sequence:
+              - type:      str
+                pattern:  /[^\n]/  # version constraint
+  substitues:
+    type:      seq
+    sequence:
+      - type:      str
+        pattern:   /^\w+$/  # package name
+  replaces:
+    type:      seq
+    sequence:
+      - type:      str
+        pattern:   /^\w+$/  # package name
+
+  resources:
+    type:      seq
+    sequence:
+      - type:      map
+        mapping:
+          id:
+            type:      str
+            pattern:   /[^\n]/ # no newline
+          url:
+            type:      str
+            pattern:   //  # url
+            required:  true
+  repositories:
+    type:      seq
+    sequence:
+      - type:      map
+        mapping:
+          id:
+            type:      str
+            pattern:   /[^\n]/ # no newline
+          url:
+            type:      str
+            pattern:   //  # url
+            required:  true
+          scm:
+            type:      str
+            pattern:   /^\w$/  # word
+  load_path:
+    type:      seq
+    sequence:
+      - type:      str
+        pattern:   /\S/  # path
+    default: [lib]
+  install_message:
+    type:      str
+  extra:
+    type:      map
+

data/data/indexer/r2013/index.yes

@@ -0,0 +1,172 @@
+---
+revision:
+  type:      int
+  required:  true
+name:
+  type:      str
+  regexp:    /^\w+$/  # package name
+  required:  true
+version:
+  type:      str
+  regexp:    /^\d(\.\w+)*/
+  required:  true
+codename:
+  type:      str
+  regexp:    /[^\n]/  # no newline
+title
+  type:      str
+  regexp:    /[^\n]/  # no newline
+date:
+  type: str
+  pic:  &pic-date 9999-99-99[ 99:99:99]
+created:
+  type: str
+  pic:  &pic-date
+summary:
+  type:   str
+  regexp: /[^\n]/  # no newline
+description:
+  type: str
+authors:
+  type: seq
+  value:
+    type: map
+    mapping:
+      name:
+        type:   str
+      email:
+        type:   str
+        regexp: /@/
+      url:
+        type:   str
+      roles:
+        type:   seq
+suite:
+  type:    str
+  regexp: /[^\n]/  # no newline
+organization:
+  type:    str
+  regexp: /[^\n]/  # no newline
+copyrights:
+  type: seq
+  value:
+    type: map
+    template:
+      holder:
+        type:   str
+        regexp: /[^\n]/  # no newline
+      year:
+        type:   str
+        regexp: /^\d{4}([-,]^\d{4})?$/
+      license:
+        type:   str
+        regexp: /[^\n]/  # no newline
+requirements: &requirements
+  type: seq
+  value:
+    type: map
+    template:
+      name:
+        type:   str
+        regexp: /[^\n]/  # no newline
+      version:
+        type: seq
+        value:
+          type:   str
+          regexp: /^\d(\.\w+)*/
+      groups:
+        type: seq
+        value:
+          type:   str
+          regexp: /[^\n]/ # no newline
+      development:
+        type: bool
+      optional:
+        type: bool
+      engine:
+        type: seq
+        value:
+          type: map
+          template:
+            name:
+              type:   str
+              regexp: /[^\n]/ # no newline
+            version:
+              type:   str
+              regexp: /^\d/
+      platform:
+        type: seq
+        value:
+          type:   str
+          regexp: /[^\n]/ # no newline
+      repository:
+        type: map
+        template:
+          url:
+            type:   str
+            regexp: /[^\n]/ # url
+          scm:
+            type:   str
+            regexp: /[^\n]/ # no newline
+dependencies: *requirements
+conflicts:
+  type: seq
+  value:
+    type: map
+    map:
+      name:
+        type:   str
+        regexp: /^\w+$/  # package name
+      version:
+        type: seq
+        value:
+          type:   str
+          regexp: /[^\n]/  # version constraint
+substitues:
+  type: seq
+  value:
+    type:   str
+    regexp: /^\w+$/  # package name
+replaces:
+  type: seq
+  value:
+    type:   str
+    regexp: /^\w+$/  # package name
+resources:
+  type: seq
+  value:
+    type: map
+    map:
+      name:
+        type:   str
+        regexp: /[^\n]/ # no newline
+      uri:
+        type:   str
+        regexp: /^http/  # url/irc
+        required: true
+repositories:
+  type: seq
+  value:
+    type: map
+    map:
+      name:
+        type:   str
+        regexp: /[^\n]/ # no newline
+      url:
+        type: str
+        regexp: //  # url
+        required:  true
+      scm:
+        type:   str
+        regexp: /^\w$/  # word
+load_path:
+  type: seq
+  value:
+    type:   str
+    regexp: /\S/  # path
+  default: [lib]
+install_message:
+  type: str
+extra:
+  type: map
+