indexer 0.1.0

data/data/indexer/r2013/index.yesi

@@ -0,0 +1,67 @@
+---
+HEADER-DIVISION:
+  apply-tag: "!http://rubyworks.github.org/dotruby"
+  description:
+    Specification for canonical .ruby files.
+  author: trans <transfire@gmail.com>
+
+TEMPLATE-DIVISION:
+  revision :        PIC ZZ9; TAG !!int; REQ true
+  name     :        PIC AW[29]; REQ true
+  version  :        PIC ZZ9{.ZZ9}[5]; REX semver
+  codename :        PIC X[30]
+  title    :        PIC X[30]
+  date     :        PIC 9999-99-99{_99:99:99}[0,1]
+  created  :        PIC 9999-99-99{_99:99:99}[0,1]
+  summary  :        PIC X[79]
+  description:      PIC X[1000]
+  authors:
+    - name  :       PIC X[30]
+      email :       REX email
+      url   :       REX url
+      roles :
+        -           PIC X[30]
+  suite:            PIC X[30]
+  organization:     PIC X[30]
+  copyrights:
+    - holder  :     PIC X[30]
+      year    :     PIC 9999{-9999}[0,1]
+      license :     PIC W[30]
+  requirements: &r
+    - name:         PIC W[30]
+      version:      REX //
+      groups:
+        -           PIC W[30]
+      development:  TAG !!bool
+      optional:     TAG !!bool
+      engine:
+        - name:     PIC W[30]
+          version:  PIC W[30]
+      platform:
+        -           PIC W[30]
+      repository:
+        name:       PIC W[30]
+        uri:        REX uri
+        scm:        PIC W[15]
+  dependencies: *r
+  conflicts:
+    - name:         PIC W[30]
+      version:      PIC X[30]
+  substitues:
+    -               PIC W[30]
+  replaces:
+    -               PIC W[30]
+  resources:
+    - name:         PIC X[30]
+      uri:          REX uri
+  repositories:
+    - name:         PIC X[30]
+      uri:          REX uri
+      scm:          PIC W[30]
+  load_path:
+    -               REX file; DEF 'lib'
+  install_message:  PIC X[1000]
+  extra: {}
+
+CONSTRAINTS-DIVISION: {}
+

data/data/indexer/r2013/ruby.txt

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+name    <%= name.inspect %>
+version <%= version.inspect %>
+title   <%= title.inspect %>
+summary <%= summary.inspect %>
+
+description \
+  <% description.inspect %>
+
+authors [
+  'you <you@foomail.com>'
+]
+
+requirements [
+  'foo 1.0~', 
+  'rake (build)',
+  'test (test)'
+]
+
+repositories {
+  'upstream' => 'http://github.com/organization/app_name/<%= name %>.git'
+}
+
+resources {
+  'home' => 'http://organization.github.org/<%= name %>',
+  'code' => 'http://github.com/organization/<%= name %>'
+}
+
+categories ['foo']
+
+copyrights: [
+  '2012 Your Name (MIT)'
+]
+

data/data/indexer/r2013/yaml.txt

@@ -0,0 +1,30 @@
+--- 
+name:    <%= name %>
+version: <%= version %>
+title:   <%= title %>
+summary: <%= summary %>
+
+description:
+  <%= description %>
+
+authors:
+  - you <you@foomail.com>
+
+requirements:
+- dependency 1.0~
+- rake (build)
+- test (test)
+
+repositories:
+  upstream: http://github.com/organization/app_name/app_name.git
+
+resources:
+  home: http://organization.github.org/app_name
+  code: http://github.com/organization/app_name
+
+categories:
+  - foo
+
+copyrights:
+  - 2012 Your Name (MIT)
+

data/lib/indexer.rb

@@ -0,0 +1,65 @@
+module Indexer
+  # Name of this program.
+  NAME = 'indexer'
+
+  # Current stable revision of the specification (by year).
+  REVISION = 2013
+
+  # File name of locked metadata file.
+  LOCK_FILE = '.index'
+
+  # Default metadata file name for use by end-developer.
+  USER_FILES = '{Indexfile,Indexfile.rb,Metadata,Metadata.yml,Metadata.yaml}'
+
+  # Indexer library directory.
+  LIBDIR = File.dirname(__FILE__) + '/indexer'
+
+  # Indexer library directory.
+  DATADIR = File.dirname(__FILE__) + '/../data/indexer'
+
+  # Metadata from the project's `indexer.yml` index file.
+  # This is used as a fallback for #const_missing.
+  #
+  # Returns [Hash] of metadata.
+  def self.index
+    @index ||= (
+      require 'yaml'
+      dir  = File.dirname(__FILE__)
+      file = Dir[File.join(dir, "{#{NAME}.yml,../.index}")].first
+      file ? YAML.load_file(file) : {}
+    )
+  end
+
+  # Project metadata via RubyGems, fallback to index file.
+  #
+  # TODO: The #to_s on the gemspec return value is a bit too simplistic. But how to fix?
+  #       The goal is reduce the value to a basic type (String, Hash, Array, Numeric).
+  #
+  def self.const_missing(const_name)
+    name = const_name.to_s.downcase
+    begin
+      Gem.loaded_specs[NAME].send(name).to_s
+    rescue StandardError
+      index[name] || super(const_name)
+    end
+  end
+end
+
+require 'yaml'
+require 'time'
+
+require 'indexer/version/exceptions'
+require 'indexer/version/number'
+require 'indexer/version/constraint'
+
+require 'indexer/core_ext'
+require 'indexer/command'
+require 'indexer/error'
+require 'indexer/valid'
+require 'indexer/revision'
+
+require 'indexer/model'
+require 'indexer/components'
+require 'indexer/metadata'
+require 'indexer/importer'
+

data/lib/indexer/attributes.rb

@@ -0,0 +1,171 @@
+module Indexer
+
+  # Tracks supported attributes.
+  def self.attributes
+    @attributes ||= []
+  end
+
+  # The Attributes module defines all of the accepted metadata fields.
+  module Attributes
+
+    # Define attribute, plus track it.
+    def self.attr_accessor(name)
+      Indexer.attributes << name.to_sym
+
+      class_eval %{
+        def #{name}
+          @data[:#{name}]
+        end
+        def #{name}=(val)
+          @data[:#{name}] = val
+        end
+      }
+    end
+
+    #
+    def attributes
+      Indexer.attributes
+    end
+
+    # The revision of ruby meta specification.
+    attr_accessor :revision
+
+    #def revision
+    #  REVISION
+    #end
+
+    # The type of ruby meta specification.
+    attr_accessor :type
+
+    # Files from which to import metadata.
+    attr_accessor :sources
+
+    # The name of the project
+    attr_accessor :name
+
+    # The version of the project
+    attr_accessor :version
+
+    # The nick name for the particular version, e.g. "Lucid Lynx".
+    attr_accessor :codename
+
+    # The date of this version.
+    attr_accessor :date
+
+    # The project title
+    attr_accessor :title
+
+    # The project summary
+    attr_accessor :summary
+
+    # The project description
+    attr_accessor :description
+
+    # The suite to which the project belongs.
+    attr_accessor :suite
+
+    # The copyrights and licenses of the project.
+    attr_accessor :copyrights
+
+    # The authors of the project
+    # The first author should be the primary contact.
+    attr_accessor :authors
+
+    # The organizations involved with the project.
+    attr_accessor :organizations
+
+    # The resource locators for the project.
+    attr_accessor :resources
+
+    # The repository URLs for the project.
+    attr_accessor :repositories
+
+    # TODO: Might webcvs simply be taken from the first repository instead?
+
+    # 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 ?
+
+    # List of language engine/version family supported.
+    attr_accessor :engines
+
+    # List of platforms supported.
+    attr_accessor :platforms
+
+    # The names of the executable scripts
+    # NOTE: Do not need, executable should alwasy by in bin/, right?
+    #attr_accessor :executables
+
+    # The packages this package requires to function.
+    attr_accessor :requirements  #:dependencies
+
+    # A list of packages that provide more or less the same functionality.
+    # A good example is for a markdown library.
+    #
+    #   alternatives:
+    #     - rdiscount
+    #     - redcarpet
+    #     - BlueCloth
+    #
+    attr_accessor :alternatives
+
+    # The packages with which this project cannot function.
+    attr_accessor :conflicts
+
+    # 
+    # NOTE: This is a Debian concept. Is it useful?
+    #attr_accessor :provides
+
+    # Categories can be used to help clarify the purpose of
+    # a project, e.g. `testing` or `rest`. There are no standard
+    # categories, just use common sense. Categories must be single-line
+    # strings. When comparisons are made they will be downcased.
+    attr_accessor :categories
+
+    # The version of Ruby required by the project
+    # NOTE: is it possible to to makes this a part of ordinary requirements?
+    #attr_accessor :required_ruby_version
+
+    # The post-installation message.
+    attr_accessor :install_message
+
+    # The date the project was started.
+    attr_accessor :created
+
+    # The toplevel namespace of API, e.g. `module Foo` or `class Bar`.
+    # NOTE: how to best handle this?
+    attr_accessor :namespace
+
+    # Any user-defined extraneous metadata.
+    #attr_accessor :extra
+
+  protected
+
+    #
+    # Initializes the {Metadata} attributes.
+    #
+    # @todo Is it okay to default type to `ruby`?
+    #
+    def initialize_attributes
+      @data = {
+        :revision      => REVISION,
+        :type          => 'ruby',
+        :sources       => [],
+        :authors       => [],
+        :organizations => [],
+        :copyrights    => [],
+        :alternatives  => [],
+        :requirements  => [],
+        :conflicts     => [],
+        :repositories  => [],
+        :resources     => [],
+        :categories    => [],
+        :load_path     => ['lib']
+      }
+    end
+
+  end
+
+end

data/lib/indexer/command.rb

@@ -0,0 +1,260 @@
+module Indexer
+
+  # Command line interface.
+  #
+  class Command
+
+    #
+    # Shortcut to `new.run(argv)`.
+    #
+    def self.run(argv=ARGV)
+      new.run(argv)
+    end
+
+    #
+    #
+    #
+    def initialize
+      @force  = false
+      @stdout = false
+      @static = false
+    end
+
+    #
+    #
+    #
+    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 }
+      )
+      send(cmd || :show, *args)
+    rescue => error
+      raise error if $DEBUG
+      $stderr.puts "#{File.basename($0)} error: #{error}"
+      exit -1
+    end
+
+    #
+    # Show returns information from the `.index` file. Before doing so
+    # it always ensures the `.index` file is up to date. To suppress
+    # this update use the `-S/--static` option.
+    #
+    def show(*fields)
+      if @static
+        if Metadata.exists?
+          metadata = Metadata.open
+          puts metadata.about(*fields)
+        else
+          raise Error.exception(".index file not found", IOError)
+        end
+      else
+        Metadata.lock!(:force=>@force)
+        unless fields.empty?
+          metadata = Metadata.open
+          puts metadata.about(*fields)
+        end
+      end
+    end
+
+    #
+    def using(*sources)
+      raise Error.exception("no sources given") if sources.empty?
+      metadata = Metadata.lock(sources, :force=>true)
+      if @stdout
+        puts metadata.to_yaml
+      else
+        metadata.save!
+      end
+    end
+
+    #
+    def adding(*sources)
+      raise Error.exception("no sources given") if sources.empty?
+      metadata = Metadata.open
+      metadata = Metadata.lock((metadata.sources & sources), :force=>true)
+      if @stdout
+        puts metadata.to_yaml
+      else
+        metadata.save!
+      end
+    end
+
+    #
+    def generate(type, outfile=nil)
+      case type.downcase
+      when 'gemspec'
+        create_gemspec(outfile)
+      when 'ruby', 'index.rb', 'indexfile'
+        create_ruby(outfile)
+      when 'yaml', 'index.yml', 'index.yaml'
+        create_yaml(outfile)
+      else
+        raise Error.exception("unknown file type")
+      end
+    end
+
+    #
+    def help
+      puts <<-END
+        index [command-option] [options...] [arguments...]
+
+        (none) [fields...]              update index and provide information from index
+        -u --using <sources...>         create index using given information sources
+        -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)
+        -h --help                       show this help message
+
+        -o --stdout                     output to console instead of saving to file
+        -f --force                      force protected file overwrite if file already exists or is up to date
+        -s --static                     keep index as is or generate static format if generator supports it
+      END
+    end
+
+  private
+
+    #
+    def create_ruby(outfile=nil)
+      require 'erb'
+
+      outfile = "Indexfile" unless outfile
+
+      if File.exist?(outfile) && !(@stdout or @force)
+        raise Error.exception("#{outfile} file already exists", IOError) 
+      end
+
+      template_dir  = File.join(DATADIR, "r#{REVISION}")
+      template_file = File.join(template_dir, 'ruby.txt')
+
+      if Metadata.exists?
+        metadata = Metadata.open
+      else
+        metadata = Metadata.new
+      end
+
+      # this is a little weak, but...
+      if gemspec = Dir['{,pkg/}*.gemspec'].first
+        metadata.import_gemspec(gemspec)
+      end
+
+      template = ERB.new(File.read(template_file))
+      result   = template.result(Form.new(metadata).get_binding)
+
+      if @stdout
+        puts result
+      else
+        File.open(outfile, 'w') do |f|
+          f << result
+        end
+      end
+    end
+
+    #
+    def create_yaml(outfile)
+      require 'erb'
+
+      outfile = "Index.yml" unless outfile
+
+      if File.exist?(outfile) && !(@stdout or @force)
+        raise Error.exception("#{outfile} file already exists", IOError) 
+      end
+
+      template_dir  = File.join(DATADIR, "r#{REVISION}")
+      template_file = File.join(template_dir, 'yaml.txt')
+
+      if Metadata.exists?
+        metadata = Metadata.open
+      else
+        metadata = Metadata.new
+      end
+
+      # this is a little weak, but...
+      if gemspec = Dir['{,pkg/}*.gemspec'].first
+        metadata.import_gemspec(gemspec)
+      end
+
+      template = ERB.new(File.read(template_file))
+      result   = template.result(Form.new(metadata).get_binding)
+
+      if @stdout
+        puts result
+      else
+        File.open(outfile, 'w') do |f|
+          f << result
+        end
+      end
+    end
+
+    #
+    # Create a .gemspec file for use with indexer. Or a static one if `--static` option is used.
+    #
+    def create_gemspec(file=nil)
+      if file
+        if File.extname(file) != '.gemspec'
+          warn "gemspec file without .gemspec extension"
+        end
+      else
+        # TODO: look for pre-existent gemspec, but to do that right we should get
+        #       the name from the .index file if it eixts.
+        file = Dir['{,*,pkg/*}.gemspec'].first || '.gemspec'
+      end
+
+      #lib_file = File.join(DIR, "v#{which}", "gemspec.rb")
+
+      if file && File.exist?(file) && !@force && !@stdout
+        raise Error.exception("`#{file}' already exists, use -f/--force to overwrite.")
+      end
+
+      text = GemspecExporter.source_code + "\nIndexer::GemspecExporter.gemspec"
+
+      if @static
+        spec = eval(text, CleanBinding.new, file)
+        text = spec.to_yaml
+      end
+
+      if @stdout
+        puts text
+      else
+        File.open(file, 'w') do |f|
+          f << text
+        end
+      end
+    end
+
+    #
+    def no_cmd!(cmd)
+      raise Error.exception("more than one command flag") if cmd
+    end
+
+    # Helper class for generating template.
+    #
+    class Form
+      def initialize(metadata)
+        @metadata = metadata
+      end
+      def method_missing(s, *a, &b)
+        @metadata.public_send(s, *a, &b) || '<fill-out #{s}>'
+      end
+      def get_binding; binding; end
+    end
+
+    #
+    #
+    module CleanBinding
+      def self.new
+        binding
+      end
+    end
+
+  end
+
+end