ftw 0.0.6 → 0.0.7

data/test/all.rb

@@ -9,8 +9,16 @@ SimpleCov.start
 # Add '../lib' to the require path.
 $: << File.join(File.dirname(__FILE__), "..", "lib")
 
-glob = File.join(File.dirname(__FILE__), "ftw", "**", "*.rb")
-Dir.glob(glob).each do |path|
+def use(path)
   puts "Loading tests from #{path}"
   require File.expand_path(path)
 end
+
+dirname = File.dirname(__FILE__)
+use File.join(dirname, "docs.rb")
+
+# Load tests from ./*/**/*.rb (usually ./libraryname/....)
+glob = File.join(dirname, "*", "**", "*.rb")
+Dir.glob(glob).each do |path|
+  use path
+end

data/test/docs.rb

@@ -0,0 +1,42 @@
+require "rubygems"                                                                                               
+require "yard"                                                                                                   
+require File.join(File.expand_path(File.dirname(__FILE__)), "testing")
+
+describe "documentation tests" do
+  before do
+    # Use YARD to parse all ruby files found in '../lib'
+    libdir = File.join(File.dirname(__FILE__), "..", "lib")
+    YARD::Registry.load(Dir.glob(File.join(libdir, "**", "*.rb")))
+    @registry = YARD::Registry.all
+  end
+
+  test "All classes, methods, modules, and constants must be documented" do
+    # YARD's parser works best in ruby 1.9.x, so skip 1.8.x
+    skip if RUBY_VERSION < "1.9.2"
+    # Note, the 'find the undocumented things' code here is 
+    # copied mostly from: YARD 0.7.5's lib/yard/cli/stats.rb
+    #
+    # Find all undocumented classes, modules, and constants
+    undocumented = @registry.select do |o| 
+      [:class, :module, :constant].include?(o.type) && o.docstring.blank?
+    end
+
+    # Find all undocumented methods
+    methods = @registry.select { |m| m.type == :method }
+    methods.reject! { |m| m.is_alias? || !m.is_explicit? }
+    undocumented += methods.select do |m| 
+      m.docstring.blank? && !m.overridden_method
+    end
+
+    if (undocumented.length > 0)
+      message = ["The following are not documented"]
+      undocumented.each do |o|
+        message << "* #{o.type.to_s} #{o.to_s} <#{o.file}:#{o.line}>"
+      end
+
+      flunk(message.join("\n"))
+    else
+      pass
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ftw
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-14 00:00:00.000000000 Z
+date: 2012-03-05 00:00:00.000000000 Z
 dependencies: []
 description: For The Web. Trying to build a solid and sane API for client and server
   web stuff. Client and Server operations for HTTP, WebSockets, SPDY, etc.
@@ -19,26 +19,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/ftw/websocket.rb
-- lib/ftw/pool.rb
-- lib/ftw/agent.rb
-- lib/ftw/version.rb
-- lib/ftw/namespace.rb
-- lib/ftw/crlf.rb
-- lib/ftw/connection.rb
+- lib/rack/handler/ftw.rb
+- lib/ftw.rb
+- lib/ftw/dns.rb
+- lib/ftw/websocket/rack.rb
+- lib/ftw/websocket/writer.rb
 - lib/ftw/websocket/parser.rb
-- lib/ftw/request.rb
-- lib/ftw/cookies.rb
-- lib/ftw/http/headers.rb
+- lib/ftw/websocket/constants.rb
+- lib/ftw/poolable.rb
+- lib/ftw/connection.rb
+- lib/ftw/version.rb
+- lib/ftw/agent.rb
+- lib/ftw/pool.rb
+- lib/ftw/server.rb
+- lib/ftw/websocket.rb
 - lib/ftw/http/message.rb
+- lib/ftw/http/headers.rb
+- lib/ftw/request.rb
+- lib/ftw/protocol.rb
 - lib/ftw/response.rb
-- lib/ftw/dns.rb
-- lib/ftw/poolable.rb
-- lib/ftw.rb
-- test/ftw/crlf.rb
-- test/ftw/http/headers.rb
-- test/ftw/http/dns.rb
+- lib/ftw/namespace.rb
+- lib/ftw/cookies.rb
+- lib/ftw/singleton.rb
+- lib/ftw/crlf.rb
 - test/testing.rb
+- test/docs.rb
+- test/ftw/http/dns.rb
+- test/ftw/http/headers.rb
+- test/ftw/crlf.rb
 - test/all.rb
 - README.md
 homepage: http://github.com/jordansissel/ruby-ftw
@@ -63,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: For The Web. Trying to build a solid and sane API for client and server web