sqlsnip 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4691a62621199c780a25a27c14467e10ae3b48e2a20961a6f5660d5deab6b0aa
-  data.tar.gz: 7077d2b840173151db73d7bf038974791bbb5c4319e098d9741c2ef0b0b193b7
+  metadata.gz: 1c25a3eafcf25530a813f9b4c36b16e52d567f9ae945baed3f823642f5177555
+  data.tar.gz: 680fc3ba40fcbfcd945909ee9c994c267a2dbecea3baeb7c097b1e55e42bbe69
 SHA512:
-  metadata.gz: 4b9f2117d5242c5535a434e036c0a0926f399c3ef0cb31d6deac57f8c187048900cbba9d5d06f649fcd9bbebff95e8e172efab9713262f7422fb3157269c1b6d
-  data.tar.gz: 455d2f47f9be97fdc91e5d8b0f909a0846e19af94c3ad028550c2428373aee4c8febf923ad35743916b0aadc2d4ce544effebb491b568427744fc196fd27ffa6
+  metadata.gz: d803dd650b36880b6b574d98271846a87000c4dc7baaa26b8cfb3309dc12e981dd7c78794073457272624207591ab020166f72765f1ce388594172668f8dbbff
+  data.tar.gz: a41b647dcfcb71e3653099158e037042ac8c65f20089ac719cdb665d86dafeccf5f502cd9bd2569da848115fdb3b90eeb6c1aff0994003980c026146ed2a8267

data/exe/sqlsnip

@@ -11,11 +11,11 @@ SPEC = %(
   -- FILE [START [STOP]]
 
   Prepares a range of lines in a SQL file for execution by adding drop
-  statements for object defined in the range. If the range is absent, the whole
-  file is executed. Prints the resulting SQL script on standard output so it
-  can be piped to psql(1)
+  statements for objects defined in the range. If the range is absent, the
+  whole file is executed. Prints the resulting SQL script on standard output so
+  it can be piped to psql(1)
 
-  The range is given by a start and a stop line number (inclusive) and is
+  The range is given by a start and a stop line number (inclusive). It is
   scanned for lines matching 'create' and a drop statement is added for each
   match. Table, view, function, procedure, and trigger objects are supported.
   'or replace' definitions does not generate drop statements
@@ -28,37 +28,62 @@ SPEC = %(
   Note that the parser is very primitive: It expects the header of the
   definition to be on one line. It also doesn't know about comments
 
+  -i,interactive
+    Emit PSQL session statements (ON_ERROR_STOP)
+
+  -s,schema=SCHEMA?
+    Set initial search path. If SCHEMA is absent no initial search path is
+    emitted. Explicit search path settings in the source are always emitted
+
+  -d,drop-only
+    Only emit drop-statements. Can be used to insert drop statements in the
+    current editor
+
   EXAMPLE
 
   sqlsnip can be used to create a vim macro in .vimrcc that executes the
   selected text or the whole file:
 
-    \\function! ExecuteSqlFile() range
+    function! PrepareSqlRange() range
       let path = expand('%:p')
-      let result = system('sqlsnip' . path . ' | psql')
+      let start_line = line("'<")
+      let end_line = line("'>")
+      let result = system('sqlsnip ' . path . ' ' . start_line . ' ' . end_line . ' | psql')
       echo result
     endfunction
 
-    function! ExecuteSqlRange() range
+    " CTRL-X - execute selected range
+    map <C-X> :call PrepareSqlRange()<CR>
+
+  ...or the whole file
+
+    \\function! PrepareSqlFile() range
       let path = expand('%:p')
-      let start_line = line("'<")
-      let end_line = line("'>")
-      let result = system('sqlsnip ' . path . ' ' . start_line . ' ' . end_line . ' | psql')
+      let result = system('sqlsnip' . path . ' | psql')
       echo result
     endfunction
 
     " CTRL+G - execute whole file
-    map <C-G> :call ExecuteSqlFile()<CR>
+    map <C-G> :call PrepareSqlFile()<CR>
+
+  ...or to just replace the current selected text with drop statements
+
+  TODO
 
-    " CTRL-X - execute selected range
-    map <C-X> :call ExecuteSqlRange()<CR>
 )
 
 opts, args = ShellOpts.process(SPEC, ARGV)
-file, start_line, stop_line = args.extract(1..3)
-start_line ||= "1"
-stop_line ||= "100000000"
+file, start_line, stop_line = args.expect(1..3)
+start_line &&= start_line.to_i
+stop_line &&= stop_line.to_i
+
+search_path = opts.schema? ? opts.schema || "" : nil
+
+source = Sqlsnip::Source.parse(file, start_line, stop_line, search_path: search_path)
+puts source.generate(interactive: opts.interactive?)
 
-prg = Sqlsnip::Prg.new(file, start_line.to_i, stop_line.to_i)
-prg.run
+if !opts.drop_only?
+  puts
+  puts source.lines
+end
 

data/lib/sqlsnip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sqlsnip
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/sqlsnip.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+require 'string-text'
+require 'constrain'
+include Constrain
+
 require_relative "sqlsnip/version"
 
+
 module Sqlsnip
   class Error < StandardError; end
   
-  class Prg
+  class Source
     UID_RE = /(?:[.\w]+)/
     TABLE_MODIFIERS_RE = /(?:global|local|temporary|temp|unlogged)/
     VIEW_MODIFIERS_RE = /(?:temp|temporary|recursive)/
@@ -27,80 +32,57 @@ module Sqlsnip
 
     SEARCH_PATH_RE = /^\s*set\s+search_path/
 
-    attr_reader :file, :start_line, :stop_line
-    attr_reader :lines # The selected range of lines
+    # Source file
+    attr_reader :file
+
+    # Starting and ending line (inclusive). May be nil
+    attr_reader :start_line, :stop_line
+
+    # The selected range of lines as read from the file
+    attr_reader :lines
+
+    # Array of generated statements
+    attr_reader :stmts 
 
-    def initialize(file, start_line, stop_line)
+    # Initial search path
+    attr_reader :search_path
+
+    def initialize(file, start_line = nil, stop_line = nil, search_path: nil)
+      constrain file, String
+      constrain start_line, Integer, nil
+      constrain stop_line, Integer, nil
+      constrain search_path, String, nil
       @file, @start_line, @stop_line = file, start_line, stop_line
       File.exist?(@file) or raise Error, "Can't find #{file}"
       @lines = []
-      @initial_search_path = nil
+      @stmts = nil
+      @search_path = search_path
+      if @search_path && !@search_path.empty?
+        @search_path_stmt = "set search_path to #{@search_path};"
+      end
       @project_dir = nil
     end
 
-    def run
+    def parse
       read_lines
-      stmts, has_search_path = generate_drop_statements
-      if !has_search_path
-        search_path = @initial_search_path
-        if search_path.nil?
-          schema = find_schema_from_file(file)
-          search_path = "set search_path to #{schema}"
-        end
-        stmts.unshift search_path
-      end
-
-      puts '\set ON_ERROR_STOP on'
-      puts stmts
-      puts
-      puts lines
+      generate_drop_stmts
+      self
     end
 
-  private
-    attr_reader :initial_search_path, :project_dir
-
-    def read_lines
-      IO.readlines(file).each.with_index { |line, i|
-        i += 1
-        if i < start_line
-          @initial_search_path = line if line =~ /^\s*set\s+search_path/
-        elsif i <= stop_line
-          lines << line
-        else
-          break
-        end
-      }
-    end
+    def self.parse(*args, **opts) self.new(*args, **opts).parse end
 
-    def find_project_dir(path)
-      path = File.absolute_path(path)
-      while !File.exist?(File.join(path, "prick.yml"))
-        path != "/" or raise Error, "Can't find project directory"
-        path = File.dirname(path)
-      end
-      path
-    end
-
-    def find_schema_from_file(file)
-      path = File.dirname(file)
-      project_dir = find_project_dir(File.dirname(file))
-      path = path.delete_prefix(project_dir)
-      if path =~ /schema\/([^\/]+)/
-        schema = $1
-      else
-        schema != "" or raise Error, "Can't find schema from #{file}"
-      end
-      schema
+    def generate(interactive: false)
+      generate_search_path_stmt if @search_path != ""
+      generate_interactive_stmts if interactive
+      @stmts
     end
 
-    def generate_drop_statements
-      has_search_path = false
-      stmts = []
+    def generate_drop_stmts
+      @stmts = []
       for line in lines
         case line
           when /^\s*set\s+search_path/
             sql = line
-            has_search_path = true if stmts.empty?
           when /^\s*create\s+(.*)/
             object = $1
             case object 
@@ -134,9 +116,68 @@ module Sqlsnip
         else
           next
         end
-        stmts << sql
+        @stmts << sql
       end
-      [stmts, has_search_path]
+    end
+
+    # Generate a 'set search_path' statement
+    def generate_search_path_stmt
+      if @search_path == ""
+        return @stmts
+      elsif @search_path_stmt
+        @stmts.unshift @search_path_stmt
+      else
+        schema = find_schema_from_file(file)
+        search_path = "set search_path to #{schema};"
+        @stmts.unshift search_path
+      end
+    end
+
+    def generate_interactive_stmts
+      @stmts.unshift '\set ON_ERROR_STOP on'
+    end
+
+
+  private
+    attr_reader :search_path_stmt, :project_dir
+
+    def read_lines
+      IO.readlines(file).each.with_index { |line, i|
+        line.chomp!
+        i += 1
+        if start_line.nil?
+          @lines << line
+        elsif i < start_line
+          @search_path_stmt = line if @search_path.nil? && line =~ /^\s*set\s+search_path/
+        elsif stop_line.nil? || i <= stop_line
+          @lines << line
+        else
+          break
+        end
+      }
+    end
+
+    # Search upwards in the directory hierarchy for a prick project directory
+    def find_project_dir(path)
+      path = File.absolute_path(path)
+      while !File.exist?(File.join(path, "prick.yml"))
+        path != "/" or raise Error, "Can't find project directory"
+        path = File.dirname(path)
+      end
+      path
+    end
+  
+    # Use the prick source directory structure to find the schema name
+    def find_schema_from_file(file)
+      path = File.dirname(file)
+      project_dir = find_project_dir(File.dirname(file))
+      path = path.delete_prefix(project_dir)
+      if path =~ /schema\/([^\/]+)/
+        schema = $1
+      else
+        schema != "" or raise Error, "Can't find schema from #{file}"
+      end
+      schema
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqlsnip
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-19 00:00:00.000000000 Z
+date: 2024-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: indented_io
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: string-text
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: constrain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem sqlsnip
 email:
 - claus.l.rasmussen@gmail.com