data_doc 0.0.2

data/History.txt

@@ -0,0 +1,10 @@
+=== 0.0.2 2012-10-18
+
+* 1 minor enhancement:
+  * Documentation fix
+  * Test release
+
+=== 0.0.1 2012-10-18
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/data_doc
+lib/data_doc.rb
+lib/data_doc/cli.rb
+script/console
+script/destroy
+script/generate
+test/test_data_doc.rb
+test/test_data_doc_cli.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on data_doc, see http://data_doc.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,75 @@
+= data_doc
+
+* http://github.com/alilee/data_doc
+
+{<img src="https://secure.travis-ci.org/alilee/data_doc.png" alt="Build Status" />}[http://travis-ci.org/alilee/data_doc]
+
+== DESCRIPTION:
+
+Complex documents can be challenging to author, and time-consuming to achieve 
+high levels of internal consistency. This gem offers a Domain Specific Language 
+to embed structured data in a markdown document and then render it into 
+configurable tables. 
+
+== FEATURES/PROBLEMS:
+
+* Main document is Markdown for convenient content authoring.
+* Builds up data in relational database, facilitating review and 
+  analysis.
+* Generates HTML from Markdown.
+* Provides fine-grained control over the HTML headers, including 
+  CSS, for the output.
+* Simple DSL for capturing structured data
+* Simple DSL for querying data stores and laying out in tables.
+
+== SYNOPSIS:
+
+  data_doc your_file.md.erb > result.html
+  
+The data definition language looks like this:
+
+  store 'requirement' do
+    string 'name'
+    text 'description'
+    string 'priority'
+    alternate_key 'name'    
+  end
+  
+  requirement name: "It MUST "
+  
+The 
+
+== REQUIREMENTS:
+
+* Tested on Ruby 1.9.3 only (so far)
+* ActiveRecord-compatible data store
+* RDiscount for Markdown
+
+== INSTALL:
+
+  gem install data_doc
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Alister Lee
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/data_doc'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'data_doc' do
+  self.developer 'Alister Lee', 'gems@shortepic.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = 'data-doc' # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/bin/data_doc

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2012-10-18.
+#  Copyright (c) 2012. All rights reserved.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/data_doc")
+require "data_doc/cli"
+
+DataDoc::CLI.execute(STDOUT, ARGV)

data/lib/data_doc/cli.rb

@@ -0,0 +1,42 @@
+require 'optparse'
+
+module DataDoc
+  class CLI
+    def self.execute(stdout, arguments=[])
+
+      # NOTE: the option -p/--path= is given as an example, and should be replaced in your application.
+
+      options = {
+        :path     => '~'
+      }
+      mandatory_options = %w(  )
+
+      parser = OptionParser.new do |opts|
+        opts.banner = <<-BANNER.gsub(/^          /,'')
+          This application is wonderful because...
+
+          Usage: #{File.basename($0)} [options]
+
+          Options are:
+        BANNER
+        opts.separator ""
+        opts.on("-p", "--path PATH", String,
+                "This is a sample message.",
+                "For multiple lines, add more strings.",
+                "Default: ~") { |arg| options[:path] = arg }
+        opts.on("-h", "--help",
+                "Show this help message.") { stdout.puts opts; exit }
+        opts.parse!(arguments)
+
+        if mandatory_options && mandatory_options.find { |option| options[option.to_sym].nil? }
+          stdout.puts opts; exit
+        end
+      end
+
+      path = options[:path]
+
+      # do stuff
+      stdout.puts "To update this executable, look in lib/data_doc/cli.rb"
+    end
+  end
+end

data/lib/data_doc.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module DataDoc
+  VERSION = '0.0.2'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/data_doc.rb'}"
+puts "Loading data_doc gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_data_doc.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestDataDoc < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_data_doc_cli.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+require 'data_doc/cli'
+
+class TestDataDocCli < Test::Unit::TestCase
+  def setup
+    DataDoc::CLI.execute(@stdout_io = StringIO.new, [])
+    @stdout_io.rewind
+    @stdout = @stdout_io.read
+  end
+  
+  def test_print_default_output
+    assert_match(/To update this executable/, @stdout)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/data_doc'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: data_doc
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Alister Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: newgem
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: ! "Complex documents can be challenging to author, and time-consuming
+  to achieve \nhigh levels of internal consistency. This gem offers a Domain Specific
+  Language \nto embed structured data in a markdown document and then render it into
+  \nconfigurable tables."
+email:
+- gems@shortepic.com
+executables:
+- data_doc
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files:
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- bin/data_doc
+- lib/data_doc.rb
+- lib/data_doc/cli.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_data_doc.rb
+- test/test_data_doc_cli.rb
+- test/test_helper.rb
+- .gemtest
+homepage: http://github.com/alilee/data_doc
+licenses: []
+post_install_message: PostInstall.txt
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1827853280249206312
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: data-doc
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Complex documents can be challenging to author, and time-consuming to achieve  high
+  levels of internal consistency
+test_files:
+- test/test_data_doc.rb
+- test/test_data_doc_cli.rb
+- test/test_helper.rb