indexer 0.1.0 → 0.2.0

data/.index

@@ -13,7 +13,10 @@ organizations: []
 requirements:
 - version: 1.5+
   name: nokogiri
+- version: 0.14+
+  name: kramdown
 - version: 2.0+
+  optional: true
   name: redcarpet
 - groups:
   - test
@@ -40,15 +43,16 @@ resources:
 repositories: []
 categories:
 - metadata
-load_path:
-- lib
+paths:
+  load:
+  - lib
 copyrights:
 - holder: Rubyworks
   year: '2012'
   license: BSD-2-Clause
-version: 0.1.0
+version: 0.2.0
 summary: Enable Your Project's Metadata
 description: Indexer provides projects with a universal metadata format.
 name: indexer
 title: Indexer
-date: '2012-12-09'
+date: '2012-12-27'

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: pkg
+  specs:
+    indexer (0.1.0)
+      nokogiri (>= 1.5)
+      redcarpet (>= 2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ae (1.8.1)
+      ansi
+    ansi (1.4.3)
+    brass (1.2.1)
+    facets (2.9.3)
+    nokogiri (1.5.5)
+    qed (2.9.0)
+      ansi
+      brass
+      facets (>= 2.8)
+    redcarpet (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ae
+  indexer!
+  qed (>= 2.9)

data/HISTORY.md

@@ -1,6 +1,23 @@
 # RELEASE HISTORY
 
-## 0.1.0 / 2012-12-08
+## 0.2.0 / 2012-12-27
+
+The `load_path` field has been deprecated and replaced with the `paths` field,
+which holds a mapping of names to local path locations within the project. This
+makes identifying paths completely generic. For Ruby projects use the 'load' entry.
+
+This release also makes Kramdown the fallback for importing microformat data from 
+markdown documents if Redcarpet is not available. This makes it usable with JRuby.
+(Kramdown may become the only support markdown render in the future.)
+
+Changes:
+
+* Deprecate `load_path` array in favor of `paths` hash.
+* Support Kramdown as fallback Markdown renderer.
+* Add requirement optional field support to microformat importer.
+
+
+## 0.1.0 / 2012-12-09
 
 Initial release of Indexer.
 

data/README.md

@@ -1,4 +1,4 @@
-# <span class="ititle">Indexer</span> (v<span class="iversion">0.1.0</span>)
+# <span class="ititle">Indexer</span> (v<span class="iversion">0.2.0</span>)
 
 <b class="isummary">Enable Your Project's Metadata<b>
 
@@ -106,7 +106,10 @@ and the Manpages.
   <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>
+  <a class="name" href="http://kramdown.rubyforge.org/">kramdown</a> <span class="version">0.14+</span>
+</li>
+<li class="irequirement">
+  <a class="name" href="https://github.com/vmg/redcarpet">redcarpet</a> <span class="version">2.0+</span> (<span class="optional">optional</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>

data/lib/indexer/attributes.rb

@@ -85,8 +85,12 @@ module Indexer
     # URI for linking to source code.
     attr_accessor :webcvs
 
-    # The directories to search within the project when requiring files
-    attr_accessor :load_path  # :loadpath or :require_paths ?
+    # Map of path sets which can be used to identify paths within the project.
+    #
+    # For example, the `load` key is used by Ruby projectss to define which paths
+    # to search within the project when requiring files.
+    #
+    attr_accessor :paths
 
     # List of language engine/version family supported.
     attr_accessor :engines
@@ -162,7 +166,7 @@ module Indexer
         :repositories  => [],
         :resources     => [],
         :categories    => [],
-        :load_path     => ['lib']
+        :paths         => {'load' => ['lib']}
       }
     end
 

data/lib/indexer/command.rb

@@ -26,15 +26,15 @@ module Indexer
     def run(argv=ARGV)
       cmd = nil
       args = cli(argv,
-        '-d --debug'    => lambda{ $DEBUG = true },
-        '-w --warn'     => lambda{ $VERBOSE = true },
-        '-f --force'    => lambda{ @force = true },
-        '-o --stdout'   => lambda{ @stdout = true },
-        '-s --static'   => lambda{ @static = true },
-        '-u --using'    => lambda{ no_cmd!(cmd); cmd = :using },
-        '-a --adding'   => lambda{ no_cmd!(cmd); cmd = :adding },
-        '-g --generate' => lambda{ no_cmd!(cmd); cmd = :generate },
-        '-h --help'     => lambda{ no_cmd!(cmd); cmd = :help }
+        '-u --using'     => lambda{ no_cmd!(cmd); cmd = :using },
+        '-a --adding'    => lambda{ no_cmd!(cmd); cmd = :adding },
+        '-g --generate'  => lambda{ no_cmd!(cmd); cmd = :generate },
+        '-w --webserver' => lambda{ no_cmd!(cmd); cmd = :webserver },
+        '-h --help'      => lambda{ no_cmd!(cmd); cmd = :help },
+        '-d --debug'     => lambda{ $DEBUG = true; $VERBOSE = true },
+        '-f --force'     => lambda{ @force = true },
+        '-o --stdout'    => lambda{ @stdout = true },
+        '-s --static'    => lambda{ @static = true }
       )
       send(cmd || :show, *args)
     rescue => error
@@ -102,6 +102,12 @@ module Indexer
       end
     end
 
+    #
+    def webserver
+      require 'indexer/webui'
+      Indexer::WebUI::Server.start(ARGV)
+    end
+
     #
     def help
       puts <<-END
@@ -112,6 +118,7 @@ module Indexer
         -a --adding <sources...>        update index appending additional information sources
         -r --remove <sources...>        update index removing given information sources
         -g --generate <type> [fname]    generate a file (gemspec, indexfile, metadata)
+        -w --webserver                  (experimental) edit .index file via web interface
         -h --help                       show this help message
 
         -o --stdout                     output to console instead of saving to file
@@ -132,8 +139,7 @@ module Indexer
         raise Error.exception("#{outfile} file already exists", IOError) 
       end
 
-      template_dir  = File.join(DATADIR, "r#{REVISION}")
-      template_file = File.join(template_dir, 'ruby.txt')
+      template_file = File.join(DATADIR, 'ruby.txt')
 
       if Metadata.exists?
         metadata = Metadata.open
@@ -168,8 +174,7 @@ module Indexer
         raise Error.exception("#{outfile} file already exists", IOError) 
       end
 
-      template_dir  = File.join(DATADIR, "r#{REVISION}")
-      template_file = File.join(template_dir, 'yaml.txt')
+      template_file = File.join(DATADIR, 'yaml.txt')
 
       if Metadata.exists?
         metadata = Metadata.open

data/lib/indexer/components.rb

@@ -5,4 +5,5 @@ require_relative 'components/conflict'
 require_relative 'components/resource'
 require_relative 'components/repository'
 require_relative 'components/requirement'
+require_relative 'components/engine'
 

data/lib/indexer/components/conflict.rb

@@ -73,6 +73,13 @@ module Indexer
       @data[:version] = Version::Constraint.parse(version)
     end
 
+    #
+    #
+    #
+    def to_h
+      {'name'=>name, 'version'=>version.to_s}
+    end
+
   end
 
 end

data/lib/indexer/components/engine.rb

@@ -0,0 +1,87 @@
+module Indexer
+
+  # The Engine class models the name and version of a
+  # the language necessray to run the software.
+  #
+  class Engine < Model
+
+    # Parse `data` into a Dependency instance.
+    #
+    # TODO: What about respond_to?(:to_str) for String, etc.
+    def self.parse(data)
+      case data
+      when Engine
+        data
+      when String
+        parse_string(data)
+      when Array
+        parse_array(data)
+      when Hash
+        parse_hash(data)
+      else
+        raise(ValidationError, "Engine")
+      end
+    end
+
+  private
+
+    #
+    #
+    def self.parse_string(data)
+      name, version = data.split(/\s+/)
+      new(:name=>name, :version=>version)
+    end
+
+    #
+    #
+    def self.parse_array(data)
+      name, version = *data
+      new(:name=>name, :version=>version)
+    end
+
+    #
+    #
+    def self.parse_hash(data)
+      new(data)
+    end
+
+  public
+
+    #
+    # The name of the package that causes the conflict.
+    #
+    # Yea it's *ALWAYS* THEIR fault ;-)
+    #
+    attr :name
+
+    #
+    # Set the name of the package.
+    #
+    def name=(name)
+      @data[:name] = name.to_s
+    end
+
+    #
+    # The versions constraint of the conflicting package.
+    # This is used when only certain versions of the package
+    # are the problem.
+    #
+    attr_reader :version
+
+    #
+    # Set the version constraint.
+    #
+    def version=(version)
+      @data[:version] = Version::Constraint.parse(version)
+    end
+
+    #
+    #
+    #
+    def to_h
+      {'name'=>name, 'version'=>version.to_s}
+    end
+
+  end
+
+end

data/lib/indexer/components/requirement.rb

@@ -254,21 +254,22 @@ module Indexer
     #   ]
     #
     def engines=(engines)
-      @data['engines'] = Array(engines).map do |engine|
-        case engine
-        when String
-          name, vers = engine.strip.split(/\s+/)
-          vers = nil if vers.empty?
-        when Array
-          name, vers = *engine
-        when Hash
-          name = engine['name']
-          vers = engine['version']
-        end
-        e = {}
-        e['name']    = name
-        e['version'] = Version::Constraint.parse(vers) if vers
-        e
+      @data[:engines] = Array(engines).map do |engine|
+        Engine.parse(engine)
+        #case engine
+        #when String
+        #  name, vers = engine.strip.split(/\s+/)
+        #  vers = nil if vers.empty?
+        #when Array
+        #  name, vers = *engine
+        #when Hash
+        #  name = engine['name']
+        #  vers = engine['version']
+        #end
+        #e = {}
+        #e['name']    = name
+        #e['version'] = Version::Constraint.parse(vers) if vers
+        #e
       end
     end
 
@@ -334,6 +335,7 @@ module Indexer
 
       h['version']     = version.to_s if version
       h['repository']  = repository.to_h if repository
+      h['engines']     = engines.map{ |e| e.to_h }
 
       h.delete('groups')    if h['groups']    && h['groups'].empty?
       h.delete('engines')   if h['engines']   && h['engines'].empty?

data/lib/indexer/conversion/gemspec.rb

@@ -65,15 +65,15 @@ module Indexer
 
       # TODO: how to handle license(s) ?
 
-      self.name         = gemspec.name
-      self.version      = gemspec.version.to_s
-      self.date         = gemspec.date
-      self.title        = gemspec.name.capitalize
-      self.summary      = gemspec.summary
-      self.description  = gemspec.description || gemspec.summary
-      self.authors      = authors
-      self.load_path    = gemspec.require_paths
-      self.homepage     = gemspec.homepage
+      self.name          = gemspec.name
+      self.version       = gemspec.version.to_s
+      self.date          = gemspec.date
+      self.title         = gemspec.name.capitalize
+      self.summary       = gemspec.summary
+      self.description   = gemspec.description || gemspec.summary
+      self.authors       = authors
+      self.paths['load'] = gemspec.require_paths
+      self.homepage      = gemspec.homepage
 
       #self.engines      = gemspec.platform
       #self.extensions   = gemspec.extensions

data/lib/indexer/conversion/gemspec_exporter.rb

@@ -155,7 +155,8 @@ module Indexer
     end
 
     def require_paths
-      metadata['load_path'] || ['lib']
+      paths = metadata['paths'] || {}
+      paths['load'] || ['lib']
     end
 
     #

data/lib/indexer/core_ext/hash/rekey.rb

@@ -0,0 +1,89 @@
+class Hash
+
+  unless method_defined?(:rekey)
+
+    # Rekey a hash:
+    #
+    #   rekey()
+    #   rekey(from_key => to_key, ...)
+    #   rekey{|from_key| to_key}
+    #   rekey{|from_key, value| to_key}
+    #
+    # If a key map is given, then the first key is changed to the second key.
+    #
+    #   foo = { :a=>1, :b=>2 }
+    #   foo.rekey(:a=>'a')       #=> { 'a'=>1, :b=>2 }
+    #   foo.rekey(:b=>:x)        #=> { :a =>1, :x=>2 }
+    #   foo.rekey('foo'=>'bar')  #=> { :a =>1, :b=>2 }
+    #
+    # If a block is given, converts all keys in the Hash accroding to the
+    # given block procedure. If the block returns +NA+ for a given key,
+    # then that key will be left intact.
+    #
+    #   foo = { :name=>'Gavin', :wife=>:Lisa }
+    #   foo.rekey{ |k| k.to_s }  #=>  { "name"=>"Gavin", "wife"=>:Lisa }
+    #   foo                      #=>  { :name =>"Gavin", :wife=>:Lisa }
+    #
+    # If no key map or block is given, then all keys are converted
+    # to Symbols.
+    #
+    # Note that if both a +key_map+ and a block are given, the +key_map+ is 
+    # applied first then the block.
+    #
+    # CREDIT: Trans, Gavin Kistner
+
+    def rekey(key_map=nil, &block)
+      if !(key_map or block)
+        block = lambda{|k| k.to_sym}
+      end
+
+      key_map ||= {} 
+
+      hash = dup.replace({})  # to keep default_proc
+
+      (keys - key_map.keys).each do |key|
+        hash[key] = self[key]
+      end
+
+      key_map.each do |from, to|
+        hash[to] = self[from] if key?(from)
+      end
+
+      if block
+        hash2 = dup.replace({})
+        case block.arity
+        when 2  # TODO: is this condition needed?
+          hash.each do |k, v|
+            nk = block.call(k,v)
+            nk = (nk ? nk : k)
+            hash2[nk] = v
+          end
+        else
+          hash.each do |k, v|
+            nk = block.call(k)
+            nk = (nk ? nk : k)
+            hash2[nk] = v
+          end
+        end
+      else
+        hash2 = hash
+      end
+
+      hash2
+    end
+
+    # Synonym for Hash#rekey, but modifies the receiver in place (and returns it).
+    #
+    #   foo = { :name=>'Gavin', :wife=>:Lisa }
+    #   foo.rekey!{ |k| k.to_s }  #=>  { "name"=>"Gavin", "wife"=>:Lisa }
+    #   foo                       #=>  { "name"=>"Gavin", "wife"=>:Lisa }
+    #
+    # CREDIT: Trans, Gavin Kistner
+
+    def rekey!(key_map=nil, &block)
+      replace(rekey(key_map, &block))
+    end
+
+  end
+
+end