readme 0.1.0

data/.ruby

@@ -0,0 +1,71 @@
+---
+source:
+- var
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2011'
+  license: BSD-2-Clause
+replacements: []
+alternatives: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: reap
+  groups:
+  - build
+  development: true
+- name: mast
+  groups:
+  - test
+  development: true
+- name: rubytest
+  groups:
+  - test
+  development: true
+- name: citron
+  groups:
+  - test
+  development: true
+- name: ae
+  groups:
+  - test
+  development: true
+- name: simplecov
+  groups:
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/readme.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/readme
+  code: http://github.com/rubyworks/readme
+  bugs: http://github.com/rubyworks/readme/issues
+  mail: http://groups.google.com/groups/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2009-07-22'
+summary: Extract information from README files.
+title: Readme
+version: 0.1.0
+name: readme
+description: ! 'Ever thought perhaps that all the effect in creating a good README,
+  while
+
+  great for your end-userss, did''t every do you a hill of beans worth of good
+
+  when it came to constructing your project''s metadata. Well, hang on to your
+
+  nerd glasses! Here comes a gem that does just that!'
+organization: rubyworks
+date: '2012-02-08'

data/HISTORY.md

@@ -0,0 +1,10 @@
+# Release History
+
+## 0.1.0 | 2011-01-01
+
+First release of Readme project, spun-off from the Ruby POM project.
+
+Changes:
+
+* Happy first release day!
+

data/README.md

@@ -0,0 +1,52 @@
+# README
+
+[Website](http://rubyworks.github.com/readme) /
+[Development](http://github.com/rubyworks/readme) /
+[Issue Tracker](http://github.com/rubyworks/readme/issues) /
+[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist)
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/readme.png)](http://travis-ci.org/rubyworks/readme)
+
+
+## Description
+
+Ever thought perhaps that all the effect in creating a good README, while
+great for your end-users, didn't every do you a hill of beans worth of good
+when it came to constructing your project's metadata. Well, hang on to your
+nerd glasses! Here comes a gem that does just that!
+
+Okay, don't get too excited just yet. Readme's heuristics are rather limited
+thus far, but with time and contribution she'll be right fine in the not
+to distant future.
+
+
+## Instruction
+
+The library is about as easy to use as you can imagine.
+
+    require 'readme'
+
+    readme = Readme.file
+
+    readme.name
+    readme.description
+    readme.copyright
+
+It also come with a command line client to pump out the data into variant
+formats, such a YAML, JSON and even Ruby code.
+
+    $ readme --yaml
+
+    $ readme description
+
+See the [API documentation](http:/rubydoc.info/gems/readme) and `readme --help` for more information.
+
+
+## Copyright
+
+Copyright (c) 2009 Rubyworks. All rights reserved.
+
+Readme can be redistributed in accordance with the **BSD-2-Clause** license.
+
+See COPYING.md file for details.
+

data/bin/readme

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'readme'
+Readme.cli(*ARGV)

data/lib/readme.rb

@@ -0,0 +1,287 @@
+# Readme is designed to parse a README file applying various hueristics
+# in order to descern metadata about a project.
+#
+# The heuristics are fairly simplistic  at this point, but will improve
+# with time and contribution.
+#
+class Readme
+
+  if RUBY_VERSION < '1.9'
+    require 'readme/version'
+    require 'readme/cli'
+  else
+    require_relative 'readme/version'
+    require_relative 'readme/cli'
+  end
+
+  # File glob for matching README file.
+  FILE_PATTERN = "README{,.*}"
+
+  #
+  def self.file(path=Dir.pwd)
+    if File.directory?(path)
+      path = Dir.glob(File.join(path, FILE_PATTERN), File::FNM_CASEFOLD).first
+    end
+    if path
+      new(File.read(path), path)
+    else
+      raise IOError, "no such README -- #{path}"
+    end
+  end
+
+  #
+  def initialize(text, file=nil)
+    @text  = text
+    @file  = file
+    @data = {}
+    parse
+  end
+
+  #
+  # The ERADME file path, if provided.
+  #
+  attr :file
+
+  #
+  # The README text.
+  #
+  attr :text
+
+  #
+  # Location of README file, if file was provided.
+  #
+  # @return [String] Directory of README file
+  #
+  def root
+    File.dirname(file) if file
+  end
+
+  #
+  # The full README text.
+  #
+  # @return [String] The complete README text.
+  #
+  def to_s
+    text.to_s
+  end
+
+  #
+  # Access to underlying parse table.
+  #
+  def [](name)
+    @data[name.to_s]
+    #return nil unless file
+    #if respond_to?(name)
+    #  __send__(name)
+    #else
+    #  nil
+    #end
+  end
+
+  #
+  def name
+    @data['name']
+  end
+
+  #
+  def title
+    @data['title']
+  end
+
+  #
+  def description
+    @data['description']
+  end
+
+  #
+  def license
+    @data['license']
+  end
+
+  #
+  def copyright
+    @data['copyright']
+  end
+
+  #
+  def authors
+    @data['authors']
+  end
+
+  #
+  def resources
+    @data['resources'] ||= {}
+  end
+
+  #
+  def homepage
+    resources['home']
+  end
+
+  #
+  def wiki
+    resources['wiki']
+  end
+
+  #
+  def issues
+    resources['issues']
+  end
+
+  #
+  # Return file extension of README. Even if the file has no extension,
+  # this method will look at the contents and try to determine it.
+  #
+  # @todo Improve type heuristics.
+  #
+  # @return [String] Extension type, e.g. `.md`.
+  #
+  def extname
+    ext = File.extname(file)
+    if ext.empty?
+      ext = '.rdoc' if /^\=/ =~ text
+      ext = '.md'   if /^\#/ =~ text
+    end
+    return ext
+  end
+
+  #
+  # Access to a copy of the underlying parse table.
+  #
+  # @return [Hash] Copy of the underlying table.
+  #
+  def to_h
+    @data.dup
+  end
+
+private
+
+  #
+  def parse
+    parse_title
+    parse_description
+    parse_license
+    parse_copyright
+    parse_resources
+  end
+
+  #
+  def parse_title
+    if md = /^[=#]\s*(.*?)$/m.match(text)
+      title = md[1].strip
+      @data['title'] = title
+      @data['name']  = title.downcase.gsub(/\s+/, '_')
+    end
+  end
+
+  #
+  def parse_description
+    if md = /[=#]+\s*(DESCRIPTION|ABSTRACT)[:]*(.*?)[=#]/mi.match(text)
+      @data['description'] = md[2].strip #.sub("\n", ' ')  # unfold instead of sub?
+    else
+      d = []
+      o = false
+      text.split("\n").each do |line|
+        if o
+          if /^(\w|\s*$)/ !~ line
+            break d
+          else
+            d << line
+          end
+        else
+          if /^\w/ =~ line
+            d << line
+            o = true
+          end
+        end
+      end
+      @data['description'] = d.join(' ').strip
+    end
+  end
+
+  #
+  def parse_license
+    if md = /[=]+\s*(LICENSE)/i.match(text)
+      section = md.post_match
+      @data['license'] = (
+        case section
+        when /LGPL/
+          "LGPL"
+        when /GPL/
+          "GPL"
+        when /MIT/
+          "MIT"
+        when /BSD/
+          "BSD"
+        end
+      )
+    end
+  end
+
+  #
+  def parse_copyright
+    md = /Copyright.*?\d+(.*?)$/.match(text)
+    if md
+      copyright = md[0]
+
+      authors = md[1].split(/(and|\&|\,)/).map{|a|a.strip}
+      authors = authors.map{ |a| a.sub(/all rights reserved\.?/i, '').strip.chomp('.') }
+
+      @data['copyright'] = copyright
+      @data['authors']   = authors
+    end
+  end
+
+  #
+  def parse_resources
+    @data['resources'] = {}
+
+    scan_for_github
+    scan_for_google_groups
+
+    text.scan(/(\w+)\:\s*(http:.*?[\w\/])$/) do |m|
+      @data['resources'][$1] = $2
+    end
+  end
+
+  #
+  # TODO: Improve on github matching.
+  def scan_for_github
+    text.scan(/http\:.*?github\.com.*?[">)\s]/) do |m|
+      case m
+      when /wiki/
+        @data['resources']['wiki'] = m[0...-1]
+      when /issues/
+        @data['resources']['issues'] = m[0...-1]
+      else
+        if m[0] =~ /:\/\/github/
+          @data['resources']['code'] = m[0...-1]
+        else
+          @data['resources']['home'] = m[0...-1]
+        end
+      end
+    end
+  end
+
+  #
+  def scan_for_google_groups
+    if m = /http\:.*?groups\.google\.com.*?[">)\s]/.match(text)
+      @data['resources']['mail'] = m[0][0...-1]
+    end
+  end
+
+  #
+  # TODO: parse readme into sections of [label, text].
+  #def sections
+  #  @sections ||= (
+  #    secs = text.split(/^(==|##)/)
+  #    secs.map do |sec|
+  #      i = sec.index("\n")
+  #      n = sec[0..i].sub(/^[=#]*/, '')
+  #      t = sec[i+1..-1]
+  #      [n, t]
+  #    end
+  #  )
+  #end
+end
+

data/lib/readme/cli.rb

@@ -0,0 +1,59 @@
+class Readme
+
+  require 'optparse'
+
+  def self.cli(*argv)
+    format = nil
+    name   = nil
+
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: readme [option] [field]'
+      opt.on('-y', '--yml', '--yaml', 'return in YAML format') do
+        format = :yaml
+      end
+      opt.on('-j', '--json', 'return in JSON format') do
+        format = :json
+      end
+      opt.on('-r', '--ruby', 'return in Ruby code format') do
+        format = :ruby
+      end
+      opt.on_tail('-h', '--help', 'show this help message') do
+        puts opt
+        exit
+      end
+    end.parse!(argv)
+   
+    if argv.first
+      name = argv.shift
+      data = Readme.file[name]
+    else
+      if format
+        data = Readme.file.to_h
+      else
+        data = Readme.file
+      end
+    end
+
+    case format
+    when :yaml
+      require 'yaml'
+      puts data.to_yaml
+    when :json
+      require 'json'
+      puts data.to_json
+    when :ruby
+      data = {name => data} if name
+      data.each do |k,v|
+        case v
+        when Hash
+          puts "#{k} #{v.inspect[1...-1]}"
+        else
+          puts "#{k} #{v.inspect}"
+        end
+      end
+    else
+      puts data #Readme.file.to_s
+    end
+  end
+
+end

data/lib/readme/version.rb

@@ -0,0 +1,3 @@
+class Readme
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: readme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &20548700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20548700
+- !ruby/object:Gem::Dependency
+  name: reap
+  requirement: &20548060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20548060
+- !ruby/object:Gem::Dependency
+  name: mast
+  requirement: &20547460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20547460
+- !ruby/object:Gem::Dependency
+  name: rubytest
+  requirement: &20546860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20546860
+- !ruby/object:Gem::Dependency
+  name: citron
+  requirement: &20546260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20546260
+- !ruby/object:Gem::Dependency
+  name: ae
+  requirement: &20545680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20545680
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &20545100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20545100
+description: ! 'Ever thought perhaps that all the effect in creating a good README,
+  while
+
+  great for your end-userss, did''t every do you a hill of beans worth of good
+
+  when it came to constructing your project''s metadata. Well, hang on to your
+
+  nerd glasses! Here comes a gem that does just that!'
+email:
+- transfire@gmail.com
+executables:
+- readme
+extensions: []
+extra_rdoc_files:
+- HISTORY.md
+- README.md
+files:
+- .ruby
+- bin/readme
+- lib/readme/cli.rb
+- lib/readme/version.rb
+- lib/readme.rb
+- HISTORY.md
+- README.md
+homepage: http://rubyworks.github.com/readme
+licenses:
+- BSD-2-Clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Extract information from README files.
+test_files: []