yard-struct 1.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Edgar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# yard-struct
+
+Plugin for YARD which generates documentation for Struct members.
+
+## Why?
+
+Without yard-struct, there's a big difference between these as YARD can see
+them:
+
+    class A < Struct.new(:foo, :bar)
+      def to_s
+        foo + bar
+      end
+    end
+
+    class B
+      attr_accessor :foo, :bar
+      def to_s
+        foo + bar
+      end
+    end
+
+`yard-struct` makes it so that when YARD examines the first, it creates attributes
+for the auto-generated accessors `:foo` and `:bar`.
+
+## There's more
+
+This plugin also adds a new tag, `@member`. This lets you document the Struct members
+with types. Use it as such:
+
+    ##
+    # Whizbang class does lots of stuff.
+    #
+    # @member [IO, #read] input the input file to whizbang
+    # @member [Proc, #call] frob the proc to frobinate the input
+    class Whizbang < Struct.new(:input, :frob)
+    end
+    
+The generated types will be shown prominently in the generated documentation.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Michael Edgar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yard-struct"
+    gem.summary = %Q{YARD plugin for documenting auto-generated members of Struct subclasses.}
+    gem.description = %Q{yard-struct allows users to document their classes created through Struct.new using a simple, familiar syntax and @member tag.}
+    gem.email = "michael.j.edgar@dartmouth.edu"
+    gem.homepage = "http://github.com/michaeledgar/yard-struct"
+    gem.authors = ["Michael Edgar"]
+    gem.add_dependency "yard", ">= 0.4.0"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yard-struct #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/lib/yard-struct.rb

@@ -0,0 +1,5 @@
+require 'yard'
+require 'yard-struct/shared_methods'
+require 'yard-struct/tag_handler'
+require 'yard-struct/legacy_handler'
+require 'yard-struct/modern_handler'

data/lib/yard-struct/legacy_handler.rb

@@ -0,0 +1,61 @@
+module YardStruct
+  class StructHandler < YARD::Handlers::Ruby::Legacy::Base
+    include SharedMethods
+    
+    handles TkCLASS
+    CLASS_REGEX = /^class\s+(#{NAMESPACEMATCH})\s*(?:<\s*(.+)|\Z)/m
+
+    ##
+    # Called to process all class definitions. We'll ignore anything but subclasses
+    # of Struct.new()
+    def process
+      # matches normal classes
+      if match = normal_class?
+        classname, klass_string = match[1], match[2]
+        # is it a struct/ostruct subclass
+        if superclass = struct_subclass?(klass_string)
+          # get the class
+          klass = create_class(classname, superclass)
+
+          # Get the members
+          params = extract_parameters klass_string
+          
+          create_attributes(klass, params)
+        end # end if struct subclass
+      end # end if normal class declaration
+    end # end process
+    
+    ##
+    # Is this a normal class definition (and not a singleton class dereference)?
+    #
+    # @return [MatchData] a match that will contain the class name in the first
+    #   entry and the superclass in the second entry as strings.
+    def normal_class?
+      statement.tokens.to_s.match(CLASS_REGEX)
+    end
+
+    ##
+    # Is this the definition of a Struct/OStruct subclass? If so, return the name
+    # of the method.
+    #
+    # @param [String] superstring the string saying what the superclass is
+    # @return [String, nil] the name of the superclass type, or nil if it's not a
+    #   Struct or OStruct
+    def struct_subclass?(superstring)
+      superstring && (superstring.match(/\A(O?Struct)\.new\((.*?)\)/) ? $1 : nil)
+    end
+    
+    ##
+    # Extracts the parameter list from the Struct.new declaration and returns it
+    # formatted as a list of member names. Expects the user will have used symbols
+    # to define the struct member names
+    #
+    # @param [String] superstring the string declaring the superclass
+    # @return [Array<String>] a list of member names
+    def extract_parameters(superstring)
+      paramstring = superstring.match(/\A(Struct|OStruct)\.new\((.*?)\)/)[2]
+      paramstring.split(",").map {|x| x.strip[1..-1] } # the 1..-1 chops the leading :
+    end
+    
+  end
+end

data/lib/yard-struct/modern_handler.rb

@@ -0,0 +1,60 @@
+module YardStruct
+  ##
+  # This handler is used by the Ruby 1.9+ parser engine. Uses AST nodes.
+  #
+  # All the interesting logic is actually all in SharedMethods. This class
+  # specifically defines the parsing logic to get the data ready for the
+  # Shared Methods.
+  class ModernStructHandler < YARD::Handlers::Ruby::Base
+    include SharedMethods
+    
+    namespace_only
+    handles :class
+    
+    ##
+    # Called to process all class definitions. We'll ignore anything but subclasses
+    # of Struct.new()
+    def process
+      classname = statement[0].source
+      superclass = parse_superclass(statement[1])
+      # did we get a superclass worth parsing?
+      if superclass
+        # get the class
+        klass = create_class(classname, superclass)
+        # get the members
+        members = extract_parameters(statement[1])
+        # create all the members
+        create_attributes(klass, members)
+      end
+    end
+    
+    ##
+    # Extrat the parameters from the Struct.new AST node, returning them as a list
+    # of strings
+    #
+    # @param [MethodCallNode] superclass the AST node for the Struct.new call
+    # @return [Array<String>] the member names to generate methods for
+    def extract_parameters(superclass)
+      members = superclass.parameters.dup[0..-2] # drop the "false" at the end
+      members.map {|x| x.source.strip[1..-1]}
+    end
+    
+    ##
+    # Extracts the superclass name from the class definition, returning `nil` if
+    # we get something other than a Struct/OStruct subclass.
+    #
+    # @param [AstNode] superclass some AST node representing a superclass definition
+    # @return [String, nil] either a name to use as a superclass, or nil if we are
+    #   not interested in this class definition
+    def parse_superclass(superclass)
+      return nil unless superclass
+      return nil unless superclass.type == :call || superclass.type == :command_call
+      
+      cname = superclass.namespace.source
+      if cname =~ /^O?Struct$/ && superclass.method_name(true) == :new
+        return cname
+      end
+      nil
+    end
+  end
+end

data/lib/yard-struct/shared_methods.rb

@@ -0,0 +1,123 @@
+module YardStruct
+  module SharedMethods
+    include YARD::CodeObjects
+    
+    ##
+    # Extracts the user's defined @member tag for a given class and its member. Returns
+    # nil if the user did not define a @member tag for this struct entry.
+    #
+    # @param [ClassObject] klass the class whose tags we're searching
+    # @param [String] member the name of the struct member we need
+    # @return [YARD::Tags::Tag, nil] the tag matching the request, or nil if not found
+    def member_tag_for_member(klass, member)
+      klass.tags(:member).find {|tag| tag.name == member}
+    end
+    
+    ##
+    # Gets the return type for the member in a nicely formatted string. Used
+    # to be injected into auto-generated docstrings.
+    #
+    # @param [ClassObject] klass the class whose tags we're searching
+    # @param [String] member the name of the struct member whose return type we need
+    # @return [String] the user-declared type of the struct member, or [Object] if
+    #   the user did not define a type for this member.
+    def return_type_for_member(klass, member)
+      member_tag = member_tag_for_member(klass, member)
+      return_type = member_tag ? "[#{member_tag.types.join(', ')}]" : "[Object]"
+    end
+    
+    ##
+    # Creates the auto-generated docstring for the getter method of a struct's
+    # member. This is used so the generated documentation will look just like that
+    # of an attribute defined using attr_accessor.
+    #
+    # @param [ClassObject] klass the class whose members we're working with
+    # @param [String] member the name of the member we're generating documentation for
+    # @return [String] a docstring to be attached to the getter method for this member
+    def getter_docstring(klass, member)
+      member_tag = member_tag_for_member(klass, member)
+      getter_doc_text = member_tag ? member_tag.text : "Returns the value of attribute #{member}"
+      getter_doc_text += "\n@return #{return_type_for_member(klass, member)} the current value of #{member}"
+    end
+    
+    ##
+    # Creates the auto-generated docstring for the setter method of a struct's
+    # member. This is used so the generated documentation will look just like that
+    # of an attribute defined using attr_accessor.
+    #
+    # @param [ClassObject] klass the class whose members we're working with
+    # @param [String] member the name of the member we're generating documentation for
+    # @return [String] a docstring to be attached to the setter method for this member
+    def setter_docstring(klass, member)
+      member_tag = member_tag_for_member(klass, member)
+      return_type = return_type_for_member(klass, member)
+      setter_doc_text = member_tag ? member_tag.text : "Sets the attribute #{member}"
+      setter_doc_text += "\n@param #{return_type} value the value to set the attribute #{member} to."
+      setter_doc_text += "\n@return #{return_type} the newly set value"
+    end
+    
+    ##
+    # Creates and registers a class object with the given name and superclass name.
+    # Returns it for further use.
+    #
+    # @param [String] classname the name of the class
+    # @param [String] superclass the name of the superclass
+    # @return [ClassObject] the class object for further processing/method attaching
+    def create_class(classname, superclass)
+      register ClassObject.new(namespace, classname) do |o|
+        o.superclass = superclass if superclass
+        o.superclass.type = :class if o.superclass.is_a?(Proxy)
+      end
+    end
+    
+    ##
+    # Creates the setter (writer) method and attaches it to the class as an attribute.
+    # Also sets up the docstring to prettify the documentation output.
+    #
+    # @param [ClassObject] klass the class to attach the method to
+    # @param [String] member the name of the member we're generating a method for
+    def create_writer(klass, member)
+      # We want to convert these members into attributes just like
+      # as if they were declared using attr_accessor.
+      new_meth = register MethodObject.new(klass, "#{member}=", :instance) do |o|
+        o.parameters = [['value', nil]]
+        o.signature ||= "def #{member}=(value)"
+        o.source ||= "#{o.signature}\n  @#{member} = value\nend"
+      end
+      new_meth.docstring.replace setter_docstring(klass, member)
+      klass.attributes[:instance][member][:write] = new_meth
+    end
+    
+    ##
+    # Creates the getter (reader) method and attaches it to the class as an attribute.
+    # Also sets up the docstring to prettify the documentation output.
+    #
+    # @param [ClassObject] klass the class to attach the method to
+    # @param [String] member the name of the member we're generating a method for
+    def create_reader(klass, member)
+      # Do the getter
+      new_meth = register MethodObject.new(klass, member, :instance) do |o|
+        o.signature ||= "def #{member}"
+        o.source ||= "#{o.signature}\n  @#{member}\nend"
+      end
+      new_meth.docstring.replace getter_docstring(klass, member)
+      klass.attributes[:instance][member][:read] = new_meth
+    end
+    
+    ##
+    # Creates the given member methods and attaches them to the given ClassObject.
+    #
+    # @param [ClassObject] klass the class to generate attributes for
+    # @param [Array<String>] members a list of member names
+    def create_attributes(klass, members)
+      # For each parameter, add reader and writers
+      members.each do |member|
+        # Ripped off from YARD's attribute handling source
+        klass.attributes[:instance][member] = SymbolHash[:read => nil, :write => nil]
+        
+        create_writer klass, member
+        create_reader klass, member
+      end
+    end
+  end
+end

data/lib/yard-struct/tag_handler.rb

@@ -0,0 +1,3 @@
+module YardStruct
+  YARD::Tags::Library.define_tag "Struct Member", :member, :with_types_name_and_default
+end

data/spec/examples/example_helper.rb

@@ -0,0 +1,23 @@
+require 'yard'
+
+##
+# Stolen from http://github.com/postmodern/yard-parameters/blob/master/spec/helpers/examples.rb.
+#
+# Thanks!
+
+module Helpers
+  module Examples
+    EXAMPLES_DIR = File.expand_path(File.join(File.dirname(__FILE__),'examples'))
+
+    def parse_file(file, thisfile = __FILE__)
+      YARD::Registry.clear
+
+      path = File.join(Helpers::Examples::EXAMPLES_DIR, "#{file}.rb")
+      YARD::Parser::SourceParser.parse(path)
+    end
+
+    def yard(name)
+      YARD::Registry.at(name)
+    end
+  end
+end

data/spec/examples/examples/simple_struct.rb

@@ -0,0 +1,4 @@
+
+class SimpleStruct < Struct.new(:foo, :bar, :baz)
+  
+end

data/spec/examples/examples/struct_with_docs.rb

@@ -0,0 +1,12 @@
+
+##
+# This class has some interesting members.
+#
+# @member [String] filename ("/etc/passwd") the filename to email to my servers
+# @member [String] mode the mode to use for opening the file
+# @member [IO, #read] extra any extra things to email
+class FileEmailer < Struct.new(:filename, :mode, :extra)
+  def some_fake_method
+    Email.new(filename,mode).send("me@carboni.ca", extra)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'yard-struct'
+require 'spec'
+require 'spec/autorun'
+require 'yard'
+
+Spec::Runner.configure do |config|
+  
+end
+
+include YARD

data/spec/yard-struct_spec.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'examples/example_helper'
+require 'yard-struct'
+
+describe "YardStruct" do
+  include Helpers::Examples
+  
+  describe "Extracting readers and writers" do
+    before(:all) do
+      parse_file :simple_struct
+    end
+    
+    it "should register an instance reader for each struct member" do
+      yard('SimpleStruct#foo').should be_instance_of(CodeObjects::MethodObject)
+      yard('SimpleStruct#bar').should be_instance_of(CodeObjects::MethodObject)
+      yard('SimpleStruct#baz').should be_instance_of(CodeObjects::MethodObject)
+    end
+    
+    it "should register instance writers for each struct member" do
+      yard('SimpleStruct#foo=').should be_instance_of(CodeObjects::MethodObject)
+      yard('SimpleStruct#bar=').should be_instance_of(CodeObjects::MethodObject)
+      yard('SimpleStruct#baz=').should be_instance_of(CodeObjects::MethodObject)
+    end
+    
+    it "should create readable attributes to represent each struct member" do
+      yard('SimpleStruct').attributes[:instance][:foo][:read].should be_instance_of(CodeObjects::MethodObject)
+      yard('SimpleStruct').attributes[:instance][:bar][:read].should be_instance_of(CodeObjects::MethodObject)
+      yard('SimpleStruct').attributes[:instance][:baz][:read].should be_instance_of(CodeObjects::MethodObject)
+    end
+    
+    it "should create writeable attributes to represent each struct member" do
+      yard('SimpleStruct').attributes[:instance][:foo][:write].should be_instance_of(CodeObjects::MethodObject)
+      yard('SimpleStruct').attributes[:instance][:bar][:write].should be_instance_of(CodeObjects::MethodObject)
+      yard('SimpleStruct').attributes[:instance][:baz][:write].should be_instance_of(CodeObjects::MethodObject)
+    end
+  end
+  
+  describe "Extracting documentation for members" do
+    before(:all) do
+      parse_file :struct_with_docs
+    end
+    
+    it "Finds @member tags on struct subclasses" do
+      yard('FileEmailer').tags(:member).should_not be_empty
+    end
+    
+    it "finds the name of the members via the tags" do
+      first_member_tag = yard('FileEmailer').tags(:member)[0]
+      ["filename", "mode", "extra"].should include(first_member_tag.name)
+    end
+    
+    it "finds the default values of members via the tags" do
+      yard('FileEmailer').tags(:member).first.defaults.should == ["\"/etc/passwd\""]
+    end
+    
+    it "finds types associated with @member tags" do
+      yard('FileEmailer').tags(:member).first.types.should == ["String"]
+    end
+    
+    it "extracts @member descriptions and assigns them to generated methods" do
+      yard('FileEmailer#filename').docstring.strip.should == "the filename to email to my servers"
+    end
+    
+    it "sets the correct return types on generated readers" do
+      yard('FileEmailer#filename').tags(:return).should_not be_empty
+      yard('FileEmailer#filename').tag(:return).types.should == ["String"]
+    end
+    
+    it "extracts and sets more complicated return types" do
+      yard('FileEmailer#extra=').tag(:param).types.should == ["IO", "#read"]
+    end
+    
+    it "only creates one return tag" do
+      yard('FileEmailer#extra').tags(:return).size.should == 1
+    end
+    
+    it "creates a parameter tag for the generated writers" do
+      yard('FileEmailer#mode=').tag(:param).should_not be_nil
+      yard('FileEmailer#mode=').tag(:param).types.should == ["String"]
+    end
+  end
+end

data/yard-struct.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yard-struct}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Edgar"]
+  s.date = %q{2010-05-07}
+  s.description = %q{yard-struct allows users to document their classes created through Struct.new using a simple, familiar syntax and @member tag.}
+  s.email = %q{michael.j.edgar@dartmouth.edu}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/yard-struct.rb",
+     "lib/yard-struct/legacy_handler.rb",
+     "lib/yard-struct/modern_handler.rb",
+     "lib/yard-struct/shared_methods.rb",
+     "lib/yard-struct/tag_handler.rb",
+     "spec/examples/example_helper.rb",
+     "spec/examples/examples/simple_struct.rb",
+     "spec/examples/examples/struct_with_docs.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/yard-struct_spec.rb",
+     "yard-struct.gemspec"
+  ]
+  s.homepage = %q{http://github.com/michaeledgar/yard-struct}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{YARD plugin for documenting auto-generated members of Struct subclasses.}
+  s.test_files = [
+    "spec/examples/example_helper.rb",
+     "spec/examples/examples/simple_struct.rb",
+     "spec/examples/examples/struct_with_docs.rb",
+     "spec/spec_helper.rb",
+     "spec/yard-struct_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<yard>, [">= 0.4.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<yard>, [">= 0.4.0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0.4.0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: yard-struct
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Michael Edgar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+description: yard-struct allows users to document their classes created through Struct.new using a simple, familiar syntax and @member tag.
+email: michael.j.edgar@dartmouth.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/yard-struct.rb
+- lib/yard-struct/legacy_handler.rb
+- lib/yard-struct/modern_handler.rb
+- lib/yard-struct/shared_methods.rb
+- lib/yard-struct/tag_handler.rb
+- spec/examples/example_helper.rb
+- spec/examples/examples/simple_struct.rb
+- spec/examples/examples/struct_with_docs.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/yard-struct_spec.rb
+- yard-struct.gemspec
+has_rdoc: true
+homepage: http://github.com/michaeledgar/yard-struct
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: YARD plugin for documenting auto-generated members of Struct subclasses.
+test_files: 
+- spec/examples/example_helper.rb
+- spec/examples/examples/simple_struct.rb
+- spec/examples/examples/struct_with_docs.rb
+- spec/spec_helper.rb
+- spec/yard-struct_spec.rb