shomen-model 0.1.0

data/.ruby

@@ -0,0 +1,53 @@
+---
+source:
+- meta
+authors:
+- name: trans
+  email: transfire@gmail.com
+copyrights: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+dependencies: []
+alternatives: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/shomen-model.git
+  scm: git
+  name: upstream
+resources:
+- uri: http://rubyworks.github.com/shomen-model
+  name: home
+  type: home
+- uri: http://rubydoc.info/gems/shomen-model/frames
+  name: docs
+  type: doc
+- uri: http://github.com/rubyworks/shomen-model
+  name: code
+  type: code
+- uri: http://github.com/rubyworks/shomen-model/issues
+  name: bugs
+  type: bugs
+- uri: http://groups.google.com/groups/rubyworks-mailinglist
+  name: mail
+  type: mail
+- uri: http://chat.us.freenode.net/rubyworks
+  name: chat
+  type: chat
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2010-07-01'
+summary: Ruby Models for Shomen Documentation Format
+title: Shomen Model
+version: 0.1.0
+name: shomen-model
+description: ! "Shomen defines a standard API documentaiton format for object-oriented
+  software\n(Ruby programs in particular) which can be used by documentation interfaces,
+  \ne.g. Hypervisor, to render API documentation. Shomen Model is a set of Ruby\nclasses
+  the module this format, and can be used to generate Shomen documentation."
+organization: rubyworks
+date: '2012-04-20'

data/.yardopts

@@ -0,0 +1,7 @@
+--private
+--protected
+-r README.rdoc
+lib/
+-
+[A-Z]*.*
+log/[A-Z].*

data/HISTORY.md

@@ -0,0 +1,9 @@
+# RELEASE HISTORY
+
+## 0.1.0 / 2012-04-20
+
+Initial release of Shomen Model.
+
+Changes:
+
+* Happy 1st Release Day!

data/LICENSE.txt

@@ -0,0 +1,28 @@
+Shomen Model - Ruby Models for Shomen Documentation Format
+(http://github.com/rubyworks/shomen)
+
+Copyright (c) 2011 Rubyworks. All rights reserved. 
+
+Redistribution and use in source and binary forms,
+with or without modification, are permitted provided that the following
+conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+SPDX: BSD-2-Clause

data/README.md

@@ -0,0 +1,82 @@
+# Shomen
+
+[Website](http://rubyworks.github.com/shomen) /
+[User Manual](http://github.com/rubyworks/shomen/wiki) /
+[Development](http://github.com/rubyworks/shomen) /
+[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist) /
+[IRC Channel](http://chat.us.freenode.net/rubyworks)
+
+
+## Description
+
+Shomen is an intermediary documentation model designed for documenting
+object-oriented programming languages, particularly Ruby. The specification
+is a flat mapping, without internal referencing, suitable for storage in both
+YAML and JSON formats.
+
+
+## Why?
+
+By using a standard intermediary format, documentation parsers need only concern
+themselves with a single output target. And documentation templates in turn only
+need to concern themselves with a single input format regardless of the parsing
+system that was used to generate it.
+
+
+## Features
+
+* Update a single portable file to update documentation.
+* Site disc footprint is extra small thanks to CDNs.
+* Personalize site design to best fit your project.
+* Test drive others customizations with your own remote docs!
+
+
+## Instructions
+
+To learn about Shomen in detail please visit:
+
+* [User Manual](http://github.com/rubyworks/shomen/wiki)
+* [API Documentation](http://rubyworks.github.com/shomen)
+
+Overall usage consists of generating a Shomen documentation file for a
+project. Typical usage looks something like:
+
+  $ shomen -R -r README.rdoc lib - [A-Z]*.* > doc.json
+
+Next you want to pair up your doc.json file with a viewer. Currently that means
+using one of the following:
+
+* [HyperVisor](http://github.com/rubyworks/hypervisor)
+* [Rebecca](http://github.com/rubyworks/rebecca)
+* [Rubyfaux](http://github.com/rubyworks/rubyfaux)
+
+You can copy any of those repos to your website (e.g. site/) and run with it.
+If you want to try it out locally, we recommend using [thin](http://code.macournoyer.com/thin/)
+to view the site.
+
+    $ cd site
+    $ thin start -A file
+
+If you can't use thin, Shomen provides a simplistic rack-based static server
+which can be used.
+
+    $ cd site
+    $ shomen-server
+
+Viewers don't necessarily need to be copied. All three above can take
+a `doc={url-to-shomen-json-file}` http parameter and server up the docs remotely.
+You just need to publish your `doc.json` file to a publicly accessible URL.
+Note, I recommend that in this case you name the file more specifically,
+e.g. `myapp-1.0.0.json`.
+
+See the viewer projects for more information.
+
+
+## Copying
+
+Copyright (c) 2010 Rubyworks
+
+Shomen is distributed under the terms of the **BSD-2-Clause** license.
+
+See License.txt for license details.
+

data/lib/shomen-model.rb

@@ -0,0 +1,35 @@
+# Shomen is an intermediary documentation model designed for documenting
+# object-oriented programming languages, particularly Ruby. The specification
+# is a flat mapping, without internal referencing, suitable for storage in both
+# YAML and JSON formats.
+#
+module Shomen
+end
+
+if RUBY_VERSION > '1.9'
+  require_relative 'shomen-model/core_ext'
+  require_relative 'shomen-model/generator'
+  require_relative 'shomen-model/abstract'
+  require_relative 'shomen-model/document'
+  require_relative 'shomen-model/script'
+  require_relative 'shomen-model/module'
+  require_relative 'shomen-model/class'
+  require_relative 'shomen-model/method'
+  require_relative 'shomen-model/attribute'
+# require_relative 'shomen-model/function'
+  require_relative 'shomen-model/constant'
+  require_relative 'shomen-model/metadata'
+else
+  require 'shomen-model/core_ext'
+  require 'shomen-model/generator'
+  require 'shomen-model/abstract'
+  require 'shomen-model/document'
+  require 'shomen-model/script'
+  require 'shomen-model/module'
+  require 'shomen-model/class'
+  require 'shomen-model/method'
+  require 'shomen-model/attribute'
+# require 'shomen-model/function'
+  require 'shomen-model/constant'
+  require 'shomen-model/metadata'
+end

data/lib/shomen-model.yml

@@ -0,0 +1,53 @@
+---
+source:
+- meta
+authors:
+- name: trans
+  email: transfire@gmail.com
+copyrights: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+dependencies: []
+alternatives: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/shomen-model.git
+  scm: git
+  name: upstream
+resources:
+- uri: http://rubyworks.github.com/shomen-model
+  name: home
+  type: home
+- uri: http://rubydoc.info/gems/shomen-model/frames
+  name: docs
+  type: doc
+- uri: http://github.com/rubyworks/shomen-model
+  name: code
+  type: code
+- uri: http://github.com/rubyworks/shomen-model/issues
+  name: bugs
+  type: bugs
+- uri: http://groups.google.com/groups/rubyworks-mailinglist
+  name: mail
+  type: mail
+- uri: http://chat.us.freenode.net/rubyworks
+  name: chat
+  type: chat
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2010-07-01'
+summary: Ruby Models for Shomen Documentation Format
+title: Shomen Model
+version: 0.1.0
+name: shomen-model
+description: ! "Shomen defines a standard API documentaiton format for object-oriented
+  software\n(Ruby programs in particular) which can be used by documentation interfaces,
+  \ne.g. Hypervisor, to render API documentation. Shomen Model is a set of Ruby\nclasses
+  the module this format, and can be used to generate Shomen documentation."
+organization: rubyworks
+date: '2012-04-20'

data/lib/shomen-model/abstract.rb

@@ -0,0 +1,114 @@
+module Shomen
+
+  module Model
+
+    # Base class for all model classes.
+    #
+    class AbstractPrime
+
+      # Models use an internal hash to store attributes instead of 
+      # the usual instance methods.
+      #
+      # Returns nothing.
+      def self.attr_accessor(name)
+        name = name.to_s
+        define_method(name) do
+          self[name]
+        end
+        define_method(name+'=') do |x|
+          self[name] = x
+        end
+      end
+
+      # Module type is the "last name" of the module downcased.
+      #
+      # Returns String of module type.
+      def self.type
+        name.split('::').last.downcase
+      end
+
+      # Initialize new instance of model.
+      #
+      # settings - Hash of attribute settings.
+      #
+      # Returns new model instance.
+      def initialize(settings={})
+        @table = {}
+        settings.each do |k,v|
+          s = "#{k}=".gsub('-','_')
+          __send__(s,v)
+        end
+      end
+
+      # Fetch attribute.
+      #
+      # key - String of attribute's name.
+      #
+      # Returns attribute value.
+      def [](key)
+        @table[key.to_s]
+      end
+
+      # Store attribute.
+      #
+      # key   - String of attribute's name.
+      # value - Object as value of attribute.
+      #
+      # Returns attribute value.
+      def []=(k,v)
+        @table[k.to_s] = v
+      end
+
+      # Convert attributes to hash, including all nested object
+      # that repsond to #to_h.
+      #
+      # Returns Hash of attribute's key-value pairs.
+      def to_h
+        t = {}
+        @table.each do |k,v|
+          if v.respond_to?(:to_h)
+            t[k] = v.to_h
+          else
+            t[k] = v
+          end
+        end
+        t
+      end
+
+    end
+
+    # Abstract base class for model classes that have a type field,
+    # i.e. a `!` field. 
+    #
+    class Abstract < AbstractPrime
+
+      # Initialize new model instance.
+      def initialize(settings={})
+        super(settings)
+        @table['!'] = self.class.type
+      end
+
+      # Full path name of documentation entry.
+      #
+      # Returns String.
+      attr_accessor :path
+
+      # Hash of `label => description`.
+      #
+      # Returns Hash.
+      attr_accessor :tags
+
+      # Type of documentation entry. Valid types are `document`,
+      # `script`, `method`, `class_method`, `constant` and, for one
+      # entry only, `(metadata)`.
+      #
+      # Retuns String of documentation entry type.
+      def type
+        self['!']
+      end
+
+    end
+
+  end
+
+end

data/lib/shomen-model/attribute.rb

@@ -0,0 +1,23 @@
+module Shomen
+
+  module Model
+
+    #
+    class Attribute < Method
+      #
+      def self.type; 'attribute'; end
+
+      #
+      def initialize(settings={})
+        super(settings)
+        self['!'] = settings['singleton'] ? 'class-attribute' : 'attribute'
+      end
+
+      # 'R', 'W' or 'RW'
+      attr_accessor :rw
+
+    end
+
+  end
+
+end

data/lib/shomen-model/class.rb

@@ -0,0 +1,18 @@
+module Shomen
+
+  module Model
+
+    #
+    class Class < Module
+
+      #
+      def self.type; 'class'; end
+
+      #
+      attr_accessor :superclass
+
+    end
+
+  end
+
+end

data/lib/shomen-model/constant.rb

@@ -0,0 +1,32 @@
+module Shomen
+
+  module Model
+
+    #
+    class Constant < Abstract
+      #
+      def self.type; 'constant'; end
+
+      # Constant's basename, must start with a capitalized letter.
+      attr_accessor :name
+
+      #
+      attr_accessor :namespace
+
+      #
+      attr_accessor :comment
+
+      # Format of comment (rdoc, markdown or plain).
+      attr_accessor :format
+
+      #
+      attr_accessor :value
+
+      #
+      attr_accessor :files
+
+    end
+
+  end
+
+end

data/lib/shomen-model/core_ext.rb

@@ -0,0 +1,5 @@
+class Hash
+  def to_h
+    self
+  end unless method_defined?(:to_h)
+end

data/lib/shomen-model/document.rb

@@ -0,0 +1,48 @@
+module Shomen
+
+  module Model
+
+    #
+    class Document < Abstract
+      #
+      def self.type
+        'document'
+      end
+
+      #def key=(path)
+      #  path = '/' + path unless path[0,1] == '/'
+      #  super(path)
+      #end
+
+      attr_accessor :name
+
+      #attr_accessor :parent
+
+      attr_accessor :path
+
+      # Time stamp when script was last modifed.
+      attr_accessor :modified
+
+      alias :mtime :modified
+      alias :mtime= :modified=
+
+      # Time stamp when script was first created.
+      attr_accessor :created
+
+      alias :ctime :created
+      alias :ctime= :created=
+
+      # Source code URI.
+      attr_accessor :uri
+
+      #
+      attr_accessor :text
+
+      # Format of comment (rdoc, markdown or plain).
+      attr_accessor :format
+
+    end
+
+  end
+
+end

data/lib/shomen-model/generator.rb

@@ -0,0 +1,187 @@
+module Shomen
+
+  begin; gem 'json'; rescue; end
+
+  require 'yaml'
+  require 'json'
+
+  #require 'shomen-model/metadata'
+  #require 'shomen-model'
+
+  # Shared base class that can be used by generators.
+  #
+  class Generator
+
+    # Default output format is JSON.
+    DEFAULT_FORMAT = 'json'
+
+    # Is `$FORCE` set?
+    #
+    # Return true/false.
+    def force?
+      $FORCE
+    end
+
+    # Outpu format is eitehr :yaml or :json. The default is :json.
+    attr_accessor :format
+
+    # Flag to include full source code in script entries.
+    #
+    # Returns true/false.
+    attr_accessor :source
+
+    # URI prefix to link to online documentation.
+    #
+    # Returns String.
+    attr_accessor :webcvs
+
+    # Name of README file.
+    attr_accessor :readme
+
+    # Markup used for comments. This is typically either :rdoc or :markdown.
+    attr_accessor :markup
+
+    # List of scripts to document.
+    attr_accessor :scripts
+
+    # List of "information documents" to document.
+    attr_accessor :documents
+
+    # Include source code in scripts?
+    #
+    # Returns true/false.
+    def source?
+      @soruce
+    end
+
+  private
+
+    # Initialize new generator.
+    #
+    # options - Hash of generator options.
+    #
+    # Returns Generator instance.
+    def initialize(options)
+      @format     = DEFAULT_FORMAT
+      @readme     = Dir['README*'].first
+      @source     = false
+      @use_cache  = false
+      @markup     = nil
+      @scripts    = []
+      @documents  = []
+
+      options.each do |k,v|
+        __send__("#{k}=", v)
+      end
+    end
+
+  public
+
+    # Produce documentation in YAML or JSON format depending
+    # on the setting of #format setting.
+    #
+    # Returns String of either YAML or JSON.
+    def produce_format
+      case format.to_sym
+      when :yaml
+        produce_yaml
+      else
+        produce_json
+      end
+    end
+
+    # Alias for #produce_format.
+    #
+    # Returns String of either YAML or JSON.
+    alias to_s produce_format
+
+    # Documentation table in YAML format.
+    #
+    # Returns String of YAML.
+    def produce_yaml
+      produce_table.to_yaml
+    end
+
+    # Documentation table in JSON format.
+    #
+    # Returns String of JSON.
+    def produce_json
+      force_encoding(produce_table).to_json
+    end
+
+    # Generates documentation table using rdoc or yard 
+    # depending on the `adapter` setting.
+    #
+    # Returns documentation table. [Hash]
+    def produce_table
+      generate
+    end
+
+    # Project metadata.
+    #
+    # Returns Metadata instance.
+    def project_metadata
+      @project_metadata ||= Shomen::Metadata.new
+    end
+
+  private
+
+
+=begin
+    #
+    # Remove setting options from command line arguments.
+    #
+    def remove_options(argv, *options)
+      options.each do |opt|
+        i = argv.index(opt)
+        if i
+          argv.delete_at(i)
+          argv.delete_at(i)
+        end
+      end
+      argv
+    end
+
+    #
+    # Remove flag options from command line arguments.
+    #
+    def remove_flags(argv, *flags)
+      flags.each do |opt|
+        i = argv.index(opt)
+        if i
+          argv.delete_index(i)
+        end
+      end
+      argv
+    end
+=end
+
+    # Force encoding to UTF-8.
+    #
+    # value - Common core object.
+    #
+    # Returns object with values encoded to UTF-8.
+    def force_encoding(value)
+      case value
+      when Time,Date
+        value = value.dup if value.frozen?
+        value.to_s.force_encoding('UTF-8')
+      when String
+        value = value.dup if value.frozen?
+        value.force_encoding('UTF-8')
+      when Array
+        value.map{ |v| force_encoding(v) }
+      when Hash
+        new = {}
+        value.each do |k,v|
+          k = force_encoding(k)
+          v = force_encoding(v)
+          new[k] = v
+        end
+        new
+      end
+    end
+
+  end
+
+end

data/lib/shomen-model/interface.rb

@@ -0,0 +1,33 @@
+module Shomen
+
+  module Model
+
+    #
+    class Interface < AbstractPrime
+
+      # TODO: validate that there is an interface image.
+      def initialize(settings={})
+        #@table = {'arguments'=>[], 'parameters'=>[]}
+        super(settings)
+      end
+
+      # The source code "image" of the method's inteface.
+      attr_accessor :signature
+
+      # Arguments breakdown.
+      attr_accessor :arguments
+
+      # Parameters breakdown.
+      attr_accessor :parameters
+
+      # Block
+      attr_accessor :block
+
+      # Return value.
+      attr_accessor :returns
+
+    end
+
+  end
+
+end

data/lib/shomen-model/metadata.rb

@@ -0,0 +1,83 @@
+require 'yaml'
+
+module Shomen
+
+  # Encapsulate metadata, which preferably comes from a .ruby file,
+  # but can fallback to a gemspec.
+  #
+  class Metadata
+    include Enumerable
+
+    # Present working directoty.
+    PWD = Dir.pwd
+
+    # Glob pattern for looking up gemspec.
+    GEMSPEC_PATTERN = '{.gemspec,*.gemspec}'
+
+    #
+    # Initialize new Metadata instance.
+    #
+    def initialize
+      @data = (
+        data = {}
+        if dotruby
+          data.merge!(YAML.load_file(dotruby))
+        elsif gemspec
+          # prefereably use dotruby library to convert,
+          # but wait until it's more mainstream
+          require 'rubygems/specification'
+          spec = ::Gem::Specification.load(gemspec)
+          data['name']        = spec.name,
+          data['title']       = spec.name.capitalize,
+          data['version']     = spec.version.to_s,
+          data['authors']     = [spec.author],
+          data['summary']     = spec.summary,
+          data['description'] = spec.description,
+          data['resources']   = {'homepage' => spec.homepage}
+        else
+          # TODO: Raise error instead ?
+          data['name'] = File.basename(Dir.pwd)
+        end
+        data['path']   = '(metadata)'
+        data['markup'] = 'rdoc'  # FIXME
+        data
+      )
+    end
+
+    #
+    def dotruby
+      file = File.join(PWD, '.ruby')
+      return nil unless File.exist?(file)
+      file
+    end
+
+    #
+    def gemspec
+      file = Dir[File.join(PWD, GEMSPEC_PATTERN)].first
+      return nil unless file && File.exist?(file)
+      file
+    end
+
+    #
+    def [](name)
+      @data[name]
+    end
+
+    #
+    def size
+      @data.size
+    end
+
+    #
+    def each(&blk)
+      @data.each(&blk)
+    end
+
+    #
+    def to_h
+      @data
+    end
+
+  end
+
+end

data/lib/shomen-model/method.rb

@@ -0,0 +1,101 @@
+module Shomen
+
+  module Model
+
+    #
+    class Method < Abstract
+
+      #
+      def initialize(settings={})
+        super(settings)
+        @table['declarations'] ||= []
+      end
+
+      # Method's name.
+      attr_accessor :name
+
+      # Method's namespace.
+      attr_accessor :namespace
+
+      # Comment accompanying method definition.
+      attr_accessor :comment
+
+      # Format of comment (rdoc, markdown or plain).
+      attr_accessor :format
+
+      # Singleton method `true` or `false/nil`.
+      attr_accessor :singleton
+
+      # Delarations is a list of keywords that designates characteristics
+      # about a method. Common characteristics include `reader`, `writer`
+      # or `accessor` if the method is defined via an attr method; `public`
+      # `private` or `protected` given the methods visibility; and `class`
+      # or `instance` given the methods scope. Default designations are
+      # are impled if not specifically stated, such as `public` and `instance`.
+      #
+      # Using a declarations list simplifies the Shomen data format by allowing
+      # declarations to be freely defined, rather than creating a field for each
+      # possible designation possible.
+      attr_accessor :declarations
+
+      # Aliases.
+      attr_accessor :aliases
+
+      # Aliases.
+      attr_accessor :alias_for
+
+      # Breakdown of interfaces signature, arguments, parameters, block argument
+      # an return values.
+      attr_accessor :interfaces
+
+      #
+      def interfaces=(array)
+        self['interfaces'] = (
+          array.map do |settings|
+            case settings
+            when Interface
+              settings
+            else
+              Interface.new(settings)
+            end
+          end
+        )
+      end
+
+      # List of possible returns types.
+      attr_accessor :returns
+
+      # List of possible raised errors.
+      attr_accessor :raises
+
+      # Method generated dynamically?
+      attr_accessor :dynamic
+
+      # Filename.
+      attr_accessor :file
+
+      # Line number.
+      attr_accessor :line
+
+      # Source code.
+      attr_accessor :source
+
+      # Source code language.
+      attr_accessor :language
+
+
+      # Deprecated method.
+      alias :parent :namespace
+
+      #
+      def to_h
+        h = super
+        h['!'] = 'method'
+        h['interfaces'] = (interfaces || []).map{ |s| s.to_h }
+        h
+      end
+    end
+
+  end
+
+end

data/lib/shomen-model/module.rb

@@ -0,0 +1,54 @@
+module Shomen
+
+  module Model
+
+    #
+    class Module < Abstract
+
+      #
+      def self.type; 'module'; end
+
+      # Method's name.
+      attr_accessor :name
+
+      # Namespace of module is the path of the class or module
+      # containing this module.
+      attr_accessor :namespace
+
+      # Comment associated with module.
+      attr_accessor :comment
+
+      # Format of comment (rdoc, markdown or plain).
+      attr_accessor :format
+
+      # Mixins.
+      attr_accessor :includes
+
+      # Metaclass mixins.
+      attr_accessor :extensions
+
+      # Constants defined within this module.
+      attr_accessor :constants
+
+      #
+      attr_accessor :modules
+
+      #
+      attr_accessor :classes
+
+      # List of instance methods defined in the module.
+      attr_accessor :methods
+
+      # List of attributes.
+      attr_accessor :accessors
+
+      # The files in which the module is defined.
+      attr_accessor :files
+
+      #
+      alias :fullname :path
+    end
+
+  end
+
+end

data/lib/shomen-model/script.rb

@@ -0,0 +1,72 @@
+module Shomen
+
+  module Model
+
+    #
+    class Script < Document
+      #
+      def self.type; 'script'; end
+
+      # Full source code or +nil+ if not provided.
+      attr_accessor :source
+
+      # Route text to source.
+      alias :text  :source
+      alias :text= :source=
+
+      # TODO: Since we are making source available should we deprecate header and footer,
+      # or should we include it if source is excluded ?
+
+      attr_accessor :header
+
+      attr_accessor :footer
+
+      # Source code URI.
+      attr_accessor :uri
+
+      # The lanuage of the script.
+      attr_accessor :language
+
+      # File basename of script path.
+      attr_accessor :name
+
+      # Full path of script, relative to project root.
+      attr_accessor :path
+
+      # Time stamp when script was last modifed.
+      attr_accessor :modified
+
+      alias :mtime :modified
+      alias :mtime= :modified=
+
+      # Time stamp when script was first created.
+      attr_accessor :created
+
+      alias :ctime :created
+      alias :ctime= :created=
+
+      # Other scripts required by this script.
+      attr_accessor :requires
+
+      # TODO: Presently these are not being fully utilized by the parsers, need to fix.
+
+      # Constants defined by this script.
+      attr_accessor :constants
+
+      # Modules defined by this script.
+      attr_accessor :modules
+
+      # Classes defined by this script.
+      attr_accessor :classes
+
+      # Class methods defined in this script.
+      attr_accessor :class_methods
+
+      # Methods defined in this script.
+      attr_accessor :methods
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: shomen-model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &22566460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22566460
+description: ! "Shomen defines a standard API documentaiton format for object-oriented
+  software\n(Ruby programs in particular) which can be used by documentation interfaces,
+  \ne.g. Hypervisor, to render API documentation. Shomen Model is a set of Ruby\nclasses
+  the module this format, and can be used to generate Shomen documentation."
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- HISTORY.md
+- README.md
+files:
+- .ruby
+- .yardopts
+- lib/shomen-model/abstract.rb
+- lib/shomen-model/attribute.rb
+- lib/shomen-model/class.rb
+- lib/shomen-model/constant.rb
+- lib/shomen-model/core_ext.rb
+- lib/shomen-model/document.rb
+- lib/shomen-model/generator.rb
+- lib/shomen-model/interface.rb
+- lib/shomen-model/metadata.rb
+- lib/shomen-model/method.rb
+- lib/shomen-model/module.rb
+- lib/shomen-model/script.rb
+- lib/shomen-model.rb
+- lib/shomen-model.yml
+- LICENSE.txt
+- HISTORY.md
+- README.md
+homepage: http://rubyworks.github.com/shomen-model
+licenses: []
+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: Ruby Models for Shomen Documentation Format
+test_files: []