hsql 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa554151931427ef137d81dc3dde5461408278ad
-  data.tar.gz: 0f17ea6afbf1a1b23de5b3dd371cf614a5a9c78c
+  metadata.gz: 82602edd7ada1606c4d57b9295082549d459f219
+  data.tar.gz: 127987efbe6ea8b8b35c29cff1ee19e79fcf3343
 SHA512:
-  metadata.gz: 279e328a404d609dd56f11953f1e76759b5a46856625cd277ac839caeba2be1a2569df4c39d7bd452abc43cd07a40dbe86283755888f3b900678fb5e8961299b
-  data.tar.gz: e88f9555bb36a5a8288fb87d82f363442eede3033ee12ba7c5d59e6a0f526eee4e1782c473de6dae7c83091071e58b7d661f42db1b95bf09e15032ac36d84365
+  metadata.gz: 0202059f7b57dba2b6fa56278cf534748f191c46454d43634619e8e6653dd19fa518caf1c11d929bfc8f435804763f77f4f21539f4ea6ebc20ed7e36322137b7
+  data.tar.gz: 5902bb40c3f183f693434ee7c0789812456ec19ce40e08b82d76f9010be2b4ab432e0e042ef4d2f805bac3c3a077da9494ae5c9b89a87d3ffbc348e4bdcf5c2f

data/.rubocop.yml

@@ -12,3 +12,6 @@ StructInheritance:
 # `module_function` introduces by not copying private methods to the class.
 Style/ModuleFunction:
   Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false

data/Rakefile

@@ -18,7 +18,7 @@ task default: [:lint, :spec]
 task test: :spec
 task lint: :rubocop
 
-task :publish do
+task publish: [:lint, :spec] do
   require_relative 'lib/hsql/version'
   system(p('gem build hsql.gemspec'))
   system(p("gem push hsql-#{HSQL::VERSION}.gem"))

data/bin/hsql

@@ -1,75 +1,12 @@
 #!/usr/bin/env ruby
+require_relative '../lib/hsql/command_line'
 
-require 'optparse'
-require 'yaml'
-require 'json'
-require 'active_support/time'
-
-options = {}
-option_parser = OptionParser.new do |opts|
-  opts.banner = <<-BANNER
-Usage: #{File.basename(__FILE__)} file [environment]
-
-Arguments
-  file: Any *.sql file. If it has a YAML header (ending in three hyphens) the metadata will be processed;
-
-Options
-BANNER
-
-  opts.on('-d DATE',
-          '--date DATE',
-          '--timestamp DATE', 'The time that the SQL will consider to be "{{{now}}}".') do |option|
-    options[:timestamp] = Time.parse(option) if option
-  end
-  opts.on('-e ENV',
-          '--env ENV',
-          'Which key of the YAML header "data:" key you want to interpolate.') do |option|
-    options[:environment] = option
-  end
-  opts.on('-y', '--yaml', 'Output just the metadata for this file as YAML') do |_option|
-    options[:meta_only] = 'yaml'
-  end
-  opts.on('-j', '--json', 'Output just the metadata for this file as JSON') do |_option|
-    options[:meta_only] = 'json'
-  end
-  opts.on_tail('-v', '--version', 'Show the current version of HSQL') do |_option|
-    require_relative '../lib/hsql/version'
-    puts HSQL::VERSION
-    exit 1
-  end
-  opts.on('-h', '--help', 'Show the full help documentation') do |_option|
-    require_relative '../lib/hsql/data'
-    <<-HELP
-TEMPLATE
-
-You can use the Mustache syntax (three curly braces) to interpolate any of your
-'data' into your SQL. You specify the data in the YAML header like so:
-
-    data:
-      production:     # whatever you want to be interpolated into your SQL
-        name: Alison  # when you pass 'production' as the environment argument
-      development:
-        name: Kailey
-    ---
-    SELECT * FROM users WHERE name = '{{{name}}}'
-
-
-There are some common date values available to you at all times, without having
-to be defined in the YAML header:
-
-#{HSQL::Data.for_humans}
-
-For more details, run:
-  open https://github.com/JackDanger/hsql
-HELP
-  end
-end
-option_parser.parse!
-
-filename = ARGV.first
+command_line = HSQL::CommandLine.new
+options = command_line.options
+filename = command_line.filename
 
 unless filename
-  puts option_parser
+  puts command_line.option_parser
   exit 1
 end
 
@@ -88,8 +25,10 @@ if 'yaml' == options[:meta_only]
 elsif 'json' == options[:meta_only]
   puts file.to_json
 else
+  # Runs the whole SQL string through the parser to find the individual queries
+  # and then deparses it
   file.queries.each do |query|
-    # Runs the query through the parser and then deparses it
+    puts '-- Parsed and deparsed SQL:' if command_line.options[:verbose]
     puts query
   end
 end

data/examples/simple.sql

@@ -14,5 +14,6 @@ data:
     update_condition: WHERE 1 <> 1
 ---
 INSERT INTO {{{output_table}}} -- this query is joined to one line
-  SELECT COUNT(*) FROM interesting_information; -- and the comments get stripped
+  SELECT COUNT(*)
+  FROM interesting_information; -- and the comments get stripped
 UPDATE summaries_performed SET complete = 1 {{{update_condition}}};

data/lib/hsql/command_line.rb

@@ -0,0 +1,94 @@
+# rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+require 'optparse'
+require 'active_support/time'
+require_relative 'data'
+require_relative 'version'
+
+module HSQL
+  # Stuff that I'd rather not put directly into the executable goes here. This
+  # makes it much easier to test.
+  class CommandLine
+    def initialize
+      @options = {}
+    end
+
+    def options
+      option_parser.parse!
+      @options
+    end
+
+    def filename
+      option_parser.parse!
+      ARGV.first
+    end
+
+    def option_parser
+      @option_parser ||= OptionParser.new do |opts|
+        opts.banner = banner
+        opts.on('-d DATE',
+                '--date DATE',
+                '--timestamp DATE', 'The time that the SQL will consider to be "{{{now}}}".') do |option|
+          @options[:timestamp] = Time.parse(option) if option
+        end
+        opts.on('-e ENV',
+                '--env ENV',
+                'Which key of the YAML header "data:" key you want to interpolate.') do |option|
+          @options[:environment] = option
+        end
+        opts.on('-y', '--yaml', 'Output just the metadata for this file as YAML') do |_option|
+          @options[:meta_only] = 'yaml'
+        end
+        opts.on('-j', '--json', 'Output just the metadata for this file as JSON') do |_option|
+          @options[:meta_only] = 'json'
+        end
+        opts.on('-v', '--verbose', 'Output debug information') do |_option|
+          @options[:verbose] = true
+        end
+        opts.on_tail('-V', '--version', 'Show the current version of HSQL') do |_option|
+          puts HSQL::VERSION
+          exit 1
+        end
+        opts.on('-h', '--help', 'Show the full help documentation') do |_option|
+          help
+        end
+      end
+    end
+
+    def banner
+      <<-BANNER
+Usage: #{File.basename(__FILE__)} file [environment]
+
+Arguments
+  file: Any *.sql file. If it has a YAML header (ending in three hyphens) the metadata will be processed;
+
+Options
+BANNER
+    end
+
+    def help
+      <<-HELP
+TEMPLATE
+
+You can use the Mustache syntax (three curly braces) to interpolate any of your
+'data' into your SQL. You specify the data in the YAML header like so:
+
+    data:
+      production:     # whatever you want to be interpolated into your SQL
+        name: Alison  # when you pass 'production' as the environment argument
+      development:
+        name: Kailey
+    ---
+    SELECT * FROM users WHERE name = '{{{name}}}'
+
+
+There are some common date values available to you at all times, without having
+to be defined in the YAML header:
+
+#{HSQL::Data.for_humans}
+
+For more details, run:
+  open https://github.com/JackDanger/hsql
+HELP
+    end
+  end
+end

data/lib/hsql/file.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'json'
 require_relative 'query'
 require_relative 'data'
 require_relative 'template'
@@ -17,6 +18,7 @@ module HSQL
       @string = string
       @timestamp = options.fetch(:timestamp, Time.current)
       @environment = options[:environment]
+      @verbose = options[:verbose]
     end
 
     # Given the contents of a SQL file with YAML front matter (see README for an
@@ -54,6 +56,10 @@ module HSQL
 
     private
 
+    def verbose?
+      @verbose
+    end
+
     def split!
       @split ||= begin
         top_half, divider, rest = string.partition(/^---$/)
@@ -75,20 +81,27 @@ module HSQL
       end
     end
 
-    def interpolate_data!
+    def template
       template = Template.new(@sql)
       template.variable_names.each do |name|
         next if data.key?(name)
-
         if environment
           fail FormatError, "#{name.inspect} is not set in #{environment.inspect} environment"
         else
           fail FormatError, "#{name.inspect} is not set! Did you provide the right environment argument?"
         end
       end
+      template
+    end
 
+    def interpolate_data!
       # Insert the `data:` section of YAML for the given environment into our SQL queries.
       @rendered_sql = template.render(data)
+      if verbose?
+        STDERR.puts '-- Rendered SQL:'
+        STDERR.puts @rendered_sql
+      end
+      @rendered_sql
     end
   end
 end

data/lib/hsql/version.rb

@@ -1,4 +1,4 @@
 # http://semver.org/
 module HSQL
-  VERSION = '0.3.4'
+  VERSION = '0.3.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hsql
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Jack Danger Canty
@@ -161,6 +161,7 @@ files:
 - examples/simple.sql
 - hsql.gemspec
 - lib/hsql.rb
+- lib/hsql/command_line.rb
 - lib/hsql/data.rb
 - lib/hsql/file.rb
 - lib/hsql/query.rb