sqltorial 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b81ab5d2e41712b52e7b96f1f6332e5a28c2ee01
-  data.tar.gz: 88ad7165935ab617c70786ddd96546c2545c2e35
+  metadata.gz: f3ca9d5ba9e65f3a01f00225e743efd0a4be9060
+  data.tar.gz: 4e7f40a198a35b4c14d4a71bb1273b5485680eff
 SHA512:
-  metadata.gz: 1cbc570b9ea4c206a0811816e307ab89d05ef6904ea1250dacd4a976d9a9aebfdd59e601c460b3914a2462e76fbd55d4e5d62d4ae8da6cf1ebfdc98a22abec1a
-  data.tar.gz: dcaf1f0cef469d9ca8fc8b56d15b1b7ff6113368ce1f9c2d3b33a5b8aef26e1c5128166d180d4506df4be0d0483d106edf0e776c3c90ef86ebfedfab04bc8e3a
+  metadata.gz: bbee4c513b93704a42818553114c40b82fd28945954bf1aa8122c3e626a77de7837cfff17678e62e1f2116298ba04434a124c7523b36933c78ebb0b2827bdf14
+  data.tar.gz: ff37c16257fd820609d68567bb3b80288be467c5551b1b982f8d136a0c2635b8364b7e7c2906cbcc71327ef6fd74aa2c433690b11cc25b98a7a09289cc4c231d

data/CHANGELOG.md

@@ -6,6 +6,47 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+- Nothing.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
+## 0.0.5
+
+### Added
+
+- More commas for more types of number columns.
+- Support for several Impala-oriented commands.
+- --ignore-cache option
+- --drop-tables option
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- ID columns shouldn't end up with commas
+- Markdown lists should render properly
+- Handle NULL values in columns
+
+## 0.0.4
+
+### Added
+
 - Watch mode.
 
 ### Deprecated

data/exe/sqltorial

@@ -11,6 +11,8 @@ Escort::App.create do |app|
 
   app.options do |opts|
     opts.opt :no_results, "Don't Include Results", short: '-n', long: '--no-results', type: :boolean, default: false
+    opts.opt :drop_it, "Drop tables before create", short: '-D', long: '--drop-tables', type: :boolean, default: false
+    opts.opt :ignore_cache, "Ignore cache", short: '-C', long: '--ignore-cache', type: :boolean, default: false
     opts.opt :output, "Output File", short: '-o', long: '--output', type: :string, default: 'output.md'
     opts.opt :preface, "Preface File", short: '-p', long: '--preface', type: :string, default: 'preface.md'
     opts.opt :watch, "Watch Mode", short: '-w', long: '--watch', type: :boolean, default: false

data/lib/sqltorial/assemble_command.rb

@@ -2,6 +2,7 @@ require_relative 'sql_to_example'
 require 'sequelizer'
 require 'facets/pathname/chdir'
 require 'listen'
+require "fileutils"
 
 module SQLtorial
   class AssembleCommand < ::Escort::ActionCommand::Base
@@ -11,7 +12,7 @@ module SQLtorial
     end
 
     def watch
-      listener = Listen.to(path) do |modified, added, removed|
+      listener = Listen.to(dir) do |modified, added, removed|
         process
        end
       listener.only(/\.sql$/)
@@ -20,13 +21,14 @@ module SQLtorial
     end
 
     def process
+      FileUtils.rm_rf(".sqltorial_cache") if global_options[:ignore_cache]
       process_dir.chdir do
         preface = Pathname.new(global_options[:preface]) if global_options[:preface]
         File.open(global_options[:output], 'w') do |f|
           f.puts preface.read if preface && preface.exist?
           examples = files.map.with_index do |file, index|
             Escort::Logger.output.puts "Examplizing #{file.to_s}"
-            SqlToExample.new(file, db, index + 1).to_str(!global_options[:no_results])
+            SqlToExample.new(file, db, index + 1).to_str(global_options)
           end
           f.puts(examples.join("\n\n"))
         end
@@ -37,6 +39,10 @@ module SQLtorial
       @process_dir = path.directory? ? path : Pathname.pwd
     end
 
+    def dir
+      @dir ||= path.directory? ? path : path.dirname
+    end
+
     def path
       @path ||= Pathname.new(arguments.first || ".")
     end

data/lib/sqltorial/directives/valid_column_directive.rb

@@ -1,6 +1,13 @@
 module SQLtorial
   class ValidColumnDirective
-    REGEXP = /^ DIRECTIVE:\s*(\S+)\s+(\S+)\s+(.+)/
+    REGEXP = /^\s*DIRECTIVE:\s*(\S+)\s+(\S+)\s+(.+)/
+
+    class << self
+      def regexp
+        REGEXP
+      end 
+    end 
+
     attr :column, :op, :matcher
     def initialize(line)
       _, column, op, matcher = REGEXP.match(line).to_a
@@ -18,5 +25,5 @@ module SQLtorial
       [column, op, matcher].join(" ")
     end
   end
-  Directive.register(AllDirective)
+  Directive.register(ValidColumnDirective)
 end

data/lib/sqltorial/metadata.rb

@@ -1,5 +1,5 @@
 module SQLtorial
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
   SUMMARY = %q{Knitr, but for SQL files, sorta}
   DESCRIPTION = %q{Ingests a set of commented SQL statements, executes them, and dumps the comments, queries, and results into a markdown file}
   HOMEPAGE = "http://github.com/outcomesinsights/sqltorial"

data/lib/sqltorial/query_cache.rb

@@ -21,7 +21,7 @@ module SQLtorial
     end
 
     def cache_file
-      @cache_file ||= Pathname.pwd + '.cache' + cache_file_name
+      @cache_file ||= Pathname.pwd + '.sqltorial_cache' + cache_file_name
     end
 
     def cache_file_name

data/lib/sqltorial/query_to_md.rb

@@ -24,9 +24,9 @@ module SQLtorial
     def get_md
       return "**No results found.**" if all.empty?
       output = []
-      output << "Found #{count} results."
+      output << "Found #{commatize(count)} results."
       if count > row_limit
-        output.last << "  Displaying first #{row_limit}."
+        output.last << "  Displaying first #{commatize(row_limit)}."
       end
       output << ""
       output << tableize(all.first.keys + additional_headers)
@@ -84,7 +84,7 @@ module SQLtorial
 
     def make_processors
       output_rows.first.map do |name, column|
-        if name.to_s.end_with?('_id')
+        if name.to_s =~ /_?id(_|$)/
           Proc.new do |column|
             column.to_s.chomp
           end
@@ -92,11 +92,11 @@ module SQLtorial
           case column
           when Float, BigDecimal
             Proc.new do |column|
-              sprintf("%.02f", column)
+              column ? commatize(sprintf("%.02f", column)) : nil
             end
           when Numeric, Fixnum
             Proc.new do |column|
-              commatize(column.to_s)
+              column ? commatize(column.to_s) : nil
             end
           else
             Proc.new do |column|
@@ -130,9 +130,13 @@ module SQLtorial
       widths.map { |width| '-' * width }
     end
 
-    def commatize(str)
-      return str unless str =~ /^\d+$/
-      str.reverse.chars.each_slice(3).map(&:join).join(',').reverse
+    def commatize(input)
+      str = input.to_s
+      return str unless str =~ /^[\d.]+$/
+      str, dec = str.split('.')
+      commaed = str.reverse.chars.each_slice(3).map(&:join).join(',').reverse
+      commaed << ".#{dec}" if dec and !dec.empty?
+      commaed
     end
 
     def cache

data/lib/sqltorial/sql_to_example.rb

@@ -48,29 +48,29 @@ module SQLtorial
       lines.shift while lines.first.strip.empty?
       prose_lines << lines.shift.sub(WHITESPACE_REGEX, ' ').sub(/^\s*$/, "\n\n") while lines.first && (lines.first =~ WHITESPACE_REGEX || lines.first.empty?)
       directives, prose_lines = prose_lines.partition { |line| Directive.match(line) }
-      [prose_lines.join(''), process_directives(directives), lines.join]
+      [prose_lines.map(&:strip).join("\n"), process_directives(directives), lines.join("\n")]
     end
 
     def number
       @number ||= file.basename.to_s.to_i
     end
 
-    def to_str(include_results = true)
+    def to_str(options = {})
+      options = options.merge(include_results: true)
       hash = {}
       queries.each_with_index do |query, index|
         prose, directives, sql = make_prose_directives_and_query(query)
 
         begin
           if is_create(sql)
-            execute(sql, include_results)
-            hash[sql] = [prose, create_to_md(include_results, sql, directives)];
+            hash[sql] = [prose, create_to_md(options, sql, directives)];
             next
-          elsif is_drop(sql)
-            execute(sql, include_results)
+          elsif is_passthru(sql)
+            execute(sql, options)
             hash[sql] = [prose, nil];
             next
           end
-          hash[sql] = [prose, query_to_md(include_results, sql, directives)]
+          hash[sql] = [prose, query_to_md(options, sql, directives)]
         rescue
           puts sql
           puts $!.message
@@ -90,7 +90,7 @@ module SQLtorial
         arr << value.last
         arr.join("\n\n")
       end
-      parts.join("\n") + "\n\n"
+      parts.join("\n\n") + "\n\n"
     end
 
     private
@@ -114,18 +114,34 @@ module SQLtorial
       sql =~ /^\s*drop/i
     end
 
-    def execute(sql, include_results)
-      db.execute(sql) if include_results
+    def is_use(sql)
+      sql =~ /^\s*use/i
     end
 
-    def create_to_md(include_results, sql, directives)
-      return nil unless include_results
-      table_name = /create\s*(?:temp)?\s*(?:table|view)\s*(\S+)/i.match(sql)[1].gsub('.', '__')
+    def is_compute(sql)
+      sql =~ /^\s*compute\s*stats/i
+    end
+
+    def is_passthru(sql)
+      is_drop(sql) || is_use(sql) || is_compute(sql)
+    end
+
+    def execute(sql, options)
+      db.execute(sql) if options[:include_results]
+    end
+
+    def create_to_md(options, sql, directives)
+      return nil unless options[:include_results]
+      table_name = /create\s*(?:temp)?\s*(?:table|view)(?:\s*if\s*not\s*exists)?\s*(\S+)/i.match(sql)[1]
+      execute("DROP TABLE IF EXISTS #{table_name}", options) if options[:drop_it]
+      execute(sql, options)
+      execute("COMPUTE STATS #{table_name}", options)
+      table_name.gsub!('.', '__')
       QueryToMD.new(db[table_name.to_sym], directives).to_md
     end
 
-    def query_to_md(include_results, sql, directives)
-      return nil unless include_results
+    def query_to_md(options, sql, directives)
+      return nil unless options[:include_results]
       return nil if sql.empty?
       QueryToMD.new(db[sql.sub(';', '')], directives).to_md
     end

data/sqltorial.gemspec

@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "anbt-sql-formatter", "~> 0.0.3"
   spec.add_dependency "facets", "~> 3.0"
   spec.add_dependency "escort", "~> 0.4.0"
-  spec.add_dependency "listen", "~> 3.0.0"
+  spec.add_dependency "listen", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqltorial
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ryan Duryea
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 description: Ingests a set of commented SQL statements, executes them, and dumps the
   comments, queries, and results into a markdown file
 email: