danski-tzatziki 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 danski
+
+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

@@ -0,0 +1,7 @@
+tzatziki========
+Description goes here.
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 danski. See LICENSE for details.

data/README.markdown

@@ -0,0 +1,8 @@
+tzatziki
+========
+Description goes here.
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Dan Glegg. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 1
+:major: 0

data/bin/taz

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+help = <<HELP
+Tzatziki is a combined API documentation and testing tool.
+----------------------------------------------------------
+By writing your developer API documentation with Tzatziki, 
+you're creating a set of tests that run over HTTP *and* a 
+lovely, readable, configurable HTML documentation set.
+
+Basic Command Line Usage:
+  taz --help                                            # Show this message
+  taz <path to write generated site>                    # Runs the Tzatziki suites in ./ and saves the resulting documentation to <destination>
+  taz <path to source> <path to write generated site>   # Runs the Tzatziki suites in <source> and saves the resulting documentation to <destination>
+    
+  Options:
+HELP
+
+require 'optparse'
+require 'tzatziki'
+
+options = {
+  :generate_default_template=>false,
+  :domain=>"http://localhost"
+}
+
+opts = OptionParser.new do |opts|
+  opts.banner = help
+  
+  opts.on("--generate", "Generate a new Tzatziki site in the specified directory.") do
+    options[:generate_default_template] = true
+  end
+  
+  opts.on("--domain [domain]", "Run the tests against a specific domain. Defaults to #{options[:domain]}") do |domain|
+    Tzatziki.domain = domain || options[:domain]
+  end
+  
+  opts.on("--nodoc", "Runs your Tzatziki files as tests without producing new documentation files.") do
+    Tzatziki.write_docs = false
+  end
+  
+  opts.on("--notest", "Compiles the Tzatziki documentation for your API without running the tests.") do
+    Tzatziki.run_tests = false
+  end
+  
+  opts.on("--pygments", "Use pygments to highlight code") do
+    Tzatziki.pygments = true
+  end
+  
+  opts.on("--version", "Display current version") do
+    puts "Tzatziki " + Tzatziki.version
+    exit 0
+  end
+end
+
+opts.parse!
+
+def clean(dest)
+  FileUtils.rm_rf(dest)
+  FileUtils.mkdir_p(dest)
+end
+
+def globs(source)
+  Dir.chdir(source) do
+    dirs = Dir['*'].select { |x| File.directory?(x) }
+    dirs -= ['_site']
+    dirs = dirs.map { |x| "#{x}/**/*" }
+    dirs += ['*']
+  end
+end
+
+source = nil
+destination = nil
+
+case ARGV.size
+  when 0
+    source = '.'
+    destination = File.join('.', 'docs')
+  when 1
+    source = '.'
+    destination = ARGV[0]
+  when 2
+    source = ARGV[0]
+    destination = ARGV[1]
+  else
+    puts "Invalid options. Run `taz --help` for assistance."
+    exit(1)
+end
+
+if options[:generate_default_template]
+  puts "Generating default template in #{destination}..."
+else
+  Tzatziki.process!(source, destination)
+end

data/lib/tzatziki.rb

@@ -0,0 +1,58 @@
+$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+# Core requires
+require 'rubygems'
+# Stdlib requires
+require 'fileutils'
+require 'yaml'
+# Gem requires
+require 'liquid'
+require 'redcloth'
+# Tzatziki requires
+require 'tzatziki/testable'
+require 'tzatziki/site'
+require 'tzatziki/page'
+require 'tzatziki/specification'
+
+module Tzatziki
+  
+  class << self
+    attr_accessor :source, :destination, :domain, :pygments, :write_docs, :run_tests
+  end
+  
+  # Configuration
+  Tzatziki.domain = "http://localhost"
+  Tzatziki.pygments = false
+  Tzatziki.write_docs = true
+  Tzatziki.run_tests = true
+  
+  # Pointers
+  
+  
+  def self.process!(source, destination)
+    if run_tests
+      puts "Running tests against #{domain}..."
+      test(source, destination)
+    end
+    if write_docs
+      puts "Generating documentation in #{destination}"
+      document(source, destination)
+    end
+    puts "Out of Tzatziki."
+  end
+  
+  
+   
+  def self.test(source, destination)
+    
+  end
+  
+  def self.document(source, destination)
+    
+  end
+  
+  def self.version
+    yml = YAML.load(File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION.yml])))
+    "#{yml[:major]}.#{yml[:minor]}.#{yml[:patch]}"
+  end
+  
+end

data/lib/tzatziki/site.rb

@@ -0,0 +1,11 @@
+module Tzatziki
+  
+  class Site
+    
+    def initialize(source, destination)
+      
+    end
+    
+  end
+  
+end

data/lib/tzatziki/specification.rb

@@ -0,0 +1,7 @@
+module Tzatziki
+  
+  class Specification
+    
+  end
+  
+end

data/spec/example/source/_layouts/default.html

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+	<title>{{page.title}} - Example Tzatziki Suite</title>	
+</head>
+
+<body>
+	
+	<h1>{{page.title}}</h1>
+	
+	<div>
+		{{content}}
+	</div>
+
+</body>
+</html>

data/spec/example/source/the_google/index.textile

@@ -0,0 +1,7 @@
+---
+title: The Google Search API
+---
+
+This is a textile document intended to be a cover sheet for the The Google Search API. It searches The Google.
+
+This one doesn't generate any test results, but it does appear in the generated site pretty much just like a Jekyll::Page.

data/spec/example/source/the_google/search.markdown

@@ -0,0 +1,17 @@
+---
+title: Requesting the search results from The Google
+request:
+  protocol: http
+  domain: www.google.com
+  uri: /search
+	method: get
+  query_string:
+    q:
+      description: An entity-escaped string that you wish to search for on The Google.
+      example: google (now you're thinking with portals)
+			format: /.*/
+specifications:
+	successful: true
+---
+
+This is an example API document designed to document and test parts of the The Google Search API.

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format
+specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__)+'/../lib/tzatziki'

data/spec/tzatziki_spec.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Tzatziki do
+  
+  it "should only run the test suites when run with the --nodoc option"
+  it "should only run the document generator when run with the --notest option"
+  
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: danski-tzatziki
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- danski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-27 00:00:00 -07:00
+default_executable: taz
+dependencies: []
+
+description: TODO
+email: dan@angryamoeba.co.uk
+executables: 
+- taz
+extensions: []
+
+extra_rdoc_files: 
+- README
+- README.markdown
+- LICENSE
+files: 
+- README.markdown
+- VERSION.yml
+- bin/taz
+- lib/tzatziki
+- lib/tzatziki/site.rb
+- lib/tzatziki/specification.rb
+- lib/tzatziki.rb
+- spec/example
+- spec/example/destination
+- spec/example/source
+- spec/example/source/_layouts
+- spec/example/source/_layouts/default.html
+- spec/example/source/_specifications
+- spec/example/source/_types
+- spec/example/source/the_google
+- spec/example/source/the_google/index.textile
+- spec/example/source/the_google/search.markdown
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/tzatziki_spec.rb
+- README
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/danski/tzatziki
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+