data_doc 0.0.3 → 0.1.0

data/History.txt

@@ -1,3 +1,14 @@
+=== 0.1.0 2012-10-23
+
+* 2 major enhancements:
+  * DSL for stores, including adding rows
+  * DSL for presenting simple tables
+  
+* 2 known issues
+  * ERB processing under $SAFE = 4 unavailable 
+  * Good testing coverage, although possibly too complex
+    in use of nested describes and before and after
+
 === 0.0.3 2012-10-22
 
 * 4 minor enhancements:

data/README.rdoc

@@ -2,9 +2,13 @@
 
 * 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]
+== DEVELOPMENT STATUS: 
 
-NOTE: THIS GEM DOES NOTHING YET.
+Generates html from markdown files containing erb, including layout and 
+headers. DSL in place for stores, attributes and simple tables. Testing 
+doesn't quite cover the Present DSL.
+
+{<img src="https://secure.travis-ci.org/alilee/data_doc.png" alt="Build Status" />}[http://travis-ci.org/alilee/data_doc] {<img src="https://gemnasium.com/alilee/data_doc.png" alt="Dependency Status" />}[https://gemnasium.com/alilee/data_doc]
 
 == DESCRIPTION:
 
@@ -58,7 +62,7 @@ your level of risk.
   
 The data definition language looks like this:
 
-  connection adapter: sqlite3 database: '/tmp/example.db'
+  connection adapter: sqlite3 database: '/tmp/example.db' #=>
   
   store 'priority' do
     string 'name'

data/Rakefile

@@ -11,7 +11,7 @@ Hoe.plugin :newgem
 $hoe = Hoe.spec 'data_doc' do
   self.developer        'Alister Lee', 'gems@shortepic.com'
   self.rubyforge_name = 'data-doc'
-  self.extra_deps =     [['activerecord','>= 2.0.2']]
+  self.extra_deps =     [['activerecord','~> 3.2.8'],['rdiscount','~> 1.6.8']]
 end
 
 require 'newgem/tasks'

data/lib/data_doc/cli.rb

@@ -17,7 +17,7 @@ module DataDoc
     def self.execute(stdout, arguments=[])
 
       doc = DataDoc::Document.new
-      doc.output = stdout
+      filename = nil
 
       OptionParser.new do |opts|
         opts.banner = <<-BANNER.gsub(/^          /,'')
@@ -50,13 +50,8 @@ module DataDoc
         end
 
         opts.on("-o", "--output FILENAME", 
-                "Put generated output in FILENAME") do |filename|
-          begin
-            doc.output = File.open(filename, 'w+')
-          rescue Exception => e
-            stdout.puts "ERROR with output file (#{e.message})"
-            return 1
-          end
+                "Put generated output in FILENAME") do |f|  
+          filename = f
         end
                 
         type_list = DataDoc::Document::OUTPUT_TYPES.join(', ')
@@ -97,7 +92,20 @@ module DataDoc
         return 1
       end
             
-      doc.generate(content)
+      result = doc.generate(content)
+      unless filename.nil?
+        begin
+          File.open(filename, 'w+') do |f|
+            f.write(result)
+          end
+        rescue Exception => e
+          stdout.puts "ERROR with output file (#{e.message})"
+          return 1
+        end
+      else
+        stdout.write(result)
+      end
+      0      
     end
   end
 end

data/lib/data_doc/document.rb

@@ -1,5 +1,7 @@
 require 'rdiscount'
 require 'erb'
+require 'data_doc/store.rb'
+require 'data_doc/present.rb'
 
 module DataDoc
 
@@ -21,7 +23,6 @@ module DataDoc
     #
     def initialize
       @format = 'html'
-      @output = STDOUT
       @verbose = false
       @read_only = false
       @data_only = false
@@ -29,6 +30,7 @@ module DataDoc
       @layout_filename = nil
       
       @headers = Array.new
+      @stores = Hash.new
     end
     
     # MIME-type for output
@@ -37,23 +39,33 @@ module DataDoc
     # Available mime types that can be generated.
     OUTPUT_TYPES = ['html']
 
-    # output filename
-    attr_accessor :output 
-
     # display verbose output during processing
     attr_accessor :verbose
 
     # do not change schema or data
-    attr_accessor :read_only 
+    attr_reader :read_only 
 
     # do not change schema; truncates tables
     attr_accessor :data_only
     
+    # ActiveRecord connection
+    attr_reader :connection
+    
+    #
+    # Do not change schema or data.
+    #
+    def read_only=(ro)
+      @read_only = ro
+      @data_only = ro if ro
+    end
+
     # 
     # Sets the database connection that the stores will be using
     #
-    def connection=(connection)
-    end
+    def connection=(conn_filename)
+      settings = YAML::load_file(conn_filename)
+      set_connection(settings)
+    end    
     
     # 
     # Sets the layout file option.
@@ -74,24 +86,29 @@ module DataDoc
     def generate(content_io)
       erb_content = content_io.read
       begin
-        self.untrust
-        mark_down = ERB.new(erb_content, 4).result(binding.taint) # $SAFE = 4
+        # @store.taint
+        # self.untrust
+        mark_down = ERB.new(erb_content, 0).result(binding.taint) # TODO: $SAFE = 4
       ensure
-        self.trust
+        # self.trust
+        # @store.untaint
       end
       content_html = RDiscount.new(mark_down).to_html
-      html = wrap_in_layout(content_html)
-      @output.write(html)
-      0
+      wrap_in_layout(content_html)
     end
     
     #
     # :section: 3. DSL for layout file
     #
+    # Each function below includes a usage example which shows how it would be
+    # called from within a content file.
+    #
     
     #
     # Set layout file (from the filename, not the template content itself)
     #
+    #   <% set_layout_file 'myfile.html.erb' %>
+    #
     # Content is html, with ERB placeholders to yield to add content at 
     # appropriate points.
     #
@@ -114,6 +131,9 @@ module DataDoc
     #
     # :section: 4. DSL for header tags
     #
+    # Each function below includes a usage example which shows how it would be
+    # called from within a content file.
+    #
   
     #
     # Sets the title tag and emits the title in a classed div.title. 
@@ -144,14 +164,47 @@ module DataDoc
       add_header "<link #{html_attrs(attrs)}>"
     end
             
+            
+    #
+    # :section: 5. DSL for stores
+    #
+    
+    #
+    # Specifies ActiveRecord connection settings.
+    #
+    def set_connection(settings)
+      ActiveRecord::Base.establish_connection(settings)
+      @connection = ActiveRecord::Base.connection
+    end
+    
+    #
+    # Define a table store.
     #
-    # :section: 5. Protected
+    def store(name, opts = {}, &blk)
+      @stores[name.to_s] = DataDoc::Store.new(self, name, opts, &blk)
+      name
+    end
+    
+    #
+    # :section: 6. DSL for presenting tables
     #
     
+    #
+    # Present a table. Pass a block to set options for display.
+    # For more information see DataDoc::Present
+    #
+    def present(arel_or_str)
+      DataDoc::Present.present(self, arel_or_str)
+    end
+            
   protected
-          
+
     #
-    # Isolates ERB for layout
+    # :section: 9. Protected
+    #
+              
+    #
+    # Isolates ERB for layout.
     #
     class IsolatedLayoutContext
       # captures binding including any block
@@ -193,6 +246,25 @@ module DataDoc
       h
     end
     
+    #
+    # Allow use of relation names as calls for adding or querying.
+    #
+    # If no args then returns an arel for querying, otherwise assumes add.
+    #
+    def method_missing(name, *args, &block)
+      table_name = name.to_s
+      if @stores.has_key?(table_name)
+        if args.empty?
+          return @stores[table_name].arel
+        else
+          @stores[table_name].insert(*args) unless @read_only
+        end
+      else
+        super
+      end 
+    end
+    
+    
   end
   
 end

data/lib/data_doc/present.rb

@@ -0,0 +1,106 @@
+require 'builder'
+
+module DataDoc
+  
+  #
+  # Presents the results of a query in an html table.
+  #
+  class Present
+    
+    #
+    # Accept display options from a block. Returns html table.
+    #
+    def self.present(doc, arel_or_str, &blk)
+      rows = doc.connection.select_all(arel_or_str)
+      p = Present.new(doc, rows)
+      p.instance_eval(&blk) if block_given?
+      p.render
+    end
+    
+    #
+    # Defines presentation set and order of columns.
+    #
+    # Not every field queried needs to be presented.
+    #
+    def column_order(*order)
+      @column_order = order
+    end
+    
+    #
+    # Set the caption for the table
+    #
+    def caption(text)
+      @caption = text
+    end
+    
+    #
+    # Rename the column heading text for a particular column.
+    #
+    def label(column, text)
+      @labels[column] = text
+    end
+    
+    #
+    # Define a block which is called to override the contents of
+    # a cell.
+    #
+    # Return nil to revert to the default behaviour.
+    #
+    def each_cell(&blk) # :yields: col, row
+      @each_cell = blk
+    end
+    
+    #
+    # Define a calculated column based on a block.
+    #
+    def calculate(col, &blk) # :yields: row
+      @calculated[col] = blk
+    end
+    
+    #
+    # Generate html.
+    #
+    def render
+      h = Builder::XmlMarkup.new
+      h.table {
+        h.caption(@caption) unless @caption.nil?
+        h.thead {
+          h.tr {
+            @column_order.each { |c| h.th(@labels[c] || c.to_s.humanize) }
+          }
+        }
+        h.tfoot
+        h.tbody {
+          @rows.each do |r|
+            h.tr {
+              if @each_cell.nil?
+                @column_order.each {|col| h.td(r[col.to_s]) }
+              else
+                @column_order.each do |col|
+                  h.td(@each_cell.call(r, col) || r[col.to_s])
+                end
+              end
+            }
+          end
+        }
+      }
+    end
+        
+  protected
+    
+    #
+    # Create new.
+    #
+    def initialize(doc, rows)
+      @doc = doc
+      @rows = rows
+      @caption = nil
+      @each_cell = nil
+      @labels = Hash.new
+      @calculated = Hash.new
+      @column_order = rows.first.keys
+    end
+        
+  end
+  
+end

data/lib/data_doc/store.rb

@@ -0,0 +1,89 @@
+require 'active_record'
+
+module DataDoc
+
+  #
+  # Defines schema for structured content and accepts rows.
+  #
+  # Sets up an ActiveRecord store, defines its tables and 
+  # fields, and adds row content.
+  #
+  class Store
+    
+    #
+    # Define a store.
+    #
+    # Yields to a block calling the store for fields and other
+    # schema definition. Table is re-created and emptied unless 
+    # read_only, and just emptied if data_only.
+    #
+    def initialize(doc, table_name_or_sym, opts = {}, &blk)
+      @doc = doc
+      @connection = @doc.connection
+      create_store(table_name_or_sym, opts, &blk)
+    end
+    
+    # AREL object encapsulating table.
+    attr_reader :arel
+            
+    #
+    # Define a string field.
+    #
+    def string(name, opts = {})
+      @connection.add_column(@arel.name, name, :string, opts)
+    end
+    
+    #
+    # Define an integer field.
+    #
+    def integer(name, opts = {})
+      @connection.add_column(@arel.name, name, :integer, opts)
+    end
+    
+    # 
+    # Define a text field.
+    #
+    def text(name, opts = {})
+      @connection.add_column(@arel.name, name, :text, opts)
+    end
+    
+    # 
+    # Define a datetime field.
+    #
+    def datetime(name, opts = {})
+      @connection.add_column(@arel.name, name, :datetime, opts)
+    end    
+    
+    #
+    # Insert a row from a hash. 
+    #
+    def insert(record)
+      return if @doc.read_only
+      manager = @arel.insert_manager
+      columns = record.keys.map { |k| @arel[k] }
+      manager.insert(columns.zip(record.values))
+      @connection.insert(manager)
+    end
+
+  protected
+    
+    #
+    # Create and empty the store unless options prevent. 
+    #
+    def create_store(table_name_or_sym, opts = {}, &blk)
+      table_name = table_name_or_sym.to_s 
+      @arel = Arel::Table.new(table_name)
+      unless @doc.read_only
+        if @doc.data_only
+          @connection.delete_sql("DELETE from #{table_name}")
+        else
+          @connection.create_table(table_name, opts.merge(force: true))
+        end
+      end
+      self.instance_eval(&blk) if block_given?
+      table_name_or_sym
+    end
+            
+  end
+  
+end

data/lib/data_doc.rb

@@ -6,11 +6,10 @@ $:.unshift(File.dirname(__FILE__)) unless
 #
 module DataDoc
   # Gem version
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
   # A summary of purpose of the tool.  
   DESCRIPTION = 'Processes structured data embedded in a markdown document and then renders it into configurable tables.'
 end
 
 require 'data_doc/document.rb'
-# require 'data_doc/store.rb'
 # require 'data_doc/table.rb'

data/test/test_data_doc_document.rb

@@ -6,14 +6,15 @@ describe DataDoc::Document do
     @doc = DataDoc::Document.new
     @input = ""
     @expected_output = ""
+    @expected_rows = nil
   end
 
   after do
-    output = StringIO.new
-    @doc.output = output
-    @doc.generate(StringIO.new(@input))
-    output.rewind
-    output.read.strip.must_equal @expected_output.strip
+    output = @doc.generate(StringIO.new(@input))
+    output.strip.must_equal @expected_output.strip
+    unless @expected_rows.nil?
+      @doc.connection.select_value("select count(1) from #{@expected_table_name}").must_equal(@expected_rows)
+    end
   end
       
   it "should process empty input" do
@@ -72,5 +73,93 @@ describe DataDoc::Document do
     end
   
   end
+  
+  describe "defining stores" do
+    
+    before do
+      @db_filename = temp_file("")
+      @conn_filename = temp_file("adapter: sqlite3\ndatabase: #{@db_filename}") # YAML
+    end
+    
+    it "should specify connection settings to a database via DSL" do
+      @input = "<% set_connection adapter: 'sqlite3', database: '#{@db_filename}' %>"
+      @doc.layout = temp_file('')
+      @expected_output = ''
+    end
+    
+    it "should accept connection settings via option" do
+      @doc.connection = @conn_filename
+      @doc.layout = temp_file('<%= yield %>')
+      @input = ''
+      @expected_output = ''
+    end
+    
+    it "should define stores" do
+      @doc.connection = @conn_filename
+      @doc.layout = temp_file('<%= yield %>')
+      @input = "<% store 'relation' %>"
+      @expected_output = ''
+    end
+    
+    describe "adding rows" do
+      
+      before do
+        @doc.connection = @conn_filename
+        @doc.layout = temp_file('<%= yield %>')
+        @expected_output = ''
+        @expected_table_name = 'relation'
+        @input = <<EOS
+<% store 'relation' do
+     string 'string'
+   end
+   relation string: 'a string'
+%>      
+EOS
+      end
+            
+      it "should accept a row" do
+        @expected_rows = 1
+      end
+      
+      describe "when read_only" do
+
+        before do
+          @doc.connection.execute("create table relation(integer id, varchar string)")
+          @doc.read_only = true
+        end
+        
+        it "should ignore a row" do
+          @expected_rows = 0          
+        end
+        
+      end
+      
+    end
+    
+  end
+  
+  describe "presenting tables" do
+    
+    before do
+      db_filename = temp_file("")
+      conn_filename = temp_file("adapter: sqlite3\ndatabase: #{db_filename}") # YAML
+      @doc.connection = conn_filename
+      @doc.layout = temp_file('<%= yield %>')
+      @doc.store 'relation' do
+        string 'string'
+        integer 'number'
+      end
+      @doc.relation(string: 'a string', number: 42)
+    end
+    
+    it "should present raw sql" do
+      @doc.present("select * from relation").must_match(/<table>.*<\/table>/) 
+    end
+    
+    it "should present an arel" do
+      @doc.present(@doc.relation.project('*')).must_match(/<table>.*<\/table>/)
+    end
+    
+  end
 
 end

data/test/test_data_doc_present.rb

@@ -0,0 +1,18 @@
+require_relative 'test_helper.rb'
+
+describe DataDoc::Present do
+    
+  before do
+    @mock_doc = MockDoc.new
+  end
+  
+  it "should be" do
+    DataDoc::Present.present(@mock_doc, "select 1")
+  end
+  
+  it "should generate a table" do
+    DataDoc::Present.present(@mock_doc, "select 1").must_match(/<table>.*<\/table>/)
+  end
+  
+end
+    

data/test/test_data_doc_store.rb

@@ -0,0 +1,139 @@
+require_relative 'test_helper.rb'
+
+describe DataDoc::Store do
+    
+  before do
+    @mock_doc = MockDoc.new
+  end
+    
+  describe "defining stores" do
+
+    describe "create table" do
+
+      before do
+        @mock_doc.connection.create_table('relation', force: true)
+        @mock_doc.connection.add_column('relation', 'string', :string, default: 'present')
+        @mock_doc.connection.insert_sql('INSERT INTO relation(id) VALUES (1)')
+        @confirm_old_table_value = false
+        @confirm_old_table_column = false
+      end
+
+      after do
+        DataDoc::Store.new(@mock_doc, 'relation')
+        @mock_doc.connection.select_value('select count(1) from relation').must_equal @expected_rows
+        if @confirm_old_table_value
+          @mock_doc.connection.select_value('select string from relation limit 1').must_equal 'present'
+        end
+        if @confirm_old_table_column
+          @mock_doc.connection.insert_sql("INSERT INTO relation(string) VALUES ('hello')")
+        end
+      end
+
+      it "shouldn't create a table if read_only" do
+        @mock_doc.read_only = true
+        @expected_rows = 1
+        @confirm_old_table_value = true
+      end
+
+      it "shouldn't create a table if data_only" do
+        @mock_doc.data_only = true
+        @expected_rows = 0
+        @confirm_old_table_column = true
+      end
+
+      it "should truncate the table if data_only" do
+        @mock_doc.data_only = true
+        @expected_rows = 0
+      end
+          
+      it "shouldn't truncate the table if read_only" do
+        @mock_doc.read_only = true
+        @expected_rows = 1
+        @confirm_old_table_value = true
+      end
+          
+    end
+        
+    describe "add attributes" do
+                    
+      def check_insert(field, value)
+        @mock_doc.connection.select_value("insert into relation(#{field}) values ('#{value}')").must_be_nil
+      end
+          
+      it "adds a string attribute" do
+        DataDoc::Store.new(@mock_doc, 'relation') do
+          string 'string'
+        end
+        check_insert('string', 'a string')
+      end
+          
+      it "adds an integer attribute" do
+        DataDoc::Store.new(@mock_doc, 'relation') do
+          integer 'number'
+        end
+        check_insert('number', 42)
+      end
+          
+      it "adds a text attribute" do
+        DataDoc::Store.new(@mock_doc, 'relation') do
+          text 'description'
+        end
+        check_insert('description', 'a string')            
+      end
+          
+      it "adds a datetime attribute" do
+        DataDoc::Store.new(@mock_doc, 'relation') do
+          datetime 'timestamp'
+        end
+        check_insert('timestamp', '2012-10-12')
+      end
+
+    end
+
+    describe "alternate keys" do
+    end
+        
+  end
+
+  describe "accepting rows" do
+          
+    before do
+      @store = DataDoc::Store.new(@mock_doc, 'relation') do
+        string 's'
+        integer 'i'
+        text 't'
+      end    
+      @mock_doc.connection.select_value("select count(1) from relation").must_equal 0
+    end
+    
+    describe "when not read_only" do
+    
+      after do
+        @mock_doc.connection.select_value("select count(1) from relation").must_equal 1
+      end
+      
+      it "should accept a row" do
+        @store.insert(s: 'a string', i: 42, t: 'a string')
+      end
+
+    end
+    
+    describe "when read_only" do
+
+      before do
+        @mock_doc.read_only = true
+      end
+
+      after do
+        @mock_doc.connection.select_value("select count(1) from relation").must_equal 0
+      end
+      
+      it "should ignore a row" do
+        @store.insert(s: 'a string', i: 42, t: 'a string')
+      end
+      
+    end
+    
+  end
+
+end

data/test/test_helper.rb

@@ -15,7 +15,31 @@ def temp_file(content)
   f.path
 end
 
+
 # allows yield to call block
 def erb(content)
   ERB.new(content).result(binding)
 end
+
+# connection to temp database
+def test_connection
+  settings = {
+    adapter: 'sqlite3',
+    database: temp_file("")
+  }
+  ActiveRecord::Base.establish_connection(settings)
+  ActiveRecord::Base.connection
+end
+
+# Test Document for Store and Present
+class MockDoc
+
+  attr_accessor :data_only, :read_only, :connection
+
+  def initialize
+    @data_only = false
+    @read_only = false
+    @connection = test_connection
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-21 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 3.2.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +66,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +74,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2005409692758115623
+      hash: -1350312980764895826
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: